babylon.module.d.ts 5.7 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518
  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. readonly 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. * Extracts text content from a DOM element hierarchy
  290. * @param element defines the root element
  291. * @returns a string
  292. */
  293. static GetDOMTextContent(element: HTMLElement): string;
  294. }
  295. }
  296. declare module "babylonjs/Misc/logger" {
  297. /**
  298. * Logger used througouht the application to allow configuration of
  299. * the log level required for the messages.
  300. */
  301. export class Logger {
  302. /**
  303. * No log
  304. */
  305. static readonly NoneLogLevel: number;
  306. /**
  307. * Only message logs
  308. */
  309. static readonly MessageLogLevel: number;
  310. /**
  311. * Only warning logs
  312. */
  313. static readonly WarningLogLevel: number;
  314. /**
  315. * Only error logs
  316. */
  317. static readonly ErrorLogLevel: number;
  318. /**
  319. * All logs
  320. */
  321. static readonly AllLogLevel: number;
  322. private static _LogCache;
  323. /**
  324. * Gets a value indicating the number of loading errors
  325. * @ignorenaming
  326. */
  327. static errorsCount: number;
  328. /**
  329. * Callback called when a new log is added
  330. */
  331. static OnNewCacheEntry: (entry: string) => void;
  332. private static _AddLogEntry;
  333. private static _FormatMessage;
  334. private static _LogDisabled;
  335. private static _LogEnabled;
  336. private static _WarnDisabled;
  337. private static _WarnEnabled;
  338. private static _ErrorDisabled;
  339. private static _ErrorEnabled;
  340. /**
  341. * Log a message to the console
  342. */
  343. static Log: (message: string) => void;
  344. /**
  345. * Write a warning message to the console
  346. */
  347. static Warn: (message: string) => void;
  348. /**
  349. * Write an error message to the console
  350. */
  351. static Error: (message: string) => void;
  352. /**
  353. * Gets current log cache (list of logs)
  354. */
  355. static readonly LogCache: string;
  356. /**
  357. * Clears the log cache
  358. */
  359. static ClearLogCache(): void;
  360. /**
  361. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  362. */
  363. static LogLevels: number;
  364. }
  365. }
  366. declare module "babylonjs/Misc/typeStore" {
  367. /** @hidden */
  368. export class _TypeStore {
  369. /** @hidden */
  370. static RegisteredTypes: {
  371. [key: string]: Object;
  372. };
  373. /** @hidden */
  374. static GetClass(fqdn: string): any;
  375. }
  376. }
  377. declare module "babylonjs/Misc/stringTools" {
  378. /**
  379. * Helper to manipulate strings
  380. */
  381. export class StringTools {
  382. /**
  383. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  384. * @param str Source string
  385. * @param suffix Suffix to search for in the source string
  386. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  387. */
  388. static EndsWith(str: string, suffix: string): boolean;
  389. /**
  390. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  391. * @param str Source string
  392. * @param suffix Suffix to search for in the source string
  393. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  394. */
  395. static StartsWith(str: string, suffix: string): boolean;
  396. /**
  397. * Decodes a buffer into a string
  398. * @param buffer The buffer to decode
  399. * @returns The decoded string
  400. */
  401. static Decode(buffer: Uint8Array | Uint16Array): string;
  402. /**
  403. * Encode a buffer to a base64 string
  404. * @param buffer defines the buffer to encode
  405. * @returns the encoded string
  406. */
  407. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  408. }
  409. }
  410. declare module "babylonjs/Misc/deepCopier" {
  411. /**
  412. * Class containing a set of static utilities functions for deep copy.
  413. */
  414. export class DeepCopier {
  415. /**
  416. * Tries to copy an object by duplicating every property
  417. * @param source defines the source object
  418. * @param destination defines the target object
  419. * @param doNotCopyList defines a list of properties to avoid
  420. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  421. */
  422. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  423. }
  424. }
  425. declare module "babylonjs/Misc/precisionDate" {
  426. /**
  427. * Class containing a set of static utilities functions for precision date
  428. */
  429. export class PrecisionDate {
  430. /**
  431. * Gets either window.performance.now() if supported or Date.now() else
  432. */
  433. static readonly Now: number;
  434. }
  435. }
  436. declare module "babylonjs/Misc/devTools" {
  437. /** @hidden */
  438. export class _DevTools {
  439. static WarnImport(name: string): string;
  440. }
  441. }
  442. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  443. /**
  444. * Interface used to define the mechanism to get data from the network
  445. */
  446. export interface IWebRequest {
  447. /**
  448. * Returns client's response url
  449. */
  450. responseURL: string;
  451. /**
  452. * Returns client's status
  453. */
  454. status: number;
  455. /**
  456. * Returns client's status as a text
  457. */
  458. statusText: string;
  459. }
  460. }
  461. declare module "babylonjs/Misc/webRequest" {
  462. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  463. import { Nullable } from "babylonjs/types";
  464. /**
  465. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  466. */
  467. export class WebRequest implements IWebRequest {
  468. private _xhr;
  469. /**
  470. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  471. * i.e. when loading files, where the server/service expects an Authorization header
  472. */
  473. static CustomRequestHeaders: {
  474. [key: string]: string;
  475. };
  476. /**
  477. * Add callback functions in this array to update all the requests before they get sent to the network
  478. */
  479. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  480. private _injectCustomRequestHeaders;
  481. /**
  482. * Gets or sets a function to be called when loading progress changes
  483. */
  484. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  485. /**
  486. * Returns client's state
  487. */
  488. readonly readyState: number;
  489. /**
  490. * Returns client's status
  491. */
  492. readonly status: number;
  493. /**
  494. * Returns client's status as a text
  495. */
  496. readonly statusText: string;
  497. /**
  498. * Returns client's response
  499. */
  500. readonly response: any;
  501. /**
  502. * Returns client's response url
  503. */
  504. readonly responseURL: string;
  505. /**
  506. * Returns client's response as text
  507. */
  508. readonly responseText: string;
  509. /**
  510. * Gets or sets the expected response type
  511. */
  512. responseType: XMLHttpRequestResponseType;
  513. /** @hidden */
  514. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  515. /** @hidden */
  516. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  517. /**
  518. * Cancels any network activity
  519. */
  520. abort(): void;
  521. /**
  522. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  523. * @param body defines an optional request body
  524. */
  525. send(body?: Document | BodyInit | null): void;
  526. /**
  527. * Sets the request method, request URL
  528. * @param method defines the method to use (GET, POST, etc..)
  529. * @param url defines the url to connect with
  530. */
  531. open(method: string, url: string): void;
  532. /**
  533. * Sets the value of a request header.
  534. * @param name The name of the header whose value is to be set
  535. * @param value The value to set as the body of the header
  536. */
  537. setRequestHeader(name: string, value: string): void;
  538. /**
  539. * Get the string containing the text of a particular header's value.
  540. * @param name The name of the header
  541. * @returns The string containing the text of the given header name
  542. */
  543. getResponseHeader(name: string): Nullable<string>;
  544. }
  545. }
  546. declare module "babylonjs/Misc/fileRequest" {
  547. import { Observable } from "babylonjs/Misc/observable";
  548. /**
  549. * File request interface
  550. */
  551. export interface IFileRequest {
  552. /**
  553. * Raised when the request is complete (success or error).
  554. */
  555. onCompleteObservable: Observable<IFileRequest>;
  556. /**
  557. * Aborts the request for a file.
  558. */
  559. abort: () => void;
  560. }
  561. }
  562. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  563. /**
  564. * Define options used to create a render target texture
  565. */
  566. export class RenderTargetCreationOptions {
  567. /**
  568. * Specifies is mipmaps must be generated
  569. */
  570. generateMipMaps?: boolean;
  571. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  572. generateDepthBuffer?: boolean;
  573. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  574. generateStencilBuffer?: boolean;
  575. /** Defines texture type (int by default) */
  576. type?: number;
  577. /** Defines sampling mode (trilinear by default) */
  578. samplingMode?: number;
  579. /** Defines format (RGBA by default) */
  580. format?: number;
  581. }
  582. }
  583. declare module "babylonjs/Instrumentation/timeToken" {
  584. import { Nullable } from "babylonjs/types";
  585. /**
  586. * @hidden
  587. **/
  588. export class _TimeToken {
  589. _startTimeQuery: Nullable<WebGLQuery>;
  590. _endTimeQuery: Nullable<WebGLQuery>;
  591. _timeElapsedQuery: Nullable<WebGLQuery>;
  592. _timeElapsedQueryEnded: boolean;
  593. }
  594. }
  595. declare module "babylonjs/Engines/constants" {
  596. /** Defines the cross module used constants to avoid circular dependncies */
  597. export class Constants {
  598. /** Defines that alpha blending is disabled */
  599. static readonly ALPHA_DISABLE: number;
  600. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  601. static readonly ALPHA_ADD: number;
  602. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  603. static readonly ALPHA_COMBINE: number;
  604. /** Defines that alpha blending to DEST - SRC * DEST */
  605. static readonly ALPHA_SUBTRACT: number;
  606. /** Defines that alpha blending to SRC * DEST */
  607. static readonly ALPHA_MULTIPLY: number;
  608. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  609. static readonly ALPHA_MAXIMIZED: number;
  610. /** Defines that alpha blending to SRC + DEST */
  611. static readonly ALPHA_ONEONE: number;
  612. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  613. static readonly ALPHA_PREMULTIPLIED: number;
  614. /**
  615. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  616. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  617. */
  618. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  619. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  620. static readonly ALPHA_INTERPOLATE: number;
  621. /**
  622. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  623. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  624. */
  625. static readonly ALPHA_SCREENMODE: number;
  626. /**
  627. * Defines that alpha blending to SRC + DST
  628. * Alpha will be set to SRC ALPHA + DST ALPHA
  629. */
  630. static readonly ALPHA_ONEONE_ONEONE: number;
  631. /**
  632. * Defines that alpha blending to SRC * DST ALPHA + DST
  633. * Alpha will be set to 0
  634. */
  635. static readonly ALPHA_ALPHATOCOLOR: number;
  636. /**
  637. * Defines that alpha blending to SRC * (1 - DST) + DST * (1 - SRC)
  638. */
  639. static readonly ALPHA_REVERSEONEMINUS: number;
  640. /**
  641. * Defines that alpha blending to SRC + DST * (1 - SRC ALPHA)
  642. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  643. */
  644. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  645. /**
  646. * Defines that alpha blending to SRC + DST
  647. * Alpha will be set to SRC ALPHA
  648. */
  649. static readonly ALPHA_ONEONE_ONEZERO: number;
  650. /** Defines that alpha blending equation a SUM */
  651. static readonly ALPHA_EQUATION_ADD: number;
  652. /** Defines that alpha blending equation a SUBSTRACTION */
  653. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  654. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  655. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  656. /** Defines that alpha blending equation a MAX operation */
  657. static readonly ALPHA_EQUATION_MAX: number;
  658. /** Defines that alpha blending equation a MIN operation */
  659. static readonly ALPHA_EQUATION_MIN: number;
  660. /**
  661. * Defines that alpha blending equation a DARKEN operation:
  662. * It takes the min of the src and sums the alpha channels.
  663. */
  664. static readonly ALPHA_EQUATION_DARKEN: number;
  665. /** Defines that the ressource is not delayed*/
  666. static readonly DELAYLOADSTATE_NONE: number;
  667. /** Defines that the ressource was successfully delay loaded */
  668. static readonly DELAYLOADSTATE_LOADED: number;
  669. /** Defines that the ressource is currently delay loading */
  670. static readonly DELAYLOADSTATE_LOADING: number;
  671. /** Defines that the ressource is delayed and has not started loading */
  672. static readonly DELAYLOADSTATE_NOTLOADED: number;
  673. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  674. static readonly NEVER: number;
  675. /** 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 */
  676. static readonly ALWAYS: number;
  677. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  678. static readonly LESS: number;
  679. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  680. static readonly EQUAL: number;
  681. /** 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 */
  682. static readonly LEQUAL: number;
  683. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  684. static readonly GREATER: number;
  685. /** 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 */
  686. static readonly GEQUAL: number;
  687. /** 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 */
  688. static readonly NOTEQUAL: number;
  689. /** Passed to stencilOperation to specify that stencil value must be kept */
  690. static readonly KEEP: number;
  691. /** Passed to stencilOperation to specify that stencil value must be replaced */
  692. static readonly REPLACE: number;
  693. /** Passed to stencilOperation to specify that stencil value must be incremented */
  694. static readonly INCR: number;
  695. /** Passed to stencilOperation to specify that stencil value must be decremented */
  696. static readonly DECR: number;
  697. /** Passed to stencilOperation to specify that stencil value must be inverted */
  698. static readonly INVERT: number;
  699. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  700. static readonly INCR_WRAP: number;
  701. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  702. static readonly DECR_WRAP: number;
  703. /** Texture is not repeating outside of 0..1 UVs */
  704. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  705. /** Texture is repeating outside of 0..1 UVs */
  706. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  707. /** Texture is repeating and mirrored */
  708. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  709. /** ALPHA */
  710. static readonly TEXTUREFORMAT_ALPHA: number;
  711. /** LUMINANCE */
  712. static readonly TEXTUREFORMAT_LUMINANCE: number;
  713. /** LUMINANCE_ALPHA */
  714. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  715. /** RGB */
  716. static readonly TEXTUREFORMAT_RGB: number;
  717. /** RGBA */
  718. static readonly TEXTUREFORMAT_RGBA: number;
  719. /** RED */
  720. static readonly TEXTUREFORMAT_RED: number;
  721. /** RED (2nd reference) */
  722. static readonly TEXTUREFORMAT_R: number;
  723. /** RG */
  724. static readonly TEXTUREFORMAT_RG: number;
  725. /** RED_INTEGER */
  726. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  727. /** RED_INTEGER (2nd reference) */
  728. static readonly TEXTUREFORMAT_R_INTEGER: number;
  729. /** RG_INTEGER */
  730. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  731. /** RGB_INTEGER */
  732. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  733. /** RGBA_INTEGER */
  734. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  735. /** UNSIGNED_BYTE */
  736. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  737. /** UNSIGNED_BYTE (2nd reference) */
  738. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  739. /** FLOAT */
  740. static readonly TEXTURETYPE_FLOAT: number;
  741. /** HALF_FLOAT */
  742. static readonly TEXTURETYPE_HALF_FLOAT: number;
  743. /** BYTE */
  744. static readonly TEXTURETYPE_BYTE: number;
  745. /** SHORT */
  746. static readonly TEXTURETYPE_SHORT: number;
  747. /** UNSIGNED_SHORT */
  748. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  749. /** INT */
  750. static readonly TEXTURETYPE_INT: number;
  751. /** UNSIGNED_INT */
  752. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  753. /** UNSIGNED_SHORT_4_4_4_4 */
  754. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  755. /** UNSIGNED_SHORT_5_5_5_1 */
  756. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  757. /** UNSIGNED_SHORT_5_6_5 */
  758. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  759. /** UNSIGNED_INT_2_10_10_10_REV */
  760. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  761. /** UNSIGNED_INT_24_8 */
  762. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  763. /** UNSIGNED_INT_10F_11F_11F_REV */
  764. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  765. /** UNSIGNED_INT_5_9_9_9_REV */
  766. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  767. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  768. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  769. /** nearest is mag = nearest and min = nearest and mip = linear */
  770. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  771. /** Bilinear is mag = linear and min = linear and mip = nearest */
  772. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  773. /** Trilinear is mag = linear and min = linear and mip = linear */
  774. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  775. /** nearest is mag = nearest and min = nearest and mip = linear */
  776. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  777. /** Bilinear is mag = linear and min = linear and mip = nearest */
  778. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  779. /** Trilinear is mag = linear and min = linear and mip = linear */
  780. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  781. /** mag = nearest and min = nearest and mip = nearest */
  782. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  783. /** mag = nearest and min = linear and mip = nearest */
  784. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  785. /** mag = nearest and min = linear and mip = linear */
  786. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  787. /** mag = nearest and min = linear and mip = none */
  788. static readonly TEXTURE_NEAREST_LINEAR: number;
  789. /** mag = nearest and min = nearest and mip = none */
  790. static readonly TEXTURE_NEAREST_NEAREST: number;
  791. /** mag = linear and min = nearest and mip = nearest */
  792. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  793. /** mag = linear and min = nearest and mip = linear */
  794. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  795. /** mag = linear and min = linear and mip = none */
  796. static readonly TEXTURE_LINEAR_LINEAR: number;
  797. /** mag = linear and min = nearest and mip = none */
  798. static readonly TEXTURE_LINEAR_NEAREST: number;
  799. /** Explicit coordinates mode */
  800. static readonly TEXTURE_EXPLICIT_MODE: number;
  801. /** Spherical coordinates mode */
  802. static readonly TEXTURE_SPHERICAL_MODE: number;
  803. /** Planar coordinates mode */
  804. static readonly TEXTURE_PLANAR_MODE: number;
  805. /** Cubic coordinates mode */
  806. static readonly TEXTURE_CUBIC_MODE: number;
  807. /** Projection coordinates mode */
  808. static readonly TEXTURE_PROJECTION_MODE: number;
  809. /** Skybox coordinates mode */
  810. static readonly TEXTURE_SKYBOX_MODE: number;
  811. /** Inverse Cubic coordinates mode */
  812. static readonly TEXTURE_INVCUBIC_MODE: number;
  813. /** Equirectangular coordinates mode */
  814. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  815. /** Equirectangular Fixed coordinates mode */
  816. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  817. /** Equirectangular Fixed Mirrored coordinates mode */
  818. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  819. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  820. static readonly SCALEMODE_FLOOR: number;
  821. /** Defines that texture rescaling will look for the nearest power of 2 size */
  822. static readonly SCALEMODE_NEAREST: number;
  823. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  824. static readonly SCALEMODE_CEILING: number;
  825. /**
  826. * The dirty texture flag value
  827. */
  828. static readonly MATERIAL_TextureDirtyFlag: number;
  829. /**
  830. * The dirty light flag value
  831. */
  832. static readonly MATERIAL_LightDirtyFlag: number;
  833. /**
  834. * The dirty fresnel flag value
  835. */
  836. static readonly MATERIAL_FresnelDirtyFlag: number;
  837. /**
  838. * The dirty attribute flag value
  839. */
  840. static readonly MATERIAL_AttributesDirtyFlag: number;
  841. /**
  842. * The dirty misc flag value
  843. */
  844. static readonly MATERIAL_MiscDirtyFlag: number;
  845. /**
  846. * The all dirty flag value
  847. */
  848. static readonly MATERIAL_AllDirtyFlag: number;
  849. /**
  850. * Returns the triangle fill mode
  851. */
  852. static readonly MATERIAL_TriangleFillMode: number;
  853. /**
  854. * Returns the wireframe mode
  855. */
  856. static readonly MATERIAL_WireFrameFillMode: number;
  857. /**
  858. * Returns the point fill mode
  859. */
  860. static readonly MATERIAL_PointFillMode: number;
  861. /**
  862. * Returns the point list draw mode
  863. */
  864. static readonly MATERIAL_PointListDrawMode: number;
  865. /**
  866. * Returns the line list draw mode
  867. */
  868. static readonly MATERIAL_LineListDrawMode: number;
  869. /**
  870. * Returns the line loop draw mode
  871. */
  872. static readonly MATERIAL_LineLoopDrawMode: number;
  873. /**
  874. * Returns the line strip draw mode
  875. */
  876. static readonly MATERIAL_LineStripDrawMode: number;
  877. /**
  878. * Returns the triangle strip draw mode
  879. */
  880. static readonly MATERIAL_TriangleStripDrawMode: number;
  881. /**
  882. * Returns the triangle fan draw mode
  883. */
  884. static readonly MATERIAL_TriangleFanDrawMode: number;
  885. /**
  886. * Stores the clock-wise side orientation
  887. */
  888. static readonly MATERIAL_ClockWiseSideOrientation: number;
  889. /**
  890. * Stores the counter clock-wise side orientation
  891. */
  892. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  893. /**
  894. * Nothing
  895. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  896. */
  897. static readonly ACTION_NothingTrigger: number;
  898. /**
  899. * On pick
  900. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  901. */
  902. static readonly ACTION_OnPickTrigger: number;
  903. /**
  904. * On left pick
  905. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  906. */
  907. static readonly ACTION_OnLeftPickTrigger: number;
  908. /**
  909. * On right pick
  910. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_OnRightPickTrigger: number;
  913. /**
  914. * On center pick
  915. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnCenterPickTrigger: number;
  918. /**
  919. * On pick down
  920. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnPickDownTrigger: number;
  923. /**
  924. * On double pick
  925. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnDoublePickTrigger: number;
  928. /**
  929. * On pick up
  930. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnPickUpTrigger: number;
  933. /**
  934. * On pick out.
  935. * This trigger will only be raised if you also declared a OnPickDown
  936. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  937. */
  938. static readonly ACTION_OnPickOutTrigger: number;
  939. /**
  940. * On long press
  941. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  942. */
  943. static readonly ACTION_OnLongPressTrigger: number;
  944. /**
  945. * On pointer over
  946. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  947. */
  948. static readonly ACTION_OnPointerOverTrigger: number;
  949. /**
  950. * On pointer out
  951. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPointerOutTrigger: number;
  954. /**
  955. * On every frame
  956. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnEveryFrameTrigger: number;
  959. /**
  960. * On intersection enter
  961. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnIntersectionEnterTrigger: number;
  964. /**
  965. * On intersection exit
  966. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnIntersectionExitTrigger: number;
  969. /**
  970. * On key down
  971. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnKeyDownTrigger: number;
  974. /**
  975. * On key up
  976. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnKeyUpTrigger: number;
  979. /**
  980. * Billboard mode will only apply to Y axis
  981. */
  982. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  983. /**
  984. * Billboard mode will apply to all axes
  985. */
  986. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  987. /**
  988. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  989. */
  990. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  991. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  992. * Test order :
  993. * Is the bounding sphere outside the frustum ?
  994. * If not, are the bounding box vertices outside the frustum ?
  995. * It not, then the cullable object is in the frustum.
  996. */
  997. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  998. /** Culling strategy : Bounding Sphere Only.
  999. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1000. * It's also less accurate than the standard because some not visible objects can still be selected.
  1001. * Test : is the bounding sphere outside the frustum ?
  1002. * If not, then the cullable object is in the frustum.
  1003. */
  1004. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1005. /** Culling strategy : Optimistic Inclusion.
  1006. * This in an inclusion test first, then the standard exclusion test.
  1007. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1008. * 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.
  1009. * Anyway, it's as accurate as the standard strategy.
  1010. * Test :
  1011. * Is the cullable object bounding sphere center in the frustum ?
  1012. * If not, apply the default culling strategy.
  1013. */
  1014. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1015. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1016. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1017. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1018. * 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.
  1019. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1020. * Test :
  1021. * Is the cullable object bounding sphere center in the frustum ?
  1022. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1023. */
  1024. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1025. /**
  1026. * No logging while loading
  1027. */
  1028. static readonly SCENELOADER_NO_LOGGING: number;
  1029. /**
  1030. * Minimal logging while loading
  1031. */
  1032. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1033. /**
  1034. * Summary logging while loading
  1035. */
  1036. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1037. /**
  1038. * Detailled logging while loading
  1039. */
  1040. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1041. }
  1042. }
  1043. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1044. import { Nullable } from "babylonjs/types";
  1045. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1046. /**
  1047. * This represents the required contract to create a new type of texture loader.
  1048. */
  1049. export interface IInternalTextureLoader {
  1050. /**
  1051. * Defines wether the loader supports cascade loading the different faces.
  1052. */
  1053. supportCascades: boolean;
  1054. /**
  1055. * This returns if the loader support the current file information.
  1056. * @param extension defines the file extension of the file being loaded
  1057. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1058. * @param fallback defines the fallback internal texture if any
  1059. * @param isBase64 defines whether the texture is encoded as a base64
  1060. * @param isBuffer defines whether the texture data are stored as a buffer
  1061. * @returns true if the loader can load the specified file
  1062. */
  1063. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  1064. /**
  1065. * Transform the url before loading if required.
  1066. * @param rootUrl the url of the texture
  1067. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1068. * @returns the transformed texture
  1069. */
  1070. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  1071. /**
  1072. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  1073. * @param rootUrl the url of the texture
  1074. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1075. * @returns the fallback texture
  1076. */
  1077. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  1078. /**
  1079. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  1080. * @param data contains the texture data
  1081. * @param texture defines the BabylonJS internal texture
  1082. * @param createPolynomials will be true if polynomials have been requested
  1083. * @param onLoad defines the callback to trigger once the texture is ready
  1084. * @param onError defines the callback to trigger in case of error
  1085. */
  1086. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1087. /**
  1088. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  1089. * @param data contains the texture data
  1090. * @param texture defines the BabylonJS internal texture
  1091. * @param callback defines the method to call once ready to upload
  1092. */
  1093. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1094. }
  1095. }
  1096. declare module "babylonjs/Engines/IPipelineContext" {
  1097. /**
  1098. * Class used to store and describe the pipeline context associated with an effect
  1099. */
  1100. export interface IPipelineContext {
  1101. /**
  1102. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1103. */
  1104. isAsync: boolean;
  1105. /**
  1106. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1107. */
  1108. isReady: boolean;
  1109. /** @hidden */
  1110. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1111. }
  1112. }
  1113. declare module "babylonjs/Meshes/dataBuffer" {
  1114. /**
  1115. * Class used to store gfx data (like WebGLBuffer)
  1116. */
  1117. export class DataBuffer {
  1118. /**
  1119. * Gets or sets the number of objects referencing this buffer
  1120. */
  1121. references: number;
  1122. /** Gets or sets the size of the underlying buffer */
  1123. capacity: number;
  1124. /**
  1125. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1126. */
  1127. is32Bits: boolean;
  1128. /**
  1129. * Gets the underlying buffer
  1130. */
  1131. readonly underlyingResource: any;
  1132. }
  1133. }
  1134. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1135. /** @hidden */
  1136. export interface IShaderProcessor {
  1137. attributeProcessor?: (attribute: string) => string;
  1138. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1139. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1140. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1141. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1142. lineProcessor?: (line: string, isFragment: boolean) => string;
  1143. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1144. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1145. }
  1146. }
  1147. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1148. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1149. /** @hidden */
  1150. export interface ProcessingOptions {
  1151. defines: string[];
  1152. indexParameters: any;
  1153. isFragment: boolean;
  1154. shouldUseHighPrecisionShader: boolean;
  1155. supportsUniformBuffers: boolean;
  1156. shadersRepository: string;
  1157. includesShadersStore: {
  1158. [key: string]: string;
  1159. };
  1160. processor?: IShaderProcessor;
  1161. version: string;
  1162. platformName: string;
  1163. lookForClosingBracketForUniformBuffer?: boolean;
  1164. }
  1165. }
  1166. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1167. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1168. /** @hidden */
  1169. export class ShaderCodeNode {
  1170. line: string;
  1171. children: ShaderCodeNode[];
  1172. additionalDefineKey?: string;
  1173. additionalDefineValue?: string;
  1174. isValid(preprocessors: {
  1175. [key: string]: string;
  1176. }): boolean;
  1177. process(preprocessors: {
  1178. [key: string]: string;
  1179. }, options: ProcessingOptions): string;
  1180. }
  1181. }
  1182. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1183. /** @hidden */
  1184. export class ShaderCodeCursor {
  1185. private _lines;
  1186. lineIndex: number;
  1187. readonly currentLine: string;
  1188. readonly canRead: boolean;
  1189. lines: string[];
  1190. }
  1191. }
  1192. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1193. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1194. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1195. /** @hidden */
  1196. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1197. process(preprocessors: {
  1198. [key: string]: string;
  1199. }, options: ProcessingOptions): string;
  1200. }
  1201. }
  1202. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1203. /** @hidden */
  1204. export class ShaderDefineExpression {
  1205. isTrue(preprocessors: {
  1206. [key: string]: string;
  1207. }): boolean;
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1213. /** @hidden */
  1214. export class ShaderCodeTestNode extends ShaderCodeNode {
  1215. testExpression: ShaderDefineExpression;
  1216. isValid(preprocessors: {
  1217. [key: string]: string;
  1218. }): boolean;
  1219. }
  1220. }
  1221. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1222. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1223. /** @hidden */
  1224. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1225. define: string;
  1226. not: boolean;
  1227. constructor(define: string, not?: boolean);
  1228. isTrue(preprocessors: {
  1229. [key: string]: string;
  1230. }): boolean;
  1231. }
  1232. }
  1233. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1237. leftOperand: ShaderDefineExpression;
  1238. rightOperand: ShaderDefineExpression;
  1239. isTrue(preprocessors: {
  1240. [key: string]: string;
  1241. }): boolean;
  1242. }
  1243. }
  1244. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1245. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1246. /** @hidden */
  1247. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1248. leftOperand: ShaderDefineExpression;
  1249. rightOperand: ShaderDefineExpression;
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1259. define: string;
  1260. operand: string;
  1261. testValue: string;
  1262. constructor(define: string, operand: string, testValue: string);
  1263. isTrue(preprocessors: {
  1264. [key: string]: string;
  1265. }): boolean;
  1266. }
  1267. }
  1268. declare module "babylonjs/Offline/IOfflineProvider" {
  1269. /**
  1270. * Class used to enable access to offline support
  1271. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1272. */
  1273. export interface IOfflineProvider {
  1274. /**
  1275. * Gets a boolean indicating if scene must be saved in the database
  1276. */
  1277. enableSceneOffline: boolean;
  1278. /**
  1279. * Gets a boolean indicating if textures must be saved in the database
  1280. */
  1281. enableTexturesOffline: boolean;
  1282. /**
  1283. * Open the offline support and make it available
  1284. * @param successCallback defines the callback to call on success
  1285. * @param errorCallback defines the callback to call on error
  1286. */
  1287. open(successCallback: () => void, errorCallback: () => void): void;
  1288. /**
  1289. * Loads an image from the offline support
  1290. * @param url defines the url to load from
  1291. * @param image defines the target DOM image
  1292. */
  1293. loadImage(url: string, image: HTMLImageElement): void;
  1294. /**
  1295. * Loads a file from offline support
  1296. * @param url defines the URL to load from
  1297. * @param sceneLoaded defines a callback to call on success
  1298. * @param progressCallBack defines a callback to call when progress changed
  1299. * @param errorCallback defines a callback to call on error
  1300. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1301. */
  1302. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1303. }
  1304. }
  1305. declare module "babylonjs/Misc/filesInputStore" {
  1306. /**
  1307. * Class used to help managing file picking and drag'n'drop
  1308. * File Storage
  1309. */
  1310. export class FilesInputStore {
  1311. /**
  1312. * List of files ready to be loaded
  1313. */
  1314. static FilesToLoad: {
  1315. [key: string]: File;
  1316. };
  1317. }
  1318. }
  1319. declare module "babylonjs/Misc/retryStrategy" {
  1320. import { WebRequest } from "babylonjs/Misc/webRequest";
  1321. /**
  1322. * Class used to define a retry strategy when error happens while loading assets
  1323. */
  1324. export class RetryStrategy {
  1325. /**
  1326. * Function used to defines an exponential back off strategy
  1327. * @param maxRetries defines the maximum number of retries (3 by default)
  1328. * @param baseInterval defines the interval between retries
  1329. * @returns the strategy function to use
  1330. */
  1331. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1332. }
  1333. }
  1334. declare module "babylonjs/Misc/baseError" {
  1335. /**
  1336. * @ignore
  1337. * Application error to support additional information when loading a file
  1338. */
  1339. export abstract class BaseError extends Error {
  1340. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1341. }
  1342. }
  1343. declare module "babylonjs/Misc/fileTools" {
  1344. import { WebRequest } from "babylonjs/Misc/webRequest";
  1345. import { Nullable } from "babylonjs/types";
  1346. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1347. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1348. import { BaseError } from "babylonjs/Misc/baseError";
  1349. /** @ignore */
  1350. export class LoadFileError extends BaseError {
  1351. request?: WebRequest;
  1352. file?: File;
  1353. /**
  1354. * Creates a new LoadFileError
  1355. * @param message defines the message of the error
  1356. * @param request defines the optional web request
  1357. * @param file defines the optional file
  1358. */
  1359. constructor(message: string, object?: WebRequest | File);
  1360. }
  1361. /** @ignore */
  1362. export class RequestFileError extends BaseError {
  1363. request: WebRequest;
  1364. /**
  1365. * Creates a new LoadFileError
  1366. * @param message defines the message of the error
  1367. * @param request defines the optional web request
  1368. */
  1369. constructor(message: string, request: WebRequest);
  1370. }
  1371. /** @ignore */
  1372. export class ReadFileError extends BaseError {
  1373. file: File;
  1374. /**
  1375. * Creates a new ReadFileError
  1376. * @param message defines the message of the error
  1377. * @param file defines the optional file
  1378. */
  1379. constructor(message: string, file: File);
  1380. }
  1381. /**
  1382. * @hidden
  1383. */
  1384. export class FileTools {
  1385. /**
  1386. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1387. */
  1388. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1389. /**
  1390. * Gets or sets the base URL to use to load assets
  1391. */
  1392. static BaseUrl: string;
  1393. /**
  1394. * Default behaviour for cors in the application.
  1395. * It can be a string if the expected behavior is identical in the entire app.
  1396. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1397. */
  1398. static CorsBehavior: string | ((url: string | string[]) => string);
  1399. /**
  1400. * Gets or sets a function used to pre-process url before using them to load assets
  1401. */
  1402. static PreprocessUrl: (url: string) => string;
  1403. /**
  1404. * Removes unwanted characters from an url
  1405. * @param url defines the url to clean
  1406. * @returns the cleaned url
  1407. */
  1408. private static _CleanUrl;
  1409. /**
  1410. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1411. * @param url define the url we are trying
  1412. * @param element define the dom element where to configure the cors policy
  1413. */
  1414. static SetCorsBehavior(url: string | string[], element: {
  1415. crossOrigin: string | null;
  1416. }): void;
  1417. /**
  1418. * Loads an image as an HTMLImageElement.
  1419. * @param input url string, ArrayBuffer, or Blob to load
  1420. * @param onLoad callback called when the image successfully loads
  1421. * @param onError callback called when the image fails to load
  1422. * @param offlineProvider offline provider for caching
  1423. * @param mimeType optional mime type
  1424. * @returns the HTMLImageElement of the loaded image
  1425. */
  1426. 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>;
  1427. /**
  1428. * Reads a file from a File object
  1429. * @param file defines the file to load
  1430. * @param onSuccess defines the callback to call when data is loaded
  1431. * @param onProgress defines the callback to call during loading process
  1432. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1433. * @param onError defines the callback to call when an error occurs
  1434. * @returns a file request object
  1435. */
  1436. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1437. /**
  1438. * Loads a file from a url
  1439. * @param url url to load
  1440. * @param onSuccess callback called when the file successfully loads
  1441. * @param onProgress callback called while file is loading (if the server supports this mode)
  1442. * @param offlineProvider defines the offline provider for caching
  1443. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1444. * @param onError callback called when the file fails to load
  1445. * @returns a file request object
  1446. */
  1447. 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;
  1448. /**
  1449. * Loads a file
  1450. * @param url url to load
  1451. * @param onSuccess callback called when the file successfully loads
  1452. * @param onProgress callback called while file is loading (if the server supports this mode)
  1453. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1454. * @param onError callback called when the file fails to load
  1455. * @param onOpened callback called when the web request is opened
  1456. * @returns a file request object
  1457. */
  1458. 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;
  1459. /**
  1460. * Checks if the loaded document was accessed via `file:`-Protocol.
  1461. * @returns boolean
  1462. */
  1463. static IsFileURL(): boolean;
  1464. }
  1465. }
  1466. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1467. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1468. /** @hidden */
  1469. export class ShaderProcessor {
  1470. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1471. private static _ProcessPrecision;
  1472. private static _ExtractOperation;
  1473. private static _BuildSubExpression;
  1474. private static _BuildExpression;
  1475. private static _MoveCursorWithinIf;
  1476. private static _MoveCursor;
  1477. private static _EvaluatePreProcessors;
  1478. private static _PreparePreProcessors;
  1479. private static _ProcessShaderConversion;
  1480. private static _ProcessIncludes;
  1481. }
  1482. }
  1483. declare module "babylonjs/Maths/math.like" {
  1484. import { float, int, DeepImmutable } from "babylonjs/types";
  1485. /**
  1486. * @hidden
  1487. */
  1488. export interface IColor4Like {
  1489. r: float;
  1490. g: float;
  1491. b: float;
  1492. a: float;
  1493. }
  1494. /**
  1495. * @hidden
  1496. */
  1497. export interface IColor3Like {
  1498. r: float;
  1499. g: float;
  1500. b: float;
  1501. }
  1502. /**
  1503. * @hidden
  1504. */
  1505. export interface IVector4Like {
  1506. x: float;
  1507. y: float;
  1508. z: float;
  1509. w: float;
  1510. }
  1511. /**
  1512. * @hidden
  1513. */
  1514. export interface IVector3Like {
  1515. x: float;
  1516. y: float;
  1517. z: float;
  1518. }
  1519. /**
  1520. * @hidden
  1521. */
  1522. export interface IVector2Like {
  1523. x: float;
  1524. y: float;
  1525. }
  1526. /**
  1527. * @hidden
  1528. */
  1529. export interface IMatrixLike {
  1530. toArray(): DeepImmutable<Float32Array>;
  1531. updateFlag: int;
  1532. }
  1533. /**
  1534. * @hidden
  1535. */
  1536. export interface IViewportLike {
  1537. x: float;
  1538. y: float;
  1539. width: float;
  1540. height: float;
  1541. }
  1542. /**
  1543. * @hidden
  1544. */
  1545. export interface IPlaneLike {
  1546. normal: IVector3Like;
  1547. d: float;
  1548. normalize(): void;
  1549. }
  1550. }
  1551. declare module "babylonjs/Materials/iEffectFallbacks" {
  1552. import { Effect } from "babylonjs/Materials/effect";
  1553. /**
  1554. * Interface used to define common properties for effect fallbacks
  1555. */
  1556. export interface IEffectFallbacks {
  1557. /**
  1558. * Removes the defines that should be removed when falling back.
  1559. * @param currentDefines defines the current define statements for the shader.
  1560. * @param effect defines the current effect we try to compile
  1561. * @returns The resulting defines with defines of the current rank removed.
  1562. */
  1563. reduce(currentDefines: string, effect: Effect): string;
  1564. /**
  1565. * Removes the fallback from the bound mesh.
  1566. */
  1567. unBindMesh(): void;
  1568. /**
  1569. * Checks to see if more fallbacks are still availible.
  1570. */
  1571. hasMoreFallbacks: boolean;
  1572. }
  1573. }
  1574. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1575. /**
  1576. * Class used to evalaute queries containing `and` and `or` operators
  1577. */
  1578. export class AndOrNotEvaluator {
  1579. /**
  1580. * Evaluate a query
  1581. * @param query defines the query to evaluate
  1582. * @param evaluateCallback defines the callback used to filter result
  1583. * @returns true if the query matches
  1584. */
  1585. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1586. private static _HandleParenthesisContent;
  1587. private static _SimplifyNegation;
  1588. }
  1589. }
  1590. declare module "babylonjs/Misc/tags" {
  1591. /**
  1592. * Class used to store custom tags
  1593. */
  1594. export class Tags {
  1595. /**
  1596. * Adds support for tags on the given object
  1597. * @param obj defines the object to use
  1598. */
  1599. static EnableFor(obj: any): void;
  1600. /**
  1601. * Removes tags support
  1602. * @param obj defines the object to use
  1603. */
  1604. static DisableFor(obj: any): void;
  1605. /**
  1606. * Gets a boolean indicating if the given object has tags
  1607. * @param obj defines the object to use
  1608. * @returns a boolean
  1609. */
  1610. static HasTags(obj: any): boolean;
  1611. /**
  1612. * Gets the tags available on a given object
  1613. * @param obj defines the object to use
  1614. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1615. * @returns the tags
  1616. */
  1617. static GetTags(obj: any, asString?: boolean): any;
  1618. /**
  1619. * Adds tags to an object
  1620. * @param obj defines the object to use
  1621. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1622. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1623. */
  1624. static AddTagsTo(obj: any, tagsString: string): void;
  1625. /**
  1626. * @hidden
  1627. */
  1628. static _AddTagTo(obj: any, tag: string): void;
  1629. /**
  1630. * Removes specific tags from a specific object
  1631. * @param obj defines the object to use
  1632. * @param tagsString defines the tags to remove
  1633. */
  1634. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1635. /**
  1636. * @hidden
  1637. */
  1638. static _RemoveTagFrom(obj: any, tag: string): void;
  1639. /**
  1640. * Defines if tags hosted on an object match a given query
  1641. * @param obj defines the object to use
  1642. * @param tagsQuery defines the tag query
  1643. * @returns a boolean
  1644. */
  1645. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1646. }
  1647. }
  1648. declare module "babylonjs/Maths/math.scalar" {
  1649. /**
  1650. * Scalar computation library
  1651. */
  1652. export class Scalar {
  1653. /**
  1654. * Two pi constants convenient for computation.
  1655. */
  1656. static TwoPi: number;
  1657. /**
  1658. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1659. * @param a number
  1660. * @param b number
  1661. * @param epsilon (default = 1.401298E-45)
  1662. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1663. */
  1664. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1665. /**
  1666. * Returns a string : the upper case translation of the number i to hexadecimal.
  1667. * @param i number
  1668. * @returns the upper case translation of the number i to hexadecimal.
  1669. */
  1670. static ToHex(i: number): string;
  1671. /**
  1672. * Returns -1 if value is negative and +1 is value is positive.
  1673. * @param value the value
  1674. * @returns the value itself if it's equal to zero.
  1675. */
  1676. static Sign(value: number): number;
  1677. /**
  1678. * Returns the value itself if it's between min and max.
  1679. * Returns min if the value is lower than min.
  1680. * Returns max if the value is greater than max.
  1681. * @param value the value to clmap
  1682. * @param min the min value to clamp to (default: 0)
  1683. * @param max the max value to clamp to (default: 1)
  1684. * @returns the clamped value
  1685. */
  1686. static Clamp(value: number, min?: number, max?: number): number;
  1687. /**
  1688. * the log2 of value.
  1689. * @param value the value to compute log2 of
  1690. * @returns the log2 of value.
  1691. */
  1692. static Log2(value: number): number;
  1693. /**
  1694. * Loops the value, so that it is never larger than length and never smaller than 0.
  1695. *
  1696. * This is similar to the modulo operator but it works with floating point numbers.
  1697. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1698. * With t = 5 and length = 2.5, the result would be 0.0.
  1699. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1700. * @param value the value
  1701. * @param length the length
  1702. * @returns the looped value
  1703. */
  1704. static Repeat(value: number, length: number): number;
  1705. /**
  1706. * Normalize the value between 0.0 and 1.0 using min and max values
  1707. * @param value value to normalize
  1708. * @param min max to normalize between
  1709. * @param max min to normalize between
  1710. * @returns the normalized value
  1711. */
  1712. static Normalize(value: number, min: number, max: number): number;
  1713. /**
  1714. * Denormalize the value from 0.0 and 1.0 using min and max values
  1715. * @param normalized value to denormalize
  1716. * @param min max to denormalize between
  1717. * @param max min to denormalize between
  1718. * @returns the denormalized value
  1719. */
  1720. static Denormalize(normalized: number, min: number, max: number): number;
  1721. /**
  1722. * Calculates the shortest difference between two given angles given in degrees.
  1723. * @param current current angle in degrees
  1724. * @param target target angle in degrees
  1725. * @returns the delta
  1726. */
  1727. static DeltaAngle(current: number, target: number): number;
  1728. /**
  1729. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1730. * @param tx value
  1731. * @param length length
  1732. * @returns The returned value will move back and forth between 0 and length
  1733. */
  1734. static PingPong(tx: number, length: number): number;
  1735. /**
  1736. * Interpolates between min and max with smoothing at the limits.
  1737. *
  1738. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1739. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1740. * @param from from
  1741. * @param to to
  1742. * @param tx value
  1743. * @returns the smooth stepped value
  1744. */
  1745. static SmoothStep(from: number, to: number, tx: number): number;
  1746. /**
  1747. * Moves a value current towards target.
  1748. *
  1749. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1750. * Negative values of maxDelta pushes the value away from target.
  1751. * @param current current value
  1752. * @param target target value
  1753. * @param maxDelta max distance to move
  1754. * @returns resulting value
  1755. */
  1756. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1757. /**
  1758. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1759. *
  1760. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1761. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1762. * @param current current value
  1763. * @param target target value
  1764. * @param maxDelta max distance to move
  1765. * @returns resulting angle
  1766. */
  1767. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1768. /**
  1769. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1770. * @param start start value
  1771. * @param end target value
  1772. * @param amount amount to lerp between
  1773. * @returns the lerped value
  1774. */
  1775. static Lerp(start: number, end: number, amount: number): number;
  1776. /**
  1777. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1778. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1779. * @param start start value
  1780. * @param end target value
  1781. * @param amount amount to lerp between
  1782. * @returns the lerped value
  1783. */
  1784. static LerpAngle(start: number, end: number, amount: number): number;
  1785. /**
  1786. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1787. * @param a start value
  1788. * @param b target value
  1789. * @param value value between a and b
  1790. * @returns the inverseLerp value
  1791. */
  1792. static InverseLerp(a: number, b: number, value: number): number;
  1793. /**
  1794. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1795. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1796. * @param value1 spline value
  1797. * @param tangent1 spline value
  1798. * @param value2 spline value
  1799. * @param tangent2 spline value
  1800. * @param amount input value
  1801. * @returns hermite result
  1802. */
  1803. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1804. /**
  1805. * Returns a random float number between and min and max values
  1806. * @param min min value of random
  1807. * @param max max value of random
  1808. * @returns random value
  1809. */
  1810. static RandomRange(min: number, max: number): number;
  1811. /**
  1812. * This function returns percentage of a number in a given range.
  1813. *
  1814. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1815. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1816. * @param number to convert to percentage
  1817. * @param min min range
  1818. * @param max max range
  1819. * @returns the percentage
  1820. */
  1821. static RangeToPercent(number: number, min: number, max: number): number;
  1822. /**
  1823. * This function returns number that corresponds to the percentage in a given range.
  1824. *
  1825. * PercentToRange(0.34,0,100) will return 34.
  1826. * @param percent to convert to number
  1827. * @param min min range
  1828. * @param max max range
  1829. * @returns the number
  1830. */
  1831. static PercentToRange(percent: number, min: number, max: number): number;
  1832. /**
  1833. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1834. * @param angle The angle to normalize in radian.
  1835. * @return The converted angle.
  1836. */
  1837. static NormalizeRadians(angle: number): number;
  1838. }
  1839. }
  1840. declare module "babylonjs/Maths/math.constants" {
  1841. /**
  1842. * Constant used to convert a value to gamma space
  1843. * @ignorenaming
  1844. */
  1845. export const ToGammaSpace: number;
  1846. /**
  1847. * Constant used to convert a value to linear space
  1848. * @ignorenaming
  1849. */
  1850. export const ToLinearSpace = 2.2;
  1851. /**
  1852. * Constant used to define the minimal number value in Babylon.js
  1853. * @ignorenaming
  1854. */
  1855. let Epsilon: number;
  1856. export { Epsilon };
  1857. }
  1858. declare module "babylonjs/Maths/math.viewport" {
  1859. /**
  1860. * Class used to represent a viewport on screen
  1861. */
  1862. export class Viewport {
  1863. /** viewport left coordinate */
  1864. x: number;
  1865. /** viewport top coordinate */
  1866. y: number;
  1867. /**viewport width */
  1868. width: number;
  1869. /** viewport height */
  1870. height: number;
  1871. /**
  1872. * Creates a Viewport object located at (x, y) and sized (width, height)
  1873. * @param x defines viewport left coordinate
  1874. * @param y defines viewport top coordinate
  1875. * @param width defines the viewport width
  1876. * @param height defines the viewport height
  1877. */
  1878. constructor(
  1879. /** viewport left coordinate */
  1880. x: number,
  1881. /** viewport top coordinate */
  1882. y: number,
  1883. /**viewport width */
  1884. width: number,
  1885. /** viewport height */
  1886. height: number);
  1887. /**
  1888. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1889. * @param renderWidth defines the rendering width
  1890. * @param renderHeight defines the rendering height
  1891. * @returns a new Viewport
  1892. */
  1893. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1894. /**
  1895. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1896. * @param renderWidth defines the rendering width
  1897. * @param renderHeight defines the rendering height
  1898. * @param ref defines the target viewport
  1899. * @returns the current viewport
  1900. */
  1901. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1902. /**
  1903. * Returns a new Viewport copied from the current one
  1904. * @returns a new Viewport
  1905. */
  1906. clone(): Viewport;
  1907. }
  1908. }
  1909. declare module "babylonjs/Misc/arrayTools" {
  1910. /**
  1911. * Class containing a set of static utilities functions for arrays.
  1912. */
  1913. export class ArrayTools {
  1914. /**
  1915. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1916. * @param size the number of element to construct and put in the array
  1917. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1918. * @returns a new array filled with new objects
  1919. */
  1920. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1921. }
  1922. }
  1923. declare module "babylonjs/Maths/math.vector" {
  1924. import { Viewport } from "babylonjs/Maths/math.viewport";
  1925. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  1926. import { IPlaneLike } from "babylonjs/Maths/math.like";
  1927. /**
  1928. * Class representing a vector containing 2 coordinates
  1929. */
  1930. export class Vector2 {
  1931. /** defines the first coordinate */
  1932. x: number;
  1933. /** defines the second coordinate */
  1934. y: number;
  1935. /**
  1936. * Creates a new Vector2 from the given x and y coordinates
  1937. * @param x defines the first coordinate
  1938. * @param y defines the second coordinate
  1939. */
  1940. constructor(
  1941. /** defines the first coordinate */
  1942. x?: number,
  1943. /** defines the second coordinate */
  1944. y?: number);
  1945. /**
  1946. * Gets a string with the Vector2 coordinates
  1947. * @returns a string with the Vector2 coordinates
  1948. */
  1949. toString(): string;
  1950. /**
  1951. * Gets class name
  1952. * @returns the string "Vector2"
  1953. */
  1954. getClassName(): string;
  1955. /**
  1956. * Gets current vector hash code
  1957. * @returns the Vector2 hash code as a number
  1958. */
  1959. getHashCode(): number;
  1960. /**
  1961. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  1962. * @param array defines the source array
  1963. * @param index defines the offset in source array
  1964. * @returns the current Vector2
  1965. */
  1966. toArray(array: FloatArray, index?: number): Vector2;
  1967. /**
  1968. * Copy the current vector to an array
  1969. * @returns a new array with 2 elements: the Vector2 coordinates.
  1970. */
  1971. asArray(): number[];
  1972. /**
  1973. * Sets the Vector2 coordinates with the given Vector2 coordinates
  1974. * @param source defines the source Vector2
  1975. * @returns the current updated Vector2
  1976. */
  1977. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  1978. /**
  1979. * Sets the Vector2 coordinates with the given floats
  1980. * @param x defines the first coordinate
  1981. * @param y defines the second coordinate
  1982. * @returns the current updated Vector2
  1983. */
  1984. copyFromFloats(x: number, y: number): Vector2;
  1985. /**
  1986. * Sets the Vector2 coordinates with the given floats
  1987. * @param x defines the first coordinate
  1988. * @param y defines the second coordinate
  1989. * @returns the current updated Vector2
  1990. */
  1991. set(x: number, y: number): Vector2;
  1992. /**
  1993. * Add another vector with the current one
  1994. * @param otherVector defines the other vector
  1995. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  1996. */
  1997. add(otherVector: DeepImmutable<Vector2>): Vector2;
  1998. /**
  1999. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2000. * @param otherVector defines the other vector
  2001. * @param result defines the target vector
  2002. * @returns the unmodified current Vector2
  2003. */
  2004. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2005. /**
  2006. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2007. * @param otherVector defines the other vector
  2008. * @returns the current updated Vector2
  2009. */
  2010. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2011. /**
  2012. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2013. * @param otherVector defines the other vector
  2014. * @returns a new Vector2
  2015. */
  2016. addVector3(otherVector: Vector3): Vector2;
  2017. /**
  2018. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2019. * @param otherVector defines the other vector
  2020. * @returns a new Vector2
  2021. */
  2022. subtract(otherVector: Vector2): Vector2;
  2023. /**
  2024. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2025. * @param otherVector defines the other vector
  2026. * @param result defines the target vector
  2027. * @returns the unmodified current Vector2
  2028. */
  2029. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2030. /**
  2031. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2032. * @param otherVector defines the other vector
  2033. * @returns the current updated Vector2
  2034. */
  2035. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2036. /**
  2037. * Multiplies in place the current Vector2 coordinates by the given ones
  2038. * @param otherVector defines the other vector
  2039. * @returns the current updated Vector2
  2040. */
  2041. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2042. /**
  2043. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2044. * @param otherVector defines the other vector
  2045. * @returns a new Vector2
  2046. */
  2047. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2048. /**
  2049. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2050. * @param otherVector defines the other vector
  2051. * @param result defines the target vector
  2052. * @returns the unmodified current Vector2
  2053. */
  2054. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2055. /**
  2056. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2057. * @param x defines the first coordinate
  2058. * @param y defines the second coordinate
  2059. * @returns a new Vector2
  2060. */
  2061. multiplyByFloats(x: number, y: number): Vector2;
  2062. /**
  2063. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2064. * @param otherVector defines the other vector
  2065. * @returns a new Vector2
  2066. */
  2067. divide(otherVector: Vector2): Vector2;
  2068. /**
  2069. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2070. * @param otherVector defines the other vector
  2071. * @param result defines the target vector
  2072. * @returns the unmodified current Vector2
  2073. */
  2074. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2075. /**
  2076. * Divides the current Vector2 coordinates by the given ones
  2077. * @param otherVector defines the other vector
  2078. * @returns the current updated Vector2
  2079. */
  2080. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2081. /**
  2082. * Gets a new Vector2 with current Vector2 negated coordinates
  2083. * @returns a new Vector2
  2084. */
  2085. negate(): Vector2;
  2086. /**
  2087. * Multiply the Vector2 coordinates by scale
  2088. * @param scale defines the scaling factor
  2089. * @returns the current updated Vector2
  2090. */
  2091. scaleInPlace(scale: number): Vector2;
  2092. /**
  2093. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2094. * @param scale defines the scaling factor
  2095. * @returns a new Vector2
  2096. */
  2097. scale(scale: number): Vector2;
  2098. /**
  2099. * Scale the current Vector2 values by a factor to a given Vector2
  2100. * @param scale defines the scale factor
  2101. * @param result defines the Vector2 object where to store the result
  2102. * @returns the unmodified current Vector2
  2103. */
  2104. scaleToRef(scale: number, result: Vector2): Vector2;
  2105. /**
  2106. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2107. * @param scale defines the scale factor
  2108. * @param result defines the Vector2 object where to store the result
  2109. * @returns the unmodified current Vector2
  2110. */
  2111. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2112. /**
  2113. * Gets a boolean if two vectors are equals
  2114. * @param otherVector defines the other vector
  2115. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2116. */
  2117. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2118. /**
  2119. * Gets a boolean if two vectors are equals (using an epsilon value)
  2120. * @param otherVector defines the other vector
  2121. * @param epsilon defines the minimal distance to consider equality
  2122. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2123. */
  2124. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2125. /**
  2126. * Gets a new Vector2 from current Vector2 floored values
  2127. * @returns a new Vector2
  2128. */
  2129. floor(): Vector2;
  2130. /**
  2131. * Gets a new Vector2 from current Vector2 floored values
  2132. * @returns a new Vector2
  2133. */
  2134. fract(): Vector2;
  2135. /**
  2136. * Gets the length of the vector
  2137. * @returns the vector length (float)
  2138. */
  2139. length(): number;
  2140. /**
  2141. * Gets the vector squared length
  2142. * @returns the vector squared length (float)
  2143. */
  2144. lengthSquared(): number;
  2145. /**
  2146. * Normalize the vector
  2147. * @returns the current updated Vector2
  2148. */
  2149. normalize(): Vector2;
  2150. /**
  2151. * Gets a new Vector2 copied from the Vector2
  2152. * @returns a new Vector2
  2153. */
  2154. clone(): Vector2;
  2155. /**
  2156. * Gets a new Vector2(0, 0)
  2157. * @returns a new Vector2
  2158. */
  2159. static Zero(): Vector2;
  2160. /**
  2161. * Gets a new Vector2(1, 1)
  2162. * @returns a new Vector2
  2163. */
  2164. static One(): Vector2;
  2165. /**
  2166. * Gets a new Vector2 set from the given index element of the given array
  2167. * @param array defines the data source
  2168. * @param offset defines the offset in the data source
  2169. * @returns a new Vector2
  2170. */
  2171. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2172. /**
  2173. * Sets "result" from the given index element of the given array
  2174. * @param array defines the data source
  2175. * @param offset defines the offset in the data source
  2176. * @param result defines the target vector
  2177. */
  2178. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2179. /**
  2180. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2181. * @param value1 defines 1st point of control
  2182. * @param value2 defines 2nd point of control
  2183. * @param value3 defines 3rd point of control
  2184. * @param value4 defines 4th point of control
  2185. * @param amount defines the interpolation factor
  2186. * @returns a new Vector2
  2187. */
  2188. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2189. /**
  2190. * 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".
  2191. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2192. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2193. * @param value defines the value to clamp
  2194. * @param min defines the lower limit
  2195. * @param max defines the upper limit
  2196. * @returns a new Vector2
  2197. */
  2198. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2199. /**
  2200. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2201. * @param value1 defines the 1st control point
  2202. * @param tangent1 defines the outgoing tangent
  2203. * @param value2 defines the 2nd control point
  2204. * @param tangent2 defines the incoming tangent
  2205. * @param amount defines the interpolation factor
  2206. * @returns a new Vector2
  2207. */
  2208. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2209. /**
  2210. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2211. * @param start defines the start vector
  2212. * @param end defines the end vector
  2213. * @param amount defines the interpolation factor
  2214. * @returns a new Vector2
  2215. */
  2216. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2217. /**
  2218. * Gets the dot product of the vector "left" and the vector "right"
  2219. * @param left defines first vector
  2220. * @param right defines second vector
  2221. * @returns the dot product (float)
  2222. */
  2223. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2224. /**
  2225. * Returns a new Vector2 equal to the normalized given vector
  2226. * @param vector defines the vector to normalize
  2227. * @returns a new Vector2
  2228. */
  2229. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2230. /**
  2231. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2232. * @param left defines 1st vector
  2233. * @param right defines 2nd vector
  2234. * @returns a new Vector2
  2235. */
  2236. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2237. /**
  2238. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2239. * @param left defines 1st vector
  2240. * @param right defines 2nd vector
  2241. * @returns a new Vector2
  2242. */
  2243. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2244. /**
  2245. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2246. * @param vector defines the vector to transform
  2247. * @param transformation defines the matrix to apply
  2248. * @returns a new Vector2
  2249. */
  2250. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2251. /**
  2252. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2253. * @param vector defines the vector to transform
  2254. * @param transformation defines the matrix to apply
  2255. * @param result defines the target vector
  2256. */
  2257. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2258. /**
  2259. * Determines if a given vector is included in a triangle
  2260. * @param p defines the vector to test
  2261. * @param p0 defines 1st triangle point
  2262. * @param p1 defines 2nd triangle point
  2263. * @param p2 defines 3rd triangle point
  2264. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2265. */
  2266. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2267. /**
  2268. * Gets the distance between the vectors "value1" and "value2"
  2269. * @param value1 defines first vector
  2270. * @param value2 defines second vector
  2271. * @returns the distance between vectors
  2272. */
  2273. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2274. /**
  2275. * Returns the squared distance between the vectors "value1" and "value2"
  2276. * @param value1 defines first vector
  2277. * @param value2 defines second vector
  2278. * @returns the squared distance between vectors
  2279. */
  2280. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2281. /**
  2282. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2283. * @param value1 defines first vector
  2284. * @param value2 defines second vector
  2285. * @returns a new Vector2
  2286. */
  2287. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2288. /**
  2289. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2290. * @param p defines the middle point
  2291. * @param segA defines one point of the segment
  2292. * @param segB defines the other point of the segment
  2293. * @returns the shortest distance
  2294. */
  2295. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2296. }
  2297. /**
  2298. * Classed used to store (x,y,z) vector representation
  2299. * A Vector3 is the main object used in 3D geometry
  2300. * It can represent etiher the coordinates of a point the space, either a direction
  2301. * Reminder: js uses a left handed forward facing system
  2302. */
  2303. export class Vector3 {
  2304. /**
  2305. * Defines the first coordinates (on X axis)
  2306. */
  2307. x: number;
  2308. /**
  2309. * Defines the second coordinates (on Y axis)
  2310. */
  2311. y: number;
  2312. /**
  2313. * Defines the third coordinates (on Z axis)
  2314. */
  2315. z: number;
  2316. private static _UpReadOnly;
  2317. private static _ZeroReadOnly;
  2318. /**
  2319. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2320. * @param x defines the first coordinates (on X axis)
  2321. * @param y defines the second coordinates (on Y axis)
  2322. * @param z defines the third coordinates (on Z axis)
  2323. */
  2324. constructor(
  2325. /**
  2326. * Defines the first coordinates (on X axis)
  2327. */
  2328. x?: number,
  2329. /**
  2330. * Defines the second coordinates (on Y axis)
  2331. */
  2332. y?: number,
  2333. /**
  2334. * Defines the third coordinates (on Z axis)
  2335. */
  2336. z?: number);
  2337. /**
  2338. * Creates a string representation of the Vector3
  2339. * @returns a string with the Vector3 coordinates.
  2340. */
  2341. toString(): string;
  2342. /**
  2343. * Gets the class name
  2344. * @returns the string "Vector3"
  2345. */
  2346. getClassName(): string;
  2347. /**
  2348. * Creates the Vector3 hash code
  2349. * @returns a number which tends to be unique between Vector3 instances
  2350. */
  2351. getHashCode(): number;
  2352. /**
  2353. * Creates an array containing three elements : the coordinates of the Vector3
  2354. * @returns a new array of numbers
  2355. */
  2356. asArray(): number[];
  2357. /**
  2358. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2359. * @param array defines the destination array
  2360. * @param index defines the offset in the destination array
  2361. * @returns the current Vector3
  2362. */
  2363. toArray(array: FloatArray, index?: number): Vector3;
  2364. /**
  2365. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2366. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2367. */
  2368. toQuaternion(): Quaternion;
  2369. /**
  2370. * Adds the given vector to the current Vector3
  2371. * @param otherVector defines the second operand
  2372. * @returns the current updated Vector3
  2373. */
  2374. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2375. /**
  2376. * Adds the given coordinates to the current Vector3
  2377. * @param x defines the x coordinate of the operand
  2378. * @param y defines the y coordinate of the operand
  2379. * @param z defines the z coordinate of the operand
  2380. * @returns the current updated Vector3
  2381. */
  2382. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2383. /**
  2384. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2385. * @param otherVector defines the second operand
  2386. * @returns the resulting Vector3
  2387. */
  2388. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2389. /**
  2390. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2391. * @param otherVector defines the second operand
  2392. * @param result defines the Vector3 object where to store the result
  2393. * @returns the current Vector3
  2394. */
  2395. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2396. /**
  2397. * Subtract the given vector from the current Vector3
  2398. * @param otherVector defines the second operand
  2399. * @returns the current updated Vector3
  2400. */
  2401. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2402. /**
  2403. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2404. * @param otherVector defines the second operand
  2405. * @returns the resulting Vector3
  2406. */
  2407. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2408. /**
  2409. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2410. * @param otherVector defines the second operand
  2411. * @param result defines the Vector3 object where to store the result
  2412. * @returns the current Vector3
  2413. */
  2414. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2415. /**
  2416. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2417. * @param x defines the x coordinate of the operand
  2418. * @param y defines the y coordinate of the operand
  2419. * @param z defines the z coordinate of the operand
  2420. * @returns the resulting Vector3
  2421. */
  2422. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2423. /**
  2424. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2425. * @param x defines the x coordinate of the operand
  2426. * @param y defines the y coordinate of the operand
  2427. * @param z defines the z coordinate of the operand
  2428. * @param result defines the Vector3 object where to store the result
  2429. * @returns the current Vector3
  2430. */
  2431. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2432. /**
  2433. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2434. * @returns a new Vector3
  2435. */
  2436. negate(): Vector3;
  2437. /**
  2438. * Multiplies the Vector3 coordinates by the float "scale"
  2439. * @param scale defines the multiplier factor
  2440. * @returns the current updated Vector3
  2441. */
  2442. scaleInPlace(scale: number): Vector3;
  2443. /**
  2444. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2445. * @param scale defines the multiplier factor
  2446. * @returns a new Vector3
  2447. */
  2448. scale(scale: number): Vector3;
  2449. /**
  2450. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2451. * @param scale defines the multiplier factor
  2452. * @param result defines the Vector3 object where to store the result
  2453. * @returns the current Vector3
  2454. */
  2455. scaleToRef(scale: number, result: Vector3): Vector3;
  2456. /**
  2457. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2458. * @param scale defines the scale factor
  2459. * @param result defines the Vector3 object where to store the result
  2460. * @returns the unmodified current Vector3
  2461. */
  2462. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2463. /**
  2464. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2465. * @param otherVector defines the second operand
  2466. * @returns true if both vectors are equals
  2467. */
  2468. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2469. /**
  2470. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2471. * @param otherVector defines the second operand
  2472. * @param epsilon defines the minimal distance to define values as equals
  2473. * @returns true if both vectors are distant less than epsilon
  2474. */
  2475. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2476. /**
  2477. * Returns true if the current Vector3 coordinates equals the given floats
  2478. * @param x defines the x coordinate of the operand
  2479. * @param y defines the y coordinate of the operand
  2480. * @param z defines the z coordinate of the operand
  2481. * @returns true if both vectors are equals
  2482. */
  2483. equalsToFloats(x: number, y: number, z: number): boolean;
  2484. /**
  2485. * Multiplies the current Vector3 coordinates by the given ones
  2486. * @param otherVector defines the second operand
  2487. * @returns the current updated Vector3
  2488. */
  2489. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2490. /**
  2491. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2492. * @param otherVector defines the second operand
  2493. * @returns the new Vector3
  2494. */
  2495. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2496. /**
  2497. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2498. * @param otherVector defines the second operand
  2499. * @param result defines the Vector3 object where to store the result
  2500. * @returns the current Vector3
  2501. */
  2502. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2503. /**
  2504. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2505. * @param x defines the x coordinate of the operand
  2506. * @param y defines the y coordinate of the operand
  2507. * @param z defines the z coordinate of the operand
  2508. * @returns the new Vector3
  2509. */
  2510. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2511. /**
  2512. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2513. * @param otherVector defines the second operand
  2514. * @returns the new Vector3
  2515. */
  2516. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2517. /**
  2518. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2519. * @param otherVector defines the second operand
  2520. * @param result defines the Vector3 object where to store the result
  2521. * @returns the current Vector3
  2522. */
  2523. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2524. /**
  2525. * Divides the current Vector3 coordinates by the given ones.
  2526. * @param otherVector defines the second operand
  2527. * @returns the current updated Vector3
  2528. */
  2529. divideInPlace(otherVector: Vector3): Vector3;
  2530. /**
  2531. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2532. * @param other defines the second operand
  2533. * @returns the current updated Vector3
  2534. */
  2535. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2536. /**
  2537. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2538. * @param other defines the second operand
  2539. * @returns the current updated Vector3
  2540. */
  2541. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2542. /**
  2543. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2544. * @param x defines the x coordinate of the operand
  2545. * @param y defines the y coordinate of the operand
  2546. * @param z defines the z coordinate of the operand
  2547. * @returns the current updated Vector3
  2548. */
  2549. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2550. /**
  2551. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2552. * @param x defines the x coordinate of the operand
  2553. * @param y defines the y coordinate of the operand
  2554. * @param z defines the z coordinate of the operand
  2555. * @returns the current updated Vector3
  2556. */
  2557. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2558. /**
  2559. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2560. * Check if is non uniform within a certain amount of decimal places to account for this
  2561. * @param epsilon the amount the values can differ
  2562. * @returns if the the vector is non uniform to a certain number of decimal places
  2563. */
  2564. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2565. /**
  2566. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2567. */
  2568. readonly isNonUniform: boolean;
  2569. /**
  2570. * Gets a new Vector3 from current Vector3 floored values
  2571. * @returns a new Vector3
  2572. */
  2573. floor(): Vector3;
  2574. /**
  2575. * Gets a new Vector3 from current Vector3 floored values
  2576. * @returns a new Vector3
  2577. */
  2578. fract(): Vector3;
  2579. /**
  2580. * Gets the length of the Vector3
  2581. * @returns the length of the Vector3
  2582. */
  2583. length(): number;
  2584. /**
  2585. * Gets the squared length of the Vector3
  2586. * @returns squared length of the Vector3
  2587. */
  2588. lengthSquared(): number;
  2589. /**
  2590. * Normalize the current Vector3.
  2591. * Please note that this is an in place operation.
  2592. * @returns the current updated Vector3
  2593. */
  2594. normalize(): Vector3;
  2595. /**
  2596. * Reorders the x y z properties of the vector in place
  2597. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2598. * @returns the current updated vector
  2599. */
  2600. reorderInPlace(order: string): this;
  2601. /**
  2602. * Rotates the vector around 0,0,0 by a quaternion
  2603. * @param quaternion the rotation quaternion
  2604. * @param result vector to store the result
  2605. * @returns the resulting vector
  2606. */
  2607. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2608. /**
  2609. * Rotates a vector around a given point
  2610. * @param quaternion the rotation quaternion
  2611. * @param point the point to rotate around
  2612. * @param result vector to store the result
  2613. * @returns the resulting vector
  2614. */
  2615. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2616. /**
  2617. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2618. * The cross product is then orthogonal to both current and "other"
  2619. * @param other defines the right operand
  2620. * @returns the cross product
  2621. */
  2622. cross(other: Vector3): Vector3;
  2623. /**
  2624. * Normalize the current Vector3 with the given input length.
  2625. * Please note that this is an in place operation.
  2626. * @param len the length of the vector
  2627. * @returns the current updated Vector3
  2628. */
  2629. normalizeFromLength(len: number): Vector3;
  2630. /**
  2631. * Normalize the current Vector3 to a new vector
  2632. * @returns the new Vector3
  2633. */
  2634. normalizeToNew(): Vector3;
  2635. /**
  2636. * Normalize the current Vector3 to the reference
  2637. * @param reference define the Vector3 to update
  2638. * @returns the updated Vector3
  2639. */
  2640. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  2641. /**
  2642. * Creates a new Vector3 copied from the current Vector3
  2643. * @returns the new Vector3
  2644. */
  2645. clone(): Vector3;
  2646. /**
  2647. * Copies the given vector coordinates to the current Vector3 ones
  2648. * @param source defines the source Vector3
  2649. * @returns the current updated Vector3
  2650. */
  2651. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2652. /**
  2653. * Copies the given floats to the current Vector3 coordinates
  2654. * @param x defines the x coordinate of the operand
  2655. * @param y defines the y coordinate of the operand
  2656. * @param z defines the z coordinate of the operand
  2657. * @returns the current updated Vector3
  2658. */
  2659. copyFromFloats(x: number, y: number, z: number): Vector3;
  2660. /**
  2661. * Copies the given floats to the current Vector3 coordinates
  2662. * @param x defines the x coordinate of the operand
  2663. * @param y defines the y coordinate of the operand
  2664. * @param z defines the z coordinate of the operand
  2665. * @returns the current updated Vector3
  2666. */
  2667. set(x: number, y: number, z: number): Vector3;
  2668. /**
  2669. * Copies the given float to the current Vector3 coordinates
  2670. * @param v defines the x, y and z coordinates of the operand
  2671. * @returns the current updated Vector3
  2672. */
  2673. setAll(v: number): Vector3;
  2674. /**
  2675. * Get the clip factor between two vectors
  2676. * @param vector0 defines the first operand
  2677. * @param vector1 defines the second operand
  2678. * @param axis defines the axis to use
  2679. * @param size defines the size along the axis
  2680. * @returns the clip factor
  2681. */
  2682. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2683. /**
  2684. * Get angle between two vectors
  2685. * @param vector0 angle between vector0 and vector1
  2686. * @param vector1 angle between vector0 and vector1
  2687. * @param normal direction of the normal
  2688. * @return the angle between vector0 and vector1
  2689. */
  2690. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2691. /**
  2692. * Returns a new Vector3 set from the index "offset" of the given array
  2693. * @param array defines the source array
  2694. * @param offset defines the offset in the source array
  2695. * @returns the new Vector3
  2696. */
  2697. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2698. /**
  2699. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2700. * This function is deprecated. Use FromArray instead
  2701. * @param array defines the source array
  2702. * @param offset defines the offset in the source array
  2703. * @returns the new Vector3
  2704. */
  2705. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2706. /**
  2707. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2708. * @param array defines the source array
  2709. * @param offset defines the offset in the source array
  2710. * @param result defines the Vector3 where to store the result
  2711. */
  2712. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2713. /**
  2714. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2715. * This function is deprecated. Use FromArrayToRef instead.
  2716. * @param array defines the source array
  2717. * @param offset defines the offset in the source array
  2718. * @param result defines the Vector3 where to store the result
  2719. */
  2720. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2721. /**
  2722. * Sets the given vector "result" with the given floats.
  2723. * @param x defines the x coordinate of the source
  2724. * @param y defines the y coordinate of the source
  2725. * @param z defines the z coordinate of the source
  2726. * @param result defines the Vector3 where to store the result
  2727. */
  2728. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2729. /**
  2730. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2731. * @returns a new empty Vector3
  2732. */
  2733. static Zero(): Vector3;
  2734. /**
  2735. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2736. * @returns a new unit Vector3
  2737. */
  2738. static One(): Vector3;
  2739. /**
  2740. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2741. * @returns a new up Vector3
  2742. */
  2743. static Up(): Vector3;
  2744. /**
  2745. * Gets a up Vector3 that must not be updated
  2746. */
  2747. static readonly UpReadOnly: DeepImmutable<Vector3>;
  2748. /**
  2749. * Gets a zero Vector3 that must not be updated
  2750. */
  2751. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  2752. /**
  2753. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2754. * @returns a new down Vector3
  2755. */
  2756. static Down(): Vector3;
  2757. /**
  2758. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2759. * @returns a new forward Vector3
  2760. */
  2761. static Forward(): Vector3;
  2762. /**
  2763. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2764. * @returns a new forward Vector3
  2765. */
  2766. static Backward(): Vector3;
  2767. /**
  2768. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2769. * @returns a new right Vector3
  2770. */
  2771. static Right(): Vector3;
  2772. /**
  2773. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2774. * @returns a new left Vector3
  2775. */
  2776. static Left(): Vector3;
  2777. /**
  2778. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2779. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2780. * @param vector defines the Vector3 to transform
  2781. * @param transformation defines the transformation matrix
  2782. * @returns the transformed Vector3
  2783. */
  2784. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2785. /**
  2786. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2787. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2788. * @param vector defines the Vector3 to transform
  2789. * @param transformation defines the transformation matrix
  2790. * @param result defines the Vector3 where to store the result
  2791. */
  2792. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2793. /**
  2794. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  2795. * This method computes tranformed coordinates only, not transformed direction vectors
  2796. * @param x define the x coordinate of the source vector
  2797. * @param y define the y coordinate of the source vector
  2798. * @param z define the z coordinate of the source vector
  2799. * @param transformation defines the transformation matrix
  2800. * @param result defines the Vector3 where to store the result
  2801. */
  2802. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2803. /**
  2804. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  2805. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2806. * @param vector defines the Vector3 to transform
  2807. * @param transformation defines the transformation matrix
  2808. * @returns the new Vector3
  2809. */
  2810. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2811. /**
  2812. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  2813. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2814. * @param vector defines the Vector3 to transform
  2815. * @param transformation defines the transformation matrix
  2816. * @param result defines the Vector3 where to store the result
  2817. */
  2818. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2819. /**
  2820. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  2821. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2822. * @param x define the x coordinate of the source vector
  2823. * @param y define the y coordinate of the source vector
  2824. * @param z define the z coordinate of the source vector
  2825. * @param transformation defines the transformation matrix
  2826. * @param result defines the Vector3 where to store the result
  2827. */
  2828. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2829. /**
  2830. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  2831. * @param value1 defines the first control point
  2832. * @param value2 defines the second control point
  2833. * @param value3 defines the third control point
  2834. * @param value4 defines the fourth control point
  2835. * @param amount defines the amount on the spline to use
  2836. * @returns the new Vector3
  2837. */
  2838. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  2839. /**
  2840. * 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"
  2841. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2842. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2843. * @param value defines the current value
  2844. * @param min defines the lower range value
  2845. * @param max defines the upper range value
  2846. * @returns the new Vector3
  2847. */
  2848. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  2849. /**
  2850. * 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"
  2851. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2852. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2853. * @param value defines the current value
  2854. * @param min defines the lower range value
  2855. * @param max defines the upper range value
  2856. * @param result defines the Vector3 where to store the result
  2857. */
  2858. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  2859. /**
  2860. * Checks if a given vector is inside a specific range
  2861. * @param v defines the vector to test
  2862. * @param min defines the minimum range
  2863. * @param max defines the maximum range
  2864. */
  2865. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  2866. /**
  2867. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  2868. * @param value1 defines the first control point
  2869. * @param tangent1 defines the first tangent vector
  2870. * @param value2 defines the second control point
  2871. * @param tangent2 defines the second tangent vector
  2872. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  2873. * @returns the new Vector3
  2874. */
  2875. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  2876. /**
  2877. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  2878. * @param start defines the start value
  2879. * @param end defines the end value
  2880. * @param amount max defines amount between both (between 0 and 1)
  2881. * @returns the new Vector3
  2882. */
  2883. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  2884. /**
  2885. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  2886. * @param start defines the start value
  2887. * @param end defines the end value
  2888. * @param amount max defines amount between both (between 0 and 1)
  2889. * @param result defines the Vector3 where to store the result
  2890. */
  2891. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  2892. /**
  2893. * Returns the dot product (float) between the vectors "left" and "right"
  2894. * @param left defines the left operand
  2895. * @param right defines the right operand
  2896. * @returns the dot product
  2897. */
  2898. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  2899. /**
  2900. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  2901. * The cross product is then orthogonal to both "left" and "right"
  2902. * @param left defines the left operand
  2903. * @param right defines the right operand
  2904. * @returns the cross product
  2905. */
  2906. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2907. /**
  2908. * Sets the given vector "result" with the cross product of "left" and "right"
  2909. * The cross product is then orthogonal to both "left" and "right"
  2910. * @param left defines the left operand
  2911. * @param right defines the right operand
  2912. * @param result defines the Vector3 where to store the result
  2913. */
  2914. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  2915. /**
  2916. * Returns a new Vector3 as the normalization of the given vector
  2917. * @param vector defines the Vector3 to normalize
  2918. * @returns the new Vector3
  2919. */
  2920. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  2921. /**
  2922. * Sets the given vector "result" with the normalization of the given first vector
  2923. * @param vector defines the Vector3 to normalize
  2924. * @param result defines the Vector3 where to store the result
  2925. */
  2926. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  2927. /**
  2928. * Project a Vector3 onto screen space
  2929. * @param vector defines the Vector3 to project
  2930. * @param world defines the world matrix to use
  2931. * @param transform defines the transform (view x projection) matrix to use
  2932. * @param viewport defines the screen viewport to use
  2933. * @returns the new Vector3
  2934. */
  2935. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  2936. /** @hidden */
  2937. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  2938. /**
  2939. * Unproject from screen space to object space
  2940. * @param source defines the screen space Vector3 to use
  2941. * @param viewportWidth defines the current width of the viewport
  2942. * @param viewportHeight defines the current height of the viewport
  2943. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2944. * @param transform defines the transform (view x projection) matrix to use
  2945. * @returns the new Vector3
  2946. */
  2947. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  2948. /**
  2949. * Unproject from screen space to object space
  2950. * @param source defines the screen space Vector3 to use
  2951. * @param viewportWidth defines the current width of the viewport
  2952. * @param viewportHeight defines the current height of the viewport
  2953. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2954. * @param view defines the view matrix to use
  2955. * @param projection defines the projection matrix to use
  2956. * @returns the new Vector3
  2957. */
  2958. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  2959. /**
  2960. * Unproject from screen space to object space
  2961. * @param source defines the screen space Vector3 to use
  2962. * @param viewportWidth defines the current width of the viewport
  2963. * @param viewportHeight defines the current height of the viewport
  2964. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2965. * @param view defines the view matrix to use
  2966. * @param projection defines the projection matrix to use
  2967. * @param result defines the Vector3 where to store the result
  2968. */
  2969. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2970. /**
  2971. * Unproject from screen space to object space
  2972. * @param sourceX defines the screen space x coordinate to use
  2973. * @param sourceY defines the screen space y coordinate to use
  2974. * @param sourceZ defines the screen space z coordinate to use
  2975. * @param viewportWidth defines the current width of the viewport
  2976. * @param viewportHeight defines the current height of the viewport
  2977. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2978. * @param view defines the view matrix to use
  2979. * @param projection defines the projection matrix to use
  2980. * @param result defines the Vector3 where to store the result
  2981. */
  2982. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2983. /**
  2984. * Gets the minimal coordinate values between two Vector3
  2985. * @param left defines the first operand
  2986. * @param right defines the second operand
  2987. * @returns the new Vector3
  2988. */
  2989. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2990. /**
  2991. * Gets the maximal coordinate values between two Vector3
  2992. * @param left defines the first operand
  2993. * @param right defines the second operand
  2994. * @returns the new Vector3
  2995. */
  2996. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2997. /**
  2998. * Returns the distance between the vectors "value1" and "value2"
  2999. * @param value1 defines the first operand
  3000. * @param value2 defines the second operand
  3001. * @returns the distance
  3002. */
  3003. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3004. /**
  3005. * Returns the squared distance between the vectors "value1" and "value2"
  3006. * @param value1 defines the first operand
  3007. * @param value2 defines the second operand
  3008. * @returns the squared distance
  3009. */
  3010. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3011. /**
  3012. * Returns a new Vector3 located at the center between "value1" and "value2"
  3013. * @param value1 defines the first operand
  3014. * @param value2 defines the second operand
  3015. * @returns the new Vector3
  3016. */
  3017. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3018. /**
  3019. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3020. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3021. * to something in order to rotate it from its local system to the given target system
  3022. * Note: axis1, axis2 and axis3 are normalized during this operation
  3023. * @param axis1 defines the first axis
  3024. * @param axis2 defines the second axis
  3025. * @param axis3 defines the third axis
  3026. * @returns a new Vector3
  3027. */
  3028. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3029. /**
  3030. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3031. * @param axis1 defines the first axis
  3032. * @param axis2 defines the second axis
  3033. * @param axis3 defines the third axis
  3034. * @param ref defines the Vector3 where to store the result
  3035. */
  3036. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3037. }
  3038. /**
  3039. * Vector4 class created for EulerAngle class conversion to Quaternion
  3040. */
  3041. export class Vector4 {
  3042. /** x value of the vector */
  3043. x: number;
  3044. /** y value of the vector */
  3045. y: number;
  3046. /** z value of the vector */
  3047. z: number;
  3048. /** w value of the vector */
  3049. w: number;
  3050. /**
  3051. * Creates a Vector4 object from the given floats.
  3052. * @param x x value of the vector
  3053. * @param y y value of the vector
  3054. * @param z z value of the vector
  3055. * @param w w value of the vector
  3056. */
  3057. constructor(
  3058. /** x value of the vector */
  3059. x: number,
  3060. /** y value of the vector */
  3061. y: number,
  3062. /** z value of the vector */
  3063. z: number,
  3064. /** w value of the vector */
  3065. w: number);
  3066. /**
  3067. * Returns the string with the Vector4 coordinates.
  3068. * @returns a string containing all the vector values
  3069. */
  3070. toString(): string;
  3071. /**
  3072. * Returns the string "Vector4".
  3073. * @returns "Vector4"
  3074. */
  3075. getClassName(): string;
  3076. /**
  3077. * Returns the Vector4 hash code.
  3078. * @returns a unique hash code
  3079. */
  3080. getHashCode(): number;
  3081. /**
  3082. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3083. * @returns the resulting array
  3084. */
  3085. asArray(): number[];
  3086. /**
  3087. * Populates the given array from the given index with the Vector4 coordinates.
  3088. * @param array array to populate
  3089. * @param index index of the array to start at (default: 0)
  3090. * @returns the Vector4.
  3091. */
  3092. toArray(array: FloatArray, index?: number): Vector4;
  3093. /**
  3094. * Adds the given vector to the current Vector4.
  3095. * @param otherVector the vector to add
  3096. * @returns the updated Vector4.
  3097. */
  3098. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3099. /**
  3100. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3101. * @param otherVector the vector to add
  3102. * @returns the resulting vector
  3103. */
  3104. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3105. /**
  3106. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3107. * @param otherVector the vector to add
  3108. * @param result the vector to store the result
  3109. * @returns the current Vector4.
  3110. */
  3111. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3112. /**
  3113. * Subtract in place the given vector from the current Vector4.
  3114. * @param otherVector the vector to subtract
  3115. * @returns the updated Vector4.
  3116. */
  3117. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3118. /**
  3119. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3120. * @param otherVector the vector to add
  3121. * @returns the new vector with the result
  3122. */
  3123. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3124. /**
  3125. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3126. * @param otherVector the vector to subtract
  3127. * @param result the vector to store the result
  3128. * @returns the current Vector4.
  3129. */
  3130. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3131. /**
  3132. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3133. */
  3134. /**
  3135. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3136. * @param x value to subtract
  3137. * @param y value to subtract
  3138. * @param z value to subtract
  3139. * @param w value to subtract
  3140. * @returns new vector containing the result
  3141. */
  3142. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3143. /**
  3144. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3145. * @param x value to subtract
  3146. * @param y value to subtract
  3147. * @param z value to subtract
  3148. * @param w value to subtract
  3149. * @param result the vector to store the result in
  3150. * @returns the current Vector4.
  3151. */
  3152. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3153. /**
  3154. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3155. * @returns a new vector with the negated values
  3156. */
  3157. negate(): Vector4;
  3158. /**
  3159. * Multiplies the current Vector4 coordinates by scale (float).
  3160. * @param scale the number to scale with
  3161. * @returns the updated Vector4.
  3162. */
  3163. scaleInPlace(scale: number): Vector4;
  3164. /**
  3165. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3166. * @param scale the number to scale with
  3167. * @returns a new vector with the result
  3168. */
  3169. scale(scale: number): Vector4;
  3170. /**
  3171. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3172. * @param scale the number to scale with
  3173. * @param result a vector to store the result in
  3174. * @returns the current Vector4.
  3175. */
  3176. scaleToRef(scale: number, result: Vector4): Vector4;
  3177. /**
  3178. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3179. * @param scale defines the scale factor
  3180. * @param result defines the Vector4 object where to store the result
  3181. * @returns the unmodified current Vector4
  3182. */
  3183. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3184. /**
  3185. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3186. * @param otherVector the vector to compare against
  3187. * @returns true if they are equal
  3188. */
  3189. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3190. /**
  3191. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3192. * @param otherVector vector to compare against
  3193. * @param epsilon (Default: very small number)
  3194. * @returns true if they are equal
  3195. */
  3196. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3197. /**
  3198. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3199. * @param x x value to compare against
  3200. * @param y y value to compare against
  3201. * @param z z value to compare against
  3202. * @param w w value to compare against
  3203. * @returns true if equal
  3204. */
  3205. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3206. /**
  3207. * Multiplies in place the current Vector4 by the given one.
  3208. * @param otherVector vector to multiple with
  3209. * @returns the updated Vector4.
  3210. */
  3211. multiplyInPlace(otherVector: Vector4): Vector4;
  3212. /**
  3213. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3214. * @param otherVector vector to multiple with
  3215. * @returns resulting new vector
  3216. */
  3217. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3218. /**
  3219. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3220. * @param otherVector vector to multiple with
  3221. * @param result vector to store the result
  3222. * @returns the current Vector4.
  3223. */
  3224. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3225. /**
  3226. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3227. * @param x x value multiply with
  3228. * @param y y value multiply with
  3229. * @param z z value multiply with
  3230. * @param w w value multiply with
  3231. * @returns resulting new vector
  3232. */
  3233. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3234. /**
  3235. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3236. * @param otherVector vector to devide with
  3237. * @returns resulting new vector
  3238. */
  3239. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3240. /**
  3241. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3242. * @param otherVector vector to devide with
  3243. * @param result vector to store the result
  3244. * @returns the current Vector4.
  3245. */
  3246. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3247. /**
  3248. * Divides the current Vector3 coordinates by the given ones.
  3249. * @param otherVector vector to devide with
  3250. * @returns the updated Vector3.
  3251. */
  3252. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3253. /**
  3254. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3255. * @param other defines the second operand
  3256. * @returns the current updated Vector4
  3257. */
  3258. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3259. /**
  3260. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3261. * @param other defines the second operand
  3262. * @returns the current updated Vector4
  3263. */
  3264. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3265. /**
  3266. * Gets a new Vector4 from current Vector4 floored values
  3267. * @returns a new Vector4
  3268. */
  3269. floor(): Vector4;
  3270. /**
  3271. * Gets a new Vector4 from current Vector3 floored values
  3272. * @returns a new Vector4
  3273. */
  3274. fract(): Vector4;
  3275. /**
  3276. * Returns the Vector4 length (float).
  3277. * @returns the length
  3278. */
  3279. length(): number;
  3280. /**
  3281. * Returns the Vector4 squared length (float).
  3282. * @returns the length squared
  3283. */
  3284. lengthSquared(): number;
  3285. /**
  3286. * Normalizes in place the Vector4.
  3287. * @returns the updated Vector4.
  3288. */
  3289. normalize(): Vector4;
  3290. /**
  3291. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3292. * @returns this converted to a new vector3
  3293. */
  3294. toVector3(): Vector3;
  3295. /**
  3296. * Returns a new Vector4 copied from the current one.
  3297. * @returns the new cloned vector
  3298. */
  3299. clone(): Vector4;
  3300. /**
  3301. * Updates the current Vector4 with the given one coordinates.
  3302. * @param source the source vector to copy from
  3303. * @returns the updated Vector4.
  3304. */
  3305. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3306. /**
  3307. * Updates the current Vector4 coordinates with the given floats.
  3308. * @param x float to copy from
  3309. * @param y float to copy from
  3310. * @param z float to copy from
  3311. * @param w float to copy from
  3312. * @returns the updated Vector4.
  3313. */
  3314. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3315. /**
  3316. * Updates the current Vector4 coordinates with the given floats.
  3317. * @param x float to set from
  3318. * @param y float to set from
  3319. * @param z float to set from
  3320. * @param w float to set from
  3321. * @returns the updated Vector4.
  3322. */
  3323. set(x: number, y: number, z: number, w: number): Vector4;
  3324. /**
  3325. * Copies the given float to the current Vector3 coordinates
  3326. * @param v defines the x, y, z and w coordinates of the operand
  3327. * @returns the current updated Vector3
  3328. */
  3329. setAll(v: number): Vector4;
  3330. /**
  3331. * Returns a new Vector4 set from the starting index of the given array.
  3332. * @param array the array to pull values from
  3333. * @param offset the offset into the array to start at
  3334. * @returns the new vector
  3335. */
  3336. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3337. /**
  3338. * Updates the given vector "result" from the starting index of the given array.
  3339. * @param array the array to pull values from
  3340. * @param offset the offset into the array to start at
  3341. * @param result the vector to store the result in
  3342. */
  3343. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3344. /**
  3345. * Updates the given vector "result" from the starting index of the given Float32Array.
  3346. * @param array the array to pull values from
  3347. * @param offset the offset into the array to start at
  3348. * @param result the vector to store the result in
  3349. */
  3350. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3351. /**
  3352. * Updates the given vector "result" coordinates from the given floats.
  3353. * @param x float to set from
  3354. * @param y float to set from
  3355. * @param z float to set from
  3356. * @param w float to set from
  3357. * @param result the vector to the floats in
  3358. */
  3359. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3360. /**
  3361. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3362. * @returns the new vector
  3363. */
  3364. static Zero(): Vector4;
  3365. /**
  3366. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3367. * @returns the new vector
  3368. */
  3369. static One(): Vector4;
  3370. /**
  3371. * Returns a new normalized Vector4 from the given one.
  3372. * @param vector the vector to normalize
  3373. * @returns the vector
  3374. */
  3375. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3376. /**
  3377. * Updates the given vector "result" from the normalization of the given one.
  3378. * @param vector the vector to normalize
  3379. * @param result the vector to store the result in
  3380. */
  3381. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3382. /**
  3383. * Returns a vector with the minimum values from the left and right vectors
  3384. * @param left left vector to minimize
  3385. * @param right right vector to minimize
  3386. * @returns a new vector with the minimum of the left and right vector values
  3387. */
  3388. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3389. /**
  3390. * Returns a vector with the maximum values from the left and right vectors
  3391. * @param left left vector to maximize
  3392. * @param right right vector to maximize
  3393. * @returns a new vector with the maximum of the left and right vector values
  3394. */
  3395. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3396. /**
  3397. * Returns the distance (float) between the vectors "value1" and "value2".
  3398. * @param value1 value to calulate the distance between
  3399. * @param value2 value to calulate the distance between
  3400. * @return the distance between the two vectors
  3401. */
  3402. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3403. /**
  3404. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3405. * @param value1 value to calulate the distance between
  3406. * @param value2 value to calulate the distance between
  3407. * @return the distance between the two vectors squared
  3408. */
  3409. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3410. /**
  3411. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3412. * @param value1 value to calulate the center between
  3413. * @param value2 value to calulate the center between
  3414. * @return the center between the two vectors
  3415. */
  3416. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3417. /**
  3418. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3419. * This methods computes transformed normalized direction vectors only.
  3420. * @param vector the vector to transform
  3421. * @param transformation the transformation matrix to apply
  3422. * @returns the new vector
  3423. */
  3424. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3425. /**
  3426. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3427. * This methods computes transformed normalized direction vectors only.
  3428. * @param vector the vector to transform
  3429. * @param transformation the transformation matrix to apply
  3430. * @param result the vector to store the result in
  3431. */
  3432. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3433. /**
  3434. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3435. * This methods computes transformed normalized direction vectors only.
  3436. * @param x value to transform
  3437. * @param y value to transform
  3438. * @param z value to transform
  3439. * @param w value to transform
  3440. * @param transformation the transformation matrix to apply
  3441. * @param result the vector to store the results in
  3442. */
  3443. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3444. /**
  3445. * Creates a new Vector4 from a Vector3
  3446. * @param source defines the source data
  3447. * @param w defines the 4th component (default is 0)
  3448. * @returns a new Vector4
  3449. */
  3450. static FromVector3(source: Vector3, w?: number): Vector4;
  3451. }
  3452. /**
  3453. * Class used to store quaternion data
  3454. * @see https://en.wikipedia.org/wiki/Quaternion
  3455. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  3456. */
  3457. export class Quaternion {
  3458. /** defines the first component (0 by default) */
  3459. x: number;
  3460. /** defines the second component (0 by default) */
  3461. y: number;
  3462. /** defines the third component (0 by default) */
  3463. z: number;
  3464. /** defines the fourth component (1.0 by default) */
  3465. w: number;
  3466. /**
  3467. * Creates a new Quaternion from the given floats
  3468. * @param x defines the first component (0 by default)
  3469. * @param y defines the second component (0 by default)
  3470. * @param z defines the third component (0 by default)
  3471. * @param w defines the fourth component (1.0 by default)
  3472. */
  3473. constructor(
  3474. /** defines the first component (0 by default) */
  3475. x?: number,
  3476. /** defines the second component (0 by default) */
  3477. y?: number,
  3478. /** defines the third component (0 by default) */
  3479. z?: number,
  3480. /** defines the fourth component (1.0 by default) */
  3481. w?: number);
  3482. /**
  3483. * Gets a string representation for the current quaternion
  3484. * @returns a string with the Quaternion coordinates
  3485. */
  3486. toString(): string;
  3487. /**
  3488. * Gets the class name of the quaternion
  3489. * @returns the string "Quaternion"
  3490. */
  3491. getClassName(): string;
  3492. /**
  3493. * Gets a hash code for this quaternion
  3494. * @returns the quaternion hash code
  3495. */
  3496. getHashCode(): number;
  3497. /**
  3498. * Copy the quaternion to an array
  3499. * @returns a new array populated with 4 elements from the quaternion coordinates
  3500. */
  3501. asArray(): number[];
  3502. /**
  3503. * Check if two quaternions are equals
  3504. * @param otherQuaternion defines the second operand
  3505. * @return true if the current quaternion and the given one coordinates are strictly equals
  3506. */
  3507. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3508. /**
  3509. * Clone the current quaternion
  3510. * @returns a new quaternion copied from the current one
  3511. */
  3512. clone(): Quaternion;
  3513. /**
  3514. * Copy a quaternion to the current one
  3515. * @param other defines the other quaternion
  3516. * @returns the updated current quaternion
  3517. */
  3518. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3519. /**
  3520. * Updates the current quaternion with the given float coordinates
  3521. * @param x defines the x coordinate
  3522. * @param y defines the y coordinate
  3523. * @param z defines the z coordinate
  3524. * @param w defines the w coordinate
  3525. * @returns the updated current quaternion
  3526. */
  3527. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3528. /**
  3529. * Updates the current quaternion from the given float coordinates
  3530. * @param x defines the x coordinate
  3531. * @param y defines the y coordinate
  3532. * @param z defines the z coordinate
  3533. * @param w defines the w coordinate
  3534. * @returns the updated current quaternion
  3535. */
  3536. set(x: number, y: number, z: number, w: number): Quaternion;
  3537. /**
  3538. * Adds two quaternions
  3539. * @param other defines the second operand
  3540. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3541. */
  3542. add(other: DeepImmutable<Quaternion>): Quaternion;
  3543. /**
  3544. * Add a quaternion to the current one
  3545. * @param other defines the quaternion to add
  3546. * @returns the current quaternion
  3547. */
  3548. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3549. /**
  3550. * Subtract two quaternions
  3551. * @param other defines the second operand
  3552. * @returns a new quaternion as the subtraction result of the given one from the current one
  3553. */
  3554. subtract(other: Quaternion): Quaternion;
  3555. /**
  3556. * Multiplies the current quaternion by a scale factor
  3557. * @param value defines the scale factor
  3558. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3559. */
  3560. scale(value: number): Quaternion;
  3561. /**
  3562. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3563. * @param scale defines the scale factor
  3564. * @param result defines the Quaternion object where to store the result
  3565. * @returns the unmodified current quaternion
  3566. */
  3567. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3568. /**
  3569. * Multiplies in place the current quaternion by a scale factor
  3570. * @param value defines the scale factor
  3571. * @returns the current modified quaternion
  3572. */
  3573. scaleInPlace(value: number): Quaternion;
  3574. /**
  3575. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3576. * @param scale defines the scale factor
  3577. * @param result defines the Quaternion object where to store the result
  3578. * @returns the unmodified current quaternion
  3579. */
  3580. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3581. /**
  3582. * Multiplies two quaternions
  3583. * @param q1 defines the second operand
  3584. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3585. */
  3586. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3587. /**
  3588. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3589. * @param q1 defines the second operand
  3590. * @param result defines the target quaternion
  3591. * @returns the current quaternion
  3592. */
  3593. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3594. /**
  3595. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3596. * @param q1 defines the second operand
  3597. * @returns the currentupdated quaternion
  3598. */
  3599. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3600. /**
  3601. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3602. * @param ref defines the target quaternion
  3603. * @returns the current quaternion
  3604. */
  3605. conjugateToRef(ref: Quaternion): Quaternion;
  3606. /**
  3607. * Conjugates in place (1-q) the current quaternion
  3608. * @returns the current updated quaternion
  3609. */
  3610. conjugateInPlace(): Quaternion;
  3611. /**
  3612. * Conjugates in place (1-q) the current quaternion
  3613. * @returns a new quaternion
  3614. */
  3615. conjugate(): Quaternion;
  3616. /**
  3617. * Gets length of current quaternion
  3618. * @returns the quaternion length (float)
  3619. */
  3620. length(): number;
  3621. /**
  3622. * Normalize in place the current quaternion
  3623. * @returns the current updated quaternion
  3624. */
  3625. normalize(): Quaternion;
  3626. /**
  3627. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3628. * @param order is a reserved parameter and is ignore for now
  3629. * @returns a new Vector3 containing the Euler angles
  3630. */
  3631. toEulerAngles(order?: string): Vector3;
  3632. /**
  3633. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3634. * @param result defines the vector which will be filled with the Euler angles
  3635. * @param order is a reserved parameter and is ignore for now
  3636. * @returns the current unchanged quaternion
  3637. */
  3638. toEulerAnglesToRef(result: Vector3): Quaternion;
  3639. /**
  3640. * Updates the given rotation matrix with the current quaternion values
  3641. * @param result defines the target matrix
  3642. * @returns the current unchanged quaternion
  3643. */
  3644. toRotationMatrix(result: Matrix): Quaternion;
  3645. /**
  3646. * Updates the current quaternion from the given rotation matrix values
  3647. * @param matrix defines the source matrix
  3648. * @returns the current updated quaternion
  3649. */
  3650. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3651. /**
  3652. * Creates a new quaternion from a rotation matrix
  3653. * @param matrix defines the source matrix
  3654. * @returns a new quaternion created from the given rotation matrix values
  3655. */
  3656. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3657. /**
  3658. * Updates the given quaternion with the given rotation matrix values
  3659. * @param matrix defines the source matrix
  3660. * @param result defines the target quaternion
  3661. */
  3662. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3663. /**
  3664. * Returns the dot product (float) between the quaternions "left" and "right"
  3665. * @param left defines the left operand
  3666. * @param right defines the right operand
  3667. * @returns the dot product
  3668. */
  3669. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3670. /**
  3671. * Checks if the two quaternions are close to each other
  3672. * @param quat0 defines the first quaternion to check
  3673. * @param quat1 defines the second quaternion to check
  3674. * @returns true if the two quaternions are close to each other
  3675. */
  3676. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3677. /**
  3678. * Creates an empty quaternion
  3679. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3680. */
  3681. static Zero(): Quaternion;
  3682. /**
  3683. * Inverse a given quaternion
  3684. * @param q defines the source quaternion
  3685. * @returns a new quaternion as the inverted current quaternion
  3686. */
  3687. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3688. /**
  3689. * Inverse a given quaternion
  3690. * @param q defines the source quaternion
  3691. * @param result the quaternion the result will be stored in
  3692. * @returns the result quaternion
  3693. */
  3694. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3695. /**
  3696. * Creates an identity quaternion
  3697. * @returns the identity quaternion
  3698. */
  3699. static Identity(): Quaternion;
  3700. /**
  3701. * Gets a boolean indicating if the given quaternion is identity
  3702. * @param quaternion defines the quaternion to check
  3703. * @returns true if the quaternion is identity
  3704. */
  3705. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3706. /**
  3707. * Creates a quaternion from a rotation around an axis
  3708. * @param axis defines the axis to use
  3709. * @param angle defines the angle to use
  3710. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3711. */
  3712. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3713. /**
  3714. * Creates a rotation around an axis and stores it into the given quaternion
  3715. * @param axis defines the axis to use
  3716. * @param angle defines the angle to use
  3717. * @param result defines the target quaternion
  3718. * @returns the target quaternion
  3719. */
  3720. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3721. /**
  3722. * Creates a new quaternion from data stored into an array
  3723. * @param array defines the data source
  3724. * @param offset defines the offset in the source array where the data starts
  3725. * @returns a new quaternion
  3726. */
  3727. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3728. /**
  3729. * Create a quaternion from Euler rotation angles
  3730. * @param x Pitch
  3731. * @param y Yaw
  3732. * @param z Roll
  3733. * @returns the new Quaternion
  3734. */
  3735. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3736. /**
  3737. * Updates a quaternion from Euler rotation angles
  3738. * @param x Pitch
  3739. * @param y Yaw
  3740. * @param z Roll
  3741. * @param result the quaternion to store the result
  3742. * @returns the updated quaternion
  3743. */
  3744. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3745. /**
  3746. * Create a quaternion from Euler rotation vector
  3747. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3748. * @returns the new Quaternion
  3749. */
  3750. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3751. /**
  3752. * Updates a quaternion from Euler rotation vector
  3753. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3754. * @param result the quaternion to store the result
  3755. * @returns the updated quaternion
  3756. */
  3757. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  3758. /**
  3759. * Creates a new quaternion from the given Euler float angles (y, x, z)
  3760. * @param yaw defines the rotation around Y axis
  3761. * @param pitch defines the rotation around X axis
  3762. * @param roll defines the rotation around Z axis
  3763. * @returns the new quaternion
  3764. */
  3765. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  3766. /**
  3767. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  3768. * @param yaw defines the rotation around Y axis
  3769. * @param pitch defines the rotation around X axis
  3770. * @param roll defines the rotation around Z axis
  3771. * @param result defines the target quaternion
  3772. */
  3773. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  3774. /**
  3775. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  3776. * @param alpha defines the rotation around first axis
  3777. * @param beta defines the rotation around second axis
  3778. * @param gamma defines the rotation around third axis
  3779. * @returns the new quaternion
  3780. */
  3781. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  3782. /**
  3783. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  3784. * @param alpha defines the rotation around first axis
  3785. * @param beta defines the rotation around second axis
  3786. * @param gamma defines the rotation around third axis
  3787. * @param result defines the target quaternion
  3788. */
  3789. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  3790. /**
  3791. * 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)
  3792. * @param axis1 defines the first axis
  3793. * @param axis2 defines the second axis
  3794. * @param axis3 defines the third axis
  3795. * @returns the new quaternion
  3796. */
  3797. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  3798. /**
  3799. * 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
  3800. * @param axis1 defines the first axis
  3801. * @param axis2 defines the second axis
  3802. * @param axis3 defines the third axis
  3803. * @param ref defines the target quaternion
  3804. */
  3805. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  3806. /**
  3807. * Interpolates between two quaternions
  3808. * @param left defines first quaternion
  3809. * @param right defines second quaternion
  3810. * @param amount defines the gradient to use
  3811. * @returns the new interpolated quaternion
  3812. */
  3813. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3814. /**
  3815. * Interpolates between two quaternions and stores it into a target quaternion
  3816. * @param left defines first quaternion
  3817. * @param right defines second quaternion
  3818. * @param amount defines the gradient to use
  3819. * @param result defines the target quaternion
  3820. */
  3821. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  3822. /**
  3823. * Interpolate between two quaternions using Hermite interpolation
  3824. * @param value1 defines first quaternion
  3825. * @param tangent1 defines the incoming tangent
  3826. * @param value2 defines second quaternion
  3827. * @param tangent2 defines the outgoing tangent
  3828. * @param amount defines the target quaternion
  3829. * @returns the new interpolated quaternion
  3830. */
  3831. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3832. }
  3833. /**
  3834. * Class used to store matrix data (4x4)
  3835. */
  3836. export class Matrix {
  3837. private static _updateFlagSeed;
  3838. private static _identityReadOnly;
  3839. private _isIdentity;
  3840. private _isIdentityDirty;
  3841. private _isIdentity3x2;
  3842. private _isIdentity3x2Dirty;
  3843. /**
  3844. * Gets the update flag of the matrix which is an unique number for the matrix.
  3845. * It will be incremented every time the matrix data change.
  3846. * You can use it to speed the comparison between two versions of the same matrix.
  3847. */
  3848. updateFlag: number;
  3849. private readonly _m;
  3850. /**
  3851. * Gets the internal data of the matrix
  3852. */
  3853. readonly m: DeepImmutable<Float32Array>;
  3854. /** @hidden */
  3855. _markAsUpdated(): void;
  3856. /** @hidden */
  3857. private _updateIdentityStatus;
  3858. /**
  3859. * Creates an empty matrix (filled with zeros)
  3860. */
  3861. constructor();
  3862. /**
  3863. * Check if the current matrix is identity
  3864. * @returns true is the matrix is the identity matrix
  3865. */
  3866. isIdentity(): boolean;
  3867. /**
  3868. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  3869. * @returns true is the matrix is the identity matrix
  3870. */
  3871. isIdentityAs3x2(): boolean;
  3872. /**
  3873. * Gets the determinant of the matrix
  3874. * @returns the matrix determinant
  3875. */
  3876. determinant(): number;
  3877. /**
  3878. * Returns the matrix as a Float32Array
  3879. * @returns the matrix underlying array
  3880. */
  3881. toArray(): DeepImmutable<Float32Array>;
  3882. /**
  3883. * Returns the matrix as a Float32Array
  3884. * @returns the matrix underlying array.
  3885. */
  3886. asArray(): DeepImmutable<Float32Array>;
  3887. /**
  3888. * Inverts the current matrix in place
  3889. * @returns the current inverted matrix
  3890. */
  3891. invert(): Matrix;
  3892. /**
  3893. * Sets all the matrix elements to zero
  3894. * @returns the current matrix
  3895. */
  3896. reset(): Matrix;
  3897. /**
  3898. * Adds the current matrix with a second one
  3899. * @param other defines the matrix to add
  3900. * @returns a new matrix as the addition of the current matrix and the given one
  3901. */
  3902. add(other: DeepImmutable<Matrix>): Matrix;
  3903. /**
  3904. * Sets the given matrix "result" to the addition of the current matrix and the given one
  3905. * @param other defines the matrix to add
  3906. * @param result defines the target matrix
  3907. * @returns the current matrix
  3908. */
  3909. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  3910. /**
  3911. * Adds in place the given matrix to the current matrix
  3912. * @param other defines the second operand
  3913. * @returns the current updated matrix
  3914. */
  3915. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  3916. /**
  3917. * Sets the given matrix to the current inverted Matrix
  3918. * @param other defines the target matrix
  3919. * @returns the unmodified current matrix
  3920. */
  3921. invertToRef(other: Matrix): Matrix;
  3922. /**
  3923. * add a value at the specified position in the current Matrix
  3924. * @param index the index of the value within the matrix. between 0 and 15.
  3925. * @param value the value to be added
  3926. * @returns the current updated matrix
  3927. */
  3928. addAtIndex(index: number, value: number): Matrix;
  3929. /**
  3930. * mutiply the specified position in the current Matrix by a value
  3931. * @param index the index of the value within the matrix. between 0 and 15.
  3932. * @param value the value to be added
  3933. * @returns the current updated matrix
  3934. */
  3935. multiplyAtIndex(index: number, value: number): Matrix;
  3936. /**
  3937. * Inserts the translation vector (using 3 floats) in the current matrix
  3938. * @param x defines the 1st component of the translation
  3939. * @param y defines the 2nd component of the translation
  3940. * @param z defines the 3rd component of the translation
  3941. * @returns the current updated matrix
  3942. */
  3943. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3944. /**
  3945. * Adds the translation vector (using 3 floats) in the current matrix
  3946. * @param x defines the 1st component of the translation
  3947. * @param y defines the 2nd component of the translation
  3948. * @param z defines the 3rd component of the translation
  3949. * @returns the current updated matrix
  3950. */
  3951. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3952. /**
  3953. * Inserts the translation vector in the current matrix
  3954. * @param vector3 defines the translation to insert
  3955. * @returns the current updated matrix
  3956. */
  3957. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  3958. /**
  3959. * Gets the translation value of the current matrix
  3960. * @returns a new Vector3 as the extracted translation from the matrix
  3961. */
  3962. getTranslation(): Vector3;
  3963. /**
  3964. * Fill a Vector3 with the extracted translation from the matrix
  3965. * @param result defines the Vector3 where to store the translation
  3966. * @returns the current matrix
  3967. */
  3968. getTranslationToRef(result: Vector3): Matrix;
  3969. /**
  3970. * Remove rotation and scaling part from the matrix
  3971. * @returns the updated matrix
  3972. */
  3973. removeRotationAndScaling(): Matrix;
  3974. /**
  3975. * Multiply two matrices
  3976. * @param other defines the second operand
  3977. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  3978. */
  3979. multiply(other: DeepImmutable<Matrix>): Matrix;
  3980. /**
  3981. * Copy the current matrix from the given one
  3982. * @param other defines the source matrix
  3983. * @returns the current updated matrix
  3984. */
  3985. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  3986. /**
  3987. * Populates the given array from the starting index with the current matrix values
  3988. * @param array defines the target array
  3989. * @param offset defines the offset in the target array where to start storing values
  3990. * @returns the current matrix
  3991. */
  3992. copyToArray(array: Float32Array, offset?: number): Matrix;
  3993. /**
  3994. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  3995. * @param other defines the second operand
  3996. * @param result defines the matrix where to store the multiplication
  3997. * @returns the current matrix
  3998. */
  3999. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4000. /**
  4001. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4002. * @param other defines the second operand
  4003. * @param result defines the array where to store the multiplication
  4004. * @param offset defines the offset in the target array where to start storing values
  4005. * @returns the current matrix
  4006. */
  4007. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  4008. /**
  4009. * Check equality between this matrix and a second one
  4010. * @param value defines the second matrix to compare
  4011. * @returns true is the current matrix and the given one values are strictly equal
  4012. */
  4013. equals(value: DeepImmutable<Matrix>): boolean;
  4014. /**
  4015. * Clone the current matrix
  4016. * @returns a new matrix from the current matrix
  4017. */
  4018. clone(): Matrix;
  4019. /**
  4020. * Returns the name of the current matrix class
  4021. * @returns the string "Matrix"
  4022. */
  4023. getClassName(): string;
  4024. /**
  4025. * Gets the hash code of the current matrix
  4026. * @returns the hash code
  4027. */
  4028. getHashCode(): number;
  4029. /**
  4030. * Decomposes the current Matrix into a translation, rotation and scaling components
  4031. * @param scale defines the scale vector3 given as a reference to update
  4032. * @param rotation defines the rotation quaternion given as a reference to update
  4033. * @param translation defines the translation vector3 given as a reference to update
  4034. * @returns true if operation was successful
  4035. */
  4036. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4037. /**
  4038. * Gets specific row of the matrix
  4039. * @param index defines the number of the row to get
  4040. * @returns the index-th row of the current matrix as a new Vector4
  4041. */
  4042. getRow(index: number): Nullable<Vector4>;
  4043. /**
  4044. * Sets the index-th row of the current matrix to the vector4 values
  4045. * @param index defines the number of the row to set
  4046. * @param row defines the target vector4
  4047. * @returns the updated current matrix
  4048. */
  4049. setRow(index: number, row: Vector4): Matrix;
  4050. /**
  4051. * Compute the transpose of the matrix
  4052. * @returns the new transposed matrix
  4053. */
  4054. transpose(): Matrix;
  4055. /**
  4056. * Compute the transpose of the matrix and store it in a given matrix
  4057. * @param result defines the target matrix
  4058. * @returns the current matrix
  4059. */
  4060. transposeToRef(result: Matrix): Matrix;
  4061. /**
  4062. * Sets the index-th row of the current matrix with the given 4 x float values
  4063. * @param index defines the row index
  4064. * @param x defines the x component to set
  4065. * @param y defines the y component to set
  4066. * @param z defines the z component to set
  4067. * @param w defines the w component to set
  4068. * @returns the updated current matrix
  4069. */
  4070. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4071. /**
  4072. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4073. * @param scale defines the scale factor
  4074. * @returns a new matrix
  4075. */
  4076. scale(scale: number): Matrix;
  4077. /**
  4078. * Scale the current matrix values by a factor to a given result matrix
  4079. * @param scale defines the scale factor
  4080. * @param result defines the matrix to store the result
  4081. * @returns the current matrix
  4082. */
  4083. scaleToRef(scale: number, result: Matrix): Matrix;
  4084. /**
  4085. * Scale the current matrix values by a factor and add the result to a given matrix
  4086. * @param scale defines the scale factor
  4087. * @param result defines the Matrix to store the result
  4088. * @returns the current matrix
  4089. */
  4090. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4091. /**
  4092. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4093. * @param ref matrix to store the result
  4094. */
  4095. toNormalMatrix(ref: Matrix): void;
  4096. /**
  4097. * Gets only rotation part of the current matrix
  4098. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4099. */
  4100. getRotationMatrix(): Matrix;
  4101. /**
  4102. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4103. * @param result defines the target matrix to store data to
  4104. * @returns the current matrix
  4105. */
  4106. getRotationMatrixToRef(result: Matrix): Matrix;
  4107. /**
  4108. * Toggles model matrix from being right handed to left handed in place and vice versa
  4109. */
  4110. toggleModelMatrixHandInPlace(): void;
  4111. /**
  4112. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4113. */
  4114. toggleProjectionMatrixHandInPlace(): void;
  4115. /**
  4116. * Creates a matrix from an array
  4117. * @param array defines the source array
  4118. * @param offset defines an offset in the source array
  4119. * @returns a new Matrix set from the starting index of the given array
  4120. */
  4121. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4122. /**
  4123. * Copy the content of an array into a given matrix
  4124. * @param array defines the source array
  4125. * @param offset defines an offset in the source array
  4126. * @param result defines the target matrix
  4127. */
  4128. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4129. /**
  4130. * Stores an array into a matrix after having multiplied each component by a given factor
  4131. * @param array defines the source array
  4132. * @param offset defines the offset in the source array
  4133. * @param scale defines the scaling factor
  4134. * @param result defines the target matrix
  4135. */
  4136. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  4137. /**
  4138. * Gets an identity matrix that must not be updated
  4139. */
  4140. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  4141. /**
  4142. * Stores a list of values (16) inside a given matrix
  4143. * @param initialM11 defines 1st value of 1st row
  4144. * @param initialM12 defines 2nd value of 1st row
  4145. * @param initialM13 defines 3rd value of 1st row
  4146. * @param initialM14 defines 4th value of 1st row
  4147. * @param initialM21 defines 1st value of 2nd row
  4148. * @param initialM22 defines 2nd value of 2nd row
  4149. * @param initialM23 defines 3rd value of 2nd row
  4150. * @param initialM24 defines 4th value of 2nd row
  4151. * @param initialM31 defines 1st value of 3rd row
  4152. * @param initialM32 defines 2nd value of 3rd row
  4153. * @param initialM33 defines 3rd value of 3rd row
  4154. * @param initialM34 defines 4th value of 3rd row
  4155. * @param initialM41 defines 1st value of 4th row
  4156. * @param initialM42 defines 2nd value of 4th row
  4157. * @param initialM43 defines 3rd value of 4th row
  4158. * @param initialM44 defines 4th value of 4th row
  4159. * @param result defines the target matrix
  4160. */
  4161. 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;
  4162. /**
  4163. * Creates new matrix from a list of values (16)
  4164. * @param initialM11 defines 1st value of 1st row
  4165. * @param initialM12 defines 2nd value of 1st row
  4166. * @param initialM13 defines 3rd value of 1st row
  4167. * @param initialM14 defines 4th value of 1st row
  4168. * @param initialM21 defines 1st value of 2nd row
  4169. * @param initialM22 defines 2nd value of 2nd row
  4170. * @param initialM23 defines 3rd value of 2nd row
  4171. * @param initialM24 defines 4th value of 2nd row
  4172. * @param initialM31 defines 1st value of 3rd row
  4173. * @param initialM32 defines 2nd value of 3rd row
  4174. * @param initialM33 defines 3rd value of 3rd row
  4175. * @param initialM34 defines 4th value of 3rd row
  4176. * @param initialM41 defines 1st value of 4th row
  4177. * @param initialM42 defines 2nd value of 4th row
  4178. * @param initialM43 defines 3rd value of 4th row
  4179. * @param initialM44 defines 4th value of 4th row
  4180. * @returns the new matrix
  4181. */
  4182. 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;
  4183. /**
  4184. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4185. * @param scale defines the scale vector3
  4186. * @param rotation defines the rotation quaternion
  4187. * @param translation defines the translation vector3
  4188. * @returns a new matrix
  4189. */
  4190. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4191. /**
  4192. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4193. * @param scale defines the scale vector3
  4194. * @param rotation defines the rotation quaternion
  4195. * @param translation defines the translation vector3
  4196. * @param result defines the target matrix
  4197. */
  4198. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4199. /**
  4200. * Creates a new identity matrix
  4201. * @returns a new identity matrix
  4202. */
  4203. static Identity(): Matrix;
  4204. /**
  4205. * Creates a new identity matrix and stores the result in a given matrix
  4206. * @param result defines the target matrix
  4207. */
  4208. static IdentityToRef(result: Matrix): void;
  4209. /**
  4210. * Creates a new zero matrix
  4211. * @returns a new zero matrix
  4212. */
  4213. static Zero(): Matrix;
  4214. /**
  4215. * Creates a new rotation matrix for "angle" radians around the X axis
  4216. * @param angle defines the angle (in radians) to use
  4217. * @return the new matrix
  4218. */
  4219. static RotationX(angle: number): Matrix;
  4220. /**
  4221. * Creates a new matrix as the invert of a given matrix
  4222. * @param source defines the source matrix
  4223. * @returns the new matrix
  4224. */
  4225. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4226. /**
  4227. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4228. * @param angle defines the angle (in radians) to use
  4229. * @param result defines the target matrix
  4230. */
  4231. static RotationXToRef(angle: number, result: Matrix): void;
  4232. /**
  4233. * Creates a new rotation matrix for "angle" radians around the Y axis
  4234. * @param angle defines the angle (in radians) to use
  4235. * @return the new matrix
  4236. */
  4237. static RotationY(angle: number): Matrix;
  4238. /**
  4239. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4240. * @param angle defines the angle (in radians) to use
  4241. * @param result defines the target matrix
  4242. */
  4243. static RotationYToRef(angle: number, result: Matrix): void;
  4244. /**
  4245. * Creates a new rotation matrix for "angle" radians around the Z axis
  4246. * @param angle defines the angle (in radians) to use
  4247. * @return the new matrix
  4248. */
  4249. static RotationZ(angle: number): Matrix;
  4250. /**
  4251. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4252. * @param angle defines the angle (in radians) to use
  4253. * @param result defines the target matrix
  4254. */
  4255. static RotationZToRef(angle: number, result: Matrix): void;
  4256. /**
  4257. * Creates a new rotation matrix for "angle" radians around the given axis
  4258. * @param axis defines the axis to use
  4259. * @param angle defines the angle (in radians) to use
  4260. * @return the new matrix
  4261. */
  4262. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4263. /**
  4264. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4265. * @param axis defines the axis to use
  4266. * @param angle defines the angle (in radians) to use
  4267. * @param result defines the target matrix
  4268. */
  4269. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4270. /**
  4271. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4272. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4273. * @param from defines the vector to align
  4274. * @param to defines the vector to align to
  4275. * @param result defines the target matrix
  4276. */
  4277. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4278. /**
  4279. * Creates a rotation matrix
  4280. * @param yaw defines the yaw angle in radians (Y axis)
  4281. * @param pitch defines the pitch angle in radians (X axis)
  4282. * @param roll defines the roll angle in radians (X axis)
  4283. * @returns the new rotation matrix
  4284. */
  4285. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4286. /**
  4287. * Creates a rotation matrix and stores it in a given matrix
  4288. * @param yaw defines the yaw angle in radians (Y axis)
  4289. * @param pitch defines the pitch angle in radians (X axis)
  4290. * @param roll defines the roll angle in radians (X axis)
  4291. * @param result defines the target matrix
  4292. */
  4293. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4294. /**
  4295. * Creates a scaling matrix
  4296. * @param x defines the scale factor on X axis
  4297. * @param y defines the scale factor on Y axis
  4298. * @param z defines the scale factor on Z axis
  4299. * @returns the new matrix
  4300. */
  4301. static Scaling(x: number, y: number, z: number): Matrix;
  4302. /**
  4303. * Creates a scaling matrix and stores it in a given matrix
  4304. * @param x defines the scale factor on X axis
  4305. * @param y defines the scale factor on Y axis
  4306. * @param z defines the scale factor on Z axis
  4307. * @param result defines the target matrix
  4308. */
  4309. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4310. /**
  4311. * Creates a translation matrix
  4312. * @param x defines the translation on X axis
  4313. * @param y defines the translation on Y axis
  4314. * @param z defines the translationon Z axis
  4315. * @returns the new matrix
  4316. */
  4317. static Translation(x: number, y: number, z: number): Matrix;
  4318. /**
  4319. * Creates a translation matrix and stores it in a given matrix
  4320. * @param x defines the translation on X axis
  4321. * @param y defines the translation on Y axis
  4322. * @param z defines the translationon Z axis
  4323. * @param result defines the target matrix
  4324. */
  4325. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4326. /**
  4327. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4328. * @param startValue defines the start value
  4329. * @param endValue defines the end value
  4330. * @param gradient defines the gradient factor
  4331. * @returns the new matrix
  4332. */
  4333. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4334. /**
  4335. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4336. * @param startValue defines the start value
  4337. * @param endValue defines the end value
  4338. * @param gradient defines the gradient factor
  4339. * @param result defines the Matrix object where to store data
  4340. */
  4341. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4342. /**
  4343. * Builds a new matrix whose values are computed by:
  4344. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4345. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4346. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4347. * @param startValue defines the first matrix
  4348. * @param endValue defines the second matrix
  4349. * @param gradient defines the gradient between the two matrices
  4350. * @returns the new matrix
  4351. */
  4352. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4353. /**
  4354. * Update a matrix to values which are computed by:
  4355. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4356. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4357. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4358. * @param startValue defines the first matrix
  4359. * @param endValue defines the second matrix
  4360. * @param gradient defines the gradient between the two matrices
  4361. * @param result defines the target matrix
  4362. */
  4363. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4364. /**
  4365. * 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"
  4366. * This function works in left handed mode
  4367. * @param eye defines the final position of the entity
  4368. * @param target defines where the entity should look at
  4369. * @param up defines the up vector for the entity
  4370. * @returns the new matrix
  4371. */
  4372. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4373. /**
  4374. * 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".
  4375. * This function works in left handed mode
  4376. * @param eye defines the final position of the entity
  4377. * @param target defines where the entity should look at
  4378. * @param up defines the up vector for the entity
  4379. * @param result defines the target matrix
  4380. */
  4381. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4382. /**
  4383. * 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"
  4384. * This function works in right handed mode
  4385. * @param eye defines the final position of the entity
  4386. * @param target defines where the entity should look at
  4387. * @param up defines the up vector for the entity
  4388. * @returns the new matrix
  4389. */
  4390. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4391. /**
  4392. * 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".
  4393. * This function works in right handed mode
  4394. * @param eye defines the final position of the entity
  4395. * @param target defines where the entity should look at
  4396. * @param up defines the up vector for the entity
  4397. * @param result defines the target matrix
  4398. */
  4399. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4400. /**
  4401. * Create a left-handed orthographic projection matrix
  4402. * @param width defines the viewport width
  4403. * @param height defines the viewport height
  4404. * @param znear defines the near clip plane
  4405. * @param zfar defines the far clip plane
  4406. * @returns a new matrix as a left-handed orthographic projection matrix
  4407. */
  4408. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4409. /**
  4410. * Store a left-handed orthographic projection to a given matrix
  4411. * @param width defines the viewport width
  4412. * @param height defines the viewport height
  4413. * @param znear defines the near clip plane
  4414. * @param zfar defines the far clip plane
  4415. * @param result defines the target matrix
  4416. */
  4417. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4418. /**
  4419. * Create a left-handed orthographic projection matrix
  4420. * @param left defines the viewport left coordinate
  4421. * @param right defines the viewport right coordinate
  4422. * @param bottom defines the viewport bottom coordinate
  4423. * @param top defines the viewport top coordinate
  4424. * @param znear defines the near clip plane
  4425. * @param zfar defines the far clip plane
  4426. * @returns a new matrix as a left-handed orthographic projection matrix
  4427. */
  4428. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4429. /**
  4430. * Stores a left-handed orthographic projection into a given matrix
  4431. * @param left defines the viewport left coordinate
  4432. * @param right defines the viewport right coordinate
  4433. * @param bottom defines the viewport bottom coordinate
  4434. * @param top defines the viewport top coordinate
  4435. * @param znear defines the near clip plane
  4436. * @param zfar defines the far clip plane
  4437. * @param result defines the target matrix
  4438. */
  4439. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4440. /**
  4441. * Creates a right-handed orthographic projection matrix
  4442. * @param left defines the viewport left coordinate
  4443. * @param right defines the viewport right coordinate
  4444. * @param bottom defines the viewport bottom coordinate
  4445. * @param top defines the viewport top coordinate
  4446. * @param znear defines the near clip plane
  4447. * @param zfar defines the far clip plane
  4448. * @returns a new matrix as a right-handed orthographic projection matrix
  4449. */
  4450. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4451. /**
  4452. * Stores a right-handed orthographic projection into a given matrix
  4453. * @param left defines the viewport left coordinate
  4454. * @param right defines the viewport right coordinate
  4455. * @param bottom defines the viewport bottom coordinate
  4456. * @param top defines the viewport top coordinate
  4457. * @param znear defines the near clip plane
  4458. * @param zfar defines the far clip plane
  4459. * @param result defines the target matrix
  4460. */
  4461. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4462. /**
  4463. * Creates a left-handed perspective projection matrix
  4464. * @param width defines the viewport width
  4465. * @param height defines the viewport height
  4466. * @param znear defines the near clip plane
  4467. * @param zfar defines the far clip plane
  4468. * @returns a new matrix as a left-handed perspective projection matrix
  4469. */
  4470. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4471. /**
  4472. * Creates a left-handed perspective projection matrix
  4473. * @param fov defines the horizontal field of view
  4474. * @param aspect defines the aspect ratio
  4475. * @param znear defines the near clip plane
  4476. * @param zfar defines the far clip plane
  4477. * @returns a new matrix as a left-handed perspective projection matrix
  4478. */
  4479. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4480. /**
  4481. * Stores a left-handed perspective projection into a given matrix
  4482. * @param fov defines the horizontal field of view
  4483. * @param aspect defines the aspect ratio
  4484. * @param znear defines the near clip plane
  4485. * @param zfar defines the far clip plane
  4486. * @param result defines the target matrix
  4487. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4488. */
  4489. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4490. /**
  4491. * Creates a right-handed perspective projection matrix
  4492. * @param fov defines the horizontal field of view
  4493. * @param aspect defines the aspect ratio
  4494. * @param znear defines the near clip plane
  4495. * @param zfar defines the far clip plane
  4496. * @returns a new matrix as a right-handed perspective projection matrix
  4497. */
  4498. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4499. /**
  4500. * Stores a right-handed perspective projection into a given matrix
  4501. * @param fov defines the horizontal field of view
  4502. * @param aspect defines the aspect ratio
  4503. * @param znear defines the near clip plane
  4504. * @param zfar defines the far clip plane
  4505. * @param result defines the target matrix
  4506. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4507. */
  4508. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4509. /**
  4510. * Stores a perspective projection for WebVR info a given matrix
  4511. * @param fov defines the field of view
  4512. * @param znear defines the near clip plane
  4513. * @param zfar defines the far clip plane
  4514. * @param result defines the target matrix
  4515. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4516. */
  4517. static PerspectiveFovWebVRToRef(fov: {
  4518. upDegrees: number;
  4519. downDegrees: number;
  4520. leftDegrees: number;
  4521. rightDegrees: number;
  4522. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4523. /**
  4524. * Computes a complete transformation matrix
  4525. * @param viewport defines the viewport to use
  4526. * @param world defines the world matrix
  4527. * @param view defines the view matrix
  4528. * @param projection defines the projection matrix
  4529. * @param zmin defines the near clip plane
  4530. * @param zmax defines the far clip plane
  4531. * @returns the transformation matrix
  4532. */
  4533. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4534. /**
  4535. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4536. * @param matrix defines the matrix to use
  4537. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4538. */
  4539. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  4540. /**
  4541. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4542. * @param matrix defines the matrix to use
  4543. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4544. */
  4545. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  4546. /**
  4547. * Compute the transpose of a given matrix
  4548. * @param matrix defines the matrix to transpose
  4549. * @returns the new matrix
  4550. */
  4551. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4552. /**
  4553. * Compute the transpose of a matrix and store it in a target matrix
  4554. * @param matrix defines the matrix to transpose
  4555. * @param result defines the target matrix
  4556. */
  4557. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4558. /**
  4559. * Computes a reflection matrix from a plane
  4560. * @param plane defines the reflection plane
  4561. * @returns a new matrix
  4562. */
  4563. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4564. /**
  4565. * Computes a reflection matrix from a plane
  4566. * @param plane defines the reflection plane
  4567. * @param result defines the target matrix
  4568. */
  4569. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4570. /**
  4571. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4572. * @param xaxis defines the value of the 1st axis
  4573. * @param yaxis defines the value of the 2nd axis
  4574. * @param zaxis defines the value of the 3rd axis
  4575. * @param result defines the target matrix
  4576. */
  4577. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4578. /**
  4579. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4580. * @param quat defines the quaternion to use
  4581. * @param result defines the target matrix
  4582. */
  4583. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4584. }
  4585. /**
  4586. * @hidden
  4587. */
  4588. export class TmpVectors {
  4589. static Vector2: Vector2[];
  4590. static Vector3: Vector3[];
  4591. static Vector4: Vector4[];
  4592. static Quaternion: Quaternion[];
  4593. static Matrix: Matrix[];
  4594. }
  4595. }
  4596. declare module "babylonjs/Maths/math.path" {
  4597. import { DeepImmutable, Nullable } from "babylonjs/types";
  4598. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4599. /**
  4600. * Defines potential orientation for back face culling
  4601. */
  4602. export enum Orientation {
  4603. /**
  4604. * Clockwise
  4605. */
  4606. CW = 0,
  4607. /** Counter clockwise */
  4608. CCW = 1
  4609. }
  4610. /** Class used to represent a Bezier curve */
  4611. export class BezierCurve {
  4612. /**
  4613. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4614. * @param t defines the time
  4615. * @param x1 defines the left coordinate on X axis
  4616. * @param y1 defines the left coordinate on Y axis
  4617. * @param x2 defines the right coordinate on X axis
  4618. * @param y2 defines the right coordinate on Y axis
  4619. * @returns the interpolated value
  4620. */
  4621. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4622. }
  4623. /**
  4624. * Defines angle representation
  4625. */
  4626. export class Angle {
  4627. private _radians;
  4628. /**
  4629. * Creates an Angle object of "radians" radians (float).
  4630. * @param radians the angle in radians
  4631. */
  4632. constructor(radians: number);
  4633. /**
  4634. * Get value in degrees
  4635. * @returns the Angle value in degrees (float)
  4636. */
  4637. degrees(): number;
  4638. /**
  4639. * Get value in radians
  4640. * @returns the Angle value in radians (float)
  4641. */
  4642. radians(): number;
  4643. /**
  4644. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  4645. * @param a defines first vector
  4646. * @param b defines second vector
  4647. * @returns a new Angle
  4648. */
  4649. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4650. /**
  4651. * Gets a new Angle object from the given float in radians
  4652. * @param radians defines the angle value in radians
  4653. * @returns a new Angle
  4654. */
  4655. static FromRadians(radians: number): Angle;
  4656. /**
  4657. * Gets a new Angle object from the given float in degrees
  4658. * @param degrees defines the angle value in degrees
  4659. * @returns a new Angle
  4660. */
  4661. static FromDegrees(degrees: number): Angle;
  4662. }
  4663. /**
  4664. * This represents an arc in a 2d space.
  4665. */
  4666. export class Arc2 {
  4667. /** Defines the start point of the arc */
  4668. startPoint: Vector2;
  4669. /** Defines the mid point of the arc */
  4670. midPoint: Vector2;
  4671. /** Defines the end point of the arc */
  4672. endPoint: Vector2;
  4673. /**
  4674. * Defines the center point of the arc.
  4675. */
  4676. centerPoint: Vector2;
  4677. /**
  4678. * Defines the radius of the arc.
  4679. */
  4680. radius: number;
  4681. /**
  4682. * Defines the angle of the arc (from mid point to end point).
  4683. */
  4684. angle: Angle;
  4685. /**
  4686. * Defines the start angle of the arc (from start point to middle point).
  4687. */
  4688. startAngle: Angle;
  4689. /**
  4690. * Defines the orientation of the arc (clock wise/counter clock wise).
  4691. */
  4692. orientation: Orientation;
  4693. /**
  4694. * Creates an Arc object from the three given points : start, middle and end.
  4695. * @param startPoint Defines the start point of the arc
  4696. * @param midPoint Defines the midlle point of the arc
  4697. * @param endPoint Defines the end point of the arc
  4698. */
  4699. constructor(
  4700. /** Defines the start point of the arc */
  4701. startPoint: Vector2,
  4702. /** Defines the mid point of the arc */
  4703. midPoint: Vector2,
  4704. /** Defines the end point of the arc */
  4705. endPoint: Vector2);
  4706. }
  4707. /**
  4708. * Represents a 2D path made up of multiple 2D points
  4709. */
  4710. export class Path2 {
  4711. private _points;
  4712. private _length;
  4713. /**
  4714. * If the path start and end point are the same
  4715. */
  4716. closed: boolean;
  4717. /**
  4718. * Creates a Path2 object from the starting 2D coordinates x and y.
  4719. * @param x the starting points x value
  4720. * @param y the starting points y value
  4721. */
  4722. constructor(x: number, y: number);
  4723. /**
  4724. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4725. * @param x the added points x value
  4726. * @param y the added points y value
  4727. * @returns the updated Path2.
  4728. */
  4729. addLineTo(x: number, y: number): Path2;
  4730. /**
  4731. * 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.
  4732. * @param midX middle point x value
  4733. * @param midY middle point y value
  4734. * @param endX end point x value
  4735. * @param endY end point y value
  4736. * @param numberOfSegments (default: 36)
  4737. * @returns the updated Path2.
  4738. */
  4739. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  4740. /**
  4741. * Closes the Path2.
  4742. * @returns the Path2.
  4743. */
  4744. close(): Path2;
  4745. /**
  4746. * Gets the sum of the distance between each sequential point in the path
  4747. * @returns the Path2 total length (float).
  4748. */
  4749. length(): number;
  4750. /**
  4751. * Gets the points which construct the path
  4752. * @returns the Path2 internal array of points.
  4753. */
  4754. getPoints(): Vector2[];
  4755. /**
  4756. * Retreives the point at the distance aways from the starting point
  4757. * @param normalizedLengthPosition the length along the path to retreive the point from
  4758. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  4759. */
  4760. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  4761. /**
  4762. * Creates a new path starting from an x and y position
  4763. * @param x starting x value
  4764. * @param y starting y value
  4765. * @returns a new Path2 starting at the coordinates (x, y).
  4766. */
  4767. static StartingAt(x: number, y: number): Path2;
  4768. }
  4769. /**
  4770. * Represents a 3D path made up of multiple 3D points
  4771. */
  4772. export class Path3D {
  4773. /**
  4774. * an array of Vector3, the curve axis of the Path3D
  4775. */
  4776. path: Vector3[];
  4777. private _curve;
  4778. private _distances;
  4779. private _tangents;
  4780. private _normals;
  4781. private _binormals;
  4782. private _raw;
  4783. /**
  4784. * new Path3D(path, normal, raw)
  4785. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  4786. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  4787. * @param path an array of Vector3, the curve axis of the Path3D
  4788. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  4789. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  4790. */
  4791. constructor(
  4792. /**
  4793. * an array of Vector3, the curve axis of the Path3D
  4794. */
  4795. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean);
  4796. /**
  4797. * Returns the Path3D array of successive Vector3 designing its curve.
  4798. * @returns the Path3D array of successive Vector3 designing its curve.
  4799. */
  4800. getCurve(): Vector3[];
  4801. /**
  4802. * Returns an array populated with tangent vectors on each Path3D curve point.
  4803. * @returns an array populated with tangent vectors on each Path3D curve point.
  4804. */
  4805. getTangents(): Vector3[];
  4806. /**
  4807. * Returns an array populated with normal vectors on each Path3D curve point.
  4808. * @returns an array populated with normal vectors on each Path3D curve point.
  4809. */
  4810. getNormals(): Vector3[];
  4811. /**
  4812. * Returns an array populated with binormal vectors on each Path3D curve point.
  4813. * @returns an array populated with binormal vectors on each Path3D curve point.
  4814. */
  4815. getBinormals(): Vector3[];
  4816. /**
  4817. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  4818. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  4819. */
  4820. getDistances(): number[];
  4821. /**
  4822. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  4823. * @param path path which all values are copied into the curves points
  4824. * @param firstNormal which should be projected onto the curve
  4825. * @returns the same object updated.
  4826. */
  4827. update(path: Vector3[], firstNormal?: Nullable<Vector3>): Path3D;
  4828. private _compute;
  4829. private _getFirstNonNullVector;
  4830. private _getLastNonNullVector;
  4831. private _normalVector;
  4832. }
  4833. /**
  4834. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  4835. * A Curve3 is designed from a series of successive Vector3.
  4836. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  4837. */
  4838. export class Curve3 {
  4839. private _points;
  4840. private _length;
  4841. /**
  4842. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  4843. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  4844. * @param v1 (Vector3) the control point
  4845. * @param v2 (Vector3) the end point of the Quadratic Bezier
  4846. * @param nbPoints (integer) the wanted number of points in the curve
  4847. * @returns the created Curve3
  4848. */
  4849. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4850. /**
  4851. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  4852. * @param v0 (Vector3) the origin point of the Cubic Bezier
  4853. * @param v1 (Vector3) the first control point
  4854. * @param v2 (Vector3) the second control point
  4855. * @param v3 (Vector3) the end point of the Cubic Bezier
  4856. * @param nbPoints (integer) the wanted number of points in the curve
  4857. * @returns the created Curve3
  4858. */
  4859. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4860. /**
  4861. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  4862. * @param p1 (Vector3) the origin point of the Hermite Spline
  4863. * @param t1 (Vector3) the tangent vector at the origin point
  4864. * @param p2 (Vector3) the end point of the Hermite Spline
  4865. * @param t2 (Vector3) the tangent vector at the end point
  4866. * @param nbPoints (integer) the wanted number of points in the curve
  4867. * @returns the created Curve3
  4868. */
  4869. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4870. /**
  4871. * Returns a Curve3 object along a CatmullRom Spline curve :
  4872. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  4873. * @param nbPoints (integer) the wanted number of points between each curve control points
  4874. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  4875. * @returns the created Curve3
  4876. */
  4877. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  4878. /**
  4879. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  4880. * A Curve3 is designed from a series of successive Vector3.
  4881. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  4882. * @param points points which make up the curve
  4883. */
  4884. constructor(points: Vector3[]);
  4885. /**
  4886. * @returns the Curve3 stored array of successive Vector3
  4887. */
  4888. getPoints(): Vector3[];
  4889. /**
  4890. * @returns the computed length (float) of the curve.
  4891. */
  4892. length(): number;
  4893. /**
  4894. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  4895. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  4896. * curveA and curveB keep unchanged.
  4897. * @param curve the curve to continue from this curve
  4898. * @returns the newly constructed curve
  4899. */
  4900. continue(curve: DeepImmutable<Curve3>): Curve3;
  4901. private _computeLength;
  4902. }
  4903. }
  4904. declare module "babylonjs/Animations/easing" {
  4905. /**
  4906. * This represents the main contract an easing function should follow.
  4907. * Easing functions are used throughout the animation system.
  4908. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4909. */
  4910. export interface IEasingFunction {
  4911. /**
  4912. * Given an input gradient between 0 and 1, this returns the corrseponding value
  4913. * of the easing function.
  4914. * The link below provides some of the most common examples of easing functions.
  4915. * @see https://easings.net/
  4916. * @param gradient Defines the value between 0 and 1 we want the easing value for
  4917. * @returns the corresponding value on the curve defined by the easing function
  4918. */
  4919. ease(gradient: number): number;
  4920. }
  4921. /**
  4922. * Base class used for every default easing function.
  4923. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4924. */
  4925. export class EasingFunction implements IEasingFunction {
  4926. /**
  4927. * Interpolation follows the mathematical formula associated with the easing function.
  4928. */
  4929. static readonly EASINGMODE_EASEIN: number;
  4930. /**
  4931. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  4932. */
  4933. static readonly EASINGMODE_EASEOUT: number;
  4934. /**
  4935. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  4936. */
  4937. static readonly EASINGMODE_EASEINOUT: number;
  4938. private _easingMode;
  4939. /**
  4940. * Sets the easing mode of the current function.
  4941. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  4942. */
  4943. setEasingMode(easingMode: number): void;
  4944. /**
  4945. * Gets the current easing mode.
  4946. * @returns the easing mode
  4947. */
  4948. getEasingMode(): number;
  4949. /**
  4950. * @hidden
  4951. */
  4952. easeInCore(gradient: number): number;
  4953. /**
  4954. * Given an input gradient between 0 and 1, this returns the corresponding value
  4955. * of the easing function.
  4956. * @param gradient Defines the value between 0 and 1 we want the easing value for
  4957. * @returns the corresponding value on the curve defined by the easing function
  4958. */
  4959. ease(gradient: number): number;
  4960. }
  4961. /**
  4962. * Easing function with a circle shape (see link below).
  4963. * @see https://easings.net/#easeInCirc
  4964. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4965. */
  4966. export class CircleEase extends EasingFunction implements IEasingFunction {
  4967. /** @hidden */
  4968. easeInCore(gradient: number): number;
  4969. }
  4970. /**
  4971. * Easing function with a ease back shape (see link below).
  4972. * @see https://easings.net/#easeInBack
  4973. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4974. */
  4975. export class BackEase extends EasingFunction implements IEasingFunction {
  4976. /** Defines the amplitude of the function */
  4977. amplitude: number;
  4978. /**
  4979. * Instantiates a back ease easing
  4980. * @see https://easings.net/#easeInBack
  4981. * @param amplitude Defines the amplitude of the function
  4982. */
  4983. constructor(
  4984. /** Defines the amplitude of the function */
  4985. amplitude?: number);
  4986. /** @hidden */
  4987. easeInCore(gradient: number): number;
  4988. }
  4989. /**
  4990. * Easing function with a bouncing shape (see link below).
  4991. * @see https://easings.net/#easeInBounce
  4992. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4993. */
  4994. export class BounceEase extends EasingFunction implements IEasingFunction {
  4995. /** Defines the number of bounces */
  4996. bounces: number;
  4997. /** Defines the amplitude of the bounce */
  4998. bounciness: number;
  4999. /**
  5000. * Instantiates a bounce easing
  5001. * @see https://easings.net/#easeInBounce
  5002. * @param bounces Defines the number of bounces
  5003. * @param bounciness Defines the amplitude of the bounce
  5004. */
  5005. constructor(
  5006. /** Defines the number of bounces */
  5007. bounces?: number,
  5008. /** Defines the amplitude of the bounce */
  5009. bounciness?: number);
  5010. /** @hidden */
  5011. easeInCore(gradient: number): number;
  5012. }
  5013. /**
  5014. * Easing function with a power of 3 shape (see link below).
  5015. * @see https://easings.net/#easeInCubic
  5016. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5017. */
  5018. export class CubicEase extends EasingFunction implements IEasingFunction {
  5019. /** @hidden */
  5020. easeInCore(gradient: number): number;
  5021. }
  5022. /**
  5023. * Easing function with an elastic shape (see link below).
  5024. * @see https://easings.net/#easeInElastic
  5025. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5026. */
  5027. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5028. /** Defines the number of oscillations*/
  5029. oscillations: number;
  5030. /** Defines the amplitude of the oscillations*/
  5031. springiness: number;
  5032. /**
  5033. * Instantiates an elastic easing function
  5034. * @see https://easings.net/#easeInElastic
  5035. * @param oscillations Defines the number of oscillations
  5036. * @param springiness Defines the amplitude of the oscillations
  5037. */
  5038. constructor(
  5039. /** Defines the number of oscillations*/
  5040. oscillations?: number,
  5041. /** Defines the amplitude of the oscillations*/
  5042. springiness?: number);
  5043. /** @hidden */
  5044. easeInCore(gradient: number): number;
  5045. }
  5046. /**
  5047. * Easing function with an exponential shape (see link below).
  5048. * @see https://easings.net/#easeInExpo
  5049. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5050. */
  5051. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5052. /** Defines the exponent of the function */
  5053. exponent: number;
  5054. /**
  5055. * Instantiates an exponential easing function
  5056. * @see https://easings.net/#easeInExpo
  5057. * @param exponent Defines the exponent of the function
  5058. */
  5059. constructor(
  5060. /** Defines the exponent of the function */
  5061. exponent?: number);
  5062. /** @hidden */
  5063. easeInCore(gradient: number): number;
  5064. }
  5065. /**
  5066. * Easing function with a power shape (see link below).
  5067. * @see https://easings.net/#easeInQuad
  5068. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5069. */
  5070. export class PowerEase extends EasingFunction implements IEasingFunction {
  5071. /** Defines the power of the function */
  5072. power: number;
  5073. /**
  5074. * Instantiates an power base easing function
  5075. * @see https://easings.net/#easeInQuad
  5076. * @param power Defines the power of the function
  5077. */
  5078. constructor(
  5079. /** Defines the power of the function */
  5080. power?: number);
  5081. /** @hidden */
  5082. easeInCore(gradient: number): number;
  5083. }
  5084. /**
  5085. * Easing function with a power of 2 shape (see link below).
  5086. * @see https://easings.net/#easeInQuad
  5087. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5088. */
  5089. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5090. /** @hidden */
  5091. easeInCore(gradient: number): number;
  5092. }
  5093. /**
  5094. * Easing function with a power of 4 shape (see link below).
  5095. * @see https://easings.net/#easeInQuart
  5096. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5097. */
  5098. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5099. /** @hidden */
  5100. easeInCore(gradient: number): number;
  5101. }
  5102. /**
  5103. * Easing function with a power of 5 shape (see link below).
  5104. * @see https://easings.net/#easeInQuint
  5105. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5106. */
  5107. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5108. /** @hidden */
  5109. easeInCore(gradient: number): number;
  5110. }
  5111. /**
  5112. * Easing function with a sin shape (see link below).
  5113. * @see https://easings.net/#easeInSine
  5114. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5115. */
  5116. export class SineEase extends EasingFunction implements IEasingFunction {
  5117. /** @hidden */
  5118. easeInCore(gradient: number): number;
  5119. }
  5120. /**
  5121. * Easing function with a bezier shape (see link below).
  5122. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5123. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5124. */
  5125. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5126. /** Defines the x component of the start tangent in the bezier curve */
  5127. x1: number;
  5128. /** Defines the y component of the start tangent in the bezier curve */
  5129. y1: number;
  5130. /** Defines the x component of the end tangent in the bezier curve */
  5131. x2: number;
  5132. /** Defines the y component of the end tangent in the bezier curve */
  5133. y2: number;
  5134. /**
  5135. * Instantiates a bezier function
  5136. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5137. * @param x1 Defines the x component of the start tangent in the bezier curve
  5138. * @param y1 Defines the y component of the start tangent in the bezier curve
  5139. * @param x2 Defines the x component of the end tangent in the bezier curve
  5140. * @param y2 Defines the y component of the end tangent in the bezier curve
  5141. */
  5142. constructor(
  5143. /** Defines the x component of the start tangent in the bezier curve */
  5144. x1?: number,
  5145. /** Defines the y component of the start tangent in the bezier curve */
  5146. y1?: number,
  5147. /** Defines the x component of the end tangent in the bezier curve */
  5148. x2?: number,
  5149. /** Defines the y component of the end tangent in the bezier curve */
  5150. y2?: number);
  5151. /** @hidden */
  5152. easeInCore(gradient: number): number;
  5153. }
  5154. }
  5155. declare module "babylonjs/Maths/math.color" {
  5156. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5157. /**
  5158. * Class used to hold a RBG color
  5159. */
  5160. export class Color3 {
  5161. /**
  5162. * Defines the red component (between 0 and 1, default is 0)
  5163. */
  5164. r: number;
  5165. /**
  5166. * Defines the green component (between 0 and 1, default is 0)
  5167. */
  5168. g: number;
  5169. /**
  5170. * Defines the blue component (between 0 and 1, default is 0)
  5171. */
  5172. b: number;
  5173. /**
  5174. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5175. * @param r defines the red component (between 0 and 1, default is 0)
  5176. * @param g defines the green component (between 0 and 1, default is 0)
  5177. * @param b defines the blue component (between 0 and 1, default is 0)
  5178. */
  5179. constructor(
  5180. /**
  5181. * Defines the red component (between 0 and 1, default is 0)
  5182. */
  5183. r?: number,
  5184. /**
  5185. * Defines the green component (between 0 and 1, default is 0)
  5186. */
  5187. g?: number,
  5188. /**
  5189. * Defines the blue component (between 0 and 1, default is 0)
  5190. */
  5191. b?: number);
  5192. /**
  5193. * Creates a string with the Color3 current values
  5194. * @returns the string representation of the Color3 object
  5195. */
  5196. toString(): string;
  5197. /**
  5198. * Returns the string "Color3"
  5199. * @returns "Color3"
  5200. */
  5201. getClassName(): string;
  5202. /**
  5203. * Compute the Color3 hash code
  5204. * @returns an unique number that can be used to hash Color3 objects
  5205. */
  5206. getHashCode(): number;
  5207. /**
  5208. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5209. * @param array defines the array where to store the r,g,b components
  5210. * @param index defines an optional index in the target array to define where to start storing values
  5211. * @returns the current Color3 object
  5212. */
  5213. toArray(array: FloatArray, index?: number): Color3;
  5214. /**
  5215. * Returns a new Color4 object from the current Color3 and the given alpha
  5216. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5217. * @returns a new Color4 object
  5218. */
  5219. toColor4(alpha?: number): Color4;
  5220. /**
  5221. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5222. * @returns the new array
  5223. */
  5224. asArray(): number[];
  5225. /**
  5226. * Returns the luminance value
  5227. * @returns a float value
  5228. */
  5229. toLuminance(): number;
  5230. /**
  5231. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5232. * @param otherColor defines the second operand
  5233. * @returns the new Color3 object
  5234. */
  5235. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5236. /**
  5237. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5238. * @param otherColor defines the second operand
  5239. * @param result defines the Color3 object where to store the result
  5240. * @returns the current Color3
  5241. */
  5242. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5243. /**
  5244. * Determines equality between Color3 objects
  5245. * @param otherColor defines the second operand
  5246. * @returns true if the rgb values are equal to the given ones
  5247. */
  5248. equals(otherColor: DeepImmutable<Color3>): boolean;
  5249. /**
  5250. * Determines equality between the current Color3 object and a set of r,b,g values
  5251. * @param r defines the red component to check
  5252. * @param g defines the green component to check
  5253. * @param b defines the blue component to check
  5254. * @returns true if the rgb values are equal to the given ones
  5255. */
  5256. equalsFloats(r: number, g: number, b: number): boolean;
  5257. /**
  5258. * Multiplies in place each rgb value by scale
  5259. * @param scale defines the scaling factor
  5260. * @returns the updated Color3
  5261. */
  5262. scale(scale: number): Color3;
  5263. /**
  5264. * Multiplies the rgb values by scale and stores the result into "result"
  5265. * @param scale defines the scaling factor
  5266. * @param result defines the Color3 object where to store the result
  5267. * @returns the unmodified current Color3
  5268. */
  5269. scaleToRef(scale: number, result: Color3): Color3;
  5270. /**
  5271. * Scale the current Color3 values by a factor and add the result to a given Color3
  5272. * @param scale defines the scale factor
  5273. * @param result defines color to store the result into
  5274. * @returns the unmodified current Color3
  5275. */
  5276. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5277. /**
  5278. * Clamps the rgb values by the min and max values and stores the result into "result"
  5279. * @param min defines minimum clamping value (default is 0)
  5280. * @param max defines maximum clamping value (default is 1)
  5281. * @param result defines color to store the result into
  5282. * @returns the original Color3
  5283. */
  5284. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5285. /**
  5286. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5287. * @param otherColor defines the second operand
  5288. * @returns the new Color3
  5289. */
  5290. add(otherColor: DeepImmutable<Color3>): Color3;
  5291. /**
  5292. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5293. * @param otherColor defines the second operand
  5294. * @param result defines Color3 object to store the result into
  5295. * @returns the unmodified current Color3
  5296. */
  5297. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5298. /**
  5299. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5300. * @param otherColor defines the second operand
  5301. * @returns the new Color3
  5302. */
  5303. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5304. /**
  5305. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5306. * @param otherColor defines the second operand
  5307. * @param result defines Color3 object to store the result into
  5308. * @returns the unmodified current Color3
  5309. */
  5310. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5311. /**
  5312. * Copy the current object
  5313. * @returns a new Color3 copied the current one
  5314. */
  5315. clone(): Color3;
  5316. /**
  5317. * Copies the rgb values from the source in the current Color3
  5318. * @param source defines the source Color3 object
  5319. * @returns the updated Color3 object
  5320. */
  5321. copyFrom(source: DeepImmutable<Color3>): Color3;
  5322. /**
  5323. * Updates the Color3 rgb values from the given floats
  5324. * @param r defines the red component to read from
  5325. * @param g defines the green component to read from
  5326. * @param b defines the blue component to read from
  5327. * @returns the current Color3 object
  5328. */
  5329. copyFromFloats(r: number, g: number, b: number): Color3;
  5330. /**
  5331. * Updates the Color3 rgb values from the given floats
  5332. * @param r defines the red component to read from
  5333. * @param g defines the green component to read from
  5334. * @param b defines the blue component to read from
  5335. * @returns the current Color3 object
  5336. */
  5337. set(r: number, g: number, b: number): Color3;
  5338. /**
  5339. * Compute the Color3 hexadecimal code as a string
  5340. * @returns a string containing the hexadecimal representation of the Color3 object
  5341. */
  5342. toHexString(): string;
  5343. /**
  5344. * Computes a new Color3 converted from the current one to linear space
  5345. * @returns a new Color3 object
  5346. */
  5347. toLinearSpace(): Color3;
  5348. /**
  5349. * Converts current color in rgb space to HSV values
  5350. * @returns a new color3 representing the HSV values
  5351. */
  5352. toHSV(): Color3;
  5353. /**
  5354. * Converts current color in rgb space to HSV values
  5355. * @param result defines the Color3 where to store the HSV values
  5356. */
  5357. toHSVToRef(result: Color3): void;
  5358. /**
  5359. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5360. * @param convertedColor defines the Color3 object where to store the linear space version
  5361. * @returns the unmodified Color3
  5362. */
  5363. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5364. /**
  5365. * Computes a new Color3 converted from the current one to gamma space
  5366. * @returns a new Color3 object
  5367. */
  5368. toGammaSpace(): Color3;
  5369. /**
  5370. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5371. * @param convertedColor defines the Color3 object where to store the gamma space version
  5372. * @returns the unmodified Color3
  5373. */
  5374. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5375. private static _BlackReadOnly;
  5376. /**
  5377. * Convert Hue, saturation and value to a Color3 (RGB)
  5378. * @param hue defines the hue
  5379. * @param saturation defines the saturation
  5380. * @param value defines the value
  5381. * @param result defines the Color3 where to store the RGB values
  5382. */
  5383. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5384. /**
  5385. * Creates a new Color3 from the string containing valid hexadecimal values
  5386. * @param hex defines a string containing valid hexadecimal values
  5387. * @returns a new Color3 object
  5388. */
  5389. static FromHexString(hex: string): Color3;
  5390. /**
  5391. * Creates a new Color3 from the starting index of the given array
  5392. * @param array defines the source array
  5393. * @param offset defines an offset in the source array
  5394. * @returns a new Color3 object
  5395. */
  5396. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5397. /**
  5398. * Creates a new Color3 from integer values (< 256)
  5399. * @param r defines the red component to read from (value between 0 and 255)
  5400. * @param g defines the green component to read from (value between 0 and 255)
  5401. * @param b defines the blue component to read from (value between 0 and 255)
  5402. * @returns a new Color3 object
  5403. */
  5404. static FromInts(r: number, g: number, b: number): Color3;
  5405. /**
  5406. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5407. * @param start defines the start Color3 value
  5408. * @param end defines the end Color3 value
  5409. * @param amount defines the gradient value between start and end
  5410. * @returns a new Color3 object
  5411. */
  5412. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5413. /**
  5414. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5415. * @param left defines the start value
  5416. * @param right defines the end value
  5417. * @param amount defines the gradient factor
  5418. * @param result defines the Color3 object where to store the result
  5419. */
  5420. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5421. /**
  5422. * Returns a Color3 value containing a red color
  5423. * @returns a new Color3 object
  5424. */
  5425. static Red(): Color3;
  5426. /**
  5427. * Returns a Color3 value containing a green color
  5428. * @returns a new Color3 object
  5429. */
  5430. static Green(): Color3;
  5431. /**
  5432. * Returns a Color3 value containing a blue color
  5433. * @returns a new Color3 object
  5434. */
  5435. static Blue(): Color3;
  5436. /**
  5437. * Returns a Color3 value containing a black color
  5438. * @returns a new Color3 object
  5439. */
  5440. static Black(): Color3;
  5441. /**
  5442. * Gets a Color3 value containing a black color that must not be updated
  5443. */
  5444. static readonly BlackReadOnly: DeepImmutable<Color3>;
  5445. /**
  5446. * Returns a Color3 value containing a white color
  5447. * @returns a new Color3 object
  5448. */
  5449. static White(): Color3;
  5450. /**
  5451. * Returns a Color3 value containing a purple color
  5452. * @returns a new Color3 object
  5453. */
  5454. static Purple(): Color3;
  5455. /**
  5456. * Returns a Color3 value containing a magenta color
  5457. * @returns a new Color3 object
  5458. */
  5459. static Magenta(): Color3;
  5460. /**
  5461. * Returns a Color3 value containing a yellow color
  5462. * @returns a new Color3 object
  5463. */
  5464. static Yellow(): Color3;
  5465. /**
  5466. * Returns a Color3 value containing a gray color
  5467. * @returns a new Color3 object
  5468. */
  5469. static Gray(): Color3;
  5470. /**
  5471. * Returns a Color3 value containing a teal color
  5472. * @returns a new Color3 object
  5473. */
  5474. static Teal(): Color3;
  5475. /**
  5476. * Returns a Color3 value containing a random color
  5477. * @returns a new Color3 object
  5478. */
  5479. static Random(): Color3;
  5480. }
  5481. /**
  5482. * Class used to hold a RBGA color
  5483. */
  5484. export class Color4 {
  5485. /**
  5486. * Defines the red component (between 0 and 1, default is 0)
  5487. */
  5488. r: number;
  5489. /**
  5490. * Defines the green component (between 0 and 1, default is 0)
  5491. */
  5492. g: number;
  5493. /**
  5494. * Defines the blue component (between 0 and 1, default is 0)
  5495. */
  5496. b: number;
  5497. /**
  5498. * Defines the alpha component (between 0 and 1, default is 1)
  5499. */
  5500. a: number;
  5501. /**
  5502. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5503. * @param r defines the red component (between 0 and 1, default is 0)
  5504. * @param g defines the green component (between 0 and 1, default is 0)
  5505. * @param b defines the blue component (between 0 and 1, default is 0)
  5506. * @param a defines the alpha component (between 0 and 1, default is 1)
  5507. */
  5508. constructor(
  5509. /**
  5510. * Defines the red component (between 0 and 1, default is 0)
  5511. */
  5512. r?: number,
  5513. /**
  5514. * Defines the green component (between 0 and 1, default is 0)
  5515. */
  5516. g?: number,
  5517. /**
  5518. * Defines the blue component (between 0 and 1, default is 0)
  5519. */
  5520. b?: number,
  5521. /**
  5522. * Defines the alpha component (between 0 and 1, default is 1)
  5523. */
  5524. a?: number);
  5525. /**
  5526. * Adds in place the given Color4 values to the current Color4 object
  5527. * @param right defines the second operand
  5528. * @returns the current updated Color4 object
  5529. */
  5530. addInPlace(right: DeepImmutable<Color4>): Color4;
  5531. /**
  5532. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5533. * @returns the new array
  5534. */
  5535. asArray(): number[];
  5536. /**
  5537. * Stores from the starting index in the given array the Color4 successive values
  5538. * @param array defines the array where to store the r,g,b components
  5539. * @param index defines an optional index in the target array to define where to start storing values
  5540. * @returns the current Color4 object
  5541. */
  5542. toArray(array: number[], index?: number): Color4;
  5543. /**
  5544. * Determines equality between Color4 objects
  5545. * @param otherColor defines the second operand
  5546. * @returns true if the rgba values are equal to the given ones
  5547. */
  5548. equals(otherColor: DeepImmutable<Color4>): boolean;
  5549. /**
  5550. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5551. * @param right defines the second operand
  5552. * @returns a new Color4 object
  5553. */
  5554. add(right: DeepImmutable<Color4>): Color4;
  5555. /**
  5556. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5557. * @param right defines the second operand
  5558. * @returns a new Color4 object
  5559. */
  5560. subtract(right: DeepImmutable<Color4>): Color4;
  5561. /**
  5562. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5563. * @param right defines the second operand
  5564. * @param result defines the Color4 object where to store the result
  5565. * @returns the current Color4 object
  5566. */
  5567. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5568. /**
  5569. * Creates a new Color4 with the current Color4 values multiplied by scale
  5570. * @param scale defines the scaling factor to apply
  5571. * @returns a new Color4 object
  5572. */
  5573. scale(scale: number): Color4;
  5574. /**
  5575. * Multiplies the current Color4 values by scale and stores the result in "result"
  5576. * @param scale defines the scaling factor to apply
  5577. * @param result defines the Color4 object where to store the result
  5578. * @returns the current unmodified Color4
  5579. */
  5580. scaleToRef(scale: number, result: Color4): Color4;
  5581. /**
  5582. * Scale the current Color4 values by a factor and add the result to a given Color4
  5583. * @param scale defines the scale factor
  5584. * @param result defines the Color4 object where to store the result
  5585. * @returns the unmodified current Color4
  5586. */
  5587. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5588. /**
  5589. * Clamps the rgb values by the min and max values and stores the result into "result"
  5590. * @param min defines minimum clamping value (default is 0)
  5591. * @param max defines maximum clamping value (default is 1)
  5592. * @param result defines color to store the result into.
  5593. * @returns the cuurent Color4
  5594. */
  5595. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5596. /**
  5597. * Multipy an Color4 value by another and return a new Color4 object
  5598. * @param color defines the Color4 value to multiply by
  5599. * @returns a new Color4 object
  5600. */
  5601. multiply(color: Color4): Color4;
  5602. /**
  5603. * Multipy a Color4 value by another and push the result in a reference value
  5604. * @param color defines the Color4 value to multiply by
  5605. * @param result defines the Color4 to fill the result in
  5606. * @returns the result Color4
  5607. */
  5608. multiplyToRef(color: Color4, result: Color4): Color4;
  5609. /**
  5610. * Creates a string with the Color4 current values
  5611. * @returns the string representation of the Color4 object
  5612. */
  5613. toString(): string;
  5614. /**
  5615. * Returns the string "Color4"
  5616. * @returns "Color4"
  5617. */
  5618. getClassName(): string;
  5619. /**
  5620. * Compute the Color4 hash code
  5621. * @returns an unique number that can be used to hash Color4 objects
  5622. */
  5623. getHashCode(): number;
  5624. /**
  5625. * Creates a new Color4 copied from the current one
  5626. * @returns a new Color4 object
  5627. */
  5628. clone(): Color4;
  5629. /**
  5630. * Copies the given Color4 values into the current one
  5631. * @param source defines the source Color4 object
  5632. * @returns the current updated Color4 object
  5633. */
  5634. copyFrom(source: Color4): Color4;
  5635. /**
  5636. * Copies the given float values into the current one
  5637. * @param r defines the red component to read from
  5638. * @param g defines the green component to read from
  5639. * @param b defines the blue component to read from
  5640. * @param a defines the alpha component to read from
  5641. * @returns the current updated Color4 object
  5642. */
  5643. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  5644. /**
  5645. * Copies the given float values into the current one
  5646. * @param r defines the red component to read from
  5647. * @param g defines the green component to read from
  5648. * @param b defines the blue component to read from
  5649. * @param a defines the alpha component to read from
  5650. * @returns the current updated Color4 object
  5651. */
  5652. set(r: number, g: number, b: number, a: number): Color4;
  5653. /**
  5654. * Compute the Color4 hexadecimal code as a string
  5655. * @returns a string containing the hexadecimal representation of the Color4 object
  5656. */
  5657. toHexString(): string;
  5658. /**
  5659. * Computes a new Color4 converted from the current one to linear space
  5660. * @returns a new Color4 object
  5661. */
  5662. toLinearSpace(): Color4;
  5663. /**
  5664. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  5665. * @param convertedColor defines the Color4 object where to store the linear space version
  5666. * @returns the unmodified Color4
  5667. */
  5668. toLinearSpaceToRef(convertedColor: Color4): Color4;
  5669. /**
  5670. * Computes a new Color4 converted from the current one to gamma space
  5671. * @returns a new Color4 object
  5672. */
  5673. toGammaSpace(): Color4;
  5674. /**
  5675. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  5676. * @param convertedColor defines the Color4 object where to store the gamma space version
  5677. * @returns the unmodified Color4
  5678. */
  5679. toGammaSpaceToRef(convertedColor: Color4): Color4;
  5680. /**
  5681. * Creates a new Color4 from the string containing valid hexadecimal values
  5682. * @param hex defines a string containing valid hexadecimal values
  5683. * @returns a new Color4 object
  5684. */
  5685. static FromHexString(hex: string): Color4;
  5686. /**
  5687. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5688. * @param left defines the start value
  5689. * @param right defines the end value
  5690. * @param amount defines the gradient factor
  5691. * @returns a new Color4 object
  5692. */
  5693. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  5694. /**
  5695. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5696. * @param left defines the start value
  5697. * @param right defines the end value
  5698. * @param amount defines the gradient factor
  5699. * @param result defines the Color4 object where to store data
  5700. */
  5701. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  5702. /**
  5703. * Creates a new Color4 from a Color3 and an alpha value
  5704. * @param color3 defines the source Color3 to read from
  5705. * @param alpha defines the alpha component (1.0 by default)
  5706. * @returns a new Color4 object
  5707. */
  5708. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  5709. /**
  5710. * Creates a new Color4 from the starting index element of the given array
  5711. * @param array defines the source array to read from
  5712. * @param offset defines the offset in the source array
  5713. * @returns a new Color4 object
  5714. */
  5715. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5716. /**
  5717. * Creates a new Color3 from integer values (< 256)
  5718. * @param r defines the red component to read from (value between 0 and 255)
  5719. * @param g defines the green component to read from (value between 0 and 255)
  5720. * @param b defines the blue component to read from (value between 0 and 255)
  5721. * @param a defines the alpha component to read from (value between 0 and 255)
  5722. * @returns a new Color3 object
  5723. */
  5724. static FromInts(r: number, g: number, b: number, a: number): Color4;
  5725. /**
  5726. * Check the content of a given array and convert it to an array containing RGBA data
  5727. * If the original array was already containing count * 4 values then it is returned directly
  5728. * @param colors defines the array to check
  5729. * @param count defines the number of RGBA data to expect
  5730. * @returns an array containing count * 4 values (RGBA)
  5731. */
  5732. static CheckColors4(colors: number[], count: number): number[];
  5733. }
  5734. /**
  5735. * @hidden
  5736. */
  5737. export class TmpColors {
  5738. static Color3: Color3[];
  5739. static Color4: Color4[];
  5740. }
  5741. }
  5742. declare module "babylonjs/Animations/animationKey" {
  5743. /**
  5744. * Defines an interface which represents an animation key frame
  5745. */
  5746. export interface IAnimationKey {
  5747. /**
  5748. * Frame of the key frame
  5749. */
  5750. frame: number;
  5751. /**
  5752. * Value at the specifies key frame
  5753. */
  5754. value: any;
  5755. /**
  5756. * The input tangent for the cubic hermite spline
  5757. */
  5758. inTangent?: any;
  5759. /**
  5760. * The output tangent for the cubic hermite spline
  5761. */
  5762. outTangent?: any;
  5763. /**
  5764. * The animation interpolation type
  5765. */
  5766. interpolation?: AnimationKeyInterpolation;
  5767. }
  5768. /**
  5769. * Enum for the animation key frame interpolation type
  5770. */
  5771. export enum AnimationKeyInterpolation {
  5772. /**
  5773. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  5774. */
  5775. STEP = 1
  5776. }
  5777. }
  5778. declare module "babylonjs/Animations/animationRange" {
  5779. /**
  5780. * Represents the range of an animation
  5781. */
  5782. export class AnimationRange {
  5783. /**The name of the animation range**/
  5784. name: string;
  5785. /**The starting frame of the animation */
  5786. from: number;
  5787. /**The ending frame of the animation*/
  5788. to: number;
  5789. /**
  5790. * Initializes the range of an animation
  5791. * @param name The name of the animation range
  5792. * @param from The starting frame of the animation
  5793. * @param to The ending frame of the animation
  5794. */
  5795. constructor(
  5796. /**The name of the animation range**/
  5797. name: string,
  5798. /**The starting frame of the animation */
  5799. from: number,
  5800. /**The ending frame of the animation*/
  5801. to: number);
  5802. /**
  5803. * Makes a copy of the animation range
  5804. * @returns A copy of the animation range
  5805. */
  5806. clone(): AnimationRange;
  5807. }
  5808. }
  5809. declare module "babylonjs/Animations/animationEvent" {
  5810. /**
  5811. * Composed of a frame, and an action function
  5812. */
  5813. export class AnimationEvent {
  5814. /** The frame for which the event is triggered **/
  5815. frame: number;
  5816. /** The event to perform when triggered **/
  5817. action: (currentFrame: number) => void;
  5818. /** Specifies if the event should be triggered only once**/
  5819. onlyOnce?: boolean | undefined;
  5820. /**
  5821. * Specifies if the animation event is done
  5822. */
  5823. isDone: boolean;
  5824. /**
  5825. * Initializes the animation event
  5826. * @param frame The frame for which the event is triggered
  5827. * @param action The event to perform when triggered
  5828. * @param onlyOnce Specifies if the event should be triggered only once
  5829. */
  5830. constructor(
  5831. /** The frame for which the event is triggered **/
  5832. frame: number,
  5833. /** The event to perform when triggered **/
  5834. action: (currentFrame: number) => void,
  5835. /** Specifies if the event should be triggered only once**/
  5836. onlyOnce?: boolean | undefined);
  5837. /** @hidden */
  5838. _clone(): AnimationEvent;
  5839. }
  5840. }
  5841. declare module "babylonjs/Behaviors/behavior" {
  5842. import { Nullable } from "babylonjs/types";
  5843. /**
  5844. * Interface used to define a behavior
  5845. */
  5846. export interface Behavior<T> {
  5847. /** gets or sets behavior's name */
  5848. name: string;
  5849. /**
  5850. * Function called when the behavior needs to be initialized (after attaching it to a target)
  5851. */
  5852. init(): void;
  5853. /**
  5854. * Called when the behavior is attached to a target
  5855. * @param target defines the target where the behavior is attached to
  5856. */
  5857. attach(target: T): void;
  5858. /**
  5859. * Called when the behavior is detached from its target
  5860. */
  5861. detach(): void;
  5862. }
  5863. /**
  5864. * Interface implemented by classes supporting behaviors
  5865. */
  5866. export interface IBehaviorAware<T> {
  5867. /**
  5868. * Attach a behavior
  5869. * @param behavior defines the behavior to attach
  5870. * @returns the current host
  5871. */
  5872. addBehavior(behavior: Behavior<T>): T;
  5873. /**
  5874. * Remove a behavior from the current object
  5875. * @param behavior defines the behavior to detach
  5876. * @returns the current host
  5877. */
  5878. removeBehavior(behavior: Behavior<T>): T;
  5879. /**
  5880. * Gets a behavior using its name to search
  5881. * @param name defines the name to search
  5882. * @returns the behavior or null if not found
  5883. */
  5884. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  5885. }
  5886. }
  5887. declare module "babylonjs/Misc/smartArray" {
  5888. /**
  5889. * Defines an array and its length.
  5890. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  5891. */
  5892. export interface ISmartArrayLike<T> {
  5893. /**
  5894. * The data of the array.
  5895. */
  5896. data: Array<T>;
  5897. /**
  5898. * The active length of the array.
  5899. */
  5900. length: number;
  5901. }
  5902. /**
  5903. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  5904. */
  5905. export class SmartArray<T> implements ISmartArrayLike<T> {
  5906. /**
  5907. * The full set of data from the array.
  5908. */
  5909. data: Array<T>;
  5910. /**
  5911. * The active length of the array.
  5912. */
  5913. length: number;
  5914. protected _id: number;
  5915. /**
  5916. * Instantiates a Smart Array.
  5917. * @param capacity defines the default capacity of the array.
  5918. */
  5919. constructor(capacity: number);
  5920. /**
  5921. * Pushes a value at the end of the active data.
  5922. * @param value defines the object to push in the array.
  5923. */
  5924. push(value: T): void;
  5925. /**
  5926. * Iterates over the active data and apply the lambda to them.
  5927. * @param func defines the action to apply on each value.
  5928. */
  5929. forEach(func: (content: T) => void): void;
  5930. /**
  5931. * Sorts the full sets of data.
  5932. * @param compareFn defines the comparison function to apply.
  5933. */
  5934. sort(compareFn: (a: T, b: T) => number): void;
  5935. /**
  5936. * Resets the active data to an empty array.
  5937. */
  5938. reset(): void;
  5939. /**
  5940. * Releases all the data from the array as well as the array.
  5941. */
  5942. dispose(): void;
  5943. /**
  5944. * Concats the active data with a given array.
  5945. * @param array defines the data to concatenate with.
  5946. */
  5947. concat(array: any): void;
  5948. /**
  5949. * Returns the position of a value in the active data.
  5950. * @param value defines the value to find the index for
  5951. * @returns the index if found in the active data otherwise -1
  5952. */
  5953. indexOf(value: T): number;
  5954. /**
  5955. * Returns whether an element is part of the active data.
  5956. * @param value defines the value to look for
  5957. * @returns true if found in the active data otherwise false
  5958. */
  5959. contains(value: T): boolean;
  5960. private static _GlobalId;
  5961. }
  5962. /**
  5963. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  5964. * The data in this array can only be present once
  5965. */
  5966. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  5967. private _duplicateId;
  5968. /**
  5969. * Pushes a value at the end of the active data.
  5970. * THIS DOES NOT PREVENT DUPPLICATE DATA
  5971. * @param value defines the object to push in the array.
  5972. */
  5973. push(value: T): void;
  5974. /**
  5975. * Pushes a value at the end of the active data.
  5976. * If the data is already present, it won t be added again
  5977. * @param value defines the object to push in the array.
  5978. * @returns true if added false if it was already present
  5979. */
  5980. pushNoDuplicate(value: T): boolean;
  5981. /**
  5982. * Resets the active data to an empty array.
  5983. */
  5984. reset(): void;
  5985. /**
  5986. * Concats the active data with a given array.
  5987. * This ensures no dupplicate will be present in the result.
  5988. * @param array defines the data to concatenate with.
  5989. */
  5990. concatWithNoDuplicate(array: any): void;
  5991. }
  5992. }
  5993. declare module "babylonjs/Cameras/cameraInputsManager" {
  5994. import { Nullable } from "babylonjs/types";
  5995. import { Camera } from "babylonjs/Cameras/camera";
  5996. /**
  5997. * @ignore
  5998. * This is a list of all the different input types that are available in the application.
  5999. * Fo instance: ArcRotateCameraGamepadInput...
  6000. */
  6001. export var CameraInputTypes: {};
  6002. /**
  6003. * This is the contract to implement in order to create a new input class.
  6004. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6005. */
  6006. export interface ICameraInput<TCamera extends Camera> {
  6007. /**
  6008. * Defines the camera the input is attached to.
  6009. */
  6010. camera: Nullable<TCamera>;
  6011. /**
  6012. * Gets the class name of the current intput.
  6013. * @returns the class name
  6014. */
  6015. getClassName(): string;
  6016. /**
  6017. * Get the friendly name associated with the input class.
  6018. * @returns the input friendly name
  6019. */
  6020. getSimpleName(): string;
  6021. /**
  6022. * Attach the input controls to a specific dom element to get the input from.
  6023. * @param element Defines the element the controls should be listened from
  6024. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6025. */
  6026. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6027. /**
  6028. * Detach the current controls from the specified dom element.
  6029. * @param element Defines the element to stop listening the inputs from
  6030. */
  6031. detachControl(element: Nullable<HTMLElement>): void;
  6032. /**
  6033. * Update the current camera state depending on the inputs that have been used this frame.
  6034. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6035. */
  6036. checkInputs?: () => void;
  6037. }
  6038. /**
  6039. * Represents a map of input types to input instance or input index to input instance.
  6040. */
  6041. export interface CameraInputsMap<TCamera extends Camera> {
  6042. /**
  6043. * Accessor to the input by input type.
  6044. */
  6045. [name: string]: ICameraInput<TCamera>;
  6046. /**
  6047. * Accessor to the input by input index.
  6048. */
  6049. [idx: number]: ICameraInput<TCamera>;
  6050. }
  6051. /**
  6052. * This represents the input manager used within a camera.
  6053. * It helps dealing with all the different kind of input attached to a camera.
  6054. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6055. */
  6056. export class CameraInputsManager<TCamera extends Camera> {
  6057. /**
  6058. * Defines the list of inputs attahed to the camera.
  6059. */
  6060. attached: CameraInputsMap<TCamera>;
  6061. /**
  6062. * Defines the dom element the camera is collecting inputs from.
  6063. * This is null if the controls have not been attached.
  6064. */
  6065. attachedElement: Nullable<HTMLElement>;
  6066. /**
  6067. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6068. */
  6069. noPreventDefault: boolean;
  6070. /**
  6071. * Defined the camera the input manager belongs to.
  6072. */
  6073. camera: TCamera;
  6074. /**
  6075. * Update the current camera state depending on the inputs that have been used this frame.
  6076. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6077. */
  6078. checkInputs: () => void;
  6079. /**
  6080. * Instantiate a new Camera Input Manager.
  6081. * @param camera Defines the camera the input manager blongs to
  6082. */
  6083. constructor(camera: TCamera);
  6084. /**
  6085. * Add an input method to a camera
  6086. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6087. * @param input camera input method
  6088. */
  6089. add(input: ICameraInput<TCamera>): void;
  6090. /**
  6091. * Remove a specific input method from a camera
  6092. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6093. * @param inputToRemove camera input method
  6094. */
  6095. remove(inputToRemove: ICameraInput<TCamera>): void;
  6096. /**
  6097. * Remove a specific input type from a camera
  6098. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6099. * @param inputType the type of the input to remove
  6100. */
  6101. removeByType(inputType: string): void;
  6102. private _addCheckInputs;
  6103. /**
  6104. * Attach the input controls to the currently attached dom element to listen the events from.
  6105. * @param input Defines the input to attach
  6106. */
  6107. attachInput(input: ICameraInput<TCamera>): void;
  6108. /**
  6109. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6110. * @param element Defines the dom element to collect the events from
  6111. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6112. */
  6113. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6114. /**
  6115. * Detach the current manager inputs controls from a specific dom element.
  6116. * @param element Defines the dom element to collect the events from
  6117. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6118. */
  6119. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6120. /**
  6121. * Rebuild the dynamic inputCheck function from the current list of
  6122. * defined inputs in the manager.
  6123. */
  6124. rebuildInputCheck(): void;
  6125. /**
  6126. * Remove all attached input methods from a camera
  6127. */
  6128. clear(): void;
  6129. /**
  6130. * Serialize the current input manager attached to a camera.
  6131. * This ensures than once parsed,
  6132. * the input associated to the camera will be identical to the current ones
  6133. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6134. */
  6135. serialize(serializedCamera: any): void;
  6136. /**
  6137. * Parses an input manager serialized JSON to restore the previous list of inputs
  6138. * and states associated to a camera.
  6139. * @param parsedCamera Defines the JSON to parse
  6140. */
  6141. parse(parsedCamera: any): void;
  6142. }
  6143. }
  6144. declare module "babylonjs/Meshes/buffer" {
  6145. import { Nullable, DataArray } from "babylonjs/types";
  6146. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6147. /**
  6148. * Class used to store data that will be store in GPU memory
  6149. */
  6150. export class Buffer {
  6151. private _engine;
  6152. private _buffer;
  6153. /** @hidden */
  6154. _data: Nullable<DataArray>;
  6155. private _updatable;
  6156. private _instanced;
  6157. private _divisor;
  6158. /**
  6159. * Gets the byte stride.
  6160. */
  6161. readonly byteStride: number;
  6162. /**
  6163. * Constructor
  6164. * @param engine the engine
  6165. * @param data the data to use for this buffer
  6166. * @param updatable whether the data is updatable
  6167. * @param stride the stride (optional)
  6168. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6169. * @param instanced whether the buffer is instanced (optional)
  6170. * @param useBytes set to true if the stride in in bytes (optional)
  6171. * @param divisor sets an optional divisor for instances (1 by default)
  6172. */
  6173. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6174. /**
  6175. * Create a new VertexBuffer based on the current buffer
  6176. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6177. * @param offset defines offset in the buffer (0 by default)
  6178. * @param size defines the size in floats of attributes (position is 3 for instance)
  6179. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6180. * @param instanced defines if the vertex buffer contains indexed data
  6181. * @param useBytes defines if the offset and stride are in bytes *
  6182. * @param divisor sets an optional divisor for instances (1 by default)
  6183. * @returns the new vertex buffer
  6184. */
  6185. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6186. /**
  6187. * Gets a boolean indicating if the Buffer is updatable?
  6188. * @returns true if the buffer is updatable
  6189. */
  6190. isUpdatable(): boolean;
  6191. /**
  6192. * Gets current buffer's data
  6193. * @returns a DataArray or null
  6194. */
  6195. getData(): Nullable<DataArray>;
  6196. /**
  6197. * Gets underlying native buffer
  6198. * @returns underlying native buffer
  6199. */
  6200. getBuffer(): Nullable<DataBuffer>;
  6201. /**
  6202. * Gets the stride in float32 units (i.e. byte stride / 4).
  6203. * May not be an integer if the byte stride is not divisible by 4.
  6204. * DEPRECATED. Use byteStride instead.
  6205. * @returns the stride in float32 units
  6206. */
  6207. getStrideSize(): number;
  6208. /**
  6209. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6210. * @param data defines the data to store
  6211. */
  6212. create(data?: Nullable<DataArray>): void;
  6213. /** @hidden */
  6214. _rebuild(): void;
  6215. /**
  6216. * Update current buffer data
  6217. * @param data defines the data to store
  6218. */
  6219. update(data: DataArray): void;
  6220. /**
  6221. * Updates the data directly.
  6222. * @param data the new data
  6223. * @param offset the new offset
  6224. * @param vertexCount the vertex count (optional)
  6225. * @param useBytes set to true if the offset is in bytes
  6226. */
  6227. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6228. /**
  6229. * Release all resources
  6230. */
  6231. dispose(): void;
  6232. }
  6233. /**
  6234. * Specialized buffer used to store vertex data
  6235. */
  6236. export class VertexBuffer {
  6237. /** @hidden */
  6238. _buffer: Buffer;
  6239. private _kind;
  6240. private _size;
  6241. private _ownsBuffer;
  6242. private _instanced;
  6243. private _instanceDivisor;
  6244. /**
  6245. * The byte type.
  6246. */
  6247. static readonly BYTE: number;
  6248. /**
  6249. * The unsigned byte type.
  6250. */
  6251. static readonly UNSIGNED_BYTE: number;
  6252. /**
  6253. * The short type.
  6254. */
  6255. static readonly SHORT: number;
  6256. /**
  6257. * The unsigned short type.
  6258. */
  6259. static readonly UNSIGNED_SHORT: number;
  6260. /**
  6261. * The integer type.
  6262. */
  6263. static readonly INT: number;
  6264. /**
  6265. * The unsigned integer type.
  6266. */
  6267. static readonly UNSIGNED_INT: number;
  6268. /**
  6269. * The float type.
  6270. */
  6271. static readonly FLOAT: number;
  6272. /**
  6273. * Gets or sets the instance divisor when in instanced mode
  6274. */
  6275. instanceDivisor: number;
  6276. /**
  6277. * Gets the byte stride.
  6278. */
  6279. readonly byteStride: number;
  6280. /**
  6281. * Gets the byte offset.
  6282. */
  6283. readonly byteOffset: number;
  6284. /**
  6285. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6286. */
  6287. readonly normalized: boolean;
  6288. /**
  6289. * Gets the data type of each component in the array.
  6290. */
  6291. readonly type: number;
  6292. /**
  6293. * Constructor
  6294. * @param engine the engine
  6295. * @param data the data to use for this vertex buffer
  6296. * @param kind the vertex buffer kind
  6297. * @param updatable whether the data is updatable
  6298. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6299. * @param stride the stride (optional)
  6300. * @param instanced whether the buffer is instanced (optional)
  6301. * @param offset the offset of the data (optional)
  6302. * @param size the number of components (optional)
  6303. * @param type the type of the component (optional)
  6304. * @param normalized whether the data contains normalized data (optional)
  6305. * @param useBytes set to true if stride and offset are in bytes (optional)
  6306. * @param divisor defines the instance divisor to use (1 by default)
  6307. */
  6308. 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);
  6309. /** @hidden */
  6310. _rebuild(): void;
  6311. /**
  6312. * Returns the kind of the VertexBuffer (string)
  6313. * @returns a string
  6314. */
  6315. getKind(): string;
  6316. /**
  6317. * Gets a boolean indicating if the VertexBuffer is updatable?
  6318. * @returns true if the buffer is updatable
  6319. */
  6320. isUpdatable(): boolean;
  6321. /**
  6322. * Gets current buffer's data
  6323. * @returns a DataArray or null
  6324. */
  6325. getData(): Nullable<DataArray>;
  6326. /**
  6327. * Gets underlying native buffer
  6328. * @returns underlying native buffer
  6329. */
  6330. getBuffer(): Nullable<DataBuffer>;
  6331. /**
  6332. * Gets the stride in float32 units (i.e. byte stride / 4).
  6333. * May not be an integer if the byte stride is not divisible by 4.
  6334. * DEPRECATED. Use byteStride instead.
  6335. * @returns the stride in float32 units
  6336. */
  6337. getStrideSize(): number;
  6338. /**
  6339. * Returns the offset as a multiple of the type byte length.
  6340. * DEPRECATED. Use byteOffset instead.
  6341. * @returns the offset in bytes
  6342. */
  6343. getOffset(): number;
  6344. /**
  6345. * Returns the number of components per vertex attribute (integer)
  6346. * @returns the size in float
  6347. */
  6348. getSize(): number;
  6349. /**
  6350. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6351. * @returns true if this buffer is instanced
  6352. */
  6353. getIsInstanced(): boolean;
  6354. /**
  6355. * Returns the instancing divisor, zero for non-instanced (integer).
  6356. * @returns a number
  6357. */
  6358. getInstanceDivisor(): number;
  6359. /**
  6360. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6361. * @param data defines the data to store
  6362. */
  6363. create(data?: DataArray): void;
  6364. /**
  6365. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6366. * This function will create a new buffer if the current one is not updatable
  6367. * @param data defines the data to store
  6368. */
  6369. update(data: DataArray): void;
  6370. /**
  6371. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6372. * Returns the directly updated WebGLBuffer.
  6373. * @param data the new data
  6374. * @param offset the new offset
  6375. * @param useBytes set to true if the offset is in bytes
  6376. */
  6377. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6378. /**
  6379. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6380. */
  6381. dispose(): void;
  6382. /**
  6383. * Enumerates each value of this vertex buffer as numbers.
  6384. * @param count the number of values to enumerate
  6385. * @param callback the callback function called for each value
  6386. */
  6387. forEach(count: number, callback: (value: number, index: number) => void): void;
  6388. /**
  6389. * Positions
  6390. */
  6391. static readonly PositionKind: string;
  6392. /**
  6393. * Normals
  6394. */
  6395. static readonly NormalKind: string;
  6396. /**
  6397. * Tangents
  6398. */
  6399. static readonly TangentKind: string;
  6400. /**
  6401. * Texture coordinates
  6402. */
  6403. static readonly UVKind: string;
  6404. /**
  6405. * Texture coordinates 2
  6406. */
  6407. static readonly UV2Kind: string;
  6408. /**
  6409. * Texture coordinates 3
  6410. */
  6411. static readonly UV3Kind: string;
  6412. /**
  6413. * Texture coordinates 4
  6414. */
  6415. static readonly UV4Kind: string;
  6416. /**
  6417. * Texture coordinates 5
  6418. */
  6419. static readonly UV5Kind: string;
  6420. /**
  6421. * Texture coordinates 6
  6422. */
  6423. static readonly UV6Kind: string;
  6424. /**
  6425. * Colors
  6426. */
  6427. static readonly ColorKind: string;
  6428. /**
  6429. * Matrix indices (for bones)
  6430. */
  6431. static readonly MatricesIndicesKind: string;
  6432. /**
  6433. * Matrix weights (for bones)
  6434. */
  6435. static readonly MatricesWeightsKind: string;
  6436. /**
  6437. * Additional matrix indices (for bones)
  6438. */
  6439. static readonly MatricesIndicesExtraKind: string;
  6440. /**
  6441. * Additional matrix weights (for bones)
  6442. */
  6443. static readonly MatricesWeightsExtraKind: string;
  6444. /**
  6445. * Deduces the stride given a kind.
  6446. * @param kind The kind string to deduce
  6447. * @returns The deduced stride
  6448. */
  6449. static DeduceStride(kind: string): number;
  6450. /**
  6451. * Gets the byte length of the given type.
  6452. * @param type the type
  6453. * @returns the number of bytes
  6454. */
  6455. static GetTypeByteLength(type: number): number;
  6456. /**
  6457. * Enumerates each value of the given parameters as numbers.
  6458. * @param data the data to enumerate
  6459. * @param byteOffset the byte offset of the data
  6460. * @param byteStride the byte stride of the data
  6461. * @param componentCount the number of components per element
  6462. * @param componentType the type of the component
  6463. * @param count the number of values to enumerate
  6464. * @param normalized whether the data is normalized
  6465. * @param callback the callback function called for each value
  6466. */
  6467. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6468. private static _GetFloatValue;
  6469. }
  6470. }
  6471. declare module "babylonjs/Collisions/intersectionInfo" {
  6472. import { Nullable } from "babylonjs/types";
  6473. /**
  6474. * @hidden
  6475. */
  6476. export class IntersectionInfo {
  6477. bu: Nullable<number>;
  6478. bv: Nullable<number>;
  6479. distance: number;
  6480. faceId: number;
  6481. subMeshId: number;
  6482. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6483. }
  6484. }
  6485. declare module "babylonjs/Maths/math.plane" {
  6486. import { DeepImmutable } from "babylonjs/types";
  6487. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  6488. /**
  6489. * Represens a plane by the equation ax + by + cz + d = 0
  6490. */
  6491. export class Plane {
  6492. private static _TmpMatrix;
  6493. /**
  6494. * Normal of the plane (a,b,c)
  6495. */
  6496. normal: Vector3;
  6497. /**
  6498. * d component of the plane
  6499. */
  6500. d: number;
  6501. /**
  6502. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  6503. * @param a a component of the plane
  6504. * @param b b component of the plane
  6505. * @param c c component of the plane
  6506. * @param d d component of the plane
  6507. */
  6508. constructor(a: number, b: number, c: number, d: number);
  6509. /**
  6510. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  6511. */
  6512. asArray(): number[];
  6513. /**
  6514. * @returns a new plane copied from the current Plane.
  6515. */
  6516. clone(): Plane;
  6517. /**
  6518. * @returns the string "Plane".
  6519. */
  6520. getClassName(): string;
  6521. /**
  6522. * @returns the Plane hash code.
  6523. */
  6524. getHashCode(): number;
  6525. /**
  6526. * Normalize the current Plane in place.
  6527. * @returns the updated Plane.
  6528. */
  6529. normalize(): Plane;
  6530. /**
  6531. * Applies a transformation the plane and returns the result
  6532. * @param transformation the transformation matrix to be applied to the plane
  6533. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  6534. */
  6535. transform(transformation: DeepImmutable<Matrix>): Plane;
  6536. /**
  6537. * Calcualtte the dot product between the point and the plane normal
  6538. * @param point point to calculate the dot product with
  6539. * @returns the dot product (float) of the point coordinates and the plane normal.
  6540. */
  6541. dotCoordinate(point: DeepImmutable<Vector3>): number;
  6542. /**
  6543. * Updates the current Plane from the plane defined by the three given points.
  6544. * @param point1 one of the points used to contruct the plane
  6545. * @param point2 one of the points used to contruct the plane
  6546. * @param point3 one of the points used to contruct the plane
  6547. * @returns the updated Plane.
  6548. */
  6549. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6550. /**
  6551. * Checks if the plane is facing a given direction
  6552. * @param direction the direction to check if the plane is facing
  6553. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  6554. * @returns True is the vector "direction" is the same side than the plane normal.
  6555. */
  6556. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  6557. /**
  6558. * Calculates the distance to a point
  6559. * @param point point to calculate distance to
  6560. * @returns the signed distance (float) from the given point to the Plane.
  6561. */
  6562. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  6563. /**
  6564. * Creates a plane from an array
  6565. * @param array the array to create a plane from
  6566. * @returns a new Plane from the given array.
  6567. */
  6568. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  6569. /**
  6570. * Creates a plane from three points
  6571. * @param point1 point used to create the plane
  6572. * @param point2 point used to create the plane
  6573. * @param point3 point used to create the plane
  6574. * @returns a new Plane defined by the three given points.
  6575. */
  6576. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6577. /**
  6578. * Creates a plane from an origin point and a normal
  6579. * @param origin origin of the plane to be constructed
  6580. * @param normal normal of the plane to be constructed
  6581. * @returns a new Plane the normal vector to this plane at the given origin point.
  6582. * Note : the vector "normal" is updated because normalized.
  6583. */
  6584. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  6585. /**
  6586. * Calculates the distance from a plane and a point
  6587. * @param origin origin of the plane to be constructed
  6588. * @param normal normal of the plane to be constructed
  6589. * @param point point to calculate distance to
  6590. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  6591. */
  6592. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  6593. }
  6594. }
  6595. declare module "babylonjs/Culling/boundingSphere" {
  6596. import { DeepImmutable } from "babylonjs/types";
  6597. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6598. import { Plane } from "babylonjs/Maths/math.plane";
  6599. /**
  6600. * Class used to store bounding sphere information
  6601. */
  6602. export class BoundingSphere {
  6603. /**
  6604. * Gets the center of the bounding sphere in local space
  6605. */
  6606. readonly center: Vector3;
  6607. /**
  6608. * Radius of the bounding sphere in local space
  6609. */
  6610. radius: number;
  6611. /**
  6612. * Gets the center of the bounding sphere in world space
  6613. */
  6614. readonly centerWorld: Vector3;
  6615. /**
  6616. * Radius of the bounding sphere in world space
  6617. */
  6618. radiusWorld: number;
  6619. /**
  6620. * Gets the minimum vector in local space
  6621. */
  6622. readonly minimum: Vector3;
  6623. /**
  6624. * Gets the maximum vector in local space
  6625. */
  6626. readonly maximum: Vector3;
  6627. private _worldMatrix;
  6628. private static readonly TmpVector3;
  6629. /**
  6630. * Creates a new bounding sphere
  6631. * @param min defines the minimum vector (in local space)
  6632. * @param max defines the maximum vector (in local space)
  6633. * @param worldMatrix defines the new world matrix
  6634. */
  6635. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6636. /**
  6637. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6638. * @param min defines the new minimum vector (in local space)
  6639. * @param max defines the new maximum vector (in local space)
  6640. * @param worldMatrix defines the new world matrix
  6641. */
  6642. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6643. /**
  6644. * Scale the current bounding sphere by applying a scale factor
  6645. * @param factor defines the scale factor to apply
  6646. * @returns the current bounding box
  6647. */
  6648. scale(factor: number): BoundingSphere;
  6649. /**
  6650. * Gets the world matrix of the bounding box
  6651. * @returns a matrix
  6652. */
  6653. getWorldMatrix(): DeepImmutable<Matrix>;
  6654. /** @hidden */
  6655. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6656. /**
  6657. * Tests if the bounding sphere is intersecting the frustum planes
  6658. * @param frustumPlanes defines the frustum planes to test
  6659. * @returns true if there is an intersection
  6660. */
  6661. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6662. /**
  6663. * Tests if the bounding sphere center is in between the frustum planes.
  6664. * Used for optimistic fast inclusion.
  6665. * @param frustumPlanes defines the frustum planes to test
  6666. * @returns true if the sphere center is in between the frustum planes
  6667. */
  6668. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6669. /**
  6670. * Tests if a point is inside the bounding sphere
  6671. * @param point defines the point to test
  6672. * @returns true if the point is inside the bounding sphere
  6673. */
  6674. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6675. /**
  6676. * Checks if two sphere intersct
  6677. * @param sphere0 sphere 0
  6678. * @param sphere1 sphere 1
  6679. * @returns true if the speres intersect
  6680. */
  6681. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6682. }
  6683. }
  6684. declare module "babylonjs/Culling/boundingBox" {
  6685. import { DeepImmutable } from "babylonjs/types";
  6686. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6687. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6688. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6689. import { Plane } from "babylonjs/Maths/math.plane";
  6690. /**
  6691. * Class used to store bounding box information
  6692. */
  6693. export class BoundingBox implements ICullable {
  6694. /**
  6695. * Gets the 8 vectors representing the bounding box in local space
  6696. */
  6697. readonly vectors: Vector3[];
  6698. /**
  6699. * Gets the center of the bounding box in local space
  6700. */
  6701. readonly center: Vector3;
  6702. /**
  6703. * Gets the center of the bounding box in world space
  6704. */
  6705. readonly centerWorld: Vector3;
  6706. /**
  6707. * Gets the extend size in local space
  6708. */
  6709. readonly extendSize: Vector3;
  6710. /**
  6711. * Gets the extend size in world space
  6712. */
  6713. readonly extendSizeWorld: Vector3;
  6714. /**
  6715. * Gets the OBB (object bounding box) directions
  6716. */
  6717. readonly directions: Vector3[];
  6718. /**
  6719. * Gets the 8 vectors representing the bounding box in world space
  6720. */
  6721. readonly vectorsWorld: Vector3[];
  6722. /**
  6723. * Gets the minimum vector in world space
  6724. */
  6725. readonly minimumWorld: Vector3;
  6726. /**
  6727. * Gets the maximum vector in world space
  6728. */
  6729. readonly maximumWorld: Vector3;
  6730. /**
  6731. * Gets the minimum vector in local space
  6732. */
  6733. readonly minimum: Vector3;
  6734. /**
  6735. * Gets the maximum vector in local space
  6736. */
  6737. readonly maximum: Vector3;
  6738. private _worldMatrix;
  6739. private static readonly TmpVector3;
  6740. /**
  6741. * @hidden
  6742. */
  6743. _tag: number;
  6744. /**
  6745. * Creates a new bounding box
  6746. * @param min defines the minimum vector (in local space)
  6747. * @param max defines the maximum vector (in local space)
  6748. * @param worldMatrix defines the new world matrix
  6749. */
  6750. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6751. /**
  6752. * Recreates the entire bounding box from scratch as if we call the constructor in place
  6753. * @param min defines the new minimum vector (in local space)
  6754. * @param max defines the new maximum vector (in local space)
  6755. * @param worldMatrix defines the new world matrix
  6756. */
  6757. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6758. /**
  6759. * Scale the current bounding box by applying a scale factor
  6760. * @param factor defines the scale factor to apply
  6761. * @returns the current bounding box
  6762. */
  6763. scale(factor: number): BoundingBox;
  6764. /**
  6765. * Gets the world matrix of the bounding box
  6766. * @returns a matrix
  6767. */
  6768. getWorldMatrix(): DeepImmutable<Matrix>;
  6769. /** @hidden */
  6770. _update(world: DeepImmutable<Matrix>): void;
  6771. /**
  6772. * Tests if the bounding box is intersecting the frustum planes
  6773. * @param frustumPlanes defines the frustum planes to test
  6774. * @returns true if there is an intersection
  6775. */
  6776. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6777. /**
  6778. * Tests if the bounding box is entirely inside the frustum planes
  6779. * @param frustumPlanes defines the frustum planes to test
  6780. * @returns true if there is an inclusion
  6781. */
  6782. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6783. /**
  6784. * Tests if a point is inside the bounding box
  6785. * @param point defines the point to test
  6786. * @returns true if the point is inside the bounding box
  6787. */
  6788. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6789. /**
  6790. * Tests if the bounding box intersects with a bounding sphere
  6791. * @param sphere defines the sphere to test
  6792. * @returns true if there is an intersection
  6793. */
  6794. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  6795. /**
  6796. * Tests if the bounding box intersects with a box defined by a min and max vectors
  6797. * @param min defines the min vector to use
  6798. * @param max defines the max vector to use
  6799. * @returns true if there is an intersection
  6800. */
  6801. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  6802. /**
  6803. * Tests if two bounding boxes are intersections
  6804. * @param box0 defines the first box to test
  6805. * @param box1 defines the second box to test
  6806. * @returns true if there is an intersection
  6807. */
  6808. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  6809. /**
  6810. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  6811. * @param minPoint defines the minimum vector of the bounding box
  6812. * @param maxPoint defines the maximum vector of the bounding box
  6813. * @param sphereCenter defines the sphere center
  6814. * @param sphereRadius defines the sphere radius
  6815. * @returns true if there is an intersection
  6816. */
  6817. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  6818. /**
  6819. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  6820. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  6821. * @param frustumPlanes defines the frustum planes to test
  6822. * @return true if there is an inclusion
  6823. */
  6824. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6825. /**
  6826. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  6827. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  6828. * @param frustumPlanes defines the frustum planes to test
  6829. * @return true if there is an intersection
  6830. */
  6831. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6832. }
  6833. }
  6834. declare module "babylonjs/Collisions/collider" {
  6835. import { Nullable, IndicesArray } from "babylonjs/types";
  6836. import { Vector3 } from "babylonjs/Maths/math.vector";
  6837. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  6838. import { Plane } from "babylonjs/Maths/math.plane";
  6839. /** @hidden */
  6840. export class Collider {
  6841. /** Define if a collision was found */
  6842. collisionFound: boolean;
  6843. /**
  6844. * Define last intersection point in local space
  6845. */
  6846. intersectionPoint: Vector3;
  6847. /**
  6848. * Define last collided mesh
  6849. */
  6850. collidedMesh: Nullable<AbstractMesh>;
  6851. private _collisionPoint;
  6852. private _planeIntersectionPoint;
  6853. private _tempVector;
  6854. private _tempVector2;
  6855. private _tempVector3;
  6856. private _tempVector4;
  6857. private _edge;
  6858. private _baseToVertex;
  6859. private _destinationPoint;
  6860. private _slidePlaneNormal;
  6861. private _displacementVector;
  6862. /** @hidden */
  6863. _radius: Vector3;
  6864. /** @hidden */
  6865. _retry: number;
  6866. private _velocity;
  6867. private _basePoint;
  6868. private _epsilon;
  6869. /** @hidden */
  6870. _velocityWorldLength: number;
  6871. /** @hidden */
  6872. _basePointWorld: Vector3;
  6873. private _velocityWorld;
  6874. private _normalizedVelocity;
  6875. /** @hidden */
  6876. _initialVelocity: Vector3;
  6877. /** @hidden */
  6878. _initialPosition: Vector3;
  6879. private _nearestDistance;
  6880. private _collisionMask;
  6881. collisionMask: number;
  6882. /**
  6883. * Gets the plane normal used to compute the sliding response (in local space)
  6884. */
  6885. readonly slidePlaneNormal: Vector3;
  6886. /** @hidden */
  6887. _initialize(source: Vector3, dir: Vector3, e: number): void;
  6888. /** @hidden */
  6889. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  6890. /** @hidden */
  6891. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  6892. /** @hidden */
  6893. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  6894. /** @hidden */
  6895. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  6896. /** @hidden */
  6897. _getResponse(pos: Vector3, vel: Vector3): void;
  6898. }
  6899. }
  6900. declare module "babylonjs/Culling/boundingInfo" {
  6901. import { DeepImmutable } from "babylonjs/types";
  6902. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6903. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  6904. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6905. import { Plane } from "babylonjs/Maths/math.plane";
  6906. import { Collider } from "babylonjs/Collisions/collider";
  6907. /**
  6908. * Interface for cullable objects
  6909. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  6910. */
  6911. export interface ICullable {
  6912. /**
  6913. * Checks if the object or part of the object is in the frustum
  6914. * @param frustumPlanes Camera near/planes
  6915. * @returns true if the object is in frustum otherwise false
  6916. */
  6917. isInFrustum(frustumPlanes: Plane[]): boolean;
  6918. /**
  6919. * Checks if a cullable object (mesh...) is in the camera frustum
  6920. * Unlike isInFrustum this cheks the full bounding box
  6921. * @param frustumPlanes Camera near/planes
  6922. * @returns true if the object is in frustum otherwise false
  6923. */
  6924. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  6925. }
  6926. /**
  6927. * Info for a bounding data of a mesh
  6928. */
  6929. export class BoundingInfo implements ICullable {
  6930. /**
  6931. * Bounding box for the mesh
  6932. */
  6933. readonly boundingBox: BoundingBox;
  6934. /**
  6935. * Bounding sphere for the mesh
  6936. */
  6937. readonly boundingSphere: BoundingSphere;
  6938. private _isLocked;
  6939. private static readonly TmpVector3;
  6940. /**
  6941. * Constructs bounding info
  6942. * @param minimum min vector of the bounding box/sphere
  6943. * @param maximum max vector of the bounding box/sphere
  6944. * @param worldMatrix defines the new world matrix
  6945. */
  6946. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6947. /**
  6948. * Recreates the entire bounding info from scratch as if we call the constructor in place
  6949. * @param min defines the new minimum vector (in local space)
  6950. * @param max defines the new maximum vector (in local space)
  6951. * @param worldMatrix defines the new world matrix
  6952. */
  6953. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6954. /**
  6955. * min vector of the bounding box/sphere
  6956. */
  6957. readonly minimum: Vector3;
  6958. /**
  6959. * max vector of the bounding box/sphere
  6960. */
  6961. readonly maximum: Vector3;
  6962. /**
  6963. * If the info is locked and won't be updated to avoid perf overhead
  6964. */
  6965. isLocked: boolean;
  6966. /**
  6967. * Updates the bounding sphere and box
  6968. * @param world world matrix to be used to update
  6969. */
  6970. update(world: DeepImmutable<Matrix>): void;
  6971. /**
  6972. * Recreate the bounding info to be centered around a specific point given a specific extend.
  6973. * @param center New center of the bounding info
  6974. * @param extend New extend of the bounding info
  6975. * @returns the current bounding info
  6976. */
  6977. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  6978. /**
  6979. * Scale the current bounding info by applying a scale factor
  6980. * @param factor defines the scale factor to apply
  6981. * @returns the current bounding info
  6982. */
  6983. scale(factor: number): BoundingInfo;
  6984. /**
  6985. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  6986. * @param frustumPlanes defines the frustum to test
  6987. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  6988. * @returns true if the bounding info is in the frustum planes
  6989. */
  6990. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  6991. /**
  6992. * Gets the world distance between the min and max points of the bounding box
  6993. */
  6994. readonly diagonalLength: number;
  6995. /**
  6996. * Checks if a cullable object (mesh...) is in the camera frustum
  6997. * Unlike isInFrustum this cheks the full bounding box
  6998. * @param frustumPlanes Camera near/planes
  6999. * @returns true if the object is in frustum otherwise false
  7000. */
  7001. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7002. /** @hidden */
  7003. _checkCollision(collider: Collider): boolean;
  7004. /**
  7005. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7006. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7007. * @param point the point to check intersection with
  7008. * @returns if the point intersects
  7009. */
  7010. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7011. /**
  7012. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7013. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7014. * @param boundingInfo the bounding info to check intersection with
  7015. * @param precise if the intersection should be done using OBB
  7016. * @returns if the bounding info intersects
  7017. */
  7018. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7019. }
  7020. }
  7021. declare module "babylonjs/Maths/math.functions" {
  7022. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7023. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7024. /**
  7025. * Extracts minimum and maximum values from a list of indexed positions
  7026. * @param positions defines the positions to use
  7027. * @param indices defines the indices to the positions
  7028. * @param indexStart defines the start index
  7029. * @param indexCount defines the end index
  7030. * @param bias defines bias value to add to the result
  7031. * @return minimum and maximum values
  7032. */
  7033. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7034. minimum: Vector3;
  7035. maximum: Vector3;
  7036. };
  7037. /**
  7038. * Extracts minimum and maximum values from a list of positions
  7039. * @param positions defines the positions to use
  7040. * @param start defines the start index in the positions array
  7041. * @param count defines the number of positions to handle
  7042. * @param bias defines bias value to add to the result
  7043. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7044. * @return minimum and maximum values
  7045. */
  7046. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7047. minimum: Vector3;
  7048. maximum: Vector3;
  7049. };
  7050. }
  7051. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7052. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7053. /** @hidden */
  7054. export class WebGLDataBuffer extends DataBuffer {
  7055. private _buffer;
  7056. constructor(resource: WebGLBuffer);
  7057. readonly underlyingResource: any;
  7058. }
  7059. }
  7060. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7061. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7062. import { Nullable } from "babylonjs/types";
  7063. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7064. /** @hidden */
  7065. export class WebGLPipelineContext implements IPipelineContext {
  7066. engine: ThinEngine;
  7067. program: Nullable<WebGLProgram>;
  7068. context?: WebGLRenderingContext;
  7069. vertexShader?: WebGLShader;
  7070. fragmentShader?: WebGLShader;
  7071. isParallelCompiled: boolean;
  7072. onCompiled?: () => void;
  7073. transformFeedback?: WebGLTransformFeedback | null;
  7074. readonly isAsync: boolean;
  7075. readonly isReady: boolean;
  7076. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7077. }
  7078. }
  7079. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7080. import { FloatArray, Nullable } from "babylonjs/types";
  7081. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7082. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7083. module "babylonjs/Engines/thinEngine" {
  7084. interface ThinEngine {
  7085. /**
  7086. * Create an uniform buffer
  7087. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7088. * @param elements defines the content of the uniform buffer
  7089. * @returns the webGL uniform buffer
  7090. */
  7091. createUniformBuffer(elements: FloatArray): DataBuffer;
  7092. /**
  7093. * Create a dynamic uniform buffer
  7094. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7095. * @param elements defines the content of the uniform buffer
  7096. * @returns the webGL uniform buffer
  7097. */
  7098. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7099. /**
  7100. * Update an existing uniform buffer
  7101. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7102. * @param uniformBuffer defines the target uniform buffer
  7103. * @param elements defines the content to update
  7104. * @param offset defines the offset in the uniform buffer where update should start
  7105. * @param count defines the size of the data to update
  7106. */
  7107. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7108. /**
  7109. * Bind an uniform buffer to the current webGL context
  7110. * @param buffer defines the buffer to bind
  7111. */
  7112. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7113. /**
  7114. * Bind a buffer to the current webGL context at a given location
  7115. * @param buffer defines the buffer to bind
  7116. * @param location defines the index where to bind the buffer
  7117. */
  7118. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7119. /**
  7120. * Bind a specific block at a given index in a specific shader program
  7121. * @param pipelineContext defines the pipeline context to use
  7122. * @param blockName defines the block name
  7123. * @param index defines the index where to bind the block
  7124. */
  7125. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7126. }
  7127. }
  7128. }
  7129. declare module "babylonjs/Materials/uniformBuffer" {
  7130. import { Nullable, FloatArray } from "babylonjs/types";
  7131. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7132. import { Engine } from "babylonjs/Engines/engine";
  7133. import { Effect } from "babylonjs/Materials/effect";
  7134. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7135. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7136. import { Color3 } from "babylonjs/Maths/math.color";
  7137. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7138. /**
  7139. * Uniform buffer objects.
  7140. *
  7141. * Handles blocks of uniform on the GPU.
  7142. *
  7143. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7144. *
  7145. * For more information, please refer to :
  7146. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7147. */
  7148. export class UniformBuffer {
  7149. private _engine;
  7150. private _buffer;
  7151. private _data;
  7152. private _bufferData;
  7153. private _dynamic?;
  7154. private _uniformLocations;
  7155. private _uniformSizes;
  7156. private _uniformLocationPointer;
  7157. private _needSync;
  7158. private _noUBO;
  7159. private _currentEffect;
  7160. /** @hidden */
  7161. _alreadyBound: boolean;
  7162. private static _MAX_UNIFORM_SIZE;
  7163. private static _tempBuffer;
  7164. /**
  7165. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7166. * This is dynamic to allow compat with webgl 1 and 2.
  7167. * You will need to pass the name of the uniform as well as the value.
  7168. */
  7169. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7170. /**
  7171. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7172. * This is dynamic to allow compat with webgl 1 and 2.
  7173. * You will need to pass the name of the uniform as well as the value.
  7174. */
  7175. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7176. /**
  7177. * Lambda to Update a single float in a uniform buffer.
  7178. * This is dynamic to allow compat with webgl 1 and 2.
  7179. * You will need to pass the name of the uniform as well as the value.
  7180. */
  7181. updateFloat: (name: string, x: number) => void;
  7182. /**
  7183. * Lambda to Update a vec2 of float in a uniform buffer.
  7184. * This is dynamic to allow compat with webgl 1 and 2.
  7185. * You will need to pass the name of the uniform as well as the value.
  7186. */
  7187. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7188. /**
  7189. * Lambda to Update a vec3 of float in a uniform buffer.
  7190. * This is dynamic to allow compat with webgl 1 and 2.
  7191. * You will need to pass the name of the uniform as well as the value.
  7192. */
  7193. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7194. /**
  7195. * Lambda to Update a vec4 of float in a uniform buffer.
  7196. * This is dynamic to allow compat with webgl 1 and 2.
  7197. * You will need to pass the name of the uniform as well as the value.
  7198. */
  7199. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7200. /**
  7201. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7202. * This is dynamic to allow compat with webgl 1 and 2.
  7203. * You will need to pass the name of the uniform as well as the value.
  7204. */
  7205. updateMatrix: (name: string, mat: Matrix) => void;
  7206. /**
  7207. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7208. * This is dynamic to allow compat with webgl 1 and 2.
  7209. * You will need to pass the name of the uniform as well as the value.
  7210. */
  7211. updateVector3: (name: string, vector: Vector3) => void;
  7212. /**
  7213. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7214. * This is dynamic to allow compat with webgl 1 and 2.
  7215. * You will need to pass the name of the uniform as well as the value.
  7216. */
  7217. updateVector4: (name: string, vector: Vector4) => void;
  7218. /**
  7219. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7220. * This is dynamic to allow compat with webgl 1 and 2.
  7221. * You will need to pass the name of the uniform as well as the value.
  7222. */
  7223. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7224. /**
  7225. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7226. * This is dynamic to allow compat with webgl 1 and 2.
  7227. * You will need to pass the name of the uniform as well as the value.
  7228. */
  7229. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7230. /**
  7231. * Instantiates a new Uniform buffer objects.
  7232. *
  7233. * Handles blocks of uniform on the GPU.
  7234. *
  7235. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7236. *
  7237. * For more information, please refer to :
  7238. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7239. * @param engine Define the engine the buffer is associated with
  7240. * @param data Define the data contained in the buffer
  7241. * @param dynamic Define if the buffer is updatable
  7242. */
  7243. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7244. /**
  7245. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7246. * or just falling back on setUniformXXX calls.
  7247. */
  7248. readonly useUbo: boolean;
  7249. /**
  7250. * Indicates if the WebGL underlying uniform buffer is in sync
  7251. * with the javascript cache data.
  7252. */
  7253. readonly isSync: boolean;
  7254. /**
  7255. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7256. * Also, a dynamic UniformBuffer will disable cache verification and always
  7257. * update the underlying WebGL uniform buffer to the GPU.
  7258. * @returns if Dynamic, otherwise false
  7259. */
  7260. isDynamic(): boolean;
  7261. /**
  7262. * The data cache on JS side.
  7263. * @returns the underlying data as a float array
  7264. */
  7265. getData(): Float32Array;
  7266. /**
  7267. * The underlying WebGL Uniform buffer.
  7268. * @returns the webgl buffer
  7269. */
  7270. getBuffer(): Nullable<DataBuffer>;
  7271. /**
  7272. * std140 layout specifies how to align data within an UBO structure.
  7273. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7274. * for specs.
  7275. */
  7276. private _fillAlignment;
  7277. /**
  7278. * Adds an uniform in the buffer.
  7279. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7280. * for the layout to be correct !
  7281. * @param name Name of the uniform, as used in the uniform block in the shader.
  7282. * @param size Data size, or data directly.
  7283. */
  7284. addUniform(name: string, size: number | number[]): void;
  7285. /**
  7286. * Adds a Matrix 4x4 to the uniform buffer.
  7287. * @param name Name of the uniform, as used in the uniform block in the shader.
  7288. * @param mat A 4x4 matrix.
  7289. */
  7290. addMatrix(name: string, mat: Matrix): void;
  7291. /**
  7292. * Adds a vec2 to the uniform buffer.
  7293. * @param name Name of the uniform, as used in the uniform block in the shader.
  7294. * @param x Define the x component value of the vec2
  7295. * @param y Define the y component value of the vec2
  7296. */
  7297. addFloat2(name: string, x: number, y: number): void;
  7298. /**
  7299. * Adds a vec3 to the uniform buffer.
  7300. * @param name Name of the uniform, as used in the uniform block in the shader.
  7301. * @param x Define the x component value of the vec3
  7302. * @param y Define the y component value of the vec3
  7303. * @param z Define the z component value of the vec3
  7304. */
  7305. addFloat3(name: string, x: number, y: number, z: number): void;
  7306. /**
  7307. * Adds a vec3 to the uniform buffer.
  7308. * @param name Name of the uniform, as used in the uniform block in the shader.
  7309. * @param color Define the vec3 from a Color
  7310. */
  7311. addColor3(name: string, color: Color3): void;
  7312. /**
  7313. * Adds a vec4 to the uniform buffer.
  7314. * @param name Name of the uniform, as used in the uniform block in the shader.
  7315. * @param color Define the rgb components from a Color
  7316. * @param alpha Define the a component of the vec4
  7317. */
  7318. addColor4(name: string, color: Color3, alpha: number): void;
  7319. /**
  7320. * Adds a vec3 to the uniform buffer.
  7321. * @param name Name of the uniform, as used in the uniform block in the shader.
  7322. * @param vector Define the vec3 components from a Vector
  7323. */
  7324. addVector3(name: string, vector: Vector3): void;
  7325. /**
  7326. * Adds a Matrix 3x3 to the uniform buffer.
  7327. * @param name Name of the uniform, as used in the uniform block in the shader.
  7328. */
  7329. addMatrix3x3(name: string): void;
  7330. /**
  7331. * Adds a Matrix 2x2 to the uniform buffer.
  7332. * @param name Name of the uniform, as used in the uniform block in the shader.
  7333. */
  7334. addMatrix2x2(name: string): void;
  7335. /**
  7336. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7337. */
  7338. create(): void;
  7339. /** @hidden */
  7340. _rebuild(): void;
  7341. /**
  7342. * Updates the WebGL Uniform Buffer on the GPU.
  7343. * If the `dynamic` flag is set to true, no cache comparison is done.
  7344. * Otherwise, the buffer will be updated only if the cache differs.
  7345. */
  7346. update(): void;
  7347. /**
  7348. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7349. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7350. * @param data Define the flattened data
  7351. * @param size Define the size of the data.
  7352. */
  7353. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7354. private _valueCache;
  7355. private _cacheMatrix;
  7356. private _updateMatrix3x3ForUniform;
  7357. private _updateMatrix3x3ForEffect;
  7358. private _updateMatrix2x2ForEffect;
  7359. private _updateMatrix2x2ForUniform;
  7360. private _updateFloatForEffect;
  7361. private _updateFloatForUniform;
  7362. private _updateFloat2ForEffect;
  7363. private _updateFloat2ForUniform;
  7364. private _updateFloat3ForEffect;
  7365. private _updateFloat3ForUniform;
  7366. private _updateFloat4ForEffect;
  7367. private _updateFloat4ForUniform;
  7368. private _updateMatrixForEffect;
  7369. private _updateMatrixForUniform;
  7370. private _updateVector3ForEffect;
  7371. private _updateVector3ForUniform;
  7372. private _updateVector4ForEffect;
  7373. private _updateVector4ForUniform;
  7374. private _updateColor3ForEffect;
  7375. private _updateColor3ForUniform;
  7376. private _updateColor4ForEffect;
  7377. private _updateColor4ForUniform;
  7378. /**
  7379. * Sets a sampler uniform on the effect.
  7380. * @param name Define the name of the sampler.
  7381. * @param texture Define the texture to set in the sampler
  7382. */
  7383. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7384. /**
  7385. * Directly updates the value of the uniform in the cache AND on the GPU.
  7386. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7387. * @param data Define the flattened data
  7388. */
  7389. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7390. /**
  7391. * Binds this uniform buffer to an effect.
  7392. * @param effect Define the effect to bind the buffer to
  7393. * @param name Name of the uniform block in the shader.
  7394. */
  7395. bindToEffect(effect: Effect, name: string): void;
  7396. /**
  7397. * Disposes the uniform buffer.
  7398. */
  7399. dispose(): void;
  7400. }
  7401. }
  7402. declare module "babylonjs/Misc/iInspectable" {
  7403. /**
  7404. * Enum that determines the text-wrapping mode to use.
  7405. */
  7406. export enum InspectableType {
  7407. /**
  7408. * Checkbox for booleans
  7409. */
  7410. Checkbox = 0,
  7411. /**
  7412. * Sliders for numbers
  7413. */
  7414. Slider = 1,
  7415. /**
  7416. * Vector3
  7417. */
  7418. Vector3 = 2,
  7419. /**
  7420. * Quaternions
  7421. */
  7422. Quaternion = 3,
  7423. /**
  7424. * Color3
  7425. */
  7426. Color3 = 4,
  7427. /**
  7428. * String
  7429. */
  7430. String = 5
  7431. }
  7432. /**
  7433. * Interface used to define custom inspectable properties.
  7434. * This interface is used by the inspector to display custom property grids
  7435. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7436. */
  7437. export interface IInspectable {
  7438. /**
  7439. * Gets the label to display
  7440. */
  7441. label: string;
  7442. /**
  7443. * Gets the name of the property to edit
  7444. */
  7445. propertyName: string;
  7446. /**
  7447. * Gets the type of the editor to use
  7448. */
  7449. type: InspectableType;
  7450. /**
  7451. * Gets the minimum value of the property when using in "slider" mode
  7452. */
  7453. min?: number;
  7454. /**
  7455. * Gets the maximum value of the property when using in "slider" mode
  7456. */
  7457. max?: number;
  7458. /**
  7459. * Gets the setp to use when using in "slider" mode
  7460. */
  7461. step?: number;
  7462. }
  7463. }
  7464. declare module "babylonjs/Misc/timingTools" {
  7465. /**
  7466. * Class used to provide helper for timing
  7467. */
  7468. export class TimingTools {
  7469. /**
  7470. * Polyfill for setImmediate
  7471. * @param action defines the action to execute after the current execution block
  7472. */
  7473. static SetImmediate(action: () => void): void;
  7474. }
  7475. }
  7476. declare module "babylonjs/Misc/instantiationTools" {
  7477. /**
  7478. * Class used to enable instatition of objects by class name
  7479. */
  7480. export class InstantiationTools {
  7481. /**
  7482. * Use this object to register external classes like custom textures or material
  7483. * to allow the laoders to instantiate them
  7484. */
  7485. static RegisteredExternalClasses: {
  7486. [key: string]: Object;
  7487. };
  7488. /**
  7489. * Tries to instantiate a new object from a given class name
  7490. * @param className defines the class name to instantiate
  7491. * @returns the new object or null if the system was not able to do the instantiation
  7492. */
  7493. static Instantiate(className: string): any;
  7494. }
  7495. }
  7496. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7497. /**
  7498. * Define options used to create a depth texture
  7499. */
  7500. export class DepthTextureCreationOptions {
  7501. /** Specifies whether or not a stencil should be allocated in the texture */
  7502. generateStencil?: boolean;
  7503. /** Specifies whether or not bilinear filtering is enable on the texture */
  7504. bilinearFiltering?: boolean;
  7505. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7506. comparisonFunction?: number;
  7507. /** Specifies if the created texture is a cube texture */
  7508. isCube?: boolean;
  7509. }
  7510. }
  7511. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7512. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7513. import { Nullable } from "babylonjs/types";
  7514. import { Scene } from "babylonjs/scene";
  7515. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  7516. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7517. module "babylonjs/Engines/thinEngine" {
  7518. interface ThinEngine {
  7519. /**
  7520. * Creates a depth stencil cube texture.
  7521. * This is only available in WebGL 2.
  7522. * @param size The size of face edge in the cube texture.
  7523. * @param options The options defining the cube texture.
  7524. * @returns The cube texture
  7525. */
  7526. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7527. /**
  7528. * Creates a cube texture
  7529. * @param rootUrl defines the url where the files to load is located
  7530. * @param scene defines the current scene
  7531. * @param files defines the list of files to load (1 per face)
  7532. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7533. * @param onLoad defines an optional callback raised when the texture is loaded
  7534. * @param onError defines an optional callback raised if there is an issue to load the texture
  7535. * @param format defines the format of the data
  7536. * @param forcedExtension defines the extension to use to pick the right loader
  7537. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7538. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7539. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7540. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7541. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  7542. * @returns the cube texture as an InternalTexture
  7543. */
  7544. 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>, excludeLoaders: Array<IInternalTextureLoader>): InternalTexture;
  7545. /**
  7546. * Creates a cube texture
  7547. * @param rootUrl defines the url where the files to load is located
  7548. * @param scene defines the current scene
  7549. * @param files defines the list of files to load (1 per face)
  7550. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7551. * @param onLoad defines an optional callback raised when the texture is loaded
  7552. * @param onError defines an optional callback raised if there is an issue to load the texture
  7553. * @param format defines the format of the data
  7554. * @param forcedExtension defines the extension to use to pick the right loader
  7555. * @returns the cube texture as an InternalTexture
  7556. */
  7557. 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;
  7558. /**
  7559. * Creates a cube texture
  7560. * @param rootUrl defines the url where the files to load is located
  7561. * @param scene defines the current scene
  7562. * @param files defines the list of files to load (1 per face)
  7563. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7564. * @param onLoad defines an optional callback raised when the texture is loaded
  7565. * @param onError defines an optional callback raised if there is an issue to load the texture
  7566. * @param format defines the format of the data
  7567. * @param forcedExtension defines the extension to use to pick the right loader
  7568. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7569. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7570. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7571. * @returns the cube texture as an InternalTexture
  7572. */
  7573. 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;
  7574. /** @hidden */
  7575. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7576. /** @hidden */
  7577. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7578. /** @hidden */
  7579. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7580. /** @hidden */
  7581. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7582. /**
  7583. * @hidden
  7584. */
  7585. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7586. }
  7587. }
  7588. }
  7589. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7590. import { Nullable } from "babylonjs/types";
  7591. import { Scene } from "babylonjs/scene";
  7592. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7593. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7594. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7595. /**
  7596. * Class for creating a cube texture
  7597. */
  7598. export class CubeTexture extends BaseTexture {
  7599. private _delayedOnLoad;
  7600. /**
  7601. * The url of the texture
  7602. */
  7603. url: string;
  7604. /**
  7605. * Gets or sets the center of the bounding box associated with the cube texture.
  7606. * It must define where the camera used to render the texture was set
  7607. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7608. */
  7609. boundingBoxPosition: Vector3;
  7610. private _boundingBoxSize;
  7611. /**
  7612. * Gets or sets the size of the bounding box associated with the cube texture
  7613. * When defined, the cubemap will switch to local mode
  7614. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7615. * @example https://www.babylonjs-playground.com/#RNASML
  7616. */
  7617. /**
  7618. * Returns the bounding box size
  7619. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7620. */
  7621. boundingBoxSize: Vector3;
  7622. protected _rotationY: number;
  7623. /**
  7624. * Sets texture matrix rotation angle around Y axis in radians.
  7625. */
  7626. /**
  7627. * Gets texture matrix rotation angle around Y axis radians.
  7628. */
  7629. rotationY: number;
  7630. /**
  7631. * Are mip maps generated for this texture or not.
  7632. */
  7633. readonly noMipmap: boolean;
  7634. private _noMipmap;
  7635. private _files;
  7636. protected _forcedExtension: Nullable<string>;
  7637. private _extensions;
  7638. private _textureMatrix;
  7639. private _format;
  7640. private _createPolynomials;
  7641. /** @hidden */
  7642. _prefiltered: boolean;
  7643. /**
  7644. * Creates a cube texture from an array of image urls
  7645. * @param files defines an array of image urls
  7646. * @param scene defines the hosting scene
  7647. * @param noMipmap specifies if mip maps are not used
  7648. * @returns a cube texture
  7649. */
  7650. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7651. /**
  7652. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7653. * @param url defines the url of the prefiltered texture
  7654. * @param scene defines the scene the texture is attached to
  7655. * @param forcedExtension defines the extension of the file if different from the url
  7656. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7657. * @return the prefiltered texture
  7658. */
  7659. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7660. /**
  7661. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7662. * as prefiltered data.
  7663. * @param rootUrl defines the url of the texture or the root name of the six images
  7664. * @param scene defines the scene the texture is attached to
  7665. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7666. * @param noMipmap defines if mipmaps should be created or not
  7667. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7668. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7669. * @param onError defines a callback triggered in case of error during load
  7670. * @param format defines the internal format to use for the texture once loaded
  7671. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7672. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7673. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7674. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7675. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7676. * @return the cube texture
  7677. */
  7678. constructor(rootUrl: string, scene: Scene, 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);
  7679. /**
  7680. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  7681. */
  7682. readonly isPrefiltered: boolean;
  7683. /**
  7684. * Get the current class name of the texture useful for serialization or dynamic coding.
  7685. * @returns "CubeTexture"
  7686. */
  7687. getClassName(): string;
  7688. /**
  7689. * Update the url (and optional buffer) of this texture if url was null during construction.
  7690. * @param url the url of the texture
  7691. * @param forcedExtension defines the extension to use
  7692. * @param onLoad callback called when the texture is loaded (defaults to null)
  7693. */
  7694. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  7695. /**
  7696. * Delays loading of the cube texture
  7697. * @param forcedExtension defines the extension to use
  7698. */
  7699. delayLoad(forcedExtension?: string): void;
  7700. /**
  7701. * Returns the reflection texture matrix
  7702. * @returns the reflection texture matrix
  7703. */
  7704. getReflectionTextureMatrix(): Matrix;
  7705. /**
  7706. * Sets the reflection texture matrix
  7707. * @param value Reflection texture matrix
  7708. */
  7709. setReflectionTextureMatrix(value: Matrix): void;
  7710. /**
  7711. * Parses text to create a cube texture
  7712. * @param parsedTexture define the serialized text to read from
  7713. * @param scene defines the hosting scene
  7714. * @param rootUrl defines the root url of the cube texture
  7715. * @returns a cube texture
  7716. */
  7717. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  7718. /**
  7719. * Makes a clone, or deep copy, of the cube texture
  7720. * @returns a new cube texture
  7721. */
  7722. clone(): CubeTexture;
  7723. }
  7724. }
  7725. declare module "babylonjs/Materials/materialDefines" {
  7726. /**
  7727. * Manages the defines for the Material
  7728. */
  7729. export class MaterialDefines {
  7730. /** @hidden */
  7731. protected _keys: string[];
  7732. private _isDirty;
  7733. /** @hidden */
  7734. _renderId: number;
  7735. /** @hidden */
  7736. _areLightsDirty: boolean;
  7737. /** @hidden */
  7738. _areLightsDisposed: boolean;
  7739. /** @hidden */
  7740. _areAttributesDirty: boolean;
  7741. /** @hidden */
  7742. _areTexturesDirty: boolean;
  7743. /** @hidden */
  7744. _areFresnelDirty: boolean;
  7745. /** @hidden */
  7746. _areMiscDirty: boolean;
  7747. /** @hidden */
  7748. _areImageProcessingDirty: boolean;
  7749. /** @hidden */
  7750. _normals: boolean;
  7751. /** @hidden */
  7752. _uvs: boolean;
  7753. /** @hidden */
  7754. _needNormals: boolean;
  7755. /** @hidden */
  7756. _needUVs: boolean;
  7757. [id: string]: any;
  7758. /**
  7759. * Specifies if the material needs to be re-calculated
  7760. */
  7761. readonly isDirty: boolean;
  7762. /**
  7763. * Marks the material to indicate that it has been re-calculated
  7764. */
  7765. markAsProcessed(): void;
  7766. /**
  7767. * Marks the material to indicate that it needs to be re-calculated
  7768. */
  7769. markAsUnprocessed(): void;
  7770. /**
  7771. * Marks the material to indicate all of its defines need to be re-calculated
  7772. */
  7773. markAllAsDirty(): void;
  7774. /**
  7775. * Marks the material to indicate that image processing needs to be re-calculated
  7776. */
  7777. markAsImageProcessingDirty(): void;
  7778. /**
  7779. * Marks the material to indicate the lights need to be re-calculated
  7780. * @param disposed Defines whether the light is dirty due to dispose or not
  7781. */
  7782. markAsLightDirty(disposed?: boolean): void;
  7783. /**
  7784. * Marks the attribute state as changed
  7785. */
  7786. markAsAttributesDirty(): void;
  7787. /**
  7788. * Marks the texture state as changed
  7789. */
  7790. markAsTexturesDirty(): void;
  7791. /**
  7792. * Marks the fresnel state as changed
  7793. */
  7794. markAsFresnelDirty(): void;
  7795. /**
  7796. * Marks the misc state as changed
  7797. */
  7798. markAsMiscDirty(): void;
  7799. /**
  7800. * Rebuilds the material defines
  7801. */
  7802. rebuild(): void;
  7803. /**
  7804. * Specifies if two material defines are equal
  7805. * @param other - A material define instance to compare to
  7806. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  7807. */
  7808. isEqual(other: MaterialDefines): boolean;
  7809. /**
  7810. * Clones this instance's defines to another instance
  7811. * @param other - material defines to clone values to
  7812. */
  7813. cloneTo(other: MaterialDefines): void;
  7814. /**
  7815. * Resets the material define values
  7816. */
  7817. reset(): void;
  7818. /**
  7819. * Converts the material define values to a string
  7820. * @returns - String of material define information
  7821. */
  7822. toString(): string;
  7823. }
  7824. }
  7825. declare module "babylonjs/Materials/colorCurves" {
  7826. import { Effect } from "babylonjs/Materials/effect";
  7827. /**
  7828. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  7829. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  7830. * 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;
  7831. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  7832. */
  7833. export class ColorCurves {
  7834. private _dirty;
  7835. private _tempColor;
  7836. private _globalCurve;
  7837. private _highlightsCurve;
  7838. private _midtonesCurve;
  7839. private _shadowsCurve;
  7840. private _positiveCurve;
  7841. private _negativeCurve;
  7842. private _globalHue;
  7843. private _globalDensity;
  7844. private _globalSaturation;
  7845. private _globalExposure;
  7846. /**
  7847. * Gets the global Hue value.
  7848. * 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).
  7849. */
  7850. /**
  7851. * Sets the global Hue value.
  7852. * 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).
  7853. */
  7854. globalHue: number;
  7855. /**
  7856. * Gets the global Density value.
  7857. * 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.
  7858. * Values less than zero provide a filter of opposite hue.
  7859. */
  7860. /**
  7861. * Sets the global Density value.
  7862. * 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.
  7863. * Values less than zero provide a filter of opposite hue.
  7864. */
  7865. globalDensity: number;
  7866. /**
  7867. * Gets the global Saturation value.
  7868. * 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.
  7869. */
  7870. /**
  7871. * Sets the global Saturation value.
  7872. * 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.
  7873. */
  7874. globalSaturation: number;
  7875. /**
  7876. * Gets the global Exposure value.
  7877. * 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.
  7878. */
  7879. /**
  7880. * Sets the global Exposure value.
  7881. * 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.
  7882. */
  7883. globalExposure: number;
  7884. private _highlightsHue;
  7885. private _highlightsDensity;
  7886. private _highlightsSaturation;
  7887. private _highlightsExposure;
  7888. /**
  7889. * Gets the highlights Hue value.
  7890. * 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).
  7891. */
  7892. /**
  7893. * Sets the highlights Hue value.
  7894. * 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).
  7895. */
  7896. highlightsHue: number;
  7897. /**
  7898. * Gets the highlights Density value.
  7899. * 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.
  7900. * Values less than zero provide a filter of opposite hue.
  7901. */
  7902. /**
  7903. * Sets the highlights Density value.
  7904. * 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.
  7905. * Values less than zero provide a filter of opposite hue.
  7906. */
  7907. highlightsDensity: number;
  7908. /**
  7909. * Gets the highlights Saturation value.
  7910. * 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.
  7911. */
  7912. /**
  7913. * Sets the highlights Saturation value.
  7914. * 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.
  7915. */
  7916. highlightsSaturation: number;
  7917. /**
  7918. * Gets the highlights Exposure value.
  7919. * 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.
  7920. */
  7921. /**
  7922. * Sets the highlights Exposure value.
  7923. * 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.
  7924. */
  7925. highlightsExposure: number;
  7926. private _midtonesHue;
  7927. private _midtonesDensity;
  7928. private _midtonesSaturation;
  7929. private _midtonesExposure;
  7930. /**
  7931. * Gets the midtones Hue value.
  7932. * 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).
  7933. */
  7934. /**
  7935. * Sets the midtones Hue value.
  7936. * 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).
  7937. */
  7938. midtonesHue: number;
  7939. /**
  7940. * Gets the midtones Density value.
  7941. * 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.
  7942. * Values less than zero provide a filter of opposite hue.
  7943. */
  7944. /**
  7945. * Sets the midtones Density value.
  7946. * 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.
  7947. * Values less than zero provide a filter of opposite hue.
  7948. */
  7949. midtonesDensity: number;
  7950. /**
  7951. * Gets the midtones Saturation value.
  7952. * 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.
  7953. */
  7954. /**
  7955. * Sets the midtones Saturation value.
  7956. * 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.
  7957. */
  7958. midtonesSaturation: number;
  7959. /**
  7960. * Gets the midtones Exposure value.
  7961. * 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.
  7962. */
  7963. /**
  7964. * Sets the midtones Exposure value.
  7965. * 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.
  7966. */
  7967. midtonesExposure: number;
  7968. private _shadowsHue;
  7969. private _shadowsDensity;
  7970. private _shadowsSaturation;
  7971. private _shadowsExposure;
  7972. /**
  7973. * Gets the shadows Hue value.
  7974. * 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).
  7975. */
  7976. /**
  7977. * Sets the shadows Hue value.
  7978. * 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).
  7979. */
  7980. shadowsHue: number;
  7981. /**
  7982. * Gets the shadows Density value.
  7983. * 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.
  7984. * Values less than zero provide a filter of opposite hue.
  7985. */
  7986. /**
  7987. * Sets the shadows Density value.
  7988. * 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.
  7989. * Values less than zero provide a filter of opposite hue.
  7990. */
  7991. shadowsDensity: number;
  7992. /**
  7993. * Gets the shadows Saturation value.
  7994. * 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.
  7995. */
  7996. /**
  7997. * Sets the shadows Saturation value.
  7998. * 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.
  7999. */
  8000. shadowsSaturation: number;
  8001. /**
  8002. * Gets the shadows Exposure value.
  8003. * 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.
  8004. */
  8005. /**
  8006. * Sets the shadows Exposure value.
  8007. * 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.
  8008. */
  8009. shadowsExposure: number;
  8010. /**
  8011. * Returns the class name
  8012. * @returns The class name
  8013. */
  8014. getClassName(): string;
  8015. /**
  8016. * Binds the color curves to the shader.
  8017. * @param colorCurves The color curve to bind
  8018. * @param effect The effect to bind to
  8019. * @param positiveUniform The positive uniform shader parameter
  8020. * @param neutralUniform The neutral uniform shader parameter
  8021. * @param negativeUniform The negative uniform shader parameter
  8022. */
  8023. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8024. /**
  8025. * Prepare the list of uniforms associated with the ColorCurves effects.
  8026. * @param uniformsList The list of uniforms used in the effect
  8027. */
  8028. static PrepareUniforms(uniformsList: string[]): void;
  8029. /**
  8030. * Returns color grading data based on a hue, density, saturation and exposure value.
  8031. * @param filterHue The hue of the color filter.
  8032. * @param filterDensity The density of the color filter.
  8033. * @param saturation The saturation.
  8034. * @param exposure The exposure.
  8035. * @param result The result data container.
  8036. */
  8037. private getColorGradingDataToRef;
  8038. /**
  8039. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8040. * @param value The input slider value in range [-100,100].
  8041. * @returns Adjusted value.
  8042. */
  8043. private static applyColorGradingSliderNonlinear;
  8044. /**
  8045. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8046. * @param hue The hue (H) input.
  8047. * @param saturation The saturation (S) input.
  8048. * @param brightness The brightness (B) input.
  8049. * @result An RGBA color represented as Vector4.
  8050. */
  8051. private static fromHSBToRef;
  8052. /**
  8053. * Returns a value clamped between min and max
  8054. * @param value The value to clamp
  8055. * @param min The minimum of value
  8056. * @param max The maximum of value
  8057. * @returns The clamped value.
  8058. */
  8059. private static clamp;
  8060. /**
  8061. * Clones the current color curve instance.
  8062. * @return The cloned curves
  8063. */
  8064. clone(): ColorCurves;
  8065. /**
  8066. * Serializes the current color curve instance to a json representation.
  8067. * @return a JSON representation
  8068. */
  8069. serialize(): any;
  8070. /**
  8071. * Parses the color curve from a json representation.
  8072. * @param source the JSON source to parse
  8073. * @return The parsed curves
  8074. */
  8075. static Parse(source: any): ColorCurves;
  8076. }
  8077. }
  8078. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8079. import { Observable } from "babylonjs/Misc/observable";
  8080. import { Nullable } from "babylonjs/types";
  8081. import { Color4 } from "babylonjs/Maths/math.color";
  8082. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8083. import { Effect } from "babylonjs/Materials/effect";
  8084. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8085. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8086. /**
  8087. * Interface to follow in your material defines to integrate easily the
  8088. * Image proccessing functions.
  8089. * @hidden
  8090. */
  8091. export interface IImageProcessingConfigurationDefines {
  8092. IMAGEPROCESSING: boolean;
  8093. VIGNETTE: boolean;
  8094. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8095. VIGNETTEBLENDMODEOPAQUE: boolean;
  8096. TONEMAPPING: boolean;
  8097. TONEMAPPING_ACES: boolean;
  8098. CONTRAST: boolean;
  8099. EXPOSURE: boolean;
  8100. COLORCURVES: boolean;
  8101. COLORGRADING: boolean;
  8102. COLORGRADING3D: boolean;
  8103. SAMPLER3DGREENDEPTH: boolean;
  8104. SAMPLER3DBGRMAP: boolean;
  8105. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8106. }
  8107. /**
  8108. * @hidden
  8109. */
  8110. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8111. IMAGEPROCESSING: boolean;
  8112. VIGNETTE: boolean;
  8113. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8114. VIGNETTEBLENDMODEOPAQUE: boolean;
  8115. TONEMAPPING: boolean;
  8116. TONEMAPPING_ACES: boolean;
  8117. CONTRAST: boolean;
  8118. COLORCURVES: boolean;
  8119. COLORGRADING: boolean;
  8120. COLORGRADING3D: boolean;
  8121. SAMPLER3DGREENDEPTH: boolean;
  8122. SAMPLER3DBGRMAP: boolean;
  8123. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8124. EXPOSURE: boolean;
  8125. constructor();
  8126. }
  8127. /**
  8128. * This groups together the common properties used for image processing either in direct forward pass
  8129. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8130. * or not.
  8131. */
  8132. export class ImageProcessingConfiguration {
  8133. /**
  8134. * Default tone mapping applied in BabylonJS.
  8135. */
  8136. static readonly TONEMAPPING_STANDARD: number;
  8137. /**
  8138. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8139. * to other engines rendering to increase portability.
  8140. */
  8141. static readonly TONEMAPPING_ACES: number;
  8142. /**
  8143. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8144. */
  8145. colorCurves: Nullable<ColorCurves>;
  8146. private _colorCurvesEnabled;
  8147. /**
  8148. * Gets wether the color curves effect is enabled.
  8149. */
  8150. /**
  8151. * Sets wether the color curves effect is enabled.
  8152. */
  8153. colorCurvesEnabled: boolean;
  8154. private _colorGradingTexture;
  8155. /**
  8156. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8157. */
  8158. /**
  8159. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8160. */
  8161. colorGradingTexture: Nullable<BaseTexture>;
  8162. private _colorGradingEnabled;
  8163. /**
  8164. * Gets wether the color grading effect is enabled.
  8165. */
  8166. /**
  8167. * Sets wether the color grading effect is enabled.
  8168. */
  8169. colorGradingEnabled: boolean;
  8170. private _colorGradingWithGreenDepth;
  8171. /**
  8172. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8173. */
  8174. /**
  8175. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8176. */
  8177. colorGradingWithGreenDepth: boolean;
  8178. private _colorGradingBGR;
  8179. /**
  8180. * Gets wether the color grading texture contains BGR values.
  8181. */
  8182. /**
  8183. * Sets wether the color grading texture contains BGR values.
  8184. */
  8185. colorGradingBGR: boolean;
  8186. /** @hidden */
  8187. _exposure: number;
  8188. /**
  8189. * Gets the Exposure used in the effect.
  8190. */
  8191. /**
  8192. * Sets the Exposure used in the effect.
  8193. */
  8194. exposure: number;
  8195. private _toneMappingEnabled;
  8196. /**
  8197. * Gets wether the tone mapping effect is enabled.
  8198. */
  8199. /**
  8200. * Sets wether the tone mapping effect is enabled.
  8201. */
  8202. toneMappingEnabled: boolean;
  8203. private _toneMappingType;
  8204. /**
  8205. * Gets the type of tone mapping effect.
  8206. */
  8207. /**
  8208. * Sets the type of tone mapping effect used in BabylonJS.
  8209. */
  8210. toneMappingType: number;
  8211. protected _contrast: number;
  8212. /**
  8213. * Gets the contrast used in the effect.
  8214. */
  8215. /**
  8216. * Sets the contrast used in the effect.
  8217. */
  8218. contrast: number;
  8219. /**
  8220. * Vignette stretch size.
  8221. */
  8222. vignetteStretch: number;
  8223. /**
  8224. * Vignette centre X Offset.
  8225. */
  8226. vignetteCentreX: number;
  8227. /**
  8228. * Vignette centre Y Offset.
  8229. */
  8230. vignetteCentreY: number;
  8231. /**
  8232. * Vignette weight or intensity of the vignette effect.
  8233. */
  8234. vignetteWeight: number;
  8235. /**
  8236. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8237. * if vignetteEnabled is set to true.
  8238. */
  8239. vignetteColor: Color4;
  8240. /**
  8241. * Camera field of view used by the Vignette effect.
  8242. */
  8243. vignetteCameraFov: number;
  8244. private _vignetteBlendMode;
  8245. /**
  8246. * Gets the vignette blend mode allowing different kind of effect.
  8247. */
  8248. /**
  8249. * Sets the vignette blend mode allowing different kind of effect.
  8250. */
  8251. vignetteBlendMode: number;
  8252. private _vignetteEnabled;
  8253. /**
  8254. * Gets wether the vignette effect is enabled.
  8255. */
  8256. /**
  8257. * Sets wether the vignette effect is enabled.
  8258. */
  8259. vignetteEnabled: boolean;
  8260. private _applyByPostProcess;
  8261. /**
  8262. * Gets wether the image processing is applied through a post process or not.
  8263. */
  8264. /**
  8265. * Sets wether the image processing is applied through a post process or not.
  8266. */
  8267. applyByPostProcess: boolean;
  8268. private _isEnabled;
  8269. /**
  8270. * Gets wether the image processing is enabled or not.
  8271. */
  8272. /**
  8273. * Sets wether the image processing is enabled or not.
  8274. */
  8275. isEnabled: boolean;
  8276. /**
  8277. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8278. */
  8279. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8280. /**
  8281. * Method called each time the image processing information changes requires to recompile the effect.
  8282. */
  8283. protected _updateParameters(): void;
  8284. /**
  8285. * Gets the current class name.
  8286. * @return "ImageProcessingConfiguration"
  8287. */
  8288. getClassName(): string;
  8289. /**
  8290. * Prepare the list of uniforms associated with the Image Processing effects.
  8291. * @param uniforms The list of uniforms used in the effect
  8292. * @param defines the list of defines currently in use
  8293. */
  8294. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8295. /**
  8296. * Prepare the list of samplers associated with the Image Processing effects.
  8297. * @param samplersList The list of uniforms used in the effect
  8298. * @param defines the list of defines currently in use
  8299. */
  8300. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8301. /**
  8302. * Prepare the list of defines associated to the shader.
  8303. * @param defines the list of defines to complete
  8304. * @param forPostProcess Define if we are currently in post process mode or not
  8305. */
  8306. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8307. /**
  8308. * Returns true if all the image processing information are ready.
  8309. * @returns True if ready, otherwise, false
  8310. */
  8311. isReady(): boolean;
  8312. /**
  8313. * Binds the image processing to the shader.
  8314. * @param effect The effect to bind to
  8315. * @param overrideAspectRatio Override the aspect ratio of the effect
  8316. */
  8317. bind(effect: Effect, overrideAspectRatio?: number): void;
  8318. /**
  8319. * Clones the current image processing instance.
  8320. * @return The cloned image processing
  8321. */
  8322. clone(): ImageProcessingConfiguration;
  8323. /**
  8324. * Serializes the current image processing instance to a json representation.
  8325. * @return a JSON representation
  8326. */
  8327. serialize(): any;
  8328. /**
  8329. * Parses the image processing from a json representation.
  8330. * @param source the JSON source to parse
  8331. * @return The parsed image processing
  8332. */
  8333. static Parse(source: any): ImageProcessingConfiguration;
  8334. private static _VIGNETTEMODE_MULTIPLY;
  8335. private static _VIGNETTEMODE_OPAQUE;
  8336. /**
  8337. * Used to apply the vignette as a mix with the pixel color.
  8338. */
  8339. static readonly VIGNETTEMODE_MULTIPLY: number;
  8340. /**
  8341. * Used to apply the vignette as a replacement of the pixel color.
  8342. */
  8343. static readonly VIGNETTEMODE_OPAQUE: number;
  8344. }
  8345. }
  8346. declare module "babylonjs/Shaders/postprocess.vertex" {
  8347. /** @hidden */
  8348. export var postprocessVertexShader: {
  8349. name: string;
  8350. shader: string;
  8351. };
  8352. }
  8353. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8354. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8355. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8356. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8357. module "babylonjs/Engines/thinEngine" {
  8358. interface ThinEngine {
  8359. /**
  8360. * Creates a new render target texture
  8361. * @param size defines the size of the texture
  8362. * @param options defines the options used to create the texture
  8363. * @returns a new render target texture stored in an InternalTexture
  8364. */
  8365. createRenderTargetTexture(size: number | {
  8366. width: number;
  8367. height: number;
  8368. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8369. /**
  8370. * Creates a depth stencil texture.
  8371. * This is only available in WebGL 2 or with the depth texture extension available.
  8372. * @param size The size of face edge in the texture.
  8373. * @param options The options defining the texture.
  8374. * @returns The texture
  8375. */
  8376. createDepthStencilTexture(size: number | {
  8377. width: number;
  8378. height: number;
  8379. }, options: DepthTextureCreationOptions): InternalTexture;
  8380. /** @hidden */
  8381. _createDepthStencilTexture(size: number | {
  8382. width: number;
  8383. height: number;
  8384. }, options: DepthTextureCreationOptions): InternalTexture;
  8385. }
  8386. }
  8387. }
  8388. declare module "babylonjs/Maths/math.axis" {
  8389. import { Vector3 } from "babylonjs/Maths/math.vector";
  8390. /** Defines supported spaces */
  8391. export enum Space {
  8392. /** Local (object) space */
  8393. LOCAL = 0,
  8394. /** World space */
  8395. WORLD = 1,
  8396. /** Bone space */
  8397. BONE = 2
  8398. }
  8399. /** Defines the 3 main axes */
  8400. export class Axis {
  8401. /** X axis */
  8402. static X: Vector3;
  8403. /** Y axis */
  8404. static Y: Vector3;
  8405. /** Z axis */
  8406. static Z: Vector3;
  8407. }
  8408. }
  8409. declare module "babylonjs/Cameras/targetCamera" {
  8410. import { Nullable } from "babylonjs/types";
  8411. import { Camera } from "babylonjs/Cameras/camera";
  8412. import { Scene } from "babylonjs/scene";
  8413. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8414. /**
  8415. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  8416. * This is the base of the follow, arc rotate cameras and Free camera
  8417. * @see http://doc.babylonjs.com/features/cameras
  8418. */
  8419. export class TargetCamera extends Camera {
  8420. private static _RigCamTransformMatrix;
  8421. private static _TargetTransformMatrix;
  8422. private static _TargetFocalPoint;
  8423. /**
  8424. * Define the current direction the camera is moving to
  8425. */
  8426. cameraDirection: Vector3;
  8427. /**
  8428. * Define the current rotation the camera is rotating to
  8429. */
  8430. cameraRotation: Vector2;
  8431. /**
  8432. * When set, the up vector of the camera will be updated by the rotation of the camera
  8433. */
  8434. updateUpVectorFromRotation: boolean;
  8435. private _tmpQuaternion;
  8436. /**
  8437. * Define the current rotation of the camera
  8438. */
  8439. rotation: Vector3;
  8440. /**
  8441. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  8442. */
  8443. rotationQuaternion: Quaternion;
  8444. /**
  8445. * Define the current speed of the camera
  8446. */
  8447. speed: number;
  8448. /**
  8449. * Add cconstraint to the camera to prevent it to move freely in all directions and
  8450. * around all axis.
  8451. */
  8452. noRotationConstraint: boolean;
  8453. /**
  8454. * Define the current target of the camera as an object or a position.
  8455. */
  8456. lockedTarget: any;
  8457. /** @hidden */
  8458. _currentTarget: Vector3;
  8459. /** @hidden */
  8460. _initialFocalDistance: number;
  8461. /** @hidden */
  8462. _viewMatrix: Matrix;
  8463. /** @hidden */
  8464. _camMatrix: Matrix;
  8465. /** @hidden */
  8466. _cameraTransformMatrix: Matrix;
  8467. /** @hidden */
  8468. _cameraRotationMatrix: Matrix;
  8469. /** @hidden */
  8470. _referencePoint: Vector3;
  8471. /** @hidden */
  8472. _transformedReferencePoint: Vector3;
  8473. protected _globalCurrentTarget: Vector3;
  8474. protected _globalCurrentUpVector: Vector3;
  8475. /** @hidden */
  8476. _reset: () => void;
  8477. private _defaultUp;
  8478. /**
  8479. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  8480. * This is the base of the follow, arc rotate cameras and Free camera
  8481. * @see http://doc.babylonjs.com/features/cameras
  8482. * @param name Defines the name of the camera in the scene
  8483. * @param position Defines the start position of the camera in the scene
  8484. * @param scene Defines the scene the camera belongs to
  8485. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  8486. */
  8487. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  8488. /**
  8489. * Gets the position in front of the camera at a given distance.
  8490. * @param distance The distance from the camera we want the position to be
  8491. * @returns the position
  8492. */
  8493. getFrontPosition(distance: number): Vector3;
  8494. /** @hidden */
  8495. _getLockedTargetPosition(): Nullable<Vector3>;
  8496. private _storedPosition;
  8497. private _storedRotation;
  8498. private _storedRotationQuaternion;
  8499. /**
  8500. * Store current camera state of the camera (fov, position, rotation, etc..)
  8501. * @returns the camera
  8502. */
  8503. storeState(): Camera;
  8504. /**
  8505. * Restored camera state. You must call storeState() first
  8506. * @returns whether it was successful or not
  8507. * @hidden
  8508. */
  8509. _restoreStateValues(): boolean;
  8510. /** @hidden */
  8511. _initCache(): void;
  8512. /** @hidden */
  8513. _updateCache(ignoreParentClass?: boolean): void;
  8514. /** @hidden */
  8515. _isSynchronizedViewMatrix(): boolean;
  8516. /** @hidden */
  8517. _computeLocalCameraSpeed(): number;
  8518. /**
  8519. * Defines the target the camera should look at.
  8520. * @param target Defines the new target as a Vector or a mesh
  8521. */
  8522. setTarget(target: Vector3): void;
  8523. /**
  8524. * Return the current target position of the camera. This value is expressed in local space.
  8525. * @returns the target position
  8526. */
  8527. getTarget(): Vector3;
  8528. /** @hidden */
  8529. _decideIfNeedsToMove(): boolean;
  8530. /** @hidden */
  8531. _updatePosition(): void;
  8532. /** @hidden */
  8533. _checkInputs(): void;
  8534. protected _updateCameraRotationMatrix(): void;
  8535. /**
  8536. * 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)
  8537. * @returns the current camera
  8538. */
  8539. private _rotateUpVectorWithCameraRotationMatrix;
  8540. private _cachedRotationZ;
  8541. private _cachedQuaternionRotationZ;
  8542. /** @hidden */
  8543. _getViewMatrix(): Matrix;
  8544. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  8545. /**
  8546. * @hidden
  8547. */
  8548. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  8549. /**
  8550. * @hidden
  8551. */
  8552. _updateRigCameras(): void;
  8553. private _getRigCamPositionAndTarget;
  8554. /**
  8555. * Gets the current object class name.
  8556. * @return the class name
  8557. */
  8558. getClassName(): string;
  8559. }
  8560. }
  8561. declare module "babylonjs/Events/keyboardEvents" {
  8562. /**
  8563. * Gather the list of keyboard event types as constants.
  8564. */
  8565. export class KeyboardEventTypes {
  8566. /**
  8567. * The keydown event is fired when a key becomes active (pressed).
  8568. */
  8569. static readonly KEYDOWN: number;
  8570. /**
  8571. * The keyup event is fired when a key has been released.
  8572. */
  8573. static readonly KEYUP: number;
  8574. }
  8575. /**
  8576. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8577. */
  8578. export class KeyboardInfo {
  8579. /**
  8580. * Defines the type of event (KeyboardEventTypes)
  8581. */
  8582. type: number;
  8583. /**
  8584. * Defines the related dom event
  8585. */
  8586. event: KeyboardEvent;
  8587. /**
  8588. * Instantiates a new keyboard info.
  8589. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8590. * @param type Defines the type of event (KeyboardEventTypes)
  8591. * @param event Defines the related dom event
  8592. */
  8593. constructor(
  8594. /**
  8595. * Defines the type of event (KeyboardEventTypes)
  8596. */
  8597. type: number,
  8598. /**
  8599. * Defines the related dom event
  8600. */
  8601. event: KeyboardEvent);
  8602. }
  8603. /**
  8604. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8605. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  8606. */
  8607. export class KeyboardInfoPre extends KeyboardInfo {
  8608. /**
  8609. * Defines the type of event (KeyboardEventTypes)
  8610. */
  8611. type: number;
  8612. /**
  8613. * Defines the related dom event
  8614. */
  8615. event: KeyboardEvent;
  8616. /**
  8617. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  8618. */
  8619. skipOnPointerObservable: boolean;
  8620. /**
  8621. * Instantiates a new keyboard pre info.
  8622. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8623. * @param type Defines the type of event (KeyboardEventTypes)
  8624. * @param event Defines the related dom event
  8625. */
  8626. constructor(
  8627. /**
  8628. * Defines the type of event (KeyboardEventTypes)
  8629. */
  8630. type: number,
  8631. /**
  8632. * Defines the related dom event
  8633. */
  8634. event: KeyboardEvent);
  8635. }
  8636. }
  8637. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  8638. import { Nullable } from "babylonjs/types";
  8639. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  8640. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  8641. /**
  8642. * Manage the keyboard inputs to control the movement of a free camera.
  8643. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  8644. */
  8645. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  8646. /**
  8647. * Defines the camera the input is attached to.
  8648. */
  8649. camera: FreeCamera;
  8650. /**
  8651. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  8652. */
  8653. keysUp: number[];
  8654. /**
  8655. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  8656. */
  8657. keysDown: number[];
  8658. /**
  8659. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  8660. */
  8661. keysLeft: number[];
  8662. /**
  8663. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  8664. */
  8665. keysRight: number[];
  8666. private _keys;
  8667. private _onCanvasBlurObserver;
  8668. private _onKeyboardObserver;
  8669. private _engine;
  8670. private _scene;
  8671. /**
  8672. * Attach the input controls to a specific dom element to get the input from.
  8673. * @param element Defines the element the controls should be listened from
  8674. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  8675. */
  8676. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  8677. /**
  8678. * Detach the current controls from the specified dom element.
  8679. * @param element Defines the element to stop listening the inputs from
  8680. */
  8681. detachControl(element: Nullable<HTMLElement>): void;
  8682. /**
  8683. * Update the current camera state depending on the inputs that have been used this frame.
  8684. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  8685. */
  8686. checkInputs(): void;
  8687. /**
  8688. * Gets the class name of the current intput.
  8689. * @returns the class name
  8690. */
  8691. getClassName(): string;
  8692. /** @hidden */
  8693. _onLostFocus(): void;
  8694. /**
  8695. * Get the friendly name associated with the input class.
  8696. * @returns the input friendly name
  8697. */
  8698. getSimpleName(): string;
  8699. }
  8700. }
  8701. declare module "babylonjs/Lights/shadowLight" {
  8702. import { Camera } from "babylonjs/Cameras/camera";
  8703. import { Scene } from "babylonjs/scene";
  8704. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  8705. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8706. import { Light } from "babylonjs/Lights/light";
  8707. /**
  8708. * Interface describing all the common properties and methods a shadow light needs to implement.
  8709. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  8710. * as well as binding the different shadow properties to the effects.
  8711. */
  8712. export interface IShadowLight extends Light {
  8713. /**
  8714. * The light id in the scene (used in scene.findLighById for instance)
  8715. */
  8716. id: string;
  8717. /**
  8718. * The position the shdow will be casted from.
  8719. */
  8720. position: Vector3;
  8721. /**
  8722. * In 2d mode (needCube being false), the direction used to cast the shadow.
  8723. */
  8724. direction: Vector3;
  8725. /**
  8726. * The transformed position. Position of the light in world space taking parenting in account.
  8727. */
  8728. transformedPosition: Vector3;
  8729. /**
  8730. * The transformed direction. Direction of the light in world space taking parenting in account.
  8731. */
  8732. transformedDirection: Vector3;
  8733. /**
  8734. * The friendly name of the light in the scene.
  8735. */
  8736. name: string;
  8737. /**
  8738. * Defines the shadow projection clipping minimum z value.
  8739. */
  8740. shadowMinZ: number;
  8741. /**
  8742. * Defines the shadow projection clipping maximum z value.
  8743. */
  8744. shadowMaxZ: number;
  8745. /**
  8746. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8747. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8748. */
  8749. computeTransformedInformation(): boolean;
  8750. /**
  8751. * Gets the scene the light belongs to.
  8752. * @returns The scene
  8753. */
  8754. getScene(): Scene;
  8755. /**
  8756. * Callback defining a custom Projection Matrix Builder.
  8757. * This can be used to override the default projection matrix computation.
  8758. */
  8759. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8760. /**
  8761. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8762. * @param matrix The materix to updated with the projection information
  8763. * @param viewMatrix The transform matrix of the light
  8764. * @param renderList The list of mesh to render in the map
  8765. * @returns The current light
  8766. */
  8767. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8768. /**
  8769. * Gets the current depth scale used in ESM.
  8770. * @returns The scale
  8771. */
  8772. getDepthScale(): number;
  8773. /**
  8774. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8775. * @returns true if a cube texture needs to be use
  8776. */
  8777. needCube(): boolean;
  8778. /**
  8779. * Detects if the projection matrix requires to be recomputed this frame.
  8780. * @returns true if it requires to be recomputed otherwise, false.
  8781. */
  8782. needProjectionMatrixCompute(): boolean;
  8783. /**
  8784. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8785. */
  8786. forceProjectionMatrixCompute(): void;
  8787. /**
  8788. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8789. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8790. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8791. */
  8792. getShadowDirection(faceIndex?: number): Vector3;
  8793. /**
  8794. * Gets the minZ used for shadow according to both the scene and the light.
  8795. * @param activeCamera The camera we are returning the min for
  8796. * @returns the depth min z
  8797. */
  8798. getDepthMinZ(activeCamera: Camera): number;
  8799. /**
  8800. * Gets the maxZ used for shadow according to both the scene and the light.
  8801. * @param activeCamera The camera we are returning the max for
  8802. * @returns the depth max z
  8803. */
  8804. getDepthMaxZ(activeCamera: Camera): number;
  8805. }
  8806. /**
  8807. * Base implementation IShadowLight
  8808. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  8809. */
  8810. export abstract class ShadowLight extends Light implements IShadowLight {
  8811. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  8812. protected _position: Vector3;
  8813. protected _setPosition(value: Vector3): void;
  8814. /**
  8815. * Sets the position the shadow will be casted from. Also use as the light position for both
  8816. * point and spot lights.
  8817. */
  8818. /**
  8819. * Sets the position the shadow will be casted from. Also use as the light position for both
  8820. * point and spot lights.
  8821. */
  8822. position: Vector3;
  8823. protected _direction: Vector3;
  8824. protected _setDirection(value: Vector3): void;
  8825. /**
  8826. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  8827. * Also use as the light direction on spot and directional lights.
  8828. */
  8829. /**
  8830. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  8831. * Also use as the light direction on spot and directional lights.
  8832. */
  8833. direction: Vector3;
  8834. private _shadowMinZ;
  8835. /**
  8836. * Gets the shadow projection clipping minimum z value.
  8837. */
  8838. /**
  8839. * Sets the shadow projection clipping minimum z value.
  8840. */
  8841. shadowMinZ: number;
  8842. private _shadowMaxZ;
  8843. /**
  8844. * Sets the shadow projection clipping maximum z value.
  8845. */
  8846. /**
  8847. * Gets the shadow projection clipping maximum z value.
  8848. */
  8849. shadowMaxZ: number;
  8850. /**
  8851. * Callback defining a custom Projection Matrix Builder.
  8852. * This can be used to override the default projection matrix computation.
  8853. */
  8854. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8855. /**
  8856. * The transformed position. Position of the light in world space taking parenting in account.
  8857. */
  8858. transformedPosition: Vector3;
  8859. /**
  8860. * The transformed direction. Direction of the light in world space taking parenting in account.
  8861. */
  8862. transformedDirection: Vector3;
  8863. private _needProjectionMatrixCompute;
  8864. /**
  8865. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8866. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8867. */
  8868. computeTransformedInformation(): boolean;
  8869. /**
  8870. * Return the depth scale used for the shadow map.
  8871. * @returns the depth scale.
  8872. */
  8873. getDepthScale(): number;
  8874. /**
  8875. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8876. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8877. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8878. */
  8879. getShadowDirection(faceIndex?: number): Vector3;
  8880. /**
  8881. * Returns the ShadowLight absolute position in the World.
  8882. * @returns the position vector in world space
  8883. */
  8884. getAbsolutePosition(): Vector3;
  8885. /**
  8886. * Sets the ShadowLight direction toward the passed target.
  8887. * @param target The point to target in local space
  8888. * @returns the updated ShadowLight direction
  8889. */
  8890. setDirectionToTarget(target: Vector3): Vector3;
  8891. /**
  8892. * Returns the light rotation in euler definition.
  8893. * @returns the x y z rotation in local space.
  8894. */
  8895. getRotation(): Vector3;
  8896. /**
  8897. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8898. * @returns true if a cube texture needs to be use
  8899. */
  8900. needCube(): boolean;
  8901. /**
  8902. * Detects if the projection matrix requires to be recomputed this frame.
  8903. * @returns true if it requires to be recomputed otherwise, false.
  8904. */
  8905. needProjectionMatrixCompute(): boolean;
  8906. /**
  8907. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8908. */
  8909. forceProjectionMatrixCompute(): void;
  8910. /** @hidden */
  8911. _initCache(): void;
  8912. /** @hidden */
  8913. _isSynchronized(): boolean;
  8914. /**
  8915. * Computes the world matrix of the node
  8916. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  8917. * @returns the world matrix
  8918. */
  8919. computeWorldMatrix(force?: boolean): Matrix;
  8920. /**
  8921. * Gets the minZ used for shadow according to both the scene and the light.
  8922. * @param activeCamera The camera we are returning the min for
  8923. * @returns the depth min z
  8924. */
  8925. getDepthMinZ(activeCamera: Camera): number;
  8926. /**
  8927. * Gets the maxZ used for shadow according to both the scene and the light.
  8928. * @param activeCamera The camera we are returning the max for
  8929. * @returns the depth max z
  8930. */
  8931. getDepthMaxZ(activeCamera: Camera): number;
  8932. /**
  8933. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8934. * @param matrix The materix to updated with the projection information
  8935. * @param viewMatrix The transform matrix of the light
  8936. * @param renderList The list of mesh to render in the map
  8937. * @returns The current light
  8938. */
  8939. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8940. }
  8941. }
  8942. declare module "babylonjs/Materials/effectFallbacks" {
  8943. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  8944. import { Effect } from "babylonjs/Materials/effect";
  8945. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8946. /**
  8947. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  8948. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  8949. */
  8950. export class EffectFallbacks implements IEffectFallbacks {
  8951. private _defines;
  8952. private _currentRank;
  8953. private _maxRank;
  8954. private _mesh;
  8955. /**
  8956. * Removes the fallback from the bound mesh.
  8957. */
  8958. unBindMesh(): void;
  8959. /**
  8960. * Adds a fallback on the specified property.
  8961. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  8962. * @param define The name of the define in the shader
  8963. */
  8964. addFallback(rank: number, define: string): void;
  8965. /**
  8966. * Sets the mesh to use CPU skinning when needing to fallback.
  8967. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  8968. * @param mesh The mesh to use the fallbacks.
  8969. */
  8970. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  8971. /**
  8972. * Checks to see if more fallbacks are still availible.
  8973. */
  8974. readonly hasMoreFallbacks: boolean;
  8975. /**
  8976. * Removes the defines that should be removed when falling back.
  8977. * @param currentDefines defines the current define statements for the shader.
  8978. * @param effect defines the current effect we try to compile
  8979. * @returns The resulting defines with defines of the current rank removed.
  8980. */
  8981. reduce(currentDefines: string, effect: Effect): string;
  8982. }
  8983. }
  8984. declare module "babylonjs/Materials/materialHelper" {
  8985. import { Nullable } from "babylonjs/types";
  8986. import { Scene } from "babylonjs/scene";
  8987. import { Engine } from "babylonjs/Engines/engine";
  8988. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8989. import { Light } from "babylonjs/Lights/light";
  8990. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  8991. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  8992. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8993. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8994. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  8995. /**
  8996. * "Static Class" containing the most commonly used helper while dealing with material for
  8997. * rendering purpose.
  8998. *
  8999. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  9000. *
  9001. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  9002. */
  9003. export class MaterialHelper {
  9004. /**
  9005. * Bind the current view position to an effect.
  9006. * @param effect The effect to be bound
  9007. * @param scene The scene the eyes position is used from
  9008. */
  9009. static BindEyePosition(effect: Effect, scene: Scene): void;
  9010. /**
  9011. * Helps preparing the defines values about the UVs in used in the effect.
  9012. * UVs are shared as much as we can accross channels in the shaders.
  9013. * @param texture The texture we are preparing the UVs for
  9014. * @param defines The defines to update
  9015. * @param key The channel key "diffuse", "specular"... used in the shader
  9016. */
  9017. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  9018. /**
  9019. * Binds a texture matrix value to its corrsponding uniform
  9020. * @param texture The texture to bind the matrix for
  9021. * @param uniformBuffer The uniform buffer receivin the data
  9022. * @param key The channel key "diffuse", "specular"... used in the shader
  9023. */
  9024. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  9025. /**
  9026. * Gets the current status of the fog (should it be enabled?)
  9027. * @param mesh defines the mesh to evaluate for fog support
  9028. * @param scene defines the hosting scene
  9029. * @returns true if fog must be enabled
  9030. */
  9031. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  9032. /**
  9033. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  9034. * @param mesh defines the current mesh
  9035. * @param scene defines the current scene
  9036. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  9037. * @param pointsCloud defines if point cloud rendering has to be turned on
  9038. * @param fogEnabled defines if fog has to be turned on
  9039. * @param alphaTest defines if alpha testing has to be turned on
  9040. * @param defines defines the current list of defines
  9041. */
  9042. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  9043. /**
  9044. * Helper used to prepare the list of defines associated with frame values for shader compilation
  9045. * @param scene defines the current scene
  9046. * @param engine defines the current engine
  9047. * @param defines specifies the list of active defines
  9048. * @param useInstances defines if instances have to be turned on
  9049. * @param useClipPlane defines if clip plane have to be turned on
  9050. */
  9051. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  9052. /**
  9053. * Prepares the defines for bones
  9054. * @param mesh The mesh containing the geometry data we will draw
  9055. * @param defines The defines to update
  9056. */
  9057. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  9058. /**
  9059. * Prepares the defines for morph targets
  9060. * @param mesh The mesh containing the geometry data we will draw
  9061. * @param defines The defines to update
  9062. */
  9063. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  9064. /**
  9065. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  9066. * @param mesh The mesh containing the geometry data we will draw
  9067. * @param defines The defines to update
  9068. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  9069. * @param useBones Precise whether bones should be used or not (override mesh info)
  9070. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  9071. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  9072. * @returns false if defines are considered not dirty and have not been checked
  9073. */
  9074. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  9075. /**
  9076. * Prepares the defines related to multiview
  9077. * @param scene The scene we are intending to draw
  9078. * @param defines The defines to update
  9079. */
  9080. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  9081. /**
  9082. * Prepares the defines related to the light information passed in parameter
  9083. * @param scene The scene we are intending to draw
  9084. * @param mesh The mesh the effect is compiling for
  9085. * @param light The light the effect is compiling for
  9086. * @param lightIndex The index of the light
  9087. * @param defines The defines to update
  9088. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  9089. * @param state Defines the current state regarding what is needed (normals, etc...)
  9090. */
  9091. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  9092. needNormals: boolean;
  9093. needRebuild: boolean;
  9094. shadowEnabled: boolean;
  9095. specularEnabled: boolean;
  9096. lightmapMode: boolean;
  9097. }): void;
  9098. /**
  9099. * Prepares the defines related to the light information passed in parameter
  9100. * @param scene The scene we are intending to draw
  9101. * @param mesh The mesh the effect is compiling for
  9102. * @param defines The defines to update
  9103. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  9104. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  9105. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  9106. * @returns true if normals will be required for the rest of the effect
  9107. */
  9108. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  9109. /**
  9110. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  9111. * @param lightIndex defines the light index
  9112. * @param uniformsList The uniform list
  9113. * @param samplersList The sampler list
  9114. * @param projectedLightTexture defines if projected texture must be used
  9115. * @param uniformBuffersList defines an optional list of uniform buffers
  9116. */
  9117. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  9118. /**
  9119. * Prepares the uniforms and samplers list to be used in the effect
  9120. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  9121. * @param samplersList The sampler list
  9122. * @param defines The defines helping in the list generation
  9123. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  9124. */
  9125. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  9126. /**
  9127. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  9128. * @param defines The defines to update while falling back
  9129. * @param fallbacks The authorized effect fallbacks
  9130. * @param maxSimultaneousLights The maximum number of lights allowed
  9131. * @param rank the current rank of the Effect
  9132. * @returns The newly affected rank
  9133. */
  9134. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  9135. private static _TmpMorphInfluencers;
  9136. /**
  9137. * Prepares the list of attributes required for morph targets according to the effect defines.
  9138. * @param attribs The current list of supported attribs
  9139. * @param mesh The mesh to prepare the morph targets attributes for
  9140. * @param influencers The number of influencers
  9141. */
  9142. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  9143. /**
  9144. * Prepares the list of attributes required for morph targets according to the effect defines.
  9145. * @param attribs The current list of supported attribs
  9146. * @param mesh The mesh to prepare the morph targets attributes for
  9147. * @param defines The current Defines of the effect
  9148. */
  9149. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  9150. /**
  9151. * Prepares the list of attributes required for bones according to the effect defines.
  9152. * @param attribs The current list of supported attribs
  9153. * @param mesh The mesh to prepare the bones attributes for
  9154. * @param defines The current Defines of the effect
  9155. * @param fallbacks The current efffect fallback strategy
  9156. */
  9157. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  9158. /**
  9159. * Check and prepare the list of attributes required for instances according to the effect defines.
  9160. * @param attribs The current list of supported attribs
  9161. * @param defines The current MaterialDefines of the effect
  9162. */
  9163. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  9164. /**
  9165. * Add the list of attributes required for instances to the attribs array.
  9166. * @param attribs The current list of supported attribs
  9167. */
  9168. static PushAttributesForInstances(attribs: string[]): void;
  9169. /**
  9170. * Binds the light information to the effect.
  9171. * @param light The light containing the generator
  9172. * @param effect The effect we are binding the data to
  9173. * @param lightIndex The light index in the effect used to render
  9174. */
  9175. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  9176. /**
  9177. * Binds the lights information from the scene to the effect for the given mesh.
  9178. * @param light Light to bind
  9179. * @param lightIndex Light index
  9180. * @param scene The scene where the light belongs to
  9181. * @param effect The effect we are binding the data to
  9182. * @param useSpecular Defines if specular is supported
  9183. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9184. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9185. */
  9186. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9187. /**
  9188. * Binds the lights information from the scene to the effect for the given mesh.
  9189. * @param scene The scene the lights belongs to
  9190. * @param mesh The mesh we are binding the information to render
  9191. * @param effect The effect we are binding the data to
  9192. * @param defines The generated defines for the effect
  9193. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  9194. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9195. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9196. */
  9197. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9198. private static _tempFogColor;
  9199. /**
  9200. * Binds the fog information from the scene to the effect for the given mesh.
  9201. * @param scene The scene the lights belongs to
  9202. * @param mesh The mesh we are binding the information to render
  9203. * @param effect The effect we are binding the data to
  9204. * @param linearSpace Defines if the fog effect is applied in linear space
  9205. */
  9206. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  9207. /**
  9208. * Binds the bones information from the mesh to the effect.
  9209. * @param mesh The mesh we are binding the information to render
  9210. * @param effect The effect we are binding the data to
  9211. */
  9212. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  9213. /**
  9214. * Binds the morph targets information from the mesh to the effect.
  9215. * @param abstractMesh The mesh we are binding the information to render
  9216. * @param effect The effect we are binding the data to
  9217. */
  9218. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  9219. /**
  9220. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  9221. * @param defines The generated defines used in the effect
  9222. * @param effect The effect we are binding the data to
  9223. * @param scene The scene we are willing to render with logarithmic scale for
  9224. */
  9225. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  9226. /**
  9227. * Binds the clip plane information from the scene to the effect.
  9228. * @param scene The scene the clip plane information are extracted from
  9229. * @param effect The effect we are binding the data to
  9230. */
  9231. static BindClipPlane(effect: Effect, scene: Scene): void;
  9232. }
  9233. }
  9234. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9235. /** @hidden */
  9236. export var packingFunctions: {
  9237. name: string;
  9238. shader: string;
  9239. };
  9240. }
  9241. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9242. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9243. /** @hidden */
  9244. export var shadowMapPixelShader: {
  9245. name: string;
  9246. shader: string;
  9247. };
  9248. }
  9249. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9250. /** @hidden */
  9251. export var bonesDeclaration: {
  9252. name: string;
  9253. shader: string;
  9254. };
  9255. }
  9256. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9257. /** @hidden */
  9258. export var morphTargetsVertexGlobalDeclaration: {
  9259. name: string;
  9260. shader: string;
  9261. };
  9262. }
  9263. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9264. /** @hidden */
  9265. export var morphTargetsVertexDeclaration: {
  9266. name: string;
  9267. shader: string;
  9268. };
  9269. }
  9270. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9271. /** @hidden */
  9272. export var instancesDeclaration: {
  9273. name: string;
  9274. shader: string;
  9275. };
  9276. }
  9277. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9278. /** @hidden */
  9279. export var helperFunctions: {
  9280. name: string;
  9281. shader: string;
  9282. };
  9283. }
  9284. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9285. /** @hidden */
  9286. export var morphTargetsVertex: {
  9287. name: string;
  9288. shader: string;
  9289. };
  9290. }
  9291. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9292. /** @hidden */
  9293. export var instancesVertex: {
  9294. name: string;
  9295. shader: string;
  9296. };
  9297. }
  9298. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9299. /** @hidden */
  9300. export var bonesVertex: {
  9301. name: string;
  9302. shader: string;
  9303. };
  9304. }
  9305. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9306. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9307. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9308. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9309. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9310. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9311. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9312. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9313. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9314. /** @hidden */
  9315. export var shadowMapVertexShader: {
  9316. name: string;
  9317. shader: string;
  9318. };
  9319. }
  9320. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9321. /** @hidden */
  9322. export var depthBoxBlurPixelShader: {
  9323. name: string;
  9324. shader: string;
  9325. };
  9326. }
  9327. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  9328. import { Nullable } from "babylonjs/types";
  9329. import { Scene } from "babylonjs/scene";
  9330. import { Matrix } from "babylonjs/Maths/math.vector";
  9331. import { SubMesh } from "babylonjs/Meshes/subMesh";
  9332. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9333. import { Mesh } from "babylonjs/Meshes/mesh";
  9334. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  9335. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  9336. import { Effect } from "babylonjs/Materials/effect";
  9337. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  9338. import "babylonjs/Shaders/shadowMap.fragment";
  9339. import "babylonjs/Shaders/shadowMap.vertex";
  9340. import "babylonjs/Shaders/depthBoxBlur.fragment";
  9341. import { Observable } from "babylonjs/Misc/observable";
  9342. /**
  9343. * Defines the options associated with the creation of a custom shader for a shadow generator.
  9344. */
  9345. export interface ICustomShaderOptions {
  9346. /**
  9347. * Gets or sets the custom shader name to use
  9348. */
  9349. shaderName: string;
  9350. /**
  9351. * The list of attribute names used in the shader
  9352. */
  9353. attributes?: string[];
  9354. /**
  9355. * The list of unifrom names used in the shader
  9356. */
  9357. uniforms?: string[];
  9358. /**
  9359. * The list of sampler names used in the shader
  9360. */
  9361. samplers?: string[];
  9362. /**
  9363. * The list of defines used in the shader
  9364. */
  9365. defines?: string[];
  9366. }
  9367. /**
  9368. * Interface to implement to create a shadow generator compatible with BJS.
  9369. */
  9370. export interface IShadowGenerator {
  9371. /**
  9372. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9373. * @returns The render target texture if present otherwise, null
  9374. */
  9375. getShadowMap(): Nullable<RenderTargetTexture>;
  9376. /**
  9377. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9378. * @returns The render target texture if the shadow map is present otherwise, null
  9379. */
  9380. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9381. /**
  9382. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9383. * @param subMesh The submesh we want to render in the shadow map
  9384. * @param useInstances Defines wether will draw in the map using instances
  9385. * @returns true if ready otherwise, false
  9386. */
  9387. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9388. /**
  9389. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9390. * @param defines Defines of the material we want to update
  9391. * @param lightIndex Index of the light in the enabled light list of the material
  9392. */
  9393. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  9394. /**
  9395. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9396. * defined in the generator but impacting the effect).
  9397. * It implies the unifroms available on the materials are the standard BJS ones.
  9398. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9399. * @param effect The effect we are binfing the information for
  9400. */
  9401. bindShadowLight(lightIndex: string, effect: Effect): void;
  9402. /**
  9403. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9404. * (eq to shadow prjection matrix * light transform matrix)
  9405. * @returns The transform matrix used to create the shadow map
  9406. */
  9407. getTransformMatrix(): Matrix;
  9408. /**
  9409. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9410. * Cube and 2D textures for instance.
  9411. */
  9412. recreateShadowMap(): void;
  9413. /**
  9414. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9415. * @param onCompiled Callback triggered at the and of the effects compilation
  9416. * @param options Sets of optional options forcing the compilation with different modes
  9417. */
  9418. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9419. useInstances: boolean;
  9420. }>): void;
  9421. /**
  9422. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9423. * @param options Sets of optional options forcing the compilation with different modes
  9424. * @returns A promise that resolves when the compilation completes
  9425. */
  9426. forceCompilationAsync(options?: Partial<{
  9427. useInstances: boolean;
  9428. }>): Promise<void>;
  9429. /**
  9430. * Serializes the shadow generator setup to a json object.
  9431. * @returns The serialized JSON object
  9432. */
  9433. serialize(): any;
  9434. /**
  9435. * Disposes the Shadow map and related Textures and effects.
  9436. */
  9437. dispose(): void;
  9438. }
  9439. /**
  9440. * Default implementation IShadowGenerator.
  9441. * This is the main object responsible of generating shadows in the framework.
  9442. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  9443. */
  9444. export class ShadowGenerator implements IShadowGenerator {
  9445. /**
  9446. * Shadow generator mode None: no filtering applied.
  9447. */
  9448. static readonly FILTER_NONE: number;
  9449. /**
  9450. * Shadow generator mode ESM: Exponential Shadow Mapping.
  9451. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9452. */
  9453. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  9454. /**
  9455. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  9456. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  9457. */
  9458. static readonly FILTER_POISSONSAMPLING: number;
  9459. /**
  9460. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  9461. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9462. */
  9463. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  9464. /**
  9465. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  9466. * edge artifacts on steep falloff.
  9467. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9468. */
  9469. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  9470. /**
  9471. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  9472. * edge artifacts on steep falloff.
  9473. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9474. */
  9475. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  9476. /**
  9477. * Shadow generator mode PCF: Percentage Closer Filtering
  9478. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9479. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  9480. */
  9481. static readonly FILTER_PCF: number;
  9482. /**
  9483. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  9484. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9485. * Contact Hardening
  9486. */
  9487. static readonly FILTER_PCSS: number;
  9488. /**
  9489. * Reserved for PCF and PCSS
  9490. * Highest Quality.
  9491. *
  9492. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  9493. *
  9494. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  9495. */
  9496. static readonly QUALITY_HIGH: number;
  9497. /**
  9498. * Reserved for PCF and PCSS
  9499. * Good tradeoff for quality/perf cross devices
  9500. *
  9501. * Execute PCF on a 3*3 kernel.
  9502. *
  9503. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  9504. */
  9505. static readonly QUALITY_MEDIUM: number;
  9506. /**
  9507. * Reserved for PCF and PCSS
  9508. * The lowest quality but the fastest.
  9509. *
  9510. * Execute PCF on a 1*1 kernel.
  9511. *
  9512. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  9513. */
  9514. static readonly QUALITY_LOW: number;
  9515. /** Gets or sets the custom shader name to use */
  9516. customShaderOptions: ICustomShaderOptions;
  9517. /**
  9518. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  9519. */
  9520. onBeforeShadowMapRenderObservable: Observable<Effect>;
  9521. /**
  9522. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  9523. */
  9524. onAfterShadowMapRenderObservable: Observable<Effect>;
  9525. /**
  9526. * Observable triggered before a mesh is rendered in the shadow map.
  9527. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  9528. */
  9529. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  9530. /**
  9531. * Observable triggered after a mesh is rendered in the shadow map.
  9532. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  9533. */
  9534. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  9535. private _bias;
  9536. /**
  9537. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  9538. */
  9539. /**
  9540. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  9541. */
  9542. bias: number;
  9543. private _normalBias;
  9544. /**
  9545. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9546. */
  9547. /**
  9548. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9549. */
  9550. normalBias: number;
  9551. private _blurBoxOffset;
  9552. /**
  9553. * Gets the blur box offset: offset applied during the blur pass.
  9554. * Only useful if useKernelBlur = false
  9555. */
  9556. /**
  9557. * Sets the blur box offset: offset applied during the blur pass.
  9558. * Only useful if useKernelBlur = false
  9559. */
  9560. blurBoxOffset: number;
  9561. private _blurScale;
  9562. /**
  9563. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  9564. * 2 means half of the size.
  9565. */
  9566. /**
  9567. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  9568. * 2 means half of the size.
  9569. */
  9570. blurScale: number;
  9571. private _blurKernel;
  9572. /**
  9573. * Gets the blur kernel: kernel size of the blur pass.
  9574. * Only useful if useKernelBlur = true
  9575. */
  9576. /**
  9577. * Sets the blur kernel: kernel size of the blur pass.
  9578. * Only useful if useKernelBlur = true
  9579. */
  9580. blurKernel: number;
  9581. private _useKernelBlur;
  9582. /**
  9583. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  9584. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9585. */
  9586. /**
  9587. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  9588. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9589. */
  9590. useKernelBlur: boolean;
  9591. private _depthScale;
  9592. /**
  9593. * Gets the depth scale used in ESM mode.
  9594. */
  9595. /**
  9596. * Sets the depth scale used in ESM mode.
  9597. * This can override the scale stored on the light.
  9598. */
  9599. depthScale: number;
  9600. private _filter;
  9601. /**
  9602. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  9603. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9604. */
  9605. /**
  9606. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  9607. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9608. */
  9609. filter: number;
  9610. /**
  9611. * Gets if the current filter is set to Poisson Sampling.
  9612. */
  9613. /**
  9614. * Sets the current filter to Poisson Sampling.
  9615. */
  9616. usePoissonSampling: boolean;
  9617. /**
  9618. * Gets if the current filter is set to ESM.
  9619. */
  9620. /**
  9621. * Sets the current filter is to ESM.
  9622. */
  9623. useExponentialShadowMap: boolean;
  9624. /**
  9625. * Gets if the current filter is set to filtered ESM.
  9626. */
  9627. /**
  9628. * Gets if the current filter is set to filtered ESM.
  9629. */
  9630. useBlurExponentialShadowMap: boolean;
  9631. /**
  9632. * Gets if the current filter is set to "close ESM" (using the inverse of the
  9633. * exponential to prevent steep falloff artifacts).
  9634. */
  9635. /**
  9636. * Sets the current filter to "close ESM" (using the inverse of the
  9637. * exponential to prevent steep falloff artifacts).
  9638. */
  9639. useCloseExponentialShadowMap: boolean;
  9640. /**
  9641. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  9642. * exponential to prevent steep falloff artifacts).
  9643. */
  9644. /**
  9645. * Sets the current filter to filtered "close ESM" (using the inverse of the
  9646. * exponential to prevent steep falloff artifacts).
  9647. */
  9648. useBlurCloseExponentialShadowMap: boolean;
  9649. /**
  9650. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  9651. */
  9652. /**
  9653. * Sets the current filter to "PCF" (percentage closer filtering).
  9654. */
  9655. usePercentageCloserFiltering: boolean;
  9656. private _filteringQuality;
  9657. /**
  9658. * Gets the PCF or PCSS Quality.
  9659. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9660. */
  9661. /**
  9662. * Sets the PCF or PCSS Quality.
  9663. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9664. */
  9665. filteringQuality: number;
  9666. /**
  9667. * Gets if the current filter is set to "PCSS" (contact hardening).
  9668. */
  9669. /**
  9670. * Sets the current filter to "PCSS" (contact hardening).
  9671. */
  9672. useContactHardeningShadow: boolean;
  9673. private _contactHardeningLightSizeUVRatio;
  9674. /**
  9675. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9676. * Using a ratio helps keeping shape stability independently of the map size.
  9677. *
  9678. * It does not account for the light projection as it was having too much
  9679. * instability during the light setup or during light position changes.
  9680. *
  9681. * Only valid if useContactHardeningShadow is true.
  9682. */
  9683. /**
  9684. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9685. * Using a ratio helps keeping shape stability independently of the map size.
  9686. *
  9687. * It does not account for the light projection as it was having too much
  9688. * instability during the light setup or during light position changes.
  9689. *
  9690. * Only valid if useContactHardeningShadow is true.
  9691. */
  9692. contactHardeningLightSizeUVRatio: number;
  9693. private _darkness;
  9694. /** Gets or sets the actual darkness of a shadow */
  9695. darkness: number;
  9696. /**
  9697. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  9698. * 0 means strongest and 1 would means no shadow.
  9699. * @returns the darkness.
  9700. */
  9701. getDarkness(): number;
  9702. /**
  9703. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  9704. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  9705. * @returns the shadow generator allowing fluent coding.
  9706. */
  9707. setDarkness(darkness: number): ShadowGenerator;
  9708. private _transparencyShadow;
  9709. /** Gets or sets the ability to have transparent shadow */
  9710. transparencyShadow: boolean;
  9711. /**
  9712. * Sets the ability to have transparent shadow (boolean).
  9713. * @param transparent True if transparent else False
  9714. * @returns the shadow generator allowing fluent coding
  9715. */
  9716. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  9717. private _shadowMap;
  9718. private _shadowMap2;
  9719. /**
  9720. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9721. * @returns The render target texture if present otherwise, null
  9722. */
  9723. getShadowMap(): Nullable<RenderTargetTexture>;
  9724. /**
  9725. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9726. * @returns The render target texture if the shadow map is present otherwise, null
  9727. */
  9728. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9729. /**
  9730. * Gets the class name of that object
  9731. * @returns "ShadowGenerator"
  9732. */
  9733. getClassName(): string;
  9734. /**
  9735. * Helper function to add a mesh and its descendants to the list of shadow casters.
  9736. * @param mesh Mesh to add
  9737. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  9738. * @returns the Shadow Generator itself
  9739. */
  9740. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9741. /**
  9742. * Helper function to remove a mesh and its descendants from the list of shadow casters
  9743. * @param mesh Mesh to remove
  9744. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  9745. * @returns the Shadow Generator itself
  9746. */
  9747. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9748. /**
  9749. * Controls the extent to which the shadows fade out at the edge of the frustum
  9750. * Used only by directionals and spots
  9751. */
  9752. frustumEdgeFalloff: number;
  9753. private _light;
  9754. /**
  9755. * Returns the associated light object.
  9756. * @returns the light generating the shadow
  9757. */
  9758. getLight(): IShadowLight;
  9759. /**
  9760. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  9761. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  9762. * It might on the other hand introduce peter panning.
  9763. */
  9764. forceBackFacesOnly: boolean;
  9765. private _scene;
  9766. private _lightDirection;
  9767. private _effect;
  9768. private _viewMatrix;
  9769. private _projectionMatrix;
  9770. private _transformMatrix;
  9771. private _cachedPosition;
  9772. private _cachedDirection;
  9773. private _cachedDefines;
  9774. private _currentRenderID;
  9775. private _boxBlurPostprocess;
  9776. private _kernelBlurXPostprocess;
  9777. private _kernelBlurYPostprocess;
  9778. private _blurPostProcesses;
  9779. private _mapSize;
  9780. private _currentFaceIndex;
  9781. private _currentFaceIndexCache;
  9782. private _textureType;
  9783. private _defaultTextureMatrix;
  9784. private _storedUniqueId;
  9785. /** @hidden */
  9786. static _SceneComponentInitialization: (scene: Scene) => void;
  9787. /**
  9788. * Creates a ShadowGenerator object.
  9789. * A ShadowGenerator is the required tool to use the shadows.
  9790. * Each light casting shadows needs to use its own ShadowGenerator.
  9791. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  9792. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  9793. * @param light The light object generating the shadows.
  9794. * @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.
  9795. */
  9796. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  9797. private _initializeGenerator;
  9798. private _initializeShadowMap;
  9799. private _initializeBlurRTTAndPostProcesses;
  9800. private _renderForShadowMap;
  9801. private _renderSubMeshForShadowMap;
  9802. private _applyFilterValues;
  9803. /**
  9804. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9805. * @param onCompiled Callback triggered at the and of the effects compilation
  9806. * @param options Sets of optional options forcing the compilation with different modes
  9807. */
  9808. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9809. useInstances: boolean;
  9810. }>): void;
  9811. /**
  9812. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9813. * @param options Sets of optional options forcing the compilation with different modes
  9814. * @returns A promise that resolves when the compilation completes
  9815. */
  9816. forceCompilationAsync(options?: Partial<{
  9817. useInstances: boolean;
  9818. }>): Promise<void>;
  9819. /**
  9820. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9821. * @param subMesh The submesh we want to render in the shadow map
  9822. * @param useInstances Defines wether will draw in the map using instances
  9823. * @returns true if ready otherwise, false
  9824. */
  9825. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9826. /**
  9827. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9828. * @param defines Defines of the material we want to update
  9829. * @param lightIndex Index of the light in the enabled light list of the material
  9830. */
  9831. prepareDefines(defines: any, lightIndex: number): void;
  9832. /**
  9833. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9834. * defined in the generator but impacting the effect).
  9835. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9836. * @param effect The effect we are binfing the information for
  9837. */
  9838. bindShadowLight(lightIndex: string, effect: Effect): void;
  9839. /**
  9840. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9841. * (eq to shadow prjection matrix * light transform matrix)
  9842. * @returns The transform matrix used to create the shadow map
  9843. */
  9844. getTransformMatrix(): Matrix;
  9845. /**
  9846. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9847. * Cube and 2D textures for instance.
  9848. */
  9849. recreateShadowMap(): void;
  9850. private _disposeBlurPostProcesses;
  9851. private _disposeRTTandPostProcesses;
  9852. /**
  9853. * Disposes the ShadowGenerator.
  9854. * Returns nothing.
  9855. */
  9856. dispose(): void;
  9857. /**
  9858. * Serializes the shadow generator setup to a json object.
  9859. * @returns The serialized JSON object
  9860. */
  9861. serialize(): any;
  9862. /**
  9863. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  9864. * @param parsedShadowGenerator The JSON object to parse
  9865. * @param scene The scene to create the shadow map for
  9866. * @returns The parsed shadow generator
  9867. */
  9868. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  9869. }
  9870. }
  9871. declare module "babylonjs/Lights/light" {
  9872. import { Nullable } from "babylonjs/types";
  9873. import { Scene } from "babylonjs/scene";
  9874. import { Vector3 } from "babylonjs/Maths/math.vector";
  9875. import { Color3 } from "babylonjs/Maths/math.color";
  9876. import { Node } from "babylonjs/node";
  9877. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9878. import { Effect } from "babylonjs/Materials/effect";
  9879. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  9880. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  9881. /**
  9882. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  9883. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  9884. * 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.
  9885. */
  9886. export abstract class Light extends Node {
  9887. /**
  9888. * Falloff Default: light is falling off following the material specification:
  9889. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  9890. */
  9891. static readonly FALLOFF_DEFAULT: number;
  9892. /**
  9893. * Falloff Physical: light is falling off following the inverse squared distance law.
  9894. */
  9895. static readonly FALLOFF_PHYSICAL: number;
  9896. /**
  9897. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  9898. * to enhance interoperability with other engines.
  9899. */
  9900. static readonly FALLOFF_GLTF: number;
  9901. /**
  9902. * Falloff Standard: light is falling off like in the standard material
  9903. * to enhance interoperability with other materials.
  9904. */
  9905. static readonly FALLOFF_STANDARD: number;
  9906. /**
  9907. * If every light affecting the material is in this lightmapMode,
  9908. * material.lightmapTexture adds or multiplies
  9909. * (depends on material.useLightmapAsShadowmap)
  9910. * after every other light calculations.
  9911. */
  9912. static readonly LIGHTMAP_DEFAULT: number;
  9913. /**
  9914. * material.lightmapTexture as only diffuse lighting from this light
  9915. * adds only specular lighting from this light
  9916. * adds dynamic shadows
  9917. */
  9918. static readonly LIGHTMAP_SPECULAR: number;
  9919. /**
  9920. * material.lightmapTexture as only lighting
  9921. * no light calculation from this light
  9922. * only adds dynamic shadows from this light
  9923. */
  9924. static readonly LIGHTMAP_SHADOWSONLY: number;
  9925. /**
  9926. * Each light type uses the default quantity according to its type:
  9927. * point/spot lights use luminous intensity
  9928. * directional lights use illuminance
  9929. */
  9930. static readonly INTENSITYMODE_AUTOMATIC: number;
  9931. /**
  9932. * lumen (lm)
  9933. */
  9934. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  9935. /**
  9936. * candela (lm/sr)
  9937. */
  9938. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  9939. /**
  9940. * lux (lm/m^2)
  9941. */
  9942. static readonly INTENSITYMODE_ILLUMINANCE: number;
  9943. /**
  9944. * nit (cd/m^2)
  9945. */
  9946. static readonly INTENSITYMODE_LUMINANCE: number;
  9947. /**
  9948. * Light type const id of the point light.
  9949. */
  9950. static readonly LIGHTTYPEID_POINTLIGHT: number;
  9951. /**
  9952. * Light type const id of the directional light.
  9953. */
  9954. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  9955. /**
  9956. * Light type const id of the spot light.
  9957. */
  9958. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  9959. /**
  9960. * Light type const id of the hemispheric light.
  9961. */
  9962. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  9963. /**
  9964. * Diffuse gives the basic color to an object.
  9965. */
  9966. diffuse: Color3;
  9967. /**
  9968. * Specular produces a highlight color on an object.
  9969. * Note: This is note affecting PBR materials.
  9970. */
  9971. specular: Color3;
  9972. /**
  9973. * Defines the falloff type for this light. This lets overrriding how punctual light are
  9974. * falling off base on range or angle.
  9975. * This can be set to any values in Light.FALLOFF_x.
  9976. *
  9977. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  9978. * other types of materials.
  9979. */
  9980. falloffType: number;
  9981. /**
  9982. * Strength of the light.
  9983. * Note: By default it is define in the framework own unit.
  9984. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  9985. */
  9986. intensity: number;
  9987. private _range;
  9988. protected _inverseSquaredRange: number;
  9989. /**
  9990. * Defines how far from the source the light is impacting in scene units.
  9991. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  9992. */
  9993. /**
  9994. * Defines how far from the source the light is impacting in scene units.
  9995. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  9996. */
  9997. range: number;
  9998. /**
  9999. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  10000. * of light.
  10001. */
  10002. private _photometricScale;
  10003. private _intensityMode;
  10004. /**
  10005. * Gets the photometric scale used to interpret the intensity.
  10006. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  10007. */
  10008. /**
  10009. * Sets the photometric scale used to interpret the intensity.
  10010. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  10011. */
  10012. intensityMode: number;
  10013. private _radius;
  10014. /**
  10015. * Gets the light radius used by PBR Materials to simulate soft area lights.
  10016. */
  10017. /**
  10018. * sets the light radius used by PBR Materials to simulate soft area lights.
  10019. */
  10020. radius: number;
  10021. private _renderPriority;
  10022. /**
  10023. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  10024. * exceeding the number allowed of the materials.
  10025. */
  10026. renderPriority: number;
  10027. private _shadowEnabled;
  10028. /**
  10029. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  10030. * the current shadow generator.
  10031. */
  10032. /**
  10033. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  10034. * the current shadow generator.
  10035. */
  10036. shadowEnabled: boolean;
  10037. private _includedOnlyMeshes;
  10038. /**
  10039. * Gets the only meshes impacted by this light.
  10040. */
  10041. /**
  10042. * Sets the only meshes impacted by this light.
  10043. */
  10044. includedOnlyMeshes: AbstractMesh[];
  10045. private _excludedMeshes;
  10046. /**
  10047. * Gets the meshes not impacted by this light.
  10048. */
  10049. /**
  10050. * Sets the meshes not impacted by this light.
  10051. */
  10052. excludedMeshes: AbstractMesh[];
  10053. private _excludeWithLayerMask;
  10054. /**
  10055. * Gets the layer id use to find what meshes are not impacted by the light.
  10056. * Inactive if 0
  10057. */
  10058. /**
  10059. * Sets the layer id use to find what meshes are not impacted by the light.
  10060. * Inactive if 0
  10061. */
  10062. excludeWithLayerMask: number;
  10063. private _includeOnlyWithLayerMask;
  10064. /**
  10065. * Gets the layer id use to find what meshes are impacted by the light.
  10066. * Inactive if 0
  10067. */
  10068. /**
  10069. * Sets the layer id use to find what meshes are impacted by the light.
  10070. * Inactive if 0
  10071. */
  10072. includeOnlyWithLayerMask: number;
  10073. private _lightmapMode;
  10074. /**
  10075. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  10076. */
  10077. /**
  10078. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  10079. */
  10080. lightmapMode: number;
  10081. /**
  10082. * Shadow generator associted to the light.
  10083. * @hidden Internal use only.
  10084. */
  10085. _shadowGenerator: Nullable<IShadowGenerator>;
  10086. /**
  10087. * @hidden Internal use only.
  10088. */
  10089. _excludedMeshesIds: string[];
  10090. /**
  10091. * @hidden Internal use only.
  10092. */
  10093. _includedOnlyMeshesIds: string[];
  10094. /**
  10095. * The current light unifom buffer.
  10096. * @hidden Internal use only.
  10097. */
  10098. _uniformBuffer: UniformBuffer;
  10099. /** @hidden */
  10100. _renderId: number;
  10101. /**
  10102. * Creates a Light object in the scene.
  10103. * Documentation : https://doc.babylonjs.com/babylon101/lights
  10104. * @param name The firendly name of the light
  10105. * @param scene The scene the light belongs too
  10106. */
  10107. constructor(name: string, scene: Scene);
  10108. protected abstract _buildUniformLayout(): void;
  10109. /**
  10110. * Sets the passed Effect "effect" with the Light information.
  10111. * @param effect The effect to update
  10112. * @param lightIndex The index of the light in the effect to update
  10113. * @returns The light
  10114. */
  10115. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  10116. /**
  10117. * Sets the passed Effect "effect" with the Light information.
  10118. * @param effect The effect to update
  10119. * @param lightDataUniformName The uniform used to store light data (position or direction)
  10120. * @returns The light
  10121. */
  10122. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  10123. /**
  10124. * Returns the string "Light".
  10125. * @returns the class name
  10126. */
  10127. getClassName(): string;
  10128. /** @hidden */
  10129. readonly _isLight: boolean;
  10130. /**
  10131. * Converts the light information to a readable string for debug purpose.
  10132. * @param fullDetails Supports for multiple levels of logging within scene loading
  10133. * @returns the human readable light info
  10134. */
  10135. toString(fullDetails?: boolean): string;
  10136. /** @hidden */
  10137. protected _syncParentEnabledState(): void;
  10138. /**
  10139. * Set the enabled state of this node.
  10140. * @param value - the new enabled state
  10141. */
  10142. setEnabled(value: boolean): void;
  10143. /**
  10144. * Returns the Light associated shadow generator if any.
  10145. * @return the associated shadow generator.
  10146. */
  10147. getShadowGenerator(): Nullable<IShadowGenerator>;
  10148. /**
  10149. * Returns a Vector3, the absolute light position in the World.
  10150. * @returns the world space position of the light
  10151. */
  10152. getAbsolutePosition(): Vector3;
  10153. /**
  10154. * Specifies if the light will affect the passed mesh.
  10155. * @param mesh The mesh to test against the light
  10156. * @return true the mesh is affected otherwise, false.
  10157. */
  10158. canAffectMesh(mesh: AbstractMesh): boolean;
  10159. /**
  10160. * Sort function to order lights for rendering.
  10161. * @param a First Light object to compare to second.
  10162. * @param b Second Light object to compare first.
  10163. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  10164. */
  10165. static CompareLightsPriority(a: Light, b: Light): number;
  10166. /**
  10167. * Releases resources associated with this node.
  10168. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  10169. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  10170. */
  10171. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  10172. /**
  10173. * Returns the light type ID (integer).
  10174. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  10175. */
  10176. getTypeID(): number;
  10177. /**
  10178. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  10179. * @returns the scaled intensity in intensity mode unit
  10180. */
  10181. getScaledIntensity(): number;
  10182. /**
  10183. * Returns a new Light object, named "name", from the current one.
  10184. * @param name The name of the cloned light
  10185. * @returns the new created light
  10186. */
  10187. clone(name: string): Nullable<Light>;
  10188. /**
  10189. * Serializes the current light into a Serialization object.
  10190. * @returns the serialized object.
  10191. */
  10192. serialize(): any;
  10193. /**
  10194. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  10195. * This new light is named "name" and added to the passed scene.
  10196. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  10197. * @param name The friendly name of the light
  10198. * @param scene The scene the new light will belong to
  10199. * @returns the constructor function
  10200. */
  10201. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  10202. /**
  10203. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  10204. * @param parsedLight The JSON representation of the light
  10205. * @param scene The scene to create the parsed light in
  10206. * @returns the created light after parsing
  10207. */
  10208. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  10209. private _hookArrayForExcluded;
  10210. private _hookArrayForIncludedOnly;
  10211. private _resyncMeshes;
  10212. /**
  10213. * Forces the meshes to update their light related information in their rendering used effects
  10214. * @hidden Internal Use Only
  10215. */
  10216. _markMeshesAsLightDirty(): void;
  10217. /**
  10218. * Recomputes the cached photometric scale if needed.
  10219. */
  10220. private _computePhotometricScale;
  10221. /**
  10222. * Returns the Photometric Scale according to the light type and intensity mode.
  10223. */
  10224. private _getPhotometricScale;
  10225. /**
  10226. * Reorder the light in the scene according to their defined priority.
  10227. * @hidden Internal Use Only
  10228. */
  10229. _reorderLightsInScene(): void;
  10230. /**
  10231. * Prepares the list of defines specific to the light type.
  10232. * @param defines the list of defines
  10233. * @param lightIndex defines the index of the light for the effect
  10234. */
  10235. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  10236. }
  10237. }
  10238. declare module "babylonjs/Actions/action" {
  10239. import { Observable } from "babylonjs/Misc/observable";
  10240. import { Condition } from "babylonjs/Actions/condition";
  10241. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10242. import { ActionManager } from "babylonjs/Actions/actionManager";
  10243. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10244. /**
  10245. * Interface used to define Action
  10246. */
  10247. export interface IAction {
  10248. /**
  10249. * Trigger for the action
  10250. */
  10251. trigger: number;
  10252. /** Options of the trigger */
  10253. triggerOptions: any;
  10254. /**
  10255. * Gets the trigger parameters
  10256. * @returns the trigger parameters
  10257. */
  10258. getTriggerParameter(): any;
  10259. /**
  10260. * Internal only - executes current action event
  10261. * @hidden
  10262. */
  10263. _executeCurrent(evt?: ActionEvent): void;
  10264. /**
  10265. * Serialize placeholder for child classes
  10266. * @param parent of child
  10267. * @returns the serialized object
  10268. */
  10269. serialize(parent: any): any;
  10270. /**
  10271. * Internal only
  10272. * @hidden
  10273. */
  10274. _prepare(): void;
  10275. /**
  10276. * Internal only - manager for action
  10277. * @hidden
  10278. */
  10279. _actionManager: AbstractActionManager;
  10280. /**
  10281. * Adds action to chain of actions, may be a DoNothingAction
  10282. * @param action defines the next action to execute
  10283. * @returns The action passed in
  10284. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10285. */
  10286. then(action: IAction): IAction;
  10287. }
  10288. /**
  10289. * The action to be carried out following a trigger
  10290. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  10291. */
  10292. export class Action implements IAction {
  10293. /** the trigger, with or without parameters, for the action */
  10294. triggerOptions: any;
  10295. /**
  10296. * Trigger for the action
  10297. */
  10298. trigger: number;
  10299. /**
  10300. * Internal only - manager for action
  10301. * @hidden
  10302. */
  10303. _actionManager: ActionManager;
  10304. private _nextActiveAction;
  10305. private _child;
  10306. private _condition?;
  10307. private _triggerParameter;
  10308. /**
  10309. * An event triggered prior to action being executed.
  10310. */
  10311. onBeforeExecuteObservable: Observable<Action>;
  10312. /**
  10313. * Creates a new Action
  10314. * @param triggerOptions the trigger, with or without parameters, for the action
  10315. * @param condition an optional determinant of action
  10316. */
  10317. constructor(
  10318. /** the trigger, with or without parameters, for the action */
  10319. triggerOptions: any, condition?: Condition);
  10320. /**
  10321. * Internal only
  10322. * @hidden
  10323. */
  10324. _prepare(): void;
  10325. /**
  10326. * Gets the trigger parameters
  10327. * @returns the trigger parameters
  10328. */
  10329. getTriggerParameter(): any;
  10330. /**
  10331. * Internal only - executes current action event
  10332. * @hidden
  10333. */
  10334. _executeCurrent(evt?: ActionEvent): void;
  10335. /**
  10336. * Execute placeholder for child classes
  10337. * @param evt optional action event
  10338. */
  10339. execute(evt?: ActionEvent): void;
  10340. /**
  10341. * Skips to next active action
  10342. */
  10343. skipToNextActiveAction(): void;
  10344. /**
  10345. * Adds action to chain of actions, may be a DoNothingAction
  10346. * @param action defines the next action to execute
  10347. * @returns The action passed in
  10348. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10349. */
  10350. then(action: Action): Action;
  10351. /**
  10352. * Internal only
  10353. * @hidden
  10354. */
  10355. _getProperty(propertyPath: string): string;
  10356. /**
  10357. * Internal only
  10358. * @hidden
  10359. */
  10360. _getEffectiveTarget(target: any, propertyPath: string): any;
  10361. /**
  10362. * Serialize placeholder for child classes
  10363. * @param parent of child
  10364. * @returns the serialized object
  10365. */
  10366. serialize(parent: any): any;
  10367. /**
  10368. * Internal only called by serialize
  10369. * @hidden
  10370. */
  10371. protected _serialize(serializedAction: any, parent?: any): any;
  10372. /**
  10373. * Internal only
  10374. * @hidden
  10375. */
  10376. static _SerializeValueAsString: (value: any) => string;
  10377. /**
  10378. * Internal only
  10379. * @hidden
  10380. */
  10381. static _GetTargetProperty: (target: import("babylonjs/node").Node | import("babylonjs/scene").Scene) => {
  10382. name: string;
  10383. targetType: string;
  10384. value: string;
  10385. };
  10386. }
  10387. }
  10388. declare module "babylonjs/Actions/condition" {
  10389. import { ActionManager } from "babylonjs/Actions/actionManager";
  10390. /**
  10391. * A Condition applied to an Action
  10392. */
  10393. export class Condition {
  10394. /**
  10395. * Internal only - manager for action
  10396. * @hidden
  10397. */
  10398. _actionManager: ActionManager;
  10399. /**
  10400. * Internal only
  10401. * @hidden
  10402. */
  10403. _evaluationId: number;
  10404. /**
  10405. * Internal only
  10406. * @hidden
  10407. */
  10408. _currentResult: boolean;
  10409. /**
  10410. * Creates a new Condition
  10411. * @param actionManager the manager of the action the condition is applied to
  10412. */
  10413. constructor(actionManager: ActionManager);
  10414. /**
  10415. * Check if the current condition is valid
  10416. * @returns a boolean
  10417. */
  10418. isValid(): boolean;
  10419. /**
  10420. * Internal only
  10421. * @hidden
  10422. */
  10423. _getProperty(propertyPath: string): string;
  10424. /**
  10425. * Internal only
  10426. * @hidden
  10427. */
  10428. _getEffectiveTarget(target: any, propertyPath: string): any;
  10429. /**
  10430. * Serialize placeholder for child classes
  10431. * @returns the serialized object
  10432. */
  10433. serialize(): any;
  10434. /**
  10435. * Internal only
  10436. * @hidden
  10437. */
  10438. protected _serialize(serializedCondition: any): any;
  10439. }
  10440. /**
  10441. * Defines specific conditional operators as extensions of Condition
  10442. */
  10443. export class ValueCondition extends Condition {
  10444. /** path to specify the property of the target the conditional operator uses */
  10445. propertyPath: string;
  10446. /** the value compared by the conditional operator against the current value of the property */
  10447. value: any;
  10448. /** the conditional operator, default ValueCondition.IsEqual */
  10449. operator: number;
  10450. /**
  10451. * Internal only
  10452. * @hidden
  10453. */
  10454. private static _IsEqual;
  10455. /**
  10456. * Internal only
  10457. * @hidden
  10458. */
  10459. private static _IsDifferent;
  10460. /**
  10461. * Internal only
  10462. * @hidden
  10463. */
  10464. private static _IsGreater;
  10465. /**
  10466. * Internal only
  10467. * @hidden
  10468. */
  10469. private static _IsLesser;
  10470. /**
  10471. * returns the number for IsEqual
  10472. */
  10473. static readonly IsEqual: number;
  10474. /**
  10475. * Returns the number for IsDifferent
  10476. */
  10477. static readonly IsDifferent: number;
  10478. /**
  10479. * Returns the number for IsGreater
  10480. */
  10481. static readonly IsGreater: number;
  10482. /**
  10483. * Returns the number for IsLesser
  10484. */
  10485. static readonly IsLesser: number;
  10486. /**
  10487. * Internal only The action manager for the condition
  10488. * @hidden
  10489. */
  10490. _actionManager: ActionManager;
  10491. /**
  10492. * Internal only
  10493. * @hidden
  10494. */
  10495. private _target;
  10496. /**
  10497. * Internal only
  10498. * @hidden
  10499. */
  10500. private _effectiveTarget;
  10501. /**
  10502. * Internal only
  10503. * @hidden
  10504. */
  10505. private _property;
  10506. /**
  10507. * Creates a new ValueCondition
  10508. * @param actionManager manager for the action the condition applies to
  10509. * @param target for the action
  10510. * @param propertyPath path to specify the property of the target the conditional operator uses
  10511. * @param value the value compared by the conditional operator against the current value of the property
  10512. * @param operator the conditional operator, default ValueCondition.IsEqual
  10513. */
  10514. constructor(actionManager: ActionManager, target: any,
  10515. /** path to specify the property of the target the conditional operator uses */
  10516. propertyPath: string,
  10517. /** the value compared by the conditional operator against the current value of the property */
  10518. value: any,
  10519. /** the conditional operator, default ValueCondition.IsEqual */
  10520. operator?: number);
  10521. /**
  10522. * Compares the given value with the property value for the specified conditional operator
  10523. * @returns the result of the comparison
  10524. */
  10525. isValid(): boolean;
  10526. /**
  10527. * Serialize the ValueCondition into a JSON compatible object
  10528. * @returns serialization object
  10529. */
  10530. serialize(): any;
  10531. /**
  10532. * Gets the name of the conditional operator for the ValueCondition
  10533. * @param operator the conditional operator
  10534. * @returns the name
  10535. */
  10536. static GetOperatorName(operator: number): string;
  10537. }
  10538. /**
  10539. * Defines a predicate condition as an extension of Condition
  10540. */
  10541. export class PredicateCondition extends Condition {
  10542. /** defines the predicate function used to validate the condition */
  10543. predicate: () => boolean;
  10544. /**
  10545. * Internal only - manager for action
  10546. * @hidden
  10547. */
  10548. _actionManager: ActionManager;
  10549. /**
  10550. * Creates a new PredicateCondition
  10551. * @param actionManager manager for the action the condition applies to
  10552. * @param predicate defines the predicate function used to validate the condition
  10553. */
  10554. constructor(actionManager: ActionManager,
  10555. /** defines the predicate function used to validate the condition */
  10556. predicate: () => boolean);
  10557. /**
  10558. * @returns the validity of the predicate condition
  10559. */
  10560. isValid(): boolean;
  10561. }
  10562. /**
  10563. * Defines a state condition as an extension of Condition
  10564. */
  10565. export class StateCondition extends Condition {
  10566. /** Value to compare with target state */
  10567. value: string;
  10568. /**
  10569. * Internal only - manager for action
  10570. * @hidden
  10571. */
  10572. _actionManager: ActionManager;
  10573. /**
  10574. * Internal only
  10575. * @hidden
  10576. */
  10577. private _target;
  10578. /**
  10579. * Creates a new StateCondition
  10580. * @param actionManager manager for the action the condition applies to
  10581. * @param target of the condition
  10582. * @param value to compare with target state
  10583. */
  10584. constructor(actionManager: ActionManager, target: any,
  10585. /** Value to compare with target state */
  10586. value: string);
  10587. /**
  10588. * Gets a boolean indicating if the current condition is met
  10589. * @returns the validity of the state
  10590. */
  10591. isValid(): boolean;
  10592. /**
  10593. * Serialize the StateCondition into a JSON compatible object
  10594. * @returns serialization object
  10595. */
  10596. serialize(): any;
  10597. }
  10598. }
  10599. declare module "babylonjs/Actions/directActions" {
  10600. import { Action } from "babylonjs/Actions/action";
  10601. import { Condition } from "babylonjs/Actions/condition";
  10602. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10603. /**
  10604. * This defines an action responsible to toggle a boolean once triggered.
  10605. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10606. */
  10607. export class SwitchBooleanAction extends Action {
  10608. /**
  10609. * The path to the boolean property in the target object
  10610. */
  10611. propertyPath: string;
  10612. private _target;
  10613. private _effectiveTarget;
  10614. private _property;
  10615. /**
  10616. * Instantiate the action
  10617. * @param triggerOptions defines the trigger options
  10618. * @param target defines the object containing the boolean
  10619. * @param propertyPath defines the path to the boolean property in the target object
  10620. * @param condition defines the trigger related conditions
  10621. */
  10622. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  10623. /** @hidden */
  10624. _prepare(): void;
  10625. /**
  10626. * Execute the action toggle the boolean value.
  10627. */
  10628. execute(): void;
  10629. /**
  10630. * Serializes the actions and its related information.
  10631. * @param parent defines the object to serialize in
  10632. * @returns the serialized object
  10633. */
  10634. serialize(parent: any): any;
  10635. }
  10636. /**
  10637. * This defines an action responsible to set a the state field of the target
  10638. * to a desired value once triggered.
  10639. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10640. */
  10641. export class SetStateAction extends Action {
  10642. /**
  10643. * The value to store in the state field.
  10644. */
  10645. value: string;
  10646. private _target;
  10647. /**
  10648. * Instantiate the action
  10649. * @param triggerOptions defines the trigger options
  10650. * @param target defines the object containing the state property
  10651. * @param value defines the value to store in the state field
  10652. * @param condition defines the trigger related conditions
  10653. */
  10654. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  10655. /**
  10656. * Execute the action and store the value on the target state property.
  10657. */
  10658. execute(): void;
  10659. /**
  10660. * Serializes the actions and its related information.
  10661. * @param parent defines the object to serialize in
  10662. * @returns the serialized object
  10663. */
  10664. serialize(parent: any): any;
  10665. }
  10666. /**
  10667. * This defines an action responsible to set a property of the target
  10668. * to a desired value once triggered.
  10669. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10670. */
  10671. export class SetValueAction extends Action {
  10672. /**
  10673. * The path of the property to set in the target.
  10674. */
  10675. propertyPath: string;
  10676. /**
  10677. * The value to set in the property
  10678. */
  10679. value: any;
  10680. private _target;
  10681. private _effectiveTarget;
  10682. private _property;
  10683. /**
  10684. * Instantiate the action
  10685. * @param triggerOptions defines the trigger options
  10686. * @param target defines the object containing the property
  10687. * @param propertyPath defines the path of the property to set in the target
  10688. * @param value defines the value to set in the property
  10689. * @param condition defines the trigger related conditions
  10690. */
  10691. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10692. /** @hidden */
  10693. _prepare(): void;
  10694. /**
  10695. * Execute the action and set the targetted property to the desired value.
  10696. */
  10697. execute(): void;
  10698. /**
  10699. * Serializes the actions and its related information.
  10700. * @param parent defines the object to serialize in
  10701. * @returns the serialized object
  10702. */
  10703. serialize(parent: any): any;
  10704. }
  10705. /**
  10706. * This defines an action responsible to increment the target value
  10707. * to a desired value once triggered.
  10708. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10709. */
  10710. export class IncrementValueAction extends Action {
  10711. /**
  10712. * The path of the property to increment in the target.
  10713. */
  10714. propertyPath: string;
  10715. /**
  10716. * The value we should increment the property by.
  10717. */
  10718. value: any;
  10719. private _target;
  10720. private _effectiveTarget;
  10721. private _property;
  10722. /**
  10723. * Instantiate the action
  10724. * @param triggerOptions defines the trigger options
  10725. * @param target defines the object containing the property
  10726. * @param propertyPath defines the path of the property to increment in the target
  10727. * @param value defines the value value we should increment the property by
  10728. * @param condition defines the trigger related conditions
  10729. */
  10730. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10731. /** @hidden */
  10732. _prepare(): void;
  10733. /**
  10734. * Execute the action and increment the target of the value amount.
  10735. */
  10736. execute(): void;
  10737. /**
  10738. * Serializes the actions and its related information.
  10739. * @param parent defines the object to serialize in
  10740. * @returns the serialized object
  10741. */
  10742. serialize(parent: any): any;
  10743. }
  10744. /**
  10745. * This defines an action responsible to start an animation once triggered.
  10746. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10747. */
  10748. export class PlayAnimationAction extends Action {
  10749. /**
  10750. * Where the animation should start (animation frame)
  10751. */
  10752. from: number;
  10753. /**
  10754. * Where the animation should stop (animation frame)
  10755. */
  10756. to: number;
  10757. /**
  10758. * Define if the animation should loop or stop after the first play.
  10759. */
  10760. loop?: boolean;
  10761. private _target;
  10762. /**
  10763. * Instantiate the action
  10764. * @param triggerOptions defines the trigger options
  10765. * @param target defines the target animation or animation name
  10766. * @param from defines from where the animation should start (animation frame)
  10767. * @param end defines where the animation should stop (animation frame)
  10768. * @param loop defines if the animation should loop or stop after the first play
  10769. * @param condition defines the trigger related conditions
  10770. */
  10771. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10772. /** @hidden */
  10773. _prepare(): void;
  10774. /**
  10775. * Execute the action and play the animation.
  10776. */
  10777. execute(): void;
  10778. /**
  10779. * Serializes the actions and its related information.
  10780. * @param parent defines the object to serialize in
  10781. * @returns the serialized object
  10782. */
  10783. serialize(parent: any): any;
  10784. }
  10785. /**
  10786. * This defines an action responsible to stop an animation once triggered.
  10787. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10788. */
  10789. export class StopAnimationAction extends Action {
  10790. private _target;
  10791. /**
  10792. * Instantiate the action
  10793. * @param triggerOptions defines the trigger options
  10794. * @param target defines the target animation or animation name
  10795. * @param condition defines the trigger related conditions
  10796. */
  10797. constructor(triggerOptions: any, target: any, condition?: Condition);
  10798. /** @hidden */
  10799. _prepare(): void;
  10800. /**
  10801. * Execute the action and stop the animation.
  10802. */
  10803. execute(): void;
  10804. /**
  10805. * Serializes the actions and its related information.
  10806. * @param parent defines the object to serialize in
  10807. * @returns the serialized object
  10808. */
  10809. serialize(parent: any): any;
  10810. }
  10811. /**
  10812. * This defines an action responsible that does nothing once triggered.
  10813. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10814. */
  10815. export class DoNothingAction extends Action {
  10816. /**
  10817. * Instantiate the action
  10818. * @param triggerOptions defines the trigger options
  10819. * @param condition defines the trigger related conditions
  10820. */
  10821. constructor(triggerOptions?: any, condition?: Condition);
  10822. /**
  10823. * Execute the action and do nothing.
  10824. */
  10825. execute(): void;
  10826. /**
  10827. * Serializes the actions and its related information.
  10828. * @param parent defines the object to serialize in
  10829. * @returns the serialized object
  10830. */
  10831. serialize(parent: any): any;
  10832. }
  10833. /**
  10834. * This defines an action responsible to trigger several actions once triggered.
  10835. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10836. */
  10837. export class CombineAction extends Action {
  10838. /**
  10839. * The list of aggregated animations to run.
  10840. */
  10841. children: Action[];
  10842. /**
  10843. * Instantiate the action
  10844. * @param triggerOptions defines the trigger options
  10845. * @param children defines the list of aggregated animations to run
  10846. * @param condition defines the trigger related conditions
  10847. */
  10848. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10849. /** @hidden */
  10850. _prepare(): void;
  10851. /**
  10852. * Execute the action and executes all the aggregated actions.
  10853. */
  10854. execute(evt: ActionEvent): void;
  10855. /**
  10856. * Serializes the actions and its related information.
  10857. * @param parent defines the object to serialize in
  10858. * @returns the serialized object
  10859. */
  10860. serialize(parent: any): any;
  10861. }
  10862. /**
  10863. * This defines an action responsible to run code (external event) once triggered.
  10864. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10865. */
  10866. export class ExecuteCodeAction extends Action {
  10867. /**
  10868. * The callback function to run.
  10869. */
  10870. func: (evt: ActionEvent) => void;
  10871. /**
  10872. * Instantiate the action
  10873. * @param triggerOptions defines the trigger options
  10874. * @param func defines the callback function to run
  10875. * @param condition defines the trigger related conditions
  10876. */
  10877. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10878. /**
  10879. * Execute the action and run the attached code.
  10880. */
  10881. execute(evt: ActionEvent): void;
  10882. }
  10883. /**
  10884. * This defines an action responsible to set the parent property of the target once triggered.
  10885. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10886. */
  10887. export class SetParentAction extends Action {
  10888. private _parent;
  10889. private _target;
  10890. /**
  10891. * Instantiate the action
  10892. * @param triggerOptions defines the trigger options
  10893. * @param target defines the target containing the parent property
  10894. * @param parent defines from where the animation should start (animation frame)
  10895. * @param condition defines the trigger related conditions
  10896. */
  10897. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10898. /** @hidden */
  10899. _prepare(): void;
  10900. /**
  10901. * Execute the action and set the parent property.
  10902. */
  10903. execute(): void;
  10904. /**
  10905. * Serializes the actions and its related information.
  10906. * @param parent defines the object to serialize in
  10907. * @returns the serialized object
  10908. */
  10909. serialize(parent: any): any;
  10910. }
  10911. }
  10912. declare module "babylonjs/Actions/actionManager" {
  10913. import { Nullable } from "babylonjs/types";
  10914. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10915. import { Scene } from "babylonjs/scene";
  10916. import { IAction } from "babylonjs/Actions/action";
  10917. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10918. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10919. /**
  10920. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10921. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10922. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10923. */
  10924. export class ActionManager extends AbstractActionManager {
  10925. /**
  10926. * Nothing
  10927. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10928. */
  10929. static readonly NothingTrigger: number;
  10930. /**
  10931. * On pick
  10932. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10933. */
  10934. static readonly OnPickTrigger: number;
  10935. /**
  10936. * On left pick
  10937. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10938. */
  10939. static readonly OnLeftPickTrigger: number;
  10940. /**
  10941. * On right pick
  10942. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10943. */
  10944. static readonly OnRightPickTrigger: number;
  10945. /**
  10946. * On center pick
  10947. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10948. */
  10949. static readonly OnCenterPickTrigger: number;
  10950. /**
  10951. * On pick down
  10952. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10953. */
  10954. static readonly OnPickDownTrigger: number;
  10955. /**
  10956. * On double pick
  10957. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10958. */
  10959. static readonly OnDoublePickTrigger: number;
  10960. /**
  10961. * On pick up
  10962. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10963. */
  10964. static readonly OnPickUpTrigger: number;
  10965. /**
  10966. * On pick out.
  10967. * This trigger will only be raised if you also declared a OnPickDown
  10968. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10969. */
  10970. static readonly OnPickOutTrigger: number;
  10971. /**
  10972. * On long press
  10973. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10974. */
  10975. static readonly OnLongPressTrigger: number;
  10976. /**
  10977. * On pointer over
  10978. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10979. */
  10980. static readonly OnPointerOverTrigger: number;
  10981. /**
  10982. * On pointer out
  10983. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10984. */
  10985. static readonly OnPointerOutTrigger: number;
  10986. /**
  10987. * On every frame
  10988. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10989. */
  10990. static readonly OnEveryFrameTrigger: number;
  10991. /**
  10992. * On intersection enter
  10993. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10994. */
  10995. static readonly OnIntersectionEnterTrigger: number;
  10996. /**
  10997. * On intersection exit
  10998. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10999. */
  11000. static readonly OnIntersectionExitTrigger: number;
  11001. /**
  11002. * On key down
  11003. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11004. */
  11005. static readonly OnKeyDownTrigger: number;
  11006. /**
  11007. * On key up
  11008. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11009. */
  11010. static readonly OnKeyUpTrigger: number;
  11011. private _scene;
  11012. /**
  11013. * Creates a new action manager
  11014. * @param scene defines the hosting scene
  11015. */
  11016. constructor(scene: Scene);
  11017. /**
  11018. * Releases all associated resources
  11019. */
  11020. dispose(): void;
  11021. /**
  11022. * Gets hosting scene
  11023. * @returns the hosting scene
  11024. */
  11025. getScene(): Scene;
  11026. /**
  11027. * Does this action manager handles actions of any of the given triggers
  11028. * @param triggers defines the triggers to be tested
  11029. * @return a boolean indicating whether one (or more) of the triggers is handled
  11030. */
  11031. hasSpecificTriggers(triggers: number[]): boolean;
  11032. /**
  11033. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  11034. * speed.
  11035. * @param triggerA defines the trigger to be tested
  11036. * @param triggerB defines the trigger to be tested
  11037. * @return a boolean indicating whether one (or more) of the triggers is handled
  11038. */
  11039. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  11040. /**
  11041. * Does this action manager handles actions of a given trigger
  11042. * @param trigger defines the trigger to be tested
  11043. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  11044. * @return whether the trigger is handled
  11045. */
  11046. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  11047. /**
  11048. * Does this action manager has pointer triggers
  11049. */
  11050. readonly hasPointerTriggers: boolean;
  11051. /**
  11052. * Does this action manager has pick triggers
  11053. */
  11054. readonly hasPickTriggers: boolean;
  11055. /**
  11056. * Registers an action to this action manager
  11057. * @param action defines the action to be registered
  11058. * @return the action amended (prepared) after registration
  11059. */
  11060. registerAction(action: IAction): Nullable<IAction>;
  11061. /**
  11062. * Unregisters an action to this action manager
  11063. * @param action defines the action to be unregistered
  11064. * @return a boolean indicating whether the action has been unregistered
  11065. */
  11066. unregisterAction(action: IAction): Boolean;
  11067. /**
  11068. * Process a specific trigger
  11069. * @param trigger defines the trigger to process
  11070. * @param evt defines the event details to be processed
  11071. */
  11072. processTrigger(trigger: number, evt?: IActionEvent): void;
  11073. /** @hidden */
  11074. _getEffectiveTarget(target: any, propertyPath: string): any;
  11075. /** @hidden */
  11076. _getProperty(propertyPath: string): string;
  11077. /**
  11078. * Serialize this manager to a JSON object
  11079. * @param name defines the property name to store this manager
  11080. * @returns a JSON representation of this manager
  11081. */
  11082. serialize(name: string): any;
  11083. /**
  11084. * Creates a new ActionManager from a JSON data
  11085. * @param parsedActions defines the JSON data to read from
  11086. * @param object defines the hosting mesh
  11087. * @param scene defines the hosting scene
  11088. */
  11089. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  11090. /**
  11091. * Get a trigger name by index
  11092. * @param trigger defines the trigger index
  11093. * @returns a trigger name
  11094. */
  11095. static GetTriggerName(trigger: number): string;
  11096. }
  11097. }
  11098. declare module "babylonjs/Culling/ray" {
  11099. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  11100. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  11101. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11102. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11103. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  11104. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  11105. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  11106. import { Plane } from "babylonjs/Maths/math.plane";
  11107. /**
  11108. * Class representing a ray with position and direction
  11109. */
  11110. export class Ray {
  11111. /** origin point */
  11112. origin: Vector3;
  11113. /** direction */
  11114. direction: Vector3;
  11115. /** length of the ray */
  11116. length: number;
  11117. private static readonly TmpVector3;
  11118. private _tmpRay;
  11119. /**
  11120. * Creates a new ray
  11121. * @param origin origin point
  11122. * @param direction direction
  11123. * @param length length of the ray
  11124. */
  11125. constructor(
  11126. /** origin point */
  11127. origin: Vector3,
  11128. /** direction */
  11129. direction: Vector3,
  11130. /** length of the ray */
  11131. length?: number);
  11132. /**
  11133. * Checks if the ray intersects a box
  11134. * @param minimum bound of the box
  11135. * @param maximum bound of the box
  11136. * @param intersectionTreshold extra extend to be added to the box in all direction
  11137. * @returns if the box was hit
  11138. */
  11139. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  11140. /**
  11141. * Checks if the ray intersects a box
  11142. * @param box the bounding box to check
  11143. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  11144. * @returns if the box was hit
  11145. */
  11146. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  11147. /**
  11148. * If the ray hits a sphere
  11149. * @param sphere the bounding sphere to check
  11150. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  11151. * @returns true if it hits the sphere
  11152. */
  11153. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  11154. /**
  11155. * If the ray hits a triange
  11156. * @param vertex0 triangle vertex
  11157. * @param vertex1 triangle vertex
  11158. * @param vertex2 triangle vertex
  11159. * @returns intersection information if hit
  11160. */
  11161. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  11162. /**
  11163. * Checks if ray intersects a plane
  11164. * @param plane the plane to check
  11165. * @returns the distance away it was hit
  11166. */
  11167. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  11168. /**
  11169. * Calculate the intercept of a ray on a given axis
  11170. * @param axis to check 'x' | 'y' | 'z'
  11171. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  11172. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  11173. */
  11174. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  11175. /**
  11176. * Checks if ray intersects a mesh
  11177. * @param mesh the mesh to check
  11178. * @param fastCheck if only the bounding box should checked
  11179. * @returns picking info of the intersecton
  11180. */
  11181. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  11182. /**
  11183. * Checks if ray intersects a mesh
  11184. * @param meshes the meshes to check
  11185. * @param fastCheck if only the bounding box should checked
  11186. * @param results array to store result in
  11187. * @returns Array of picking infos
  11188. */
  11189. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  11190. private _comparePickingInfo;
  11191. private static smallnum;
  11192. private static rayl;
  11193. /**
  11194. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  11195. * @param sega the first point of the segment to test the intersection against
  11196. * @param segb the second point of the segment to test the intersection against
  11197. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  11198. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  11199. */
  11200. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  11201. /**
  11202. * Update the ray from viewport position
  11203. * @param x position
  11204. * @param y y position
  11205. * @param viewportWidth viewport width
  11206. * @param viewportHeight viewport height
  11207. * @param world world matrix
  11208. * @param view view matrix
  11209. * @param projection projection matrix
  11210. * @returns this ray updated
  11211. */
  11212. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11213. /**
  11214. * Creates a ray with origin and direction of 0,0,0
  11215. * @returns the new ray
  11216. */
  11217. static Zero(): Ray;
  11218. /**
  11219. * Creates a new ray from screen space and viewport
  11220. * @param x position
  11221. * @param y y position
  11222. * @param viewportWidth viewport width
  11223. * @param viewportHeight viewport height
  11224. * @param world world matrix
  11225. * @param view view matrix
  11226. * @param projection projection matrix
  11227. * @returns new ray
  11228. */
  11229. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11230. /**
  11231. * 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
  11232. * transformed to the given world matrix.
  11233. * @param origin The origin point
  11234. * @param end The end point
  11235. * @param world a matrix to transform the ray to. Default is the identity matrix.
  11236. * @returns the new ray
  11237. */
  11238. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  11239. /**
  11240. * Transforms a ray by a matrix
  11241. * @param ray ray to transform
  11242. * @param matrix matrix to apply
  11243. * @returns the resulting new ray
  11244. */
  11245. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  11246. /**
  11247. * Transforms a ray by a matrix
  11248. * @param ray ray to transform
  11249. * @param matrix matrix to apply
  11250. * @param result ray to store result in
  11251. */
  11252. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  11253. /**
  11254. * Unproject a ray from screen space to object space
  11255. * @param sourceX defines the screen space x coordinate to use
  11256. * @param sourceY defines the screen space y coordinate to use
  11257. * @param viewportWidth defines the current width of the viewport
  11258. * @param viewportHeight defines the current height of the viewport
  11259. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  11260. * @param view defines the view matrix to use
  11261. * @param projection defines the projection matrix to use
  11262. */
  11263. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  11264. }
  11265. /**
  11266. * Type used to define predicate used to select faces when a mesh intersection is detected
  11267. */
  11268. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  11269. module "babylonjs/scene" {
  11270. interface Scene {
  11271. /** @hidden */
  11272. _tempPickingRay: Nullable<Ray>;
  11273. /** @hidden */
  11274. _cachedRayForTransform: Ray;
  11275. /** @hidden */
  11276. _pickWithRayInverseMatrix: Matrix;
  11277. /** @hidden */
  11278. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  11279. /** @hidden */
  11280. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  11281. }
  11282. }
  11283. }
  11284. declare module "babylonjs/sceneComponent" {
  11285. import { Scene } from "babylonjs/scene";
  11286. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11287. import { SubMesh } from "babylonjs/Meshes/subMesh";
  11288. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  11289. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  11290. import { Nullable } from "babylonjs/types";
  11291. import { Camera } from "babylonjs/Cameras/camera";
  11292. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  11293. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11294. import { AbstractScene } from "babylonjs/abstractScene";
  11295. import { Mesh } from "babylonjs/Meshes/mesh";
  11296. /**
  11297. * Groups all the scene component constants in one place to ease maintenance.
  11298. * @hidden
  11299. */
  11300. export class SceneComponentConstants {
  11301. static readonly NAME_EFFECTLAYER: string;
  11302. static readonly NAME_LAYER: string;
  11303. static readonly NAME_LENSFLARESYSTEM: string;
  11304. static readonly NAME_BOUNDINGBOXRENDERER: string;
  11305. static readonly NAME_PARTICLESYSTEM: string;
  11306. static readonly NAME_GAMEPAD: string;
  11307. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  11308. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  11309. static readonly NAME_DEPTHRENDERER: string;
  11310. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  11311. static readonly NAME_SPRITE: string;
  11312. static readonly NAME_OUTLINERENDERER: string;
  11313. static readonly NAME_PROCEDURALTEXTURE: string;
  11314. static readonly NAME_SHADOWGENERATOR: string;
  11315. static readonly NAME_OCTREE: string;
  11316. static readonly NAME_PHYSICSENGINE: string;
  11317. static readonly NAME_AUDIO: string;
  11318. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  11319. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11320. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  11321. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11322. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  11323. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  11324. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  11325. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  11326. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  11327. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  11328. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  11329. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  11330. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  11331. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  11332. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  11333. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  11334. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  11335. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  11336. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  11337. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  11338. static readonly STEP_AFTERRENDER_AUDIO: number;
  11339. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  11340. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  11341. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  11342. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  11343. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  11344. static readonly STEP_POINTERMOVE_SPRITE: number;
  11345. static readonly STEP_POINTERDOWN_SPRITE: number;
  11346. static readonly STEP_POINTERUP_SPRITE: number;
  11347. }
  11348. /**
  11349. * This represents a scene component.
  11350. *
  11351. * This is used to decouple the dependency the scene is having on the different workloads like
  11352. * layers, post processes...
  11353. */
  11354. export interface ISceneComponent {
  11355. /**
  11356. * The name of the component. Each component must have a unique name.
  11357. */
  11358. name: string;
  11359. /**
  11360. * The scene the component belongs to.
  11361. */
  11362. scene: Scene;
  11363. /**
  11364. * Register the component to one instance of a scene.
  11365. */
  11366. register(): void;
  11367. /**
  11368. * Rebuilds the elements related to this component in case of
  11369. * context lost for instance.
  11370. */
  11371. rebuild(): void;
  11372. /**
  11373. * Disposes the component and the associated ressources.
  11374. */
  11375. dispose(): void;
  11376. }
  11377. /**
  11378. * This represents a SERIALIZABLE scene component.
  11379. *
  11380. * This extends Scene Component to add Serialization methods on top.
  11381. */
  11382. export interface ISceneSerializableComponent extends ISceneComponent {
  11383. /**
  11384. * Adds all the elements from the container to the scene
  11385. * @param container the container holding the elements
  11386. */
  11387. addFromContainer(container: AbstractScene): void;
  11388. /**
  11389. * Removes all the elements in the container from the scene
  11390. * @param container contains the elements to remove
  11391. * @param dispose if the removed element should be disposed (default: false)
  11392. */
  11393. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  11394. /**
  11395. * Serializes the component data to the specified json object
  11396. * @param serializationObject The object to serialize to
  11397. */
  11398. serialize(serializationObject: any): void;
  11399. }
  11400. /**
  11401. * Strong typing of a Mesh related stage step action
  11402. */
  11403. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  11404. /**
  11405. * Strong typing of a Evaluate Sub Mesh related stage step action
  11406. */
  11407. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  11408. /**
  11409. * Strong typing of a Active Mesh related stage step action
  11410. */
  11411. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  11412. /**
  11413. * Strong typing of a Camera related stage step action
  11414. */
  11415. export type CameraStageAction = (camera: Camera) => void;
  11416. /**
  11417. * Strong typing of a Camera Frame buffer related stage step action
  11418. */
  11419. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  11420. /**
  11421. * Strong typing of a Render Target related stage step action
  11422. */
  11423. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  11424. /**
  11425. * Strong typing of a RenderingGroup related stage step action
  11426. */
  11427. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  11428. /**
  11429. * Strong typing of a Mesh Render related stage step action
  11430. */
  11431. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  11432. /**
  11433. * Strong typing of a simple stage step action
  11434. */
  11435. export type SimpleStageAction = () => void;
  11436. /**
  11437. * Strong typing of a render target action.
  11438. */
  11439. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  11440. /**
  11441. * Strong typing of a pointer move action.
  11442. */
  11443. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, canvas: HTMLCanvasElement) => Nullable<PickingInfo>;
  11444. /**
  11445. * Strong typing of a pointer up/down action.
  11446. */
  11447. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  11448. /**
  11449. * Representation of a stage in the scene (Basically a list of ordered steps)
  11450. * @hidden
  11451. */
  11452. export class Stage<T extends Function> extends Array<{
  11453. index: number;
  11454. component: ISceneComponent;
  11455. action: T;
  11456. }> {
  11457. /**
  11458. * Hide ctor from the rest of the world.
  11459. * @param items The items to add.
  11460. */
  11461. private constructor();
  11462. /**
  11463. * Creates a new Stage.
  11464. * @returns A new instance of a Stage
  11465. */
  11466. static Create<T extends Function>(): Stage<T>;
  11467. /**
  11468. * Registers a step in an ordered way in the targeted stage.
  11469. * @param index Defines the position to register the step in
  11470. * @param component Defines the component attached to the step
  11471. * @param action Defines the action to launch during the step
  11472. */
  11473. registerStep(index: number, component: ISceneComponent, action: T): void;
  11474. /**
  11475. * Clears all the steps from the stage.
  11476. */
  11477. clear(): void;
  11478. }
  11479. }
  11480. declare module "babylonjs/Sprites/spriteSceneComponent" {
  11481. import { Nullable } from "babylonjs/types";
  11482. import { Observable } from "babylonjs/Misc/observable";
  11483. import { Scene } from "babylonjs/scene";
  11484. import { Sprite } from "babylonjs/Sprites/sprite";
  11485. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11486. import { Ray } from "babylonjs/Culling/ray";
  11487. import { Camera } from "babylonjs/Cameras/camera";
  11488. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11489. import { ISceneComponent } from "babylonjs/sceneComponent";
  11490. module "babylonjs/scene" {
  11491. interface Scene {
  11492. /** @hidden */
  11493. _pointerOverSprite: Nullable<Sprite>;
  11494. /** @hidden */
  11495. _pickedDownSprite: Nullable<Sprite>;
  11496. /** @hidden */
  11497. _tempSpritePickingRay: Nullable<Ray>;
  11498. /**
  11499. * All of the sprite managers added to this scene
  11500. * @see http://doc.babylonjs.com/babylon101/sprites
  11501. */
  11502. spriteManagers: Array<ISpriteManager>;
  11503. /**
  11504. * An event triggered when sprites rendering is about to start
  11505. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11506. */
  11507. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11508. /**
  11509. * An event triggered when sprites rendering is done
  11510. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11511. */
  11512. onAfterSpritesRenderingObservable: Observable<Scene>;
  11513. /** @hidden */
  11514. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11515. /** Launch a ray to try to pick a sprite in the scene
  11516. * @param x position on screen
  11517. * @param y position on screen
  11518. * @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
  11519. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11520. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11521. * @returns a PickingInfo
  11522. */
  11523. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11524. /** Use the given ray to pick a sprite in the scene
  11525. * @param ray The ray (in world space) to use to pick meshes
  11526. * @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
  11527. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11528. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11529. * @returns a PickingInfo
  11530. */
  11531. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11532. /** @hidden */
  11533. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11534. /** Launch a ray to try to pick sprites in the scene
  11535. * @param x position on screen
  11536. * @param y position on screen
  11537. * @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
  11538. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11539. * @returns a PickingInfo array
  11540. */
  11541. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11542. /** Use the given ray to pick sprites in the scene
  11543. * @param ray The ray (in world space) to use to pick meshes
  11544. * @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
  11545. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11546. * @returns a PickingInfo array
  11547. */
  11548. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11549. /**
  11550. * Force the sprite under the pointer
  11551. * @param sprite defines the sprite to use
  11552. */
  11553. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11554. /**
  11555. * Gets the sprite under the pointer
  11556. * @returns a Sprite or null if no sprite is under the pointer
  11557. */
  11558. getPointerOverSprite(): Nullable<Sprite>;
  11559. }
  11560. }
  11561. /**
  11562. * Defines the sprite scene component responsible to manage sprites
  11563. * in a given scene.
  11564. */
  11565. export class SpriteSceneComponent implements ISceneComponent {
  11566. /**
  11567. * The component name helpfull to identify the component in the list of scene components.
  11568. */
  11569. readonly name: string;
  11570. /**
  11571. * The scene the component belongs to.
  11572. */
  11573. scene: Scene;
  11574. /** @hidden */
  11575. private _spritePredicate;
  11576. /**
  11577. * Creates a new instance of the component for the given scene
  11578. * @param scene Defines the scene to register the component in
  11579. */
  11580. constructor(scene: Scene);
  11581. /**
  11582. * Registers the component in a given scene
  11583. */
  11584. register(): void;
  11585. /**
  11586. * Rebuilds the elements related to this component in case of
  11587. * context lost for instance.
  11588. */
  11589. rebuild(): void;
  11590. /**
  11591. * Disposes the component and the associated ressources.
  11592. */
  11593. dispose(): void;
  11594. private _pickSpriteButKeepRay;
  11595. private _pointerMove;
  11596. private _pointerDown;
  11597. private _pointerUp;
  11598. }
  11599. }
  11600. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11601. /** @hidden */
  11602. export var fogFragmentDeclaration: {
  11603. name: string;
  11604. shader: string;
  11605. };
  11606. }
  11607. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11608. /** @hidden */
  11609. export var fogFragment: {
  11610. name: string;
  11611. shader: string;
  11612. };
  11613. }
  11614. declare module "babylonjs/Shaders/sprites.fragment" {
  11615. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11616. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11617. /** @hidden */
  11618. export var spritesPixelShader: {
  11619. name: string;
  11620. shader: string;
  11621. };
  11622. }
  11623. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11624. /** @hidden */
  11625. export var fogVertexDeclaration: {
  11626. name: string;
  11627. shader: string;
  11628. };
  11629. }
  11630. declare module "babylonjs/Shaders/sprites.vertex" {
  11631. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11632. /** @hidden */
  11633. export var spritesVertexShader: {
  11634. name: string;
  11635. shader: string;
  11636. };
  11637. }
  11638. declare module "babylonjs/Sprites/spriteManager" {
  11639. import { IDisposable, Scene } from "babylonjs/scene";
  11640. import { Nullable } from "babylonjs/types";
  11641. import { Observable } from "babylonjs/Misc/observable";
  11642. import { Sprite } from "babylonjs/Sprites/sprite";
  11643. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11644. import { Camera } from "babylonjs/Cameras/camera";
  11645. import { Texture } from "babylonjs/Materials/Textures/texture";
  11646. import "babylonjs/Shaders/sprites.fragment";
  11647. import "babylonjs/Shaders/sprites.vertex";
  11648. import { Ray } from "babylonjs/Culling/ray";
  11649. /**
  11650. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11651. */
  11652. export interface ISpriteManager extends IDisposable {
  11653. /**
  11654. * Restricts the camera to viewing objects with the same layerMask.
  11655. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11656. */
  11657. layerMask: number;
  11658. /**
  11659. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11660. */
  11661. isPickable: boolean;
  11662. /**
  11663. * Specifies the rendering group id for this mesh (0 by default)
  11664. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11665. */
  11666. renderingGroupId: number;
  11667. /**
  11668. * Defines the list of sprites managed by the manager.
  11669. */
  11670. sprites: Array<Sprite>;
  11671. /**
  11672. * Tests the intersection of a sprite with a specific ray.
  11673. * @param ray The ray we are sending to test the collision
  11674. * @param camera The camera space we are sending rays in
  11675. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11676. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  11677. * @returns picking info or null.
  11678. */
  11679. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11680. /**
  11681. * Intersects the sprites with a ray
  11682. * @param ray defines the ray to intersect with
  11683. * @param camera defines the current active camera
  11684. * @param predicate defines a predicate used to select candidate sprites
  11685. * @returns null if no hit or a PickingInfo array
  11686. */
  11687. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11688. /**
  11689. * Renders the list of sprites on screen.
  11690. */
  11691. render(): void;
  11692. }
  11693. /**
  11694. * Class used to manage multiple sprites on the same spritesheet
  11695. * @see http://doc.babylonjs.com/babylon101/sprites
  11696. */
  11697. export class SpriteManager implements ISpriteManager {
  11698. /** defines the manager's name */
  11699. name: string;
  11700. /** Gets the list of sprites */
  11701. sprites: Sprite[];
  11702. /** Gets or sets the rendering group id (0 by default) */
  11703. renderingGroupId: number;
  11704. /** Gets or sets camera layer mask */
  11705. layerMask: number;
  11706. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11707. fogEnabled: boolean;
  11708. /** Gets or sets a boolean indicating if the sprites are pickable */
  11709. isPickable: boolean;
  11710. /** Defines the default width of a cell in the spritesheet */
  11711. cellWidth: number;
  11712. /** Defines the default height of a cell in the spritesheet */
  11713. cellHeight: number;
  11714. /** Associative array from JSON sprite data file */
  11715. private _cellData;
  11716. /** Array of sprite names from JSON sprite data file */
  11717. private _spriteMap;
  11718. /** True when packed cell data from JSON file is ready*/
  11719. private _packedAndReady;
  11720. /**
  11721. * An event triggered when the manager is disposed.
  11722. */
  11723. onDisposeObservable: Observable<SpriteManager>;
  11724. private _onDisposeObserver;
  11725. /**
  11726. * Callback called when the manager is disposed
  11727. */
  11728. onDispose: () => void;
  11729. private _capacity;
  11730. private _fromPacked;
  11731. private _spriteTexture;
  11732. private _epsilon;
  11733. private _scene;
  11734. private _vertexData;
  11735. private _buffer;
  11736. private _vertexBuffers;
  11737. private _indexBuffer;
  11738. private _effectBase;
  11739. private _effectFog;
  11740. /**
  11741. * Gets or sets the spritesheet texture
  11742. */
  11743. texture: Texture;
  11744. /**
  11745. * Creates a new sprite manager
  11746. * @param name defines the manager's name
  11747. * @param imgUrl defines the sprite sheet url
  11748. * @param capacity defines the maximum allowed number of sprites
  11749. * @param cellSize defines the size of a sprite cell
  11750. * @param scene defines the hosting scene
  11751. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11752. * @param samplingMode defines the smapling mode to use with spritesheet
  11753. * @param fromPacked set to false; do not alter
  11754. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11755. */
  11756. constructor(
  11757. /** defines the manager's name */
  11758. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  11759. private _makePacked;
  11760. private _appendSpriteVertex;
  11761. /**
  11762. * Intersects the sprites with a ray
  11763. * @param ray defines the ray to intersect with
  11764. * @param camera defines the current active camera
  11765. * @param predicate defines a predicate used to select candidate sprites
  11766. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11767. * @returns null if no hit or a PickingInfo
  11768. */
  11769. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11770. /**
  11771. * Intersects the sprites with a ray
  11772. * @param ray defines the ray to intersect with
  11773. * @param camera defines the current active camera
  11774. * @param predicate defines a predicate used to select candidate sprites
  11775. * @returns null if no hit or a PickingInfo array
  11776. */
  11777. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11778. /**
  11779. * Render all child sprites
  11780. */
  11781. render(): void;
  11782. /**
  11783. * Release associated resources
  11784. */
  11785. dispose(): void;
  11786. }
  11787. }
  11788. declare module "babylonjs/Sprites/sprite" {
  11789. import { Vector3 } from "babylonjs/Maths/math.vector";
  11790. import { Nullable } from "babylonjs/types";
  11791. import { ActionManager } from "babylonjs/Actions/actionManager";
  11792. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11793. import { Color4 } from "babylonjs/Maths/math.color";
  11794. /**
  11795. * Class used to represent a sprite
  11796. * @see http://doc.babylonjs.com/babylon101/sprites
  11797. */
  11798. export class Sprite {
  11799. /** defines the name */
  11800. name: string;
  11801. /** Gets or sets the current world position */
  11802. position: Vector3;
  11803. /** Gets or sets the main color */
  11804. color: Color4;
  11805. /** Gets or sets the width */
  11806. width: number;
  11807. /** Gets or sets the height */
  11808. height: number;
  11809. /** Gets or sets rotation angle */
  11810. angle: number;
  11811. /** Gets or sets the cell index in the sprite sheet */
  11812. cellIndex: number;
  11813. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  11814. cellRef: string;
  11815. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  11816. invertU: number;
  11817. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  11818. invertV: number;
  11819. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  11820. disposeWhenFinishedAnimating: boolean;
  11821. /** Gets the list of attached animations */
  11822. animations: Animation[];
  11823. /** Gets or sets a boolean indicating if the sprite can be picked */
  11824. isPickable: boolean;
  11825. /**
  11826. * Gets or sets the associated action manager
  11827. */
  11828. actionManager: Nullable<ActionManager>;
  11829. private _animationStarted;
  11830. private _loopAnimation;
  11831. private _fromIndex;
  11832. private _toIndex;
  11833. private _delay;
  11834. private _direction;
  11835. private _manager;
  11836. private _time;
  11837. private _onAnimationEnd;
  11838. /**
  11839. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  11840. */
  11841. isVisible: boolean;
  11842. /**
  11843. * Gets or sets the sprite size
  11844. */
  11845. size: number;
  11846. /**
  11847. * Creates a new Sprite
  11848. * @param name defines the name
  11849. * @param manager defines the manager
  11850. */
  11851. constructor(
  11852. /** defines the name */
  11853. name: string, manager: ISpriteManager);
  11854. /**
  11855. * Starts an animation
  11856. * @param from defines the initial key
  11857. * @param to defines the end key
  11858. * @param loop defines if the animation must loop
  11859. * @param delay defines the start delay (in ms)
  11860. * @param onAnimationEnd defines a callback to call when animation ends
  11861. */
  11862. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  11863. /** Stops current animation (if any) */
  11864. stopAnimation(): void;
  11865. /** @hidden */
  11866. _animate(deltaTime: number): void;
  11867. /** Release associated resources */
  11868. dispose(): void;
  11869. }
  11870. }
  11871. declare module "babylonjs/Collisions/pickingInfo" {
  11872. import { Nullable } from "babylonjs/types";
  11873. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11874. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11875. import { Sprite } from "babylonjs/Sprites/sprite";
  11876. import { Ray } from "babylonjs/Culling/ray";
  11877. /**
  11878. * Information about the result of picking within a scene
  11879. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  11880. */
  11881. export class PickingInfo {
  11882. /** @hidden */
  11883. _pickingUnavailable: boolean;
  11884. /**
  11885. * If the pick collided with an object
  11886. */
  11887. hit: boolean;
  11888. /**
  11889. * Distance away where the pick collided
  11890. */
  11891. distance: number;
  11892. /**
  11893. * The location of pick collision
  11894. */
  11895. pickedPoint: Nullable<Vector3>;
  11896. /**
  11897. * The mesh corresponding the the pick collision
  11898. */
  11899. pickedMesh: Nullable<AbstractMesh>;
  11900. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  11901. bu: number;
  11902. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  11903. bv: number;
  11904. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  11905. faceId: number;
  11906. /** Id of the the submesh that was picked */
  11907. subMeshId: number;
  11908. /** If a sprite was picked, this will be the sprite the pick collided with */
  11909. pickedSprite: Nullable<Sprite>;
  11910. /**
  11911. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  11912. */
  11913. originMesh: Nullable<AbstractMesh>;
  11914. /**
  11915. * The ray that was used to perform the picking.
  11916. */
  11917. ray: Nullable<Ray>;
  11918. /**
  11919. * Gets the normal correspodning to the face the pick collided with
  11920. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  11921. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  11922. * @returns The normal correspodning to the face the pick collided with
  11923. */
  11924. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  11925. /**
  11926. * Gets the texture coordinates of where the pick occured
  11927. * @returns the vector containing the coordnates of the texture
  11928. */
  11929. getTextureCoordinates(): Nullable<Vector2>;
  11930. }
  11931. }
  11932. declare module "babylonjs/Events/pointerEvents" {
  11933. import { Nullable } from "babylonjs/types";
  11934. import { Vector2 } from "babylonjs/Maths/math.vector";
  11935. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11936. import { Ray } from "babylonjs/Culling/ray";
  11937. /**
  11938. * Gather the list of pointer event types as constants.
  11939. */
  11940. export class PointerEventTypes {
  11941. /**
  11942. * 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.
  11943. */
  11944. static readonly POINTERDOWN: number;
  11945. /**
  11946. * The pointerup event is fired when a pointer is no longer active.
  11947. */
  11948. static readonly POINTERUP: number;
  11949. /**
  11950. * The pointermove event is fired when a pointer changes coordinates.
  11951. */
  11952. static readonly POINTERMOVE: number;
  11953. /**
  11954. * The pointerwheel event is fired when a mouse wheel has been rotated.
  11955. */
  11956. static readonly POINTERWHEEL: number;
  11957. /**
  11958. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  11959. */
  11960. static readonly POINTERPICK: number;
  11961. /**
  11962. * The pointertap event is fired when a the object has been touched and released without drag.
  11963. */
  11964. static readonly POINTERTAP: number;
  11965. /**
  11966. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  11967. */
  11968. static readonly POINTERDOUBLETAP: number;
  11969. }
  11970. /**
  11971. * Base class of pointer info types.
  11972. */
  11973. export class PointerInfoBase {
  11974. /**
  11975. * Defines the type of event (PointerEventTypes)
  11976. */
  11977. type: number;
  11978. /**
  11979. * Defines the related dom event
  11980. */
  11981. event: PointerEvent | MouseWheelEvent;
  11982. /**
  11983. * Instantiates the base class of pointers info.
  11984. * @param type Defines the type of event (PointerEventTypes)
  11985. * @param event Defines the related dom event
  11986. */
  11987. constructor(
  11988. /**
  11989. * Defines the type of event (PointerEventTypes)
  11990. */
  11991. type: number,
  11992. /**
  11993. * Defines the related dom event
  11994. */
  11995. event: PointerEvent | MouseWheelEvent);
  11996. }
  11997. /**
  11998. * This class is used to store pointer related info for the onPrePointerObservable event.
  11999. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  12000. */
  12001. export class PointerInfoPre extends PointerInfoBase {
  12002. /**
  12003. * Ray from a pointer if availible (eg. 6dof controller)
  12004. */
  12005. ray: Nullable<Ray>;
  12006. /**
  12007. * Defines the local position of the pointer on the canvas.
  12008. */
  12009. localPosition: Vector2;
  12010. /**
  12011. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  12012. */
  12013. skipOnPointerObservable: boolean;
  12014. /**
  12015. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  12016. * @param type Defines the type of event (PointerEventTypes)
  12017. * @param event Defines the related dom event
  12018. * @param localX Defines the local x coordinates of the pointer when the event occured
  12019. * @param localY Defines the local y coordinates of the pointer when the event occured
  12020. */
  12021. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  12022. }
  12023. /**
  12024. * This type contains all the data related to a pointer event in Babylon.js.
  12025. * 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.
  12026. */
  12027. export class PointerInfo extends PointerInfoBase {
  12028. /**
  12029. * Defines the picking info associated to the info (if any)\
  12030. */
  12031. pickInfo: Nullable<PickingInfo>;
  12032. /**
  12033. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  12034. * @param type Defines the type of event (PointerEventTypes)
  12035. * @param event Defines the related dom event
  12036. * @param pickInfo Defines the picking info associated to the info (if any)\
  12037. */
  12038. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  12039. /**
  12040. * Defines the picking info associated to the info (if any)\
  12041. */
  12042. pickInfo: Nullable<PickingInfo>);
  12043. }
  12044. /**
  12045. * Data relating to a touch event on the screen.
  12046. */
  12047. export interface PointerTouch {
  12048. /**
  12049. * X coordinate of touch.
  12050. */
  12051. x: number;
  12052. /**
  12053. * Y coordinate of touch.
  12054. */
  12055. y: number;
  12056. /**
  12057. * Id of touch. Unique for each finger.
  12058. */
  12059. pointerId: number;
  12060. /**
  12061. * Event type passed from DOM.
  12062. */
  12063. type: any;
  12064. }
  12065. }
  12066. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  12067. import { Observable } from "babylonjs/Misc/observable";
  12068. import { Nullable } from "babylonjs/types";
  12069. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  12070. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12071. /**
  12072. * Manage the mouse inputs to control the movement of a free camera.
  12073. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12074. */
  12075. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  12076. /**
  12077. * Define if touch is enabled in the mouse input
  12078. */
  12079. touchEnabled: boolean;
  12080. /**
  12081. * Defines the camera the input is attached to.
  12082. */
  12083. camera: FreeCamera;
  12084. /**
  12085. * Defines the buttons associated with the input to handle camera move.
  12086. */
  12087. buttons: number[];
  12088. /**
  12089. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  12090. */
  12091. angularSensibility: number;
  12092. private _pointerInput;
  12093. private _onMouseMove;
  12094. private _observer;
  12095. private previousPosition;
  12096. /**
  12097. * Observable for when a pointer move event occurs containing the move offset
  12098. */
  12099. onPointerMovedObservable: Observable<{
  12100. offsetX: number;
  12101. offsetY: number;
  12102. }>;
  12103. /**
  12104. * @hidden
  12105. * If the camera should be rotated automatically based on pointer movement
  12106. */
  12107. _allowCameraRotation: boolean;
  12108. /**
  12109. * Manage the mouse inputs to control the movement of a free camera.
  12110. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12111. * @param touchEnabled Defines if touch is enabled or not
  12112. */
  12113. constructor(
  12114. /**
  12115. * Define if touch is enabled in the mouse input
  12116. */
  12117. touchEnabled?: boolean);
  12118. /**
  12119. * Attach the input controls to a specific dom element to get the input from.
  12120. * @param element Defines the element the controls should be listened from
  12121. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12122. */
  12123. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12124. /**
  12125. * Called on JS contextmenu event.
  12126. * Override this method to provide functionality.
  12127. */
  12128. protected onContextMenu(evt: PointerEvent): void;
  12129. /**
  12130. * Detach the current controls from the specified dom element.
  12131. * @param element Defines the element to stop listening the inputs from
  12132. */
  12133. detachControl(element: Nullable<HTMLElement>): void;
  12134. /**
  12135. * Gets the class name of the current intput.
  12136. * @returns the class name
  12137. */
  12138. getClassName(): string;
  12139. /**
  12140. * Get the friendly name associated with the input class.
  12141. * @returns the input friendly name
  12142. */
  12143. getSimpleName(): string;
  12144. }
  12145. }
  12146. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  12147. import { Nullable } from "babylonjs/types";
  12148. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  12149. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12150. /**
  12151. * Manage the touch inputs to control the movement of a free camera.
  12152. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12153. */
  12154. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  12155. /**
  12156. * Defines the camera the input is attached to.
  12157. */
  12158. camera: FreeCamera;
  12159. /**
  12160. * Defines the touch sensibility for rotation.
  12161. * The higher the faster.
  12162. */
  12163. touchAngularSensibility: number;
  12164. /**
  12165. * Defines the touch sensibility for move.
  12166. * The higher the faster.
  12167. */
  12168. touchMoveSensibility: number;
  12169. private _offsetX;
  12170. private _offsetY;
  12171. private _pointerPressed;
  12172. private _pointerInput;
  12173. private _observer;
  12174. private _onLostFocus;
  12175. /**
  12176. * Attach the input controls to a specific dom element to get the input from.
  12177. * @param element Defines the element the controls should be listened from
  12178. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12179. */
  12180. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12181. /**
  12182. * Detach the current controls from the specified dom element.
  12183. * @param element Defines the element to stop listening the inputs from
  12184. */
  12185. detachControl(element: Nullable<HTMLElement>): void;
  12186. /**
  12187. * Update the current camera state depending on the inputs that have been used this frame.
  12188. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  12189. */
  12190. checkInputs(): void;
  12191. /**
  12192. * Gets the class name of the current intput.
  12193. * @returns the class name
  12194. */
  12195. getClassName(): string;
  12196. /**
  12197. * Get the friendly name associated with the input class.
  12198. * @returns the input friendly name
  12199. */
  12200. getSimpleName(): string;
  12201. }
  12202. }
  12203. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  12204. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12205. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  12206. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  12207. import { Nullable } from "babylonjs/types";
  12208. /**
  12209. * Default Inputs manager for the FreeCamera.
  12210. * It groups all the default supported inputs for ease of use.
  12211. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12212. */
  12213. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  12214. /**
  12215. * @hidden
  12216. */
  12217. _mouseInput: Nullable<FreeCameraMouseInput>;
  12218. /**
  12219. * Instantiates a new FreeCameraInputsManager.
  12220. * @param camera Defines the camera the inputs belong to
  12221. */
  12222. constructor(camera: FreeCamera);
  12223. /**
  12224. * Add keyboard input support to the input manager.
  12225. * @returns the current input manager
  12226. */
  12227. addKeyboard(): FreeCameraInputsManager;
  12228. /**
  12229. * Add mouse input support to the input manager.
  12230. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  12231. * @returns the current input manager
  12232. */
  12233. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  12234. /**
  12235. * Removes the mouse input support from the manager
  12236. * @returns the current input manager
  12237. */
  12238. removeMouse(): FreeCameraInputsManager;
  12239. /**
  12240. * Add touch input support to the input manager.
  12241. * @returns the current input manager
  12242. */
  12243. addTouch(): FreeCameraInputsManager;
  12244. /**
  12245. * Remove all attached input methods from a camera
  12246. */
  12247. clear(): void;
  12248. }
  12249. }
  12250. declare module "babylonjs/Cameras/freeCamera" {
  12251. import { Vector3 } from "babylonjs/Maths/math.vector";
  12252. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12253. import { Scene } from "babylonjs/scene";
  12254. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  12255. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  12256. /**
  12257. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12258. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  12259. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12260. */
  12261. export class FreeCamera extends TargetCamera {
  12262. /**
  12263. * Define the collision ellipsoid of the camera.
  12264. * This is helpful to simulate a camera body like the player body around the camera
  12265. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  12266. */
  12267. ellipsoid: Vector3;
  12268. /**
  12269. * Define an offset for the position of the ellipsoid around the camera.
  12270. * This can be helpful to determine the center of the body near the gravity center of the body
  12271. * instead of its head.
  12272. */
  12273. ellipsoidOffset: Vector3;
  12274. /**
  12275. * Enable or disable collisions of the camera with the rest of the scene objects.
  12276. */
  12277. checkCollisions: boolean;
  12278. /**
  12279. * Enable or disable gravity on the camera.
  12280. */
  12281. applyGravity: boolean;
  12282. /**
  12283. * Define the input manager associated to the camera.
  12284. */
  12285. inputs: FreeCameraInputsManager;
  12286. /**
  12287. * Gets the input sensibility for a mouse input. (default is 2000.0)
  12288. * Higher values reduce sensitivity.
  12289. */
  12290. /**
  12291. * Sets the input sensibility for a mouse input. (default is 2000.0)
  12292. * Higher values reduce sensitivity.
  12293. */
  12294. angularSensibility: number;
  12295. /**
  12296. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  12297. */
  12298. keysUp: number[];
  12299. /**
  12300. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  12301. */
  12302. keysDown: number[];
  12303. /**
  12304. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  12305. */
  12306. keysLeft: number[];
  12307. /**
  12308. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  12309. */
  12310. keysRight: number[];
  12311. /**
  12312. * Event raised when the camera collide with a mesh in the scene.
  12313. */
  12314. onCollide: (collidedMesh: AbstractMesh) => void;
  12315. private _collider;
  12316. private _needMoveForGravity;
  12317. private _oldPosition;
  12318. private _diffPosition;
  12319. private _newPosition;
  12320. /** @hidden */
  12321. _localDirection: Vector3;
  12322. /** @hidden */
  12323. _transformedDirection: Vector3;
  12324. /**
  12325. * Instantiates a Free Camera.
  12326. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12327. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  12328. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12329. * @param name Define the name of the camera in the scene
  12330. * @param position Define the start position of the camera in the scene
  12331. * @param scene Define the scene the camera belongs to
  12332. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  12333. */
  12334. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  12335. /**
  12336. * Attached controls to the current camera.
  12337. * @param element Defines the element the controls should be listened from
  12338. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12339. */
  12340. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12341. /**
  12342. * Detach the current controls from the camera.
  12343. * The camera will stop reacting to inputs.
  12344. * @param element Defines the element to stop listening the inputs from
  12345. */
  12346. detachControl(element: HTMLElement): void;
  12347. private _collisionMask;
  12348. /**
  12349. * Define a collision mask to limit the list of object the camera can collide with
  12350. */
  12351. collisionMask: number;
  12352. /** @hidden */
  12353. _collideWithWorld(displacement: Vector3): void;
  12354. private _onCollisionPositionChange;
  12355. /** @hidden */
  12356. _checkInputs(): void;
  12357. /** @hidden */
  12358. _decideIfNeedsToMove(): boolean;
  12359. /** @hidden */
  12360. _updatePosition(): void;
  12361. /**
  12362. * Destroy the camera and release the current resources hold by it.
  12363. */
  12364. dispose(): void;
  12365. /**
  12366. * Gets the current object class name.
  12367. * @return the class name
  12368. */
  12369. getClassName(): string;
  12370. }
  12371. }
  12372. declare module "babylonjs/Gamepads/gamepad" {
  12373. import { Observable } from "babylonjs/Misc/observable";
  12374. /**
  12375. * Represents a gamepad control stick position
  12376. */
  12377. export class StickValues {
  12378. /**
  12379. * The x component of the control stick
  12380. */
  12381. x: number;
  12382. /**
  12383. * The y component of the control stick
  12384. */
  12385. y: number;
  12386. /**
  12387. * Initializes the gamepad x and y control stick values
  12388. * @param x The x component of the gamepad control stick value
  12389. * @param y The y component of the gamepad control stick value
  12390. */
  12391. constructor(
  12392. /**
  12393. * The x component of the control stick
  12394. */
  12395. x: number,
  12396. /**
  12397. * The y component of the control stick
  12398. */
  12399. y: number);
  12400. }
  12401. /**
  12402. * An interface which manages callbacks for gamepad button changes
  12403. */
  12404. export interface GamepadButtonChanges {
  12405. /**
  12406. * Called when a gamepad has been changed
  12407. */
  12408. changed: boolean;
  12409. /**
  12410. * Called when a gamepad press event has been triggered
  12411. */
  12412. pressChanged: boolean;
  12413. /**
  12414. * Called when a touch event has been triggered
  12415. */
  12416. touchChanged: boolean;
  12417. /**
  12418. * Called when a value has changed
  12419. */
  12420. valueChanged: boolean;
  12421. }
  12422. /**
  12423. * Represents a gamepad
  12424. */
  12425. export class Gamepad {
  12426. /**
  12427. * The id of the gamepad
  12428. */
  12429. id: string;
  12430. /**
  12431. * The index of the gamepad
  12432. */
  12433. index: number;
  12434. /**
  12435. * The browser gamepad
  12436. */
  12437. browserGamepad: any;
  12438. /**
  12439. * Specifies what type of gamepad this represents
  12440. */
  12441. type: number;
  12442. private _leftStick;
  12443. private _rightStick;
  12444. /** @hidden */
  12445. _isConnected: boolean;
  12446. private _leftStickAxisX;
  12447. private _leftStickAxisY;
  12448. private _rightStickAxisX;
  12449. private _rightStickAxisY;
  12450. /**
  12451. * Triggered when the left control stick has been changed
  12452. */
  12453. private _onleftstickchanged;
  12454. /**
  12455. * Triggered when the right control stick has been changed
  12456. */
  12457. private _onrightstickchanged;
  12458. /**
  12459. * Represents a gamepad controller
  12460. */
  12461. static GAMEPAD: number;
  12462. /**
  12463. * Represents a generic controller
  12464. */
  12465. static GENERIC: number;
  12466. /**
  12467. * Represents an XBox controller
  12468. */
  12469. static XBOX: number;
  12470. /**
  12471. * Represents a pose-enabled controller
  12472. */
  12473. static POSE_ENABLED: number;
  12474. /**
  12475. * Represents an Dual Shock controller
  12476. */
  12477. static DUALSHOCK: number;
  12478. /**
  12479. * Specifies whether the left control stick should be Y-inverted
  12480. */
  12481. protected _invertLeftStickY: boolean;
  12482. /**
  12483. * Specifies if the gamepad has been connected
  12484. */
  12485. readonly isConnected: boolean;
  12486. /**
  12487. * Initializes the gamepad
  12488. * @param id The id of the gamepad
  12489. * @param index The index of the gamepad
  12490. * @param browserGamepad The browser gamepad
  12491. * @param leftStickX The x component of the left joystick
  12492. * @param leftStickY The y component of the left joystick
  12493. * @param rightStickX The x component of the right joystick
  12494. * @param rightStickY The y component of the right joystick
  12495. */
  12496. constructor(
  12497. /**
  12498. * The id of the gamepad
  12499. */
  12500. id: string,
  12501. /**
  12502. * The index of the gamepad
  12503. */
  12504. index: number,
  12505. /**
  12506. * The browser gamepad
  12507. */
  12508. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  12509. /**
  12510. * Callback triggered when the left joystick has changed
  12511. * @param callback
  12512. */
  12513. onleftstickchanged(callback: (values: StickValues) => void): void;
  12514. /**
  12515. * Callback triggered when the right joystick has changed
  12516. * @param callback
  12517. */
  12518. onrightstickchanged(callback: (values: StickValues) => void): void;
  12519. /**
  12520. * Gets the left joystick
  12521. */
  12522. /**
  12523. * Sets the left joystick values
  12524. */
  12525. leftStick: StickValues;
  12526. /**
  12527. * Gets the right joystick
  12528. */
  12529. /**
  12530. * Sets the right joystick value
  12531. */
  12532. rightStick: StickValues;
  12533. /**
  12534. * Updates the gamepad joystick positions
  12535. */
  12536. update(): void;
  12537. /**
  12538. * Disposes the gamepad
  12539. */
  12540. dispose(): void;
  12541. }
  12542. /**
  12543. * Represents a generic gamepad
  12544. */
  12545. export class GenericPad extends Gamepad {
  12546. private _buttons;
  12547. private _onbuttondown;
  12548. private _onbuttonup;
  12549. /**
  12550. * Observable triggered when a button has been pressed
  12551. */
  12552. onButtonDownObservable: Observable<number>;
  12553. /**
  12554. * Observable triggered when a button has been released
  12555. */
  12556. onButtonUpObservable: Observable<number>;
  12557. /**
  12558. * Callback triggered when a button has been pressed
  12559. * @param callback Called when a button has been pressed
  12560. */
  12561. onbuttondown(callback: (buttonPressed: number) => void): void;
  12562. /**
  12563. * Callback triggered when a button has been released
  12564. * @param callback Called when a button has been released
  12565. */
  12566. onbuttonup(callback: (buttonReleased: number) => void): void;
  12567. /**
  12568. * Initializes the generic gamepad
  12569. * @param id The id of the generic gamepad
  12570. * @param index The index of the generic gamepad
  12571. * @param browserGamepad The browser gamepad
  12572. */
  12573. constructor(id: string, index: number, browserGamepad: any);
  12574. private _setButtonValue;
  12575. /**
  12576. * Updates the generic gamepad
  12577. */
  12578. update(): void;
  12579. /**
  12580. * Disposes the generic gamepad
  12581. */
  12582. dispose(): void;
  12583. }
  12584. }
  12585. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  12586. import { Nullable } from "babylonjs/types";
  12587. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  12588. import { Scene } from "babylonjs/scene";
  12589. module "babylonjs/Engines/engine" {
  12590. interface Engine {
  12591. /**
  12592. * Creates a raw texture
  12593. * @param data defines the data to store in the texture
  12594. * @param width defines the width of the texture
  12595. * @param height defines the height of the texture
  12596. * @param format defines the format of the data
  12597. * @param generateMipMaps defines if the engine should generate the mip levels
  12598. * @param invertY defines if data must be stored with Y axis inverted
  12599. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  12600. * @param compression defines the compression used (null by default)
  12601. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12602. * @returns the raw texture inside an InternalTexture
  12603. */
  12604. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  12605. /**
  12606. * Update a raw texture
  12607. * @param texture defines the texture to update
  12608. * @param data defines the data to store in the texture
  12609. * @param format defines the format of the data
  12610. * @param invertY defines if data must be stored with Y axis inverted
  12611. */
  12612. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12613. /**
  12614. * Update a raw texture
  12615. * @param texture defines the texture to update
  12616. * @param data defines the data to store in the texture
  12617. * @param format defines the format of the data
  12618. * @param invertY defines if data must be stored with Y axis inverted
  12619. * @param compression defines the compression used (null by default)
  12620. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12621. */
  12622. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  12623. /**
  12624. * Creates a new raw cube texture
  12625. * @param data defines the array of data to use to create each face
  12626. * @param size defines the size of the textures
  12627. * @param format defines the format of the data
  12628. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12629. * @param generateMipMaps defines if the engine should generate the mip levels
  12630. * @param invertY defines if data must be stored with Y axis inverted
  12631. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12632. * @param compression defines the compression used (null by default)
  12633. * @returns the cube texture as an InternalTexture
  12634. */
  12635. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  12636. /**
  12637. * Update a raw cube texture
  12638. * @param texture defines the texture to udpdate
  12639. * @param data defines the data to store
  12640. * @param format defines the data format
  12641. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12642. * @param invertY defines if data must be stored with Y axis inverted
  12643. */
  12644. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  12645. /**
  12646. * Update a raw cube texture
  12647. * @param texture defines the texture to udpdate
  12648. * @param data defines the data to store
  12649. * @param format defines the data format
  12650. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12651. * @param invertY defines if data must be stored with Y axis inverted
  12652. * @param compression defines the compression used (null by default)
  12653. */
  12654. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  12655. /**
  12656. * Update a raw cube texture
  12657. * @param texture defines the texture to udpdate
  12658. * @param data defines the data to store
  12659. * @param format defines the data format
  12660. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12661. * @param invertY defines if data must be stored with Y axis inverted
  12662. * @param compression defines the compression used (null by default)
  12663. * @param level defines which level of the texture to update
  12664. */
  12665. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  12666. /**
  12667. * Creates a new raw cube texture from a specified url
  12668. * @param url defines the url where the data is located
  12669. * @param scene defines the current scene
  12670. * @param size defines the size of the textures
  12671. * @param format defines the format of the data
  12672. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12673. * @param noMipmap defines if the engine should avoid generating the mip levels
  12674. * @param callback defines a callback used to extract texture data from loaded data
  12675. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12676. * @param onLoad defines a callback called when texture is loaded
  12677. * @param onError defines a callback called if there is an error
  12678. * @returns the cube texture as an InternalTexture
  12679. */
  12680. createRawCubeTextureFromUrl(url: string, scene: 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;
  12681. /**
  12682. * Creates a new raw cube texture from a specified url
  12683. * @param url defines the url where the data is located
  12684. * @param scene defines the current scene
  12685. * @param size defines the size of the textures
  12686. * @param format defines the format of the data
  12687. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12688. * @param noMipmap defines if the engine should avoid generating the mip levels
  12689. * @param callback defines a callback used to extract texture data from loaded data
  12690. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12691. * @param onLoad defines a callback called when texture is loaded
  12692. * @param onError defines a callback called if there is an error
  12693. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12694. * @param invertY defines if data must be stored with Y axis inverted
  12695. * @returns the cube texture as an InternalTexture
  12696. */
  12697. createRawCubeTextureFromUrl(url: string, scene: 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;
  12698. /**
  12699. * Creates a new raw 3D texture
  12700. * @param data defines the data used to create the texture
  12701. * @param width defines the width of the texture
  12702. * @param height defines the height of the texture
  12703. * @param depth defines the depth of the texture
  12704. * @param format defines the format of the texture
  12705. * @param generateMipMaps defines if the engine must generate mip levels
  12706. * @param invertY defines if data must be stored with Y axis inverted
  12707. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12708. * @param compression defines the compressed used (can be null)
  12709. * @param textureType defines the compressed used (can be null)
  12710. * @returns a new raw 3D texture (stored in an InternalTexture)
  12711. */
  12712. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  12713. /**
  12714. * Update a raw 3D texture
  12715. * @param texture defines the texture to update
  12716. * @param data defines the data to store
  12717. * @param format defines the data format
  12718. * @param invertY defines if data must be stored with Y axis inverted
  12719. */
  12720. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12721. /**
  12722. * Update a raw 3D texture
  12723. * @param texture defines the texture to update
  12724. * @param data defines the data to store
  12725. * @param format defines the data format
  12726. * @param invertY defines if data must be stored with Y axis inverted
  12727. * @param compression defines the used compression (can be null)
  12728. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  12729. */
  12730. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  12731. }
  12732. }
  12733. }
  12734. declare module "babylonjs/Materials/Textures/rawTexture" {
  12735. import { Scene } from "babylonjs/scene";
  12736. import { Texture } from "babylonjs/Materials/Textures/texture";
  12737. import "babylonjs/Engines/Extensions/engine.rawTexture";
  12738. /**
  12739. * Raw texture can help creating a texture directly from an array of data.
  12740. * This can be super useful if you either get the data from an uncompressed source or
  12741. * if you wish to create your texture pixel by pixel.
  12742. */
  12743. export class RawTexture extends Texture {
  12744. /**
  12745. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12746. */
  12747. format: number;
  12748. private _engine;
  12749. /**
  12750. * Instantiates a new RawTexture.
  12751. * Raw texture can help creating a texture directly from an array of data.
  12752. * This can be super useful if you either get the data from an uncompressed source or
  12753. * if you wish to create your texture pixel by pixel.
  12754. * @param data define the array of data to use to create the texture
  12755. * @param width define the width of the texture
  12756. * @param height define the height of the texture
  12757. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12758. * @param scene define the scene the texture belongs to
  12759. * @param generateMipMaps define whether mip maps should be generated or not
  12760. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12761. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12762. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12763. */
  12764. constructor(data: ArrayBufferView, width: number, height: number,
  12765. /**
  12766. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12767. */
  12768. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  12769. /**
  12770. * Updates the texture underlying data.
  12771. * @param data Define the new data of the texture
  12772. */
  12773. update(data: ArrayBufferView): void;
  12774. /**
  12775. * Creates a luminance texture from some data.
  12776. * @param data Define the texture data
  12777. * @param width Define the width of the texture
  12778. * @param height Define the height of the texture
  12779. * @param scene Define the scene the texture belongs to
  12780. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12781. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12782. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12783. * @returns the luminance texture
  12784. */
  12785. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12786. /**
  12787. * Creates a luminance alpha texture from some data.
  12788. * @param data Define the texture data
  12789. * @param width Define the width of the texture
  12790. * @param height Define the height of the texture
  12791. * @param scene Define the scene the texture belongs to
  12792. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12793. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12794. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12795. * @returns the luminance alpha texture
  12796. */
  12797. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12798. /**
  12799. * Creates an alpha texture from some data.
  12800. * @param data Define the texture data
  12801. * @param width Define the width of the texture
  12802. * @param height Define the height of the texture
  12803. * @param scene Define the scene the texture belongs to
  12804. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12805. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12806. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12807. * @returns the alpha texture
  12808. */
  12809. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12810. /**
  12811. * Creates a RGB texture from some data.
  12812. * @param data Define the texture data
  12813. * @param width Define the width of the texture
  12814. * @param height Define the height of the texture
  12815. * @param scene Define the scene the texture belongs to
  12816. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12817. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12818. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12819. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12820. * @returns the RGB alpha texture
  12821. */
  12822. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12823. /**
  12824. * Creates a RGBA texture from some data.
  12825. * @param data Define the texture data
  12826. * @param width Define the width of the texture
  12827. * @param height Define the height of the texture
  12828. * @param scene Define the scene the texture belongs to
  12829. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12830. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12831. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12832. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12833. * @returns the RGBA texture
  12834. */
  12835. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12836. /**
  12837. * Creates a R texture from some data.
  12838. * @param data Define the texture data
  12839. * @param width Define the width of the texture
  12840. * @param height Define the height of the texture
  12841. * @param scene Define the scene the texture belongs to
  12842. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12843. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12844. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12845. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12846. * @returns the R texture
  12847. */
  12848. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12849. }
  12850. }
  12851. declare module "babylonjs/Maths/math.size" {
  12852. /**
  12853. * Interface for the size containing width and height
  12854. */
  12855. export interface ISize {
  12856. /**
  12857. * Width
  12858. */
  12859. width: number;
  12860. /**
  12861. * Heighht
  12862. */
  12863. height: number;
  12864. }
  12865. /**
  12866. * Size containing widht and height
  12867. */
  12868. export class Size implements ISize {
  12869. /**
  12870. * Width
  12871. */
  12872. width: number;
  12873. /**
  12874. * Height
  12875. */
  12876. height: number;
  12877. /**
  12878. * Creates a Size object from the given width and height (floats).
  12879. * @param width width of the new size
  12880. * @param height height of the new size
  12881. */
  12882. constructor(width: number, height: number);
  12883. /**
  12884. * Returns a string with the Size width and height
  12885. * @returns a string with the Size width and height
  12886. */
  12887. toString(): string;
  12888. /**
  12889. * "Size"
  12890. * @returns the string "Size"
  12891. */
  12892. getClassName(): string;
  12893. /**
  12894. * Returns the Size hash code.
  12895. * @returns a hash code for a unique width and height
  12896. */
  12897. getHashCode(): number;
  12898. /**
  12899. * Updates the current size from the given one.
  12900. * @param src the given size
  12901. */
  12902. copyFrom(src: Size): void;
  12903. /**
  12904. * Updates in place the current Size from the given floats.
  12905. * @param width width of the new size
  12906. * @param height height of the new size
  12907. * @returns the updated Size.
  12908. */
  12909. copyFromFloats(width: number, height: number): Size;
  12910. /**
  12911. * Updates in place the current Size from the given floats.
  12912. * @param width width to set
  12913. * @param height height to set
  12914. * @returns the updated Size.
  12915. */
  12916. set(width: number, height: number): Size;
  12917. /**
  12918. * Multiplies the width and height by numbers
  12919. * @param w factor to multiple the width by
  12920. * @param h factor to multiple the height by
  12921. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  12922. */
  12923. multiplyByFloats(w: number, h: number): Size;
  12924. /**
  12925. * Clones the size
  12926. * @returns a new Size copied from the given one.
  12927. */
  12928. clone(): Size;
  12929. /**
  12930. * True if the current Size and the given one width and height are strictly equal.
  12931. * @param other the other size to compare against
  12932. * @returns True if the current Size and the given one width and height are strictly equal.
  12933. */
  12934. equals(other: Size): boolean;
  12935. /**
  12936. * The surface of the Size : width * height (float).
  12937. */
  12938. readonly surface: number;
  12939. /**
  12940. * Create a new size of zero
  12941. * @returns a new Size set to (0.0, 0.0)
  12942. */
  12943. static Zero(): Size;
  12944. /**
  12945. * Sums the width and height of two sizes
  12946. * @param otherSize size to add to this size
  12947. * @returns a new Size set as the addition result of the current Size and the given one.
  12948. */
  12949. add(otherSize: Size): Size;
  12950. /**
  12951. * Subtracts the width and height of two
  12952. * @param otherSize size to subtract to this size
  12953. * @returns a new Size set as the subtraction result of the given one from the current Size.
  12954. */
  12955. subtract(otherSize: Size): Size;
  12956. /**
  12957. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  12958. * @param start starting size to lerp between
  12959. * @param end end size to lerp between
  12960. * @param amount amount to lerp between the start and end values
  12961. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  12962. */
  12963. static Lerp(start: Size, end: Size, amount: number): Size;
  12964. }
  12965. }
  12966. declare module "babylonjs/Animations/runtimeAnimation" {
  12967. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  12968. import { Animatable } from "babylonjs/Animations/animatable";
  12969. import { Scene } from "babylonjs/scene";
  12970. /**
  12971. * Defines a runtime animation
  12972. */
  12973. export class RuntimeAnimation {
  12974. private _events;
  12975. /**
  12976. * The current frame of the runtime animation
  12977. */
  12978. private _currentFrame;
  12979. /**
  12980. * The animation used by the runtime animation
  12981. */
  12982. private _animation;
  12983. /**
  12984. * The target of the runtime animation
  12985. */
  12986. private _target;
  12987. /**
  12988. * The initiating animatable
  12989. */
  12990. private _host;
  12991. /**
  12992. * The original value of the runtime animation
  12993. */
  12994. private _originalValue;
  12995. /**
  12996. * The original blend value of the runtime animation
  12997. */
  12998. private _originalBlendValue;
  12999. /**
  13000. * The offsets cache of the runtime animation
  13001. */
  13002. private _offsetsCache;
  13003. /**
  13004. * The high limits cache of the runtime animation
  13005. */
  13006. private _highLimitsCache;
  13007. /**
  13008. * Specifies if the runtime animation has been stopped
  13009. */
  13010. private _stopped;
  13011. /**
  13012. * The blending factor of the runtime animation
  13013. */
  13014. private _blendingFactor;
  13015. /**
  13016. * The BabylonJS scene
  13017. */
  13018. private _scene;
  13019. /**
  13020. * The current value of the runtime animation
  13021. */
  13022. private _currentValue;
  13023. /** @hidden */
  13024. _animationState: _IAnimationState;
  13025. /**
  13026. * The active target of the runtime animation
  13027. */
  13028. private _activeTargets;
  13029. private _currentActiveTarget;
  13030. private _directTarget;
  13031. /**
  13032. * The target path of the runtime animation
  13033. */
  13034. private _targetPath;
  13035. /**
  13036. * The weight of the runtime animation
  13037. */
  13038. private _weight;
  13039. /**
  13040. * The ratio offset of the runtime animation
  13041. */
  13042. private _ratioOffset;
  13043. /**
  13044. * The previous delay of the runtime animation
  13045. */
  13046. private _previousDelay;
  13047. /**
  13048. * The previous ratio of the runtime animation
  13049. */
  13050. private _previousRatio;
  13051. private _enableBlending;
  13052. private _keys;
  13053. private _minFrame;
  13054. private _maxFrame;
  13055. private _minValue;
  13056. private _maxValue;
  13057. private _targetIsArray;
  13058. /**
  13059. * Gets the current frame of the runtime animation
  13060. */
  13061. readonly currentFrame: number;
  13062. /**
  13063. * Gets the weight of the runtime animation
  13064. */
  13065. readonly weight: number;
  13066. /**
  13067. * Gets the current value of the runtime animation
  13068. */
  13069. readonly currentValue: any;
  13070. /**
  13071. * Gets the target path of the runtime animation
  13072. */
  13073. readonly targetPath: string;
  13074. /**
  13075. * Gets the actual target of the runtime animation
  13076. */
  13077. readonly target: any;
  13078. /** @hidden */
  13079. _onLoop: () => void;
  13080. /**
  13081. * Create a new RuntimeAnimation object
  13082. * @param target defines the target of the animation
  13083. * @param animation defines the source animation object
  13084. * @param scene defines the hosting scene
  13085. * @param host defines the initiating Animatable
  13086. */
  13087. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  13088. private _preparePath;
  13089. /**
  13090. * Gets the animation from the runtime animation
  13091. */
  13092. readonly animation: Animation;
  13093. /**
  13094. * Resets the runtime animation to the beginning
  13095. * @param restoreOriginal defines whether to restore the target property to the original value
  13096. */
  13097. reset(restoreOriginal?: boolean): void;
  13098. /**
  13099. * Specifies if the runtime animation is stopped
  13100. * @returns Boolean specifying if the runtime animation is stopped
  13101. */
  13102. isStopped(): boolean;
  13103. /**
  13104. * Disposes of the runtime animation
  13105. */
  13106. dispose(): void;
  13107. /**
  13108. * Apply the interpolated value to the target
  13109. * @param currentValue defines the value computed by the animation
  13110. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  13111. */
  13112. setValue(currentValue: any, weight: number): void;
  13113. private _getOriginalValues;
  13114. private _setValue;
  13115. /**
  13116. * Gets the loop pmode of the runtime animation
  13117. * @returns Loop Mode
  13118. */
  13119. private _getCorrectLoopMode;
  13120. /**
  13121. * Move the current animation to a given frame
  13122. * @param frame defines the frame to move to
  13123. */
  13124. goToFrame(frame: number): void;
  13125. /**
  13126. * @hidden Internal use only
  13127. */
  13128. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  13129. /**
  13130. * Execute the current animation
  13131. * @param delay defines the delay to add to the current frame
  13132. * @param from defines the lower bound of the animation range
  13133. * @param to defines the upper bound of the animation range
  13134. * @param loop defines if the current animation must loop
  13135. * @param speedRatio defines the current speed ratio
  13136. * @param weight defines the weight of the animation (default is -1 so no weight)
  13137. * @param onLoop optional callback called when animation loops
  13138. * @returns a boolean indicating if the animation is running
  13139. */
  13140. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  13141. }
  13142. }
  13143. declare module "babylonjs/Animations/animatable" {
  13144. import { Animation } from "babylonjs/Animations/animation";
  13145. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  13146. import { Nullable } from "babylonjs/types";
  13147. import { Observable } from "babylonjs/Misc/observable";
  13148. import { Scene } from "babylonjs/scene";
  13149. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  13150. import { Node } from "babylonjs/node";
  13151. /**
  13152. * Class used to store an actual running animation
  13153. */
  13154. export class Animatable {
  13155. /** defines the target object */
  13156. target: any;
  13157. /** defines the starting frame number (default is 0) */
  13158. fromFrame: number;
  13159. /** defines the ending frame number (default is 100) */
  13160. toFrame: number;
  13161. /** defines if the animation must loop (default is false) */
  13162. loopAnimation: boolean;
  13163. /** defines a callback to call when animation ends if it is not looping */
  13164. onAnimationEnd?: (() => void) | null | undefined;
  13165. /** defines a callback to call when animation loops */
  13166. onAnimationLoop?: (() => void) | null | undefined;
  13167. private _localDelayOffset;
  13168. private _pausedDelay;
  13169. private _runtimeAnimations;
  13170. private _paused;
  13171. private _scene;
  13172. private _speedRatio;
  13173. private _weight;
  13174. private _syncRoot;
  13175. /**
  13176. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  13177. * This will only apply for non looping animation (default is true)
  13178. */
  13179. disposeOnEnd: boolean;
  13180. /**
  13181. * Gets a boolean indicating if the animation has started
  13182. */
  13183. animationStarted: boolean;
  13184. /**
  13185. * Observer raised when the animation ends
  13186. */
  13187. onAnimationEndObservable: Observable<Animatable>;
  13188. /**
  13189. * Observer raised when the animation loops
  13190. */
  13191. onAnimationLoopObservable: Observable<Animatable>;
  13192. /**
  13193. * Gets the root Animatable used to synchronize and normalize animations
  13194. */
  13195. readonly syncRoot: Nullable<Animatable>;
  13196. /**
  13197. * Gets the current frame of the first RuntimeAnimation
  13198. * Used to synchronize Animatables
  13199. */
  13200. readonly masterFrame: number;
  13201. /**
  13202. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  13203. */
  13204. weight: number;
  13205. /**
  13206. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  13207. */
  13208. speedRatio: number;
  13209. /**
  13210. * Creates a new Animatable
  13211. * @param scene defines the hosting scene
  13212. * @param target defines the target object
  13213. * @param fromFrame defines the starting frame number (default is 0)
  13214. * @param toFrame defines the ending frame number (default is 100)
  13215. * @param loopAnimation defines if the animation must loop (default is false)
  13216. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  13217. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  13218. * @param animations defines a group of animation to add to the new Animatable
  13219. * @param onAnimationLoop defines a callback to call when animation loops
  13220. */
  13221. constructor(scene: Scene,
  13222. /** defines the target object */
  13223. target: any,
  13224. /** defines the starting frame number (default is 0) */
  13225. fromFrame?: number,
  13226. /** defines the ending frame number (default is 100) */
  13227. toFrame?: number,
  13228. /** defines if the animation must loop (default is false) */
  13229. loopAnimation?: boolean, speedRatio?: number,
  13230. /** defines a callback to call when animation ends if it is not looping */
  13231. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  13232. /** defines a callback to call when animation loops */
  13233. onAnimationLoop?: (() => void) | null | undefined);
  13234. /**
  13235. * Synchronize and normalize current Animatable with a source Animatable
  13236. * This is useful when using animation weights and when animations are not of the same length
  13237. * @param root defines the root Animatable to synchronize with
  13238. * @returns the current Animatable
  13239. */
  13240. syncWith(root: Animatable): Animatable;
  13241. /**
  13242. * Gets the list of runtime animations
  13243. * @returns an array of RuntimeAnimation
  13244. */
  13245. getAnimations(): RuntimeAnimation[];
  13246. /**
  13247. * Adds more animations to the current animatable
  13248. * @param target defines the target of the animations
  13249. * @param animations defines the new animations to add
  13250. */
  13251. appendAnimations(target: any, animations: Animation[]): void;
  13252. /**
  13253. * Gets the source animation for a specific property
  13254. * @param property defines the propertyu to look for
  13255. * @returns null or the source animation for the given property
  13256. */
  13257. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  13258. /**
  13259. * Gets the runtime animation for a specific property
  13260. * @param property defines the propertyu to look for
  13261. * @returns null or the runtime animation for the given property
  13262. */
  13263. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  13264. /**
  13265. * Resets the animatable to its original state
  13266. */
  13267. reset(): void;
  13268. /**
  13269. * Allows the animatable to blend with current running animations
  13270. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13271. * @param blendingSpeed defines the blending speed to use
  13272. */
  13273. enableBlending(blendingSpeed: number): void;
  13274. /**
  13275. * Disable animation blending
  13276. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13277. */
  13278. disableBlending(): void;
  13279. /**
  13280. * Jump directly to a given frame
  13281. * @param frame defines the frame to jump to
  13282. */
  13283. goToFrame(frame: number): void;
  13284. /**
  13285. * Pause the animation
  13286. */
  13287. pause(): void;
  13288. /**
  13289. * Restart the animation
  13290. */
  13291. restart(): void;
  13292. private _raiseOnAnimationEnd;
  13293. /**
  13294. * Stop and delete the current animation
  13295. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  13296. * @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)
  13297. */
  13298. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  13299. /**
  13300. * Wait asynchronously for the animation to end
  13301. * @returns a promise which will be fullfilled when the animation ends
  13302. */
  13303. waitAsync(): Promise<Animatable>;
  13304. /** @hidden */
  13305. _animate(delay: number): boolean;
  13306. }
  13307. module "babylonjs/scene" {
  13308. interface Scene {
  13309. /** @hidden */
  13310. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  13311. /** @hidden */
  13312. _processLateAnimationBindingsForMatrices(holder: {
  13313. totalWeight: number;
  13314. animations: RuntimeAnimation[];
  13315. originalValue: Matrix;
  13316. }): any;
  13317. /** @hidden */
  13318. _processLateAnimationBindingsForQuaternions(holder: {
  13319. totalWeight: number;
  13320. animations: RuntimeAnimation[];
  13321. originalValue: Quaternion;
  13322. }, refQuaternion: Quaternion): Quaternion;
  13323. /** @hidden */
  13324. _processLateAnimationBindings(): void;
  13325. /**
  13326. * Will start the animation sequence of a given target
  13327. * @param target defines the target
  13328. * @param from defines from which frame should animation start
  13329. * @param to defines until which frame should animation run.
  13330. * @param weight defines the weight to apply to the animation (1.0 by default)
  13331. * @param loop defines if the animation loops
  13332. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13333. * @param onAnimationEnd defines the function to be executed when the animation ends
  13334. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13335. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13336. * @param onAnimationLoop defines the callback to call when an animation loops
  13337. * @returns the animatable object created for this animation
  13338. */
  13339. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13340. /**
  13341. * Will start the animation sequence of a given target
  13342. * @param target defines the target
  13343. * @param from defines from which frame should animation start
  13344. * @param to defines until which frame should animation run.
  13345. * @param loop defines if the animation loops
  13346. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13347. * @param onAnimationEnd defines the function to be executed when the animation ends
  13348. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13349. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13350. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  13351. * @param onAnimationLoop defines the callback to call when an animation loops
  13352. * @returns the animatable object created for this animation
  13353. */
  13354. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13355. /**
  13356. * Will start the animation sequence of a given target and its hierarchy
  13357. * @param target defines the target
  13358. * @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.
  13359. * @param from defines from which frame should animation start
  13360. * @param to defines until which frame should animation run.
  13361. * @param loop defines if the animation loops
  13362. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13363. * @param onAnimationEnd defines the function to be executed when the animation ends
  13364. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13365. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13366. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13367. * @param onAnimationLoop defines the callback to call when an animation loops
  13368. * @returns the list of created animatables
  13369. */
  13370. 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): Animatable[];
  13371. /**
  13372. * Begin a new animation on a given node
  13373. * @param target defines the target where the animation will take place
  13374. * @param animations defines the list of animations to start
  13375. * @param from defines the initial value
  13376. * @param to defines the final value
  13377. * @param loop defines if you want animation to loop (off by default)
  13378. * @param speedRatio defines the speed ratio to apply to all animations
  13379. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13380. * @param onAnimationLoop defines the callback to call when an animation loops
  13381. * @returns the list of created animatables
  13382. */
  13383. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  13384. /**
  13385. * Begin a new animation on a given node and its hierarchy
  13386. * @param target defines the root node where the animation will take place
  13387. * @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.
  13388. * @param animations defines the list of animations to start
  13389. * @param from defines the initial value
  13390. * @param to defines the final value
  13391. * @param loop defines if you want animation to loop (off by default)
  13392. * @param speedRatio defines the speed ratio to apply to all animations
  13393. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13394. * @param onAnimationLoop defines the callback to call when an animation loops
  13395. * @returns the list of animatables created for all nodes
  13396. */
  13397. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  13398. /**
  13399. * Gets the animatable associated with a specific target
  13400. * @param target defines the target of the animatable
  13401. * @returns the required animatable if found
  13402. */
  13403. getAnimatableByTarget(target: any): Nullable<Animatable>;
  13404. /**
  13405. * Gets all animatables associated with a given target
  13406. * @param target defines the target to look animatables for
  13407. * @returns an array of Animatables
  13408. */
  13409. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  13410. /**
  13411. * Stops and removes all animations that have been applied to the scene
  13412. */
  13413. stopAllAnimations(): void;
  13414. /**
  13415. * Gets the current delta time used by animation engine
  13416. */
  13417. deltaTime: number;
  13418. }
  13419. }
  13420. module "babylonjs/Bones/bone" {
  13421. interface Bone {
  13422. /**
  13423. * Copy an animation range from another bone
  13424. * @param source defines the source bone
  13425. * @param rangeName defines the range name to copy
  13426. * @param frameOffset defines the frame offset
  13427. * @param rescaleAsRequired defines if rescaling must be applied if required
  13428. * @param skelDimensionsRatio defines the scaling ratio
  13429. * @returns true if operation was successful
  13430. */
  13431. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  13432. }
  13433. }
  13434. }
  13435. declare module "babylonjs/Animations/animationPropertiesOverride" {
  13436. /**
  13437. * Class used to override all child animations of a given target
  13438. */
  13439. export class AnimationPropertiesOverride {
  13440. /**
  13441. * Gets or sets a value indicating if animation blending must be used
  13442. */
  13443. enableBlending: boolean;
  13444. /**
  13445. * Gets or sets the blending speed to use when enableBlending is true
  13446. */
  13447. blendingSpeed: number;
  13448. /**
  13449. * Gets or sets the default loop mode to use
  13450. */
  13451. loopMode: number;
  13452. }
  13453. }
  13454. declare module "babylonjs/Bones/skeleton" {
  13455. import { Bone } from "babylonjs/Bones/bone";
  13456. import { Observable } from "babylonjs/Misc/observable";
  13457. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13458. import { Scene } from "babylonjs/scene";
  13459. import { Nullable } from "babylonjs/types";
  13460. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13461. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  13462. import { Animatable } from "babylonjs/Animations/animatable";
  13463. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13464. import { Animation } from "babylonjs/Animations/animation";
  13465. import { AnimationRange } from "babylonjs/Animations/animationRange";
  13466. import { IInspectable } from "babylonjs/Misc/iInspectable";
  13467. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  13468. /**
  13469. * Class used to handle skinning animations
  13470. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13471. */
  13472. export class Skeleton implements IAnimatable {
  13473. /** defines the skeleton name */
  13474. name: string;
  13475. /** defines the skeleton Id */
  13476. id: string;
  13477. /**
  13478. * Defines the list of child bones
  13479. */
  13480. bones: Bone[];
  13481. /**
  13482. * Defines an estimate of the dimension of the skeleton at rest
  13483. */
  13484. dimensionsAtRest: Vector3;
  13485. /**
  13486. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  13487. */
  13488. needInitialSkinMatrix: boolean;
  13489. /**
  13490. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  13491. */
  13492. overrideMesh: Nullable<AbstractMesh>;
  13493. /**
  13494. * Gets the list of animations attached to this skeleton
  13495. */
  13496. animations: Array<Animation>;
  13497. private _scene;
  13498. private _isDirty;
  13499. private _transformMatrices;
  13500. private _transformMatrixTexture;
  13501. private _meshesWithPoseMatrix;
  13502. private _animatables;
  13503. private _identity;
  13504. private _synchronizedWithMesh;
  13505. private _ranges;
  13506. private _lastAbsoluteTransformsUpdateId;
  13507. private _canUseTextureForBones;
  13508. private _uniqueId;
  13509. /** @hidden */
  13510. _numBonesWithLinkedTransformNode: number;
  13511. /** @hidden */
  13512. _hasWaitingData: Nullable<boolean>;
  13513. /**
  13514. * Specifies if the skeleton should be serialized
  13515. */
  13516. doNotSerialize: boolean;
  13517. private _useTextureToStoreBoneMatrices;
  13518. /**
  13519. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  13520. * Please note that this option is not available if the hardware does not support it
  13521. */
  13522. useTextureToStoreBoneMatrices: boolean;
  13523. private _animationPropertiesOverride;
  13524. /**
  13525. * Gets or sets the animation properties override
  13526. */
  13527. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13528. /**
  13529. * List of inspectable custom properties (used by the Inspector)
  13530. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  13531. */
  13532. inspectableCustomProperties: IInspectable[];
  13533. /**
  13534. * An observable triggered before computing the skeleton's matrices
  13535. */
  13536. onBeforeComputeObservable: Observable<Skeleton>;
  13537. /**
  13538. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  13539. */
  13540. readonly isUsingTextureForMatrices: boolean;
  13541. /**
  13542. * Gets the unique ID of this skeleton
  13543. */
  13544. readonly uniqueId: number;
  13545. /**
  13546. * Creates a new skeleton
  13547. * @param name defines the skeleton name
  13548. * @param id defines the skeleton Id
  13549. * @param scene defines the hosting scene
  13550. */
  13551. constructor(
  13552. /** defines the skeleton name */
  13553. name: string,
  13554. /** defines the skeleton Id */
  13555. id: string, scene: Scene);
  13556. /**
  13557. * Gets the current object class name.
  13558. * @return the class name
  13559. */
  13560. getClassName(): string;
  13561. /**
  13562. * Returns an array containing the root bones
  13563. * @returns an array containing the root bones
  13564. */
  13565. getChildren(): Array<Bone>;
  13566. /**
  13567. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  13568. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13569. * @returns a Float32Array containing matrices data
  13570. */
  13571. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  13572. /**
  13573. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  13574. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13575. * @returns a raw texture containing the data
  13576. */
  13577. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  13578. /**
  13579. * Gets the current hosting scene
  13580. * @returns a scene object
  13581. */
  13582. getScene(): Scene;
  13583. /**
  13584. * Gets a string representing the current skeleton data
  13585. * @param fullDetails defines a boolean indicating if we want a verbose version
  13586. * @returns a string representing the current skeleton data
  13587. */
  13588. toString(fullDetails?: boolean): string;
  13589. /**
  13590. * Get bone's index searching by name
  13591. * @param name defines bone's name to search for
  13592. * @return the indice of the bone. Returns -1 if not found
  13593. */
  13594. getBoneIndexByName(name: string): number;
  13595. /**
  13596. * Creater a new animation range
  13597. * @param name defines the name of the range
  13598. * @param from defines the start key
  13599. * @param to defines the end key
  13600. */
  13601. createAnimationRange(name: string, from: number, to: number): void;
  13602. /**
  13603. * Delete a specific animation range
  13604. * @param name defines the name of the range
  13605. * @param deleteFrames defines if frames must be removed as well
  13606. */
  13607. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  13608. /**
  13609. * Gets a specific animation range
  13610. * @param name defines the name of the range to look for
  13611. * @returns the requested animation range or null if not found
  13612. */
  13613. getAnimationRange(name: string): Nullable<AnimationRange>;
  13614. /**
  13615. * Gets the list of all animation ranges defined on this skeleton
  13616. * @returns an array
  13617. */
  13618. getAnimationRanges(): Nullable<AnimationRange>[];
  13619. /**
  13620. * Copy animation range from a source skeleton.
  13621. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  13622. * @param source defines the source skeleton
  13623. * @param name defines the name of the range to copy
  13624. * @param rescaleAsRequired defines if rescaling must be applied if required
  13625. * @returns true if operation was successful
  13626. */
  13627. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  13628. /**
  13629. * Forces the skeleton to go to rest pose
  13630. */
  13631. returnToRest(): void;
  13632. private _getHighestAnimationFrame;
  13633. /**
  13634. * Begin a specific animation range
  13635. * @param name defines the name of the range to start
  13636. * @param loop defines if looping must be turned on (false by default)
  13637. * @param speedRatio defines the speed ratio to apply (1 by default)
  13638. * @param onAnimationEnd defines a callback which will be called when animation will end
  13639. * @returns a new animatable
  13640. */
  13641. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  13642. /** @hidden */
  13643. _markAsDirty(): void;
  13644. /** @hidden */
  13645. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13646. /** @hidden */
  13647. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13648. private _computeTransformMatrices;
  13649. /**
  13650. * Build all resources required to render a skeleton
  13651. */
  13652. prepare(): void;
  13653. /**
  13654. * Gets the list of animatables currently running for this skeleton
  13655. * @returns an array of animatables
  13656. */
  13657. getAnimatables(): IAnimatable[];
  13658. /**
  13659. * Clone the current skeleton
  13660. * @param name defines the name of the new skeleton
  13661. * @param id defines the id of the new skeleton
  13662. * @returns the new skeleton
  13663. */
  13664. clone(name: string, id?: string): Skeleton;
  13665. /**
  13666. * Enable animation blending for this skeleton
  13667. * @param blendingSpeed defines the blending speed to apply
  13668. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13669. */
  13670. enableBlending(blendingSpeed?: number): void;
  13671. /**
  13672. * Releases all resources associated with the current skeleton
  13673. */
  13674. dispose(): void;
  13675. /**
  13676. * Serialize the skeleton in a JSON object
  13677. * @returns a JSON object
  13678. */
  13679. serialize(): any;
  13680. /**
  13681. * Creates a new skeleton from serialized data
  13682. * @param parsedSkeleton defines the serialized data
  13683. * @param scene defines the hosting scene
  13684. * @returns a new skeleton
  13685. */
  13686. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  13687. /**
  13688. * Compute all node absolute transforms
  13689. * @param forceUpdate defines if computation must be done even if cache is up to date
  13690. */
  13691. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  13692. /**
  13693. * Gets the root pose matrix
  13694. * @returns a matrix
  13695. */
  13696. getPoseMatrix(): Nullable<Matrix>;
  13697. /**
  13698. * Sorts bones per internal index
  13699. */
  13700. sortBones(): void;
  13701. private _sortBones;
  13702. }
  13703. }
  13704. declare module "babylonjs/Bones/bone" {
  13705. import { Skeleton } from "babylonjs/Bones/skeleton";
  13706. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  13707. import { Nullable } from "babylonjs/types";
  13708. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13709. import { TransformNode } from "babylonjs/Meshes/transformNode";
  13710. import { Node } from "babylonjs/node";
  13711. import { Space } from "babylonjs/Maths/math.axis";
  13712. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13713. /**
  13714. * Class used to store bone information
  13715. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13716. */
  13717. export class Bone extends Node {
  13718. /**
  13719. * defines the bone name
  13720. */
  13721. name: string;
  13722. private static _tmpVecs;
  13723. private static _tmpQuat;
  13724. private static _tmpMats;
  13725. /**
  13726. * Gets the list of child bones
  13727. */
  13728. children: Bone[];
  13729. /** Gets the animations associated with this bone */
  13730. animations: import("babylonjs/Animations/animation").Animation[];
  13731. /**
  13732. * Gets or sets bone length
  13733. */
  13734. length: number;
  13735. /**
  13736. * @hidden Internal only
  13737. * Set this value to map this bone to a different index in the transform matrices
  13738. * Set this value to -1 to exclude the bone from the transform matrices
  13739. */
  13740. _index: Nullable<number>;
  13741. private _skeleton;
  13742. private _localMatrix;
  13743. private _restPose;
  13744. private _baseMatrix;
  13745. private _absoluteTransform;
  13746. private _invertedAbsoluteTransform;
  13747. private _parent;
  13748. private _scalingDeterminant;
  13749. private _worldTransform;
  13750. private _localScaling;
  13751. private _localRotation;
  13752. private _localPosition;
  13753. private _needToDecompose;
  13754. private _needToCompose;
  13755. /** @hidden */
  13756. _linkedTransformNode: Nullable<TransformNode>;
  13757. /** @hidden */
  13758. _waitingTransformNodeId: Nullable<string>;
  13759. /** @hidden */
  13760. /** @hidden */
  13761. _matrix: Matrix;
  13762. /**
  13763. * Create a new bone
  13764. * @param name defines the bone name
  13765. * @param skeleton defines the parent skeleton
  13766. * @param parentBone defines the parent (can be null if the bone is the root)
  13767. * @param localMatrix defines the local matrix
  13768. * @param restPose defines the rest pose matrix
  13769. * @param baseMatrix defines the base matrix
  13770. * @param index defines index of the bone in the hiearchy
  13771. */
  13772. constructor(
  13773. /**
  13774. * defines the bone name
  13775. */
  13776. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  13777. /**
  13778. * Gets the current object class name.
  13779. * @return the class name
  13780. */
  13781. getClassName(): string;
  13782. /**
  13783. * Gets the parent skeleton
  13784. * @returns a skeleton
  13785. */
  13786. getSkeleton(): Skeleton;
  13787. /**
  13788. * Gets parent bone
  13789. * @returns a bone or null if the bone is the root of the bone hierarchy
  13790. */
  13791. getParent(): Nullable<Bone>;
  13792. /**
  13793. * Returns an array containing the root bones
  13794. * @returns an array containing the root bones
  13795. */
  13796. getChildren(): Array<Bone>;
  13797. /**
  13798. * Gets the node index in matrix array generated for rendering
  13799. * @returns the node index
  13800. */
  13801. getIndex(): number;
  13802. /**
  13803. * Sets the parent bone
  13804. * @param parent defines the parent (can be null if the bone is the root)
  13805. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13806. */
  13807. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  13808. /**
  13809. * Gets the local matrix
  13810. * @returns a matrix
  13811. */
  13812. getLocalMatrix(): Matrix;
  13813. /**
  13814. * Gets the base matrix (initial matrix which remains unchanged)
  13815. * @returns a matrix
  13816. */
  13817. getBaseMatrix(): Matrix;
  13818. /**
  13819. * Gets the rest pose matrix
  13820. * @returns a matrix
  13821. */
  13822. getRestPose(): Matrix;
  13823. /**
  13824. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  13825. */
  13826. getWorldMatrix(): Matrix;
  13827. /**
  13828. * Sets the local matrix to rest pose matrix
  13829. */
  13830. returnToRest(): void;
  13831. /**
  13832. * Gets the inverse of the absolute transform matrix.
  13833. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  13834. * @returns a matrix
  13835. */
  13836. getInvertedAbsoluteTransform(): Matrix;
  13837. /**
  13838. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  13839. * @returns a matrix
  13840. */
  13841. getAbsoluteTransform(): Matrix;
  13842. /**
  13843. * Links with the given transform node.
  13844. * The local matrix of this bone is copied from the transform node every frame.
  13845. * @param transformNode defines the transform node to link to
  13846. */
  13847. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  13848. /**
  13849. * Gets the node used to drive the bone's transformation
  13850. * @returns a transform node or null
  13851. */
  13852. getTransformNode(): Nullable<TransformNode>;
  13853. /** Gets or sets current position (in local space) */
  13854. position: Vector3;
  13855. /** Gets or sets current rotation (in local space) */
  13856. rotation: Vector3;
  13857. /** Gets or sets current rotation quaternion (in local space) */
  13858. rotationQuaternion: Quaternion;
  13859. /** Gets or sets current scaling (in local space) */
  13860. scaling: Vector3;
  13861. /**
  13862. * Gets the animation properties override
  13863. */
  13864. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13865. private _decompose;
  13866. private _compose;
  13867. /**
  13868. * Update the base and local matrices
  13869. * @param matrix defines the new base or local matrix
  13870. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13871. * @param updateLocalMatrix defines if the local matrix should be updated
  13872. */
  13873. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  13874. /** @hidden */
  13875. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  13876. /**
  13877. * Flag the bone as dirty (Forcing it to update everything)
  13878. */
  13879. markAsDirty(): void;
  13880. /** @hidden */
  13881. _markAsDirtyAndCompose(): void;
  13882. private _markAsDirtyAndDecompose;
  13883. /**
  13884. * Translate the bone in local or world space
  13885. * @param vec The amount to translate the bone
  13886. * @param space The space that the translation is in
  13887. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13888. */
  13889. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13890. /**
  13891. * Set the postion of the bone in local or world space
  13892. * @param position The position to set the bone
  13893. * @param space The space that the position is in
  13894. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13895. */
  13896. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13897. /**
  13898. * Set the absolute position of the bone (world space)
  13899. * @param position The position to set the bone
  13900. * @param mesh The mesh that this bone is attached to
  13901. */
  13902. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  13903. /**
  13904. * Scale the bone on the x, y and z axes (in local space)
  13905. * @param x The amount to scale the bone on the x axis
  13906. * @param y The amount to scale the bone on the y axis
  13907. * @param z The amount to scale the bone on the z axis
  13908. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  13909. */
  13910. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  13911. /**
  13912. * Set the bone scaling in local space
  13913. * @param scale defines the scaling vector
  13914. */
  13915. setScale(scale: Vector3): void;
  13916. /**
  13917. * Gets the current scaling in local space
  13918. * @returns the current scaling vector
  13919. */
  13920. getScale(): Vector3;
  13921. /**
  13922. * Gets the current scaling in local space and stores it in a target vector
  13923. * @param result defines the target vector
  13924. */
  13925. getScaleToRef(result: Vector3): void;
  13926. /**
  13927. * Set the yaw, pitch, and roll of the bone in local or world space
  13928. * @param yaw The rotation of the bone on the y axis
  13929. * @param pitch The rotation of the bone on the x axis
  13930. * @param roll The rotation of the bone on the z axis
  13931. * @param space The space that the axes of rotation are in
  13932. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13933. */
  13934. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  13935. /**
  13936. * Add a rotation to the bone on an axis in local or world space
  13937. * @param axis The axis to rotate the bone on
  13938. * @param amount The amount to rotate the bone
  13939. * @param space The space that the axis is in
  13940. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13941. */
  13942. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  13943. /**
  13944. * Set the rotation of the bone to a particular axis angle in local or world space
  13945. * @param axis The axis to rotate the bone on
  13946. * @param angle The angle that the bone should be rotated to
  13947. * @param space The space that the axis is in
  13948. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13949. */
  13950. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  13951. /**
  13952. * Set the euler rotation of the bone in local of world space
  13953. * @param rotation The euler rotation that the bone should be set to
  13954. * @param space The space that the rotation is in
  13955. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13956. */
  13957. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13958. /**
  13959. * Set the quaternion rotation of the bone in local of world space
  13960. * @param quat The quaternion rotation that the bone should be set to
  13961. * @param space The space that the rotation is in
  13962. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13963. */
  13964. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  13965. /**
  13966. * Set the rotation matrix of the bone in local of world space
  13967. * @param rotMat The rotation matrix that the bone should be set to
  13968. * @param space The space that the rotation is in
  13969. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13970. */
  13971. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  13972. private _rotateWithMatrix;
  13973. private _getNegativeRotationToRef;
  13974. /**
  13975. * Get the position of the bone in local or world space
  13976. * @param space The space that the returned position is in
  13977. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13978. * @returns The position of the bone
  13979. */
  13980. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  13981. /**
  13982. * Copy the position of the bone to a vector3 in local or world space
  13983. * @param space The space that the returned position is in
  13984. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13985. * @param result The vector3 to copy the position to
  13986. */
  13987. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  13988. /**
  13989. * Get the absolute position of the bone (world space)
  13990. * @param mesh The mesh that this bone is attached to
  13991. * @returns The absolute position of the bone
  13992. */
  13993. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  13994. /**
  13995. * Copy the absolute position of the bone (world space) to the result param
  13996. * @param mesh The mesh that this bone is attached to
  13997. * @param result The vector3 to copy the absolute position to
  13998. */
  13999. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  14000. /**
  14001. * Compute the absolute transforms of this bone and its children
  14002. */
  14003. computeAbsoluteTransforms(): void;
  14004. /**
  14005. * Get the world direction from an axis that is in the local space of the bone
  14006. * @param localAxis The local direction that is used to compute the world direction
  14007. * @param mesh The mesh that this bone is attached to
  14008. * @returns The world direction
  14009. */
  14010. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14011. /**
  14012. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  14013. * @param localAxis The local direction that is used to compute the world direction
  14014. * @param mesh The mesh that this bone is attached to
  14015. * @param result The vector3 that the world direction will be copied to
  14016. */
  14017. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14018. /**
  14019. * Get the euler rotation of the bone in local or world space
  14020. * @param space The space that the rotation should be in
  14021. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14022. * @returns The euler rotation
  14023. */
  14024. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  14025. /**
  14026. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  14027. * @param space The space that the rotation should be in
  14028. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14029. * @param result The vector3 that the rotation should be copied to
  14030. */
  14031. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14032. /**
  14033. * Get the quaternion rotation of the bone in either local or world space
  14034. * @param space The space that the rotation should be in
  14035. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14036. * @returns The quaternion rotation
  14037. */
  14038. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  14039. /**
  14040. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  14041. * @param space The space that the rotation should be in
  14042. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14043. * @param result The quaternion that the rotation should be copied to
  14044. */
  14045. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  14046. /**
  14047. * Get the rotation matrix of the bone in local or world space
  14048. * @param space The space that the rotation should be in
  14049. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14050. * @returns The rotation matrix
  14051. */
  14052. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  14053. /**
  14054. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  14055. * @param space The space that the rotation should be in
  14056. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14057. * @param result The quaternion that the rotation should be copied to
  14058. */
  14059. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  14060. /**
  14061. * Get the world position of a point that is in the local space of the bone
  14062. * @param position The local position
  14063. * @param mesh The mesh that this bone is attached to
  14064. * @returns The world position
  14065. */
  14066. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14067. /**
  14068. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  14069. * @param position The local position
  14070. * @param mesh The mesh that this bone is attached to
  14071. * @param result The vector3 that the world position should be copied to
  14072. */
  14073. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14074. /**
  14075. * Get the local position of a point that is in world space
  14076. * @param position The world position
  14077. * @param mesh The mesh that this bone is attached to
  14078. * @returns The local position
  14079. */
  14080. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14081. /**
  14082. * Get the local position of a point that is in world space and copy it to the result param
  14083. * @param position The world position
  14084. * @param mesh The mesh that this bone is attached to
  14085. * @param result The vector3 that the local position should be copied to
  14086. */
  14087. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14088. }
  14089. }
  14090. declare module "babylonjs/Meshes/transformNode" {
  14091. import { DeepImmutable } from "babylonjs/types";
  14092. import { Observable } from "babylonjs/Misc/observable";
  14093. import { Nullable } from "babylonjs/types";
  14094. import { Camera } from "babylonjs/Cameras/camera";
  14095. import { Scene } from "babylonjs/scene";
  14096. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14097. import { Node } from "babylonjs/node";
  14098. import { Bone } from "babylonjs/Bones/bone";
  14099. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14100. import { Space } from "babylonjs/Maths/math.axis";
  14101. /**
  14102. * 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.
  14103. * @see https://doc.babylonjs.com/how_to/transformnode
  14104. */
  14105. export class TransformNode extends Node {
  14106. /**
  14107. * Object will not rotate to face the camera
  14108. */
  14109. static BILLBOARDMODE_NONE: number;
  14110. /**
  14111. * Object will rotate to face the camera but only on the x axis
  14112. */
  14113. static BILLBOARDMODE_X: number;
  14114. /**
  14115. * Object will rotate to face the camera but only on the y axis
  14116. */
  14117. static BILLBOARDMODE_Y: number;
  14118. /**
  14119. * Object will rotate to face the camera but only on the z axis
  14120. */
  14121. static BILLBOARDMODE_Z: number;
  14122. /**
  14123. * Object will rotate to face the camera
  14124. */
  14125. static BILLBOARDMODE_ALL: number;
  14126. /**
  14127. * Object will rotate to face the camera's position instead of orientation
  14128. */
  14129. static BILLBOARDMODE_USE_POSITION: number;
  14130. private _forward;
  14131. private _forwardInverted;
  14132. private _up;
  14133. private _right;
  14134. private _rightInverted;
  14135. private _position;
  14136. private _rotation;
  14137. private _rotationQuaternion;
  14138. protected _scaling: Vector3;
  14139. protected _isDirty: boolean;
  14140. private _transformToBoneReferal;
  14141. private _isAbsoluteSynced;
  14142. private _billboardMode;
  14143. /**
  14144. * Gets or sets the billboard mode. Default is 0.
  14145. *
  14146. * | Value | Type | Description |
  14147. * | --- | --- | --- |
  14148. * | 0 | BILLBOARDMODE_NONE | |
  14149. * | 1 | BILLBOARDMODE_X | |
  14150. * | 2 | BILLBOARDMODE_Y | |
  14151. * | 4 | BILLBOARDMODE_Z | |
  14152. * | 7 | BILLBOARDMODE_ALL | |
  14153. *
  14154. */
  14155. billboardMode: number;
  14156. private _preserveParentRotationForBillboard;
  14157. /**
  14158. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  14159. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  14160. */
  14161. preserveParentRotationForBillboard: boolean;
  14162. /**
  14163. * 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
  14164. */
  14165. scalingDeterminant: number;
  14166. private _infiniteDistance;
  14167. /**
  14168. * Gets or sets the distance of the object to max, often used by skybox
  14169. */
  14170. infiniteDistance: boolean;
  14171. /**
  14172. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  14173. * By default the system will update normals to compensate
  14174. */
  14175. ignoreNonUniformScaling: boolean;
  14176. /**
  14177. * 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
  14178. */
  14179. reIntegrateRotationIntoRotationQuaternion: boolean;
  14180. /** @hidden */
  14181. _poseMatrix: Nullable<Matrix>;
  14182. /** @hidden */
  14183. _localMatrix: Matrix;
  14184. private _usePivotMatrix;
  14185. private _absolutePosition;
  14186. private _absoluteScaling;
  14187. private _absoluteRotationQuaternion;
  14188. private _pivotMatrix;
  14189. private _pivotMatrixInverse;
  14190. protected _postMultiplyPivotMatrix: boolean;
  14191. protected _isWorldMatrixFrozen: boolean;
  14192. /** @hidden */
  14193. _indexInSceneTransformNodesArray: number;
  14194. /**
  14195. * An event triggered after the world matrix is updated
  14196. */
  14197. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  14198. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  14199. /**
  14200. * Gets a string identifying the name of the class
  14201. * @returns "TransformNode" string
  14202. */
  14203. getClassName(): string;
  14204. /**
  14205. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  14206. */
  14207. position: Vector3;
  14208. /**
  14209. * 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)).
  14210. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  14211. */
  14212. rotation: Vector3;
  14213. /**
  14214. * 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)).
  14215. */
  14216. scaling: Vector3;
  14217. /**
  14218. * 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).
  14219. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  14220. */
  14221. rotationQuaternion: Nullable<Quaternion>;
  14222. /**
  14223. * The forward direction of that transform in world space.
  14224. */
  14225. readonly forward: Vector3;
  14226. /**
  14227. * The up direction of that transform in world space.
  14228. */
  14229. readonly up: Vector3;
  14230. /**
  14231. * The right direction of that transform in world space.
  14232. */
  14233. readonly right: Vector3;
  14234. /**
  14235. * Copies the parameter passed Matrix into the mesh Pose matrix.
  14236. * @param matrix the matrix to copy the pose from
  14237. * @returns this TransformNode.
  14238. */
  14239. updatePoseMatrix(matrix: Matrix): TransformNode;
  14240. /**
  14241. * Returns the mesh Pose matrix.
  14242. * @returns the pose matrix
  14243. */
  14244. getPoseMatrix(): Matrix;
  14245. /** @hidden */
  14246. _isSynchronized(): boolean;
  14247. /** @hidden */
  14248. _initCache(): void;
  14249. /**
  14250. * Flag the transform node as dirty (Forcing it to update everything)
  14251. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  14252. * @returns this transform node
  14253. */
  14254. markAsDirty(property: string): TransformNode;
  14255. /**
  14256. * Returns the current mesh absolute position.
  14257. * Returns a Vector3.
  14258. */
  14259. readonly absolutePosition: Vector3;
  14260. /**
  14261. * Returns the current mesh absolute scaling.
  14262. * Returns a Vector3.
  14263. */
  14264. readonly absoluteScaling: Vector3;
  14265. /**
  14266. * Returns the current mesh absolute rotation.
  14267. * Returns a Quaternion.
  14268. */
  14269. readonly absoluteRotationQuaternion: Quaternion;
  14270. /**
  14271. * Sets a new matrix to apply before all other transformation
  14272. * @param matrix defines the transform matrix
  14273. * @returns the current TransformNode
  14274. */
  14275. setPreTransformMatrix(matrix: Matrix): TransformNode;
  14276. /**
  14277. * Sets a new pivot matrix to the current node
  14278. * @param matrix defines the new pivot matrix to use
  14279. * @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
  14280. * @returns the current TransformNode
  14281. */
  14282. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  14283. /**
  14284. * Returns the mesh pivot matrix.
  14285. * Default : Identity.
  14286. * @returns the matrix
  14287. */
  14288. getPivotMatrix(): Matrix;
  14289. /**
  14290. * Instantiate (when possible) or clone that node with its hierarchy
  14291. * @param newParent defines the new parent to use for the instance (or clone)
  14292. * @param options defines options to configure how copy is done
  14293. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  14294. * @returns an instance (or a clone) of the current node with its hiearchy
  14295. */
  14296. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  14297. doNotInstantiate: boolean;
  14298. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  14299. /**
  14300. * Prevents the World matrix to be computed any longer
  14301. * @param newWorldMatrix defines an optional matrix to use as world matrix
  14302. * @returns the TransformNode.
  14303. */
  14304. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  14305. /**
  14306. * Allows back the World matrix computation.
  14307. * @returns the TransformNode.
  14308. */
  14309. unfreezeWorldMatrix(): this;
  14310. /**
  14311. * True if the World matrix has been frozen.
  14312. */
  14313. readonly isWorldMatrixFrozen: boolean;
  14314. /**
  14315. * Retuns the mesh absolute position in the World.
  14316. * @returns a Vector3.
  14317. */
  14318. getAbsolutePosition(): Vector3;
  14319. /**
  14320. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  14321. * @param absolutePosition the absolute position to set
  14322. * @returns the TransformNode.
  14323. */
  14324. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  14325. /**
  14326. * Sets the mesh position in its local space.
  14327. * @param vector3 the position to set in localspace
  14328. * @returns the TransformNode.
  14329. */
  14330. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  14331. /**
  14332. * Returns the mesh position in the local space from the current World matrix values.
  14333. * @returns a new Vector3.
  14334. */
  14335. getPositionExpressedInLocalSpace(): Vector3;
  14336. /**
  14337. * Translates the mesh along the passed Vector3 in its local space.
  14338. * @param vector3 the distance to translate in localspace
  14339. * @returns the TransformNode.
  14340. */
  14341. locallyTranslate(vector3: Vector3): TransformNode;
  14342. private static _lookAtVectorCache;
  14343. /**
  14344. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  14345. * @param targetPoint the position (must be in same space as current mesh) to look at
  14346. * @param yawCor optional yaw (y-axis) correction in radians
  14347. * @param pitchCor optional pitch (x-axis) correction in radians
  14348. * @param rollCor optional roll (z-axis) correction in radians
  14349. * @param space the choosen space of the target
  14350. * @returns the TransformNode.
  14351. */
  14352. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  14353. /**
  14354. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14355. * This Vector3 is expressed in the World space.
  14356. * @param localAxis axis to rotate
  14357. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14358. */
  14359. getDirection(localAxis: Vector3): Vector3;
  14360. /**
  14361. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  14362. * localAxis is expressed in the mesh local space.
  14363. * result is computed in the Wordl space from the mesh World matrix.
  14364. * @param localAxis axis to rotate
  14365. * @param result the resulting transformnode
  14366. * @returns this TransformNode.
  14367. */
  14368. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  14369. /**
  14370. * Sets this transform node rotation to the given local axis.
  14371. * @param localAxis the axis in local space
  14372. * @param yawCor optional yaw (y-axis) correction in radians
  14373. * @param pitchCor optional pitch (x-axis) correction in radians
  14374. * @param rollCor optional roll (z-axis) correction in radians
  14375. * @returns this TransformNode
  14376. */
  14377. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  14378. /**
  14379. * Sets a new pivot point to the current node
  14380. * @param point defines the new pivot point to use
  14381. * @param space defines if the point is in world or local space (local by default)
  14382. * @returns the current TransformNode
  14383. */
  14384. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  14385. /**
  14386. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  14387. * @returns the pivot point
  14388. */
  14389. getPivotPoint(): Vector3;
  14390. /**
  14391. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  14392. * @param result the vector3 to store the result
  14393. * @returns this TransformNode.
  14394. */
  14395. getPivotPointToRef(result: Vector3): TransformNode;
  14396. /**
  14397. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  14398. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  14399. */
  14400. getAbsolutePivotPoint(): Vector3;
  14401. /**
  14402. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  14403. * @param result vector3 to store the result
  14404. * @returns this TransformNode.
  14405. */
  14406. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  14407. /**
  14408. * Defines the passed node as the parent of the current node.
  14409. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  14410. * @see https://doc.babylonjs.com/how_to/parenting
  14411. * @param node the node ot set as the parent
  14412. * @returns this TransformNode.
  14413. */
  14414. setParent(node: Nullable<Node>): TransformNode;
  14415. private _nonUniformScaling;
  14416. /**
  14417. * True if the scaling property of this object is non uniform eg. (1,2,1)
  14418. */
  14419. readonly nonUniformScaling: boolean;
  14420. /** @hidden */
  14421. _updateNonUniformScalingState(value: boolean): boolean;
  14422. /**
  14423. * Attach the current TransformNode to another TransformNode associated with a bone
  14424. * @param bone Bone affecting the TransformNode
  14425. * @param affectedTransformNode TransformNode associated with the bone
  14426. * @returns this object
  14427. */
  14428. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  14429. /**
  14430. * Detach the transform node if its associated with a bone
  14431. * @returns this object
  14432. */
  14433. detachFromBone(): TransformNode;
  14434. private static _rotationAxisCache;
  14435. /**
  14436. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  14437. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14438. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14439. * The passed axis is also normalized.
  14440. * @param axis the axis to rotate around
  14441. * @param amount the amount to rotate in radians
  14442. * @param space Space to rotate in (Default: local)
  14443. * @returns the TransformNode.
  14444. */
  14445. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  14446. /**
  14447. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  14448. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14449. * The passed axis is also normalized. .
  14450. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  14451. * @param point the point to rotate around
  14452. * @param axis the axis to rotate around
  14453. * @param amount the amount to rotate in radians
  14454. * @returns the TransformNode
  14455. */
  14456. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  14457. /**
  14458. * Translates the mesh along the axis vector for the passed distance in the given space.
  14459. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14460. * @param axis the axis to translate in
  14461. * @param distance the distance to translate
  14462. * @param space Space to rotate in (Default: local)
  14463. * @returns the TransformNode.
  14464. */
  14465. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  14466. /**
  14467. * Adds a rotation step to the mesh current rotation.
  14468. * x, y, z are Euler angles expressed in radians.
  14469. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  14470. * This means this rotation is made in the mesh local space only.
  14471. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  14472. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  14473. * ```javascript
  14474. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  14475. * ```
  14476. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  14477. * 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.
  14478. * @param x Rotation to add
  14479. * @param y Rotation to add
  14480. * @param z Rotation to add
  14481. * @returns the TransformNode.
  14482. */
  14483. addRotation(x: number, y: number, z: number): TransformNode;
  14484. /**
  14485. * @hidden
  14486. */
  14487. protected _getEffectiveParent(): Nullable<Node>;
  14488. /**
  14489. * Computes the world matrix of the node
  14490. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14491. * @returns the world matrix
  14492. */
  14493. computeWorldMatrix(force?: boolean): Matrix;
  14494. protected _afterComputeWorldMatrix(): void;
  14495. /**
  14496. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  14497. * @param func callback function to add
  14498. *
  14499. * @returns the TransformNode.
  14500. */
  14501. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14502. /**
  14503. * Removes a registered callback function.
  14504. * @param func callback function to remove
  14505. * @returns the TransformNode.
  14506. */
  14507. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14508. /**
  14509. * Gets the position of the current mesh in camera space
  14510. * @param camera defines the camera to use
  14511. * @returns a position
  14512. */
  14513. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  14514. /**
  14515. * Returns the distance from the mesh to the active camera
  14516. * @param camera defines the camera to use
  14517. * @returns the distance
  14518. */
  14519. getDistanceToCamera(camera?: Nullable<Camera>): number;
  14520. /**
  14521. * Clone the current transform node
  14522. * @param name Name of the new clone
  14523. * @param newParent New parent for the clone
  14524. * @param doNotCloneChildren Do not clone children hierarchy
  14525. * @returns the new transform node
  14526. */
  14527. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  14528. /**
  14529. * Serializes the objects information.
  14530. * @param currentSerializationObject defines the object to serialize in
  14531. * @returns the serialized object
  14532. */
  14533. serialize(currentSerializationObject?: any): any;
  14534. /**
  14535. * Returns a new TransformNode object parsed from the source provided.
  14536. * @param parsedTransformNode is the source.
  14537. * @param scene the scne the object belongs to
  14538. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  14539. * @returns a new TransformNode object parsed from the source provided.
  14540. */
  14541. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  14542. /**
  14543. * Get all child-transformNodes of this node
  14544. * @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
  14545. * @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
  14546. * @returns an array of TransformNode
  14547. */
  14548. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  14549. /**
  14550. * Releases resources associated with this transform node.
  14551. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  14552. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  14553. */
  14554. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  14555. /**
  14556. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  14557. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  14558. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  14559. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  14560. * @returns the current mesh
  14561. */
  14562. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  14563. private _syncAbsoluteScalingAndRotation;
  14564. }
  14565. }
  14566. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  14567. import { Observable } from "babylonjs/Misc/observable";
  14568. import { Nullable } from "babylonjs/types";
  14569. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14570. import { TransformNode } from "babylonjs/Meshes/transformNode";
  14571. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14572. import { Ray } from "babylonjs/Culling/ray";
  14573. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  14574. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  14575. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  14576. /**
  14577. * Defines the types of pose enabled controllers that are supported
  14578. */
  14579. export enum PoseEnabledControllerType {
  14580. /**
  14581. * HTC Vive
  14582. */
  14583. VIVE = 0,
  14584. /**
  14585. * Oculus Rift
  14586. */
  14587. OCULUS = 1,
  14588. /**
  14589. * Windows mixed reality
  14590. */
  14591. WINDOWS = 2,
  14592. /**
  14593. * Samsung gear VR
  14594. */
  14595. GEAR_VR = 3,
  14596. /**
  14597. * Google Daydream
  14598. */
  14599. DAYDREAM = 4,
  14600. /**
  14601. * Generic
  14602. */
  14603. GENERIC = 5
  14604. }
  14605. /**
  14606. * Defines the MutableGamepadButton interface for the state of a gamepad button
  14607. */
  14608. export interface MutableGamepadButton {
  14609. /**
  14610. * Value of the button/trigger
  14611. */
  14612. value: number;
  14613. /**
  14614. * If the button/trigger is currently touched
  14615. */
  14616. touched: boolean;
  14617. /**
  14618. * If the button/trigger is currently pressed
  14619. */
  14620. pressed: boolean;
  14621. }
  14622. /**
  14623. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  14624. * @hidden
  14625. */
  14626. export interface ExtendedGamepadButton extends GamepadButton {
  14627. /**
  14628. * If the button/trigger is currently pressed
  14629. */
  14630. readonly pressed: boolean;
  14631. /**
  14632. * If the button/trigger is currently touched
  14633. */
  14634. readonly touched: boolean;
  14635. /**
  14636. * Value of the button/trigger
  14637. */
  14638. readonly value: number;
  14639. }
  14640. /** @hidden */
  14641. export interface _GamePadFactory {
  14642. /**
  14643. * Returns wether or not the current gamepad can be created for this type of controller.
  14644. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14645. * @returns true if it can be created, otherwise false
  14646. */
  14647. canCreate(gamepadInfo: any): boolean;
  14648. /**
  14649. * Creates a new instance of the Gamepad.
  14650. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14651. * @returns the new gamepad instance
  14652. */
  14653. create(gamepadInfo: any): Gamepad;
  14654. }
  14655. /**
  14656. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14657. */
  14658. export class PoseEnabledControllerHelper {
  14659. /** @hidden */
  14660. static _ControllerFactories: _GamePadFactory[];
  14661. /** @hidden */
  14662. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  14663. /**
  14664. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14665. * @param vrGamepad the gamepad to initialized
  14666. * @returns a vr controller of the type the gamepad identified as
  14667. */
  14668. static InitiateController(vrGamepad: any): Gamepad;
  14669. }
  14670. /**
  14671. * Defines the PoseEnabledController object that contains state of a vr capable controller
  14672. */
  14673. export class PoseEnabledController extends Gamepad implements PoseControlled {
  14674. /**
  14675. * If the controller is used in a webXR session
  14676. */
  14677. isXR: boolean;
  14678. private _deviceRoomPosition;
  14679. private _deviceRoomRotationQuaternion;
  14680. /**
  14681. * The device position in babylon space
  14682. */
  14683. devicePosition: Vector3;
  14684. /**
  14685. * The device rotation in babylon space
  14686. */
  14687. deviceRotationQuaternion: Quaternion;
  14688. /**
  14689. * The scale factor of the device in babylon space
  14690. */
  14691. deviceScaleFactor: number;
  14692. /**
  14693. * (Likely devicePosition should be used instead) The device position in its room space
  14694. */
  14695. position: Vector3;
  14696. /**
  14697. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  14698. */
  14699. rotationQuaternion: Quaternion;
  14700. /**
  14701. * The type of controller (Eg. Windows mixed reality)
  14702. */
  14703. controllerType: PoseEnabledControllerType;
  14704. protected _calculatedPosition: Vector3;
  14705. private _calculatedRotation;
  14706. /**
  14707. * The raw pose from the device
  14708. */
  14709. rawPose: DevicePose;
  14710. private _trackPosition;
  14711. private _maxRotationDistFromHeadset;
  14712. private _draggedRoomRotation;
  14713. /**
  14714. * @hidden
  14715. */
  14716. _disableTrackPosition(fixedPosition: Vector3): void;
  14717. /**
  14718. * Internal, the mesh attached to the controller
  14719. * @hidden
  14720. */
  14721. _mesh: Nullable<AbstractMesh>;
  14722. private _poseControlledCamera;
  14723. private _leftHandSystemQuaternion;
  14724. /**
  14725. * Internal, matrix used to convert room space to babylon space
  14726. * @hidden
  14727. */
  14728. _deviceToWorld: Matrix;
  14729. /**
  14730. * Node to be used when casting a ray from the controller
  14731. * @hidden
  14732. */
  14733. _pointingPoseNode: Nullable<TransformNode>;
  14734. /**
  14735. * Name of the child mesh that can be used to cast a ray from the controller
  14736. */
  14737. static readonly POINTING_POSE: string;
  14738. /**
  14739. * Creates a new PoseEnabledController from a gamepad
  14740. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  14741. */
  14742. constructor(browserGamepad: any);
  14743. private _workingMatrix;
  14744. /**
  14745. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  14746. */
  14747. update(): void;
  14748. /**
  14749. * Updates only the pose device and mesh without doing any button event checking
  14750. */
  14751. protected _updatePoseAndMesh(): void;
  14752. /**
  14753. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  14754. * @param poseData raw pose fromthe device
  14755. */
  14756. updateFromDevice(poseData: DevicePose): void;
  14757. /**
  14758. * @hidden
  14759. */
  14760. _meshAttachedObservable: Observable<AbstractMesh>;
  14761. /**
  14762. * Attaches a mesh to the controller
  14763. * @param mesh the mesh to be attached
  14764. */
  14765. attachToMesh(mesh: AbstractMesh): void;
  14766. /**
  14767. * Attaches the controllers mesh to a camera
  14768. * @param camera the camera the mesh should be attached to
  14769. */
  14770. attachToPoseControlledCamera(camera: TargetCamera): void;
  14771. /**
  14772. * Disposes of the controller
  14773. */
  14774. dispose(): void;
  14775. /**
  14776. * The mesh that is attached to the controller
  14777. */
  14778. readonly mesh: Nullable<AbstractMesh>;
  14779. /**
  14780. * Gets the ray of the controller in the direction the controller is pointing
  14781. * @param length the length the resulting ray should be
  14782. * @returns a ray in the direction the controller is pointing
  14783. */
  14784. getForwardRay(length?: number): Ray;
  14785. }
  14786. }
  14787. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  14788. import { Observable } from "babylonjs/Misc/observable";
  14789. import { Scene } from "babylonjs/scene";
  14790. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14791. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  14792. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  14793. import { Nullable } from "babylonjs/types";
  14794. /**
  14795. * Defines the WebVRController object that represents controllers tracked in 3D space
  14796. */
  14797. export abstract class WebVRController extends PoseEnabledController {
  14798. /**
  14799. * Internal, the default controller model for the controller
  14800. */
  14801. protected _defaultModel: Nullable<AbstractMesh>;
  14802. /**
  14803. * Fired when the trigger state has changed
  14804. */
  14805. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  14806. /**
  14807. * Fired when the main button state has changed
  14808. */
  14809. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14810. /**
  14811. * Fired when the secondary button state has changed
  14812. */
  14813. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14814. /**
  14815. * Fired when the pad state has changed
  14816. */
  14817. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  14818. /**
  14819. * Fired when controllers stick values have changed
  14820. */
  14821. onPadValuesChangedObservable: Observable<StickValues>;
  14822. /**
  14823. * Array of button availible on the controller
  14824. */
  14825. protected _buttons: Array<MutableGamepadButton>;
  14826. private _onButtonStateChange;
  14827. /**
  14828. * Fired when a controller button's state has changed
  14829. * @param callback the callback containing the button that was modified
  14830. */
  14831. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  14832. /**
  14833. * X and Y axis corresponding to the controllers joystick
  14834. */
  14835. pad: StickValues;
  14836. /**
  14837. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  14838. */
  14839. hand: string;
  14840. /**
  14841. * The default controller model for the controller
  14842. */
  14843. readonly defaultModel: Nullable<AbstractMesh>;
  14844. /**
  14845. * Creates a new WebVRController from a gamepad
  14846. * @param vrGamepad the gamepad that the WebVRController should be created from
  14847. */
  14848. constructor(vrGamepad: any);
  14849. /**
  14850. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  14851. */
  14852. update(): void;
  14853. /**
  14854. * Function to be called when a button is modified
  14855. */
  14856. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  14857. /**
  14858. * Loads a mesh and attaches it to the controller
  14859. * @param scene the scene the mesh should be added to
  14860. * @param meshLoaded callback for when the mesh has been loaded
  14861. */
  14862. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  14863. private _setButtonValue;
  14864. private _changes;
  14865. private _checkChanges;
  14866. /**
  14867. * Disposes of th webVRCOntroller
  14868. */
  14869. dispose(): void;
  14870. }
  14871. }
  14872. declare module "babylonjs/Lights/hemisphericLight" {
  14873. import { Nullable } from "babylonjs/types";
  14874. import { Scene } from "babylonjs/scene";
  14875. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14876. import { Color3 } from "babylonjs/Maths/math.color";
  14877. import { Effect } from "babylonjs/Materials/effect";
  14878. import { Light } from "babylonjs/Lights/light";
  14879. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  14880. /**
  14881. * The HemisphericLight simulates the ambient environment light,
  14882. * so the passed direction is the light reflection direction, not the incoming direction.
  14883. */
  14884. export class HemisphericLight extends Light {
  14885. /**
  14886. * The groundColor is the light in the opposite direction to the one specified during creation.
  14887. * 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.
  14888. */
  14889. groundColor: Color3;
  14890. /**
  14891. * The light reflection direction, not the incoming direction.
  14892. */
  14893. direction: Vector3;
  14894. /**
  14895. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  14896. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  14897. * The HemisphericLight can't cast shadows.
  14898. * Documentation : https://doc.babylonjs.com/babylon101/lights
  14899. * @param name The friendly name of the light
  14900. * @param direction The direction of the light reflection
  14901. * @param scene The scene the light belongs to
  14902. */
  14903. constructor(name: string, direction: Vector3, scene: Scene);
  14904. protected _buildUniformLayout(): void;
  14905. /**
  14906. * Returns the string "HemisphericLight".
  14907. * @return The class name
  14908. */
  14909. getClassName(): string;
  14910. /**
  14911. * Sets the HemisphericLight direction towards the passed target (Vector3).
  14912. * Returns the updated direction.
  14913. * @param target The target the direction should point to
  14914. * @return The computed direction
  14915. */
  14916. setDirectionToTarget(target: Vector3): Vector3;
  14917. /**
  14918. * Returns the shadow generator associated to the light.
  14919. * @returns Always null for hemispheric lights because it does not support shadows.
  14920. */
  14921. getShadowGenerator(): Nullable<IShadowGenerator>;
  14922. /**
  14923. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  14924. * @param effect The effect to update
  14925. * @param lightIndex The index of the light in the effect to update
  14926. * @returns The hemispheric light
  14927. */
  14928. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  14929. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  14930. /**
  14931. * Computes the world matrix of the node
  14932. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14933. * @param useWasUpdatedFlag defines a reserved property
  14934. * @returns the world matrix
  14935. */
  14936. computeWorldMatrix(): Matrix;
  14937. /**
  14938. * Returns the integer 3.
  14939. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  14940. */
  14941. getTypeID(): number;
  14942. /**
  14943. * Prepares the list of defines specific to the light type.
  14944. * @param defines the list of defines
  14945. * @param lightIndex defines the index of the light for the effect
  14946. */
  14947. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  14948. }
  14949. }
  14950. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  14951. /** @hidden */
  14952. export var vrMultiviewToSingleviewPixelShader: {
  14953. name: string;
  14954. shader: string;
  14955. };
  14956. }
  14957. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  14958. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  14959. import { Scene } from "babylonjs/scene";
  14960. /**
  14961. * Renders to multiple views with a single draw call
  14962. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  14963. */
  14964. export class MultiviewRenderTarget extends RenderTargetTexture {
  14965. /**
  14966. * Creates a multiview render target
  14967. * @param scene scene used with the render target
  14968. * @param size the size of the render target (used for each view)
  14969. */
  14970. constructor(scene: Scene, size?: number | {
  14971. width: number;
  14972. height: number;
  14973. } | {
  14974. ratio: number;
  14975. });
  14976. /**
  14977. * @hidden
  14978. * @param faceIndex the face index, if its a cube texture
  14979. */
  14980. _bindFrameBuffer(faceIndex?: number): void;
  14981. /**
  14982. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  14983. * @returns the view count
  14984. */
  14985. getViewCount(): number;
  14986. }
  14987. }
  14988. declare module "babylonjs/Maths/math.frustum" {
  14989. import { Matrix } from "babylonjs/Maths/math.vector";
  14990. import { DeepImmutable } from "babylonjs/types";
  14991. import { Plane } from "babylonjs/Maths/math.plane";
  14992. /**
  14993. * Represents a camera frustum
  14994. */
  14995. export class Frustum {
  14996. /**
  14997. * Gets the planes representing the frustum
  14998. * @param transform matrix to be applied to the returned planes
  14999. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  15000. */
  15001. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  15002. /**
  15003. * Gets the near frustum plane transformed by the transform matrix
  15004. * @param transform transformation matrix to be applied to the resulting frustum plane
  15005. * @param frustumPlane the resuling frustum plane
  15006. */
  15007. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15008. /**
  15009. * Gets the far frustum plane transformed by the transform matrix
  15010. * @param transform transformation matrix to be applied to the resulting frustum plane
  15011. * @param frustumPlane the resuling frustum plane
  15012. */
  15013. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15014. /**
  15015. * Gets the left frustum plane transformed by the transform matrix
  15016. * @param transform transformation matrix to be applied to the resulting frustum plane
  15017. * @param frustumPlane the resuling frustum plane
  15018. */
  15019. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15020. /**
  15021. * Gets the right frustum plane transformed by the transform matrix
  15022. * @param transform transformation matrix to be applied to the resulting frustum plane
  15023. * @param frustumPlane the resuling frustum plane
  15024. */
  15025. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15026. /**
  15027. * Gets the top frustum plane transformed by the transform matrix
  15028. * @param transform transformation matrix to be applied to the resulting frustum plane
  15029. * @param frustumPlane the resuling frustum plane
  15030. */
  15031. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15032. /**
  15033. * Gets the bottom frustum plane transformed by the transform matrix
  15034. * @param transform transformation matrix to be applied to the resulting frustum plane
  15035. * @param frustumPlane the resuling frustum plane
  15036. */
  15037. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15038. /**
  15039. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  15040. * @param transform transformation matrix to be applied to the resulting frustum planes
  15041. * @param frustumPlanes the resuling frustum planes
  15042. */
  15043. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  15044. }
  15045. }
  15046. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  15047. import { Camera } from "babylonjs/Cameras/camera";
  15048. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15049. import { Nullable } from "babylonjs/types";
  15050. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  15051. import { Matrix } from "babylonjs/Maths/math.vector";
  15052. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  15053. module "babylonjs/Engines/engine" {
  15054. interface Engine {
  15055. /**
  15056. * Creates a new multiview render target
  15057. * @param width defines the width of the texture
  15058. * @param height defines the height of the texture
  15059. * @returns the created multiview texture
  15060. */
  15061. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  15062. /**
  15063. * Binds a multiview framebuffer to be drawn to
  15064. * @param multiviewTexture texture to bind
  15065. */
  15066. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  15067. }
  15068. }
  15069. module "babylonjs/Cameras/camera" {
  15070. interface Camera {
  15071. /**
  15072. * @hidden
  15073. * 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)
  15074. */
  15075. _useMultiviewToSingleView: boolean;
  15076. /**
  15077. * @hidden
  15078. * 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)
  15079. */
  15080. _multiviewTexture: Nullable<RenderTargetTexture>;
  15081. /**
  15082. * @hidden
  15083. * ensures the multiview texture of the camera exists and has the specified width/height
  15084. * @param width height to set on the multiview texture
  15085. * @param height width to set on the multiview texture
  15086. */
  15087. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  15088. }
  15089. }
  15090. module "babylonjs/scene" {
  15091. interface Scene {
  15092. /** @hidden */
  15093. _transformMatrixR: Matrix;
  15094. /** @hidden */
  15095. _multiviewSceneUbo: Nullable<UniformBuffer>;
  15096. /** @hidden */
  15097. _createMultiviewUbo(): void;
  15098. /** @hidden */
  15099. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  15100. /** @hidden */
  15101. _renderMultiviewToSingleView(camera: Camera): void;
  15102. }
  15103. }
  15104. }
  15105. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  15106. import { Camera } from "babylonjs/Cameras/camera";
  15107. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  15108. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  15109. import "babylonjs/Engines/Extensions/engine.multiview";
  15110. /**
  15111. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  15112. * This will not be used for webXR as it supports displaying texture arrays directly
  15113. */
  15114. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  15115. /**
  15116. * Initializes a VRMultiviewToSingleview
  15117. * @param name name of the post process
  15118. * @param camera camera to be applied to
  15119. * @param scaleFactor scaling factor to the size of the output texture
  15120. */
  15121. constructor(name: string, camera: Camera, scaleFactor: number);
  15122. }
  15123. }
  15124. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  15125. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  15126. import { Nullable } from "babylonjs/types";
  15127. import { Size } from "babylonjs/Maths/math.size";
  15128. import { Observable } from "babylonjs/Misc/observable";
  15129. /**
  15130. * Interface used to define additional presentation attributes
  15131. */
  15132. export interface IVRPresentationAttributes {
  15133. /**
  15134. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  15135. */
  15136. highRefreshRate: boolean;
  15137. /**
  15138. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  15139. */
  15140. foveationLevel: number;
  15141. }
  15142. module "babylonjs/Engines/engine" {
  15143. interface Engine {
  15144. /** @hidden */
  15145. _vrDisplay: any;
  15146. /** @hidden */
  15147. _vrSupported: boolean;
  15148. /** @hidden */
  15149. _oldSize: Size;
  15150. /** @hidden */
  15151. _oldHardwareScaleFactor: number;
  15152. /** @hidden */
  15153. _vrExclusivePointerMode: boolean;
  15154. /** @hidden */
  15155. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  15156. /** @hidden */
  15157. _onVRDisplayPointerRestricted: () => void;
  15158. /** @hidden */
  15159. _onVRDisplayPointerUnrestricted: () => void;
  15160. /** @hidden */
  15161. _onVrDisplayConnect: Nullable<(display: any) => void>;
  15162. /** @hidden */
  15163. _onVrDisplayDisconnect: Nullable<() => void>;
  15164. /** @hidden */
  15165. _onVrDisplayPresentChange: Nullable<() => void>;
  15166. /**
  15167. * Observable signaled when VR display mode changes
  15168. */
  15169. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  15170. /**
  15171. * Observable signaled when VR request present is complete
  15172. */
  15173. onVRRequestPresentComplete: Observable<boolean>;
  15174. /**
  15175. * Observable signaled when VR request present starts
  15176. */
  15177. onVRRequestPresentStart: Observable<Engine>;
  15178. /**
  15179. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  15180. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  15181. */
  15182. isInVRExclusivePointerMode: boolean;
  15183. /**
  15184. * Gets a boolean indicating if a webVR device was detected
  15185. * @returns true if a webVR device was detected
  15186. */
  15187. isVRDevicePresent(): boolean;
  15188. /**
  15189. * Gets the current webVR device
  15190. * @returns the current webVR device (or null)
  15191. */
  15192. getVRDevice(): any;
  15193. /**
  15194. * Initializes a webVR display and starts listening to display change events
  15195. * The onVRDisplayChangedObservable will be notified upon these changes
  15196. * @returns A promise containing a VRDisplay and if vr is supported
  15197. */
  15198. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  15199. /** @hidden */
  15200. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  15201. /**
  15202. * Gets or sets the presentation attributes used to configure VR rendering
  15203. */
  15204. vrPresentationAttributes?: IVRPresentationAttributes;
  15205. /**
  15206. * Call this function to switch to webVR mode
  15207. * Will do nothing if webVR is not supported or if there is no webVR device
  15208. * @see http://doc.babylonjs.com/how_to/webvr_camera
  15209. */
  15210. enableVR(): void;
  15211. /** @hidden */
  15212. _onVRFullScreenTriggered(): void;
  15213. }
  15214. }
  15215. }
  15216. declare module "babylonjs/Cameras/VR/webVRCamera" {
  15217. import { Nullable } from "babylonjs/types";
  15218. import { Observable } from "babylonjs/Misc/observable";
  15219. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  15220. import { Scene } from "babylonjs/scene";
  15221. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  15222. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  15223. import { Node } from "babylonjs/node";
  15224. import { Ray } from "babylonjs/Culling/ray";
  15225. import "babylonjs/Cameras/RigModes/webVRRigMode";
  15226. import "babylonjs/Engines/Extensions/engine.webVR";
  15227. /**
  15228. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  15229. * IMPORTANT!! The data is right-hand data.
  15230. * @export
  15231. * @interface DevicePose
  15232. */
  15233. export interface DevicePose {
  15234. /**
  15235. * The position of the device, values in array are [x,y,z].
  15236. */
  15237. readonly position: Nullable<Float32Array>;
  15238. /**
  15239. * The linearVelocity of the device, values in array are [x,y,z].
  15240. */
  15241. readonly linearVelocity: Nullable<Float32Array>;
  15242. /**
  15243. * The linearAcceleration of the device, values in array are [x,y,z].
  15244. */
  15245. readonly linearAcceleration: Nullable<Float32Array>;
  15246. /**
  15247. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  15248. */
  15249. readonly orientation: Nullable<Float32Array>;
  15250. /**
  15251. * The angularVelocity of the device, values in array are [x,y,z].
  15252. */
  15253. readonly angularVelocity: Nullable<Float32Array>;
  15254. /**
  15255. * The angularAcceleration of the device, values in array are [x,y,z].
  15256. */
  15257. readonly angularAcceleration: Nullable<Float32Array>;
  15258. }
  15259. /**
  15260. * Interface representing a pose controlled object in Babylon.
  15261. * A pose controlled object has both regular pose values as well as pose values
  15262. * from an external device such as a VR head mounted display
  15263. */
  15264. export interface PoseControlled {
  15265. /**
  15266. * The position of the object in babylon space.
  15267. */
  15268. position: Vector3;
  15269. /**
  15270. * The rotation quaternion of the object in babylon space.
  15271. */
  15272. rotationQuaternion: Quaternion;
  15273. /**
  15274. * The position of the device in babylon space.
  15275. */
  15276. devicePosition?: Vector3;
  15277. /**
  15278. * The rotation quaternion of the device in babylon space.
  15279. */
  15280. deviceRotationQuaternion: Quaternion;
  15281. /**
  15282. * The raw pose coming from the device.
  15283. */
  15284. rawPose: Nullable<DevicePose>;
  15285. /**
  15286. * The scale of the device to be used when translating from device space to babylon space.
  15287. */
  15288. deviceScaleFactor: number;
  15289. /**
  15290. * Updates the poseControlled values based on the input device pose.
  15291. * @param poseData the pose data to update the object with
  15292. */
  15293. updateFromDevice(poseData: DevicePose): void;
  15294. }
  15295. /**
  15296. * Set of options to customize the webVRCamera
  15297. */
  15298. export interface WebVROptions {
  15299. /**
  15300. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  15301. */
  15302. trackPosition?: boolean;
  15303. /**
  15304. * Sets the scale of the vrDevice in babylon space. (default: 1)
  15305. */
  15306. positionScale?: number;
  15307. /**
  15308. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  15309. */
  15310. displayName?: string;
  15311. /**
  15312. * Should the native controller meshes be initialized. (default: true)
  15313. */
  15314. controllerMeshes?: boolean;
  15315. /**
  15316. * Creating a default HemiLight only on controllers. (default: true)
  15317. */
  15318. defaultLightingOnControllers?: boolean;
  15319. /**
  15320. * If you don't want to use the default VR button of the helper. (default: false)
  15321. */
  15322. useCustomVRButton?: boolean;
  15323. /**
  15324. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  15325. */
  15326. customVRButton?: HTMLButtonElement;
  15327. /**
  15328. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  15329. */
  15330. rayLength?: number;
  15331. /**
  15332. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  15333. */
  15334. defaultHeight?: number;
  15335. /**
  15336. * If multiview should be used if availible (default: false)
  15337. */
  15338. useMultiview?: boolean;
  15339. }
  15340. /**
  15341. * This represents a WebVR camera.
  15342. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  15343. * @example http://doc.babylonjs.com/how_to/webvr_camera
  15344. */
  15345. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  15346. private webVROptions;
  15347. /**
  15348. * @hidden
  15349. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  15350. */
  15351. _vrDevice: any;
  15352. /**
  15353. * The rawPose of the vrDevice.
  15354. */
  15355. rawPose: Nullable<DevicePose>;
  15356. private _onVREnabled;
  15357. private _specsVersion;
  15358. private _attached;
  15359. private _frameData;
  15360. protected _descendants: Array<Node>;
  15361. private _deviceRoomPosition;
  15362. /** @hidden */
  15363. _deviceRoomRotationQuaternion: Quaternion;
  15364. private _standingMatrix;
  15365. /**
  15366. * Represents device position in babylon space.
  15367. */
  15368. devicePosition: Vector3;
  15369. /**
  15370. * Represents device rotation in babylon space.
  15371. */
  15372. deviceRotationQuaternion: Quaternion;
  15373. /**
  15374. * The scale of the device to be used when translating from device space to babylon space.
  15375. */
  15376. deviceScaleFactor: number;
  15377. private _deviceToWorld;
  15378. private _worldToDevice;
  15379. /**
  15380. * References to the webVR controllers for the vrDevice.
  15381. */
  15382. controllers: Array<WebVRController>;
  15383. /**
  15384. * Emits an event when a controller is attached.
  15385. */
  15386. onControllersAttachedObservable: Observable<WebVRController[]>;
  15387. /**
  15388. * Emits an event when a controller's mesh has been loaded;
  15389. */
  15390. onControllerMeshLoadedObservable: Observable<WebVRController>;
  15391. /**
  15392. * Emits an event when the HMD's pose has been updated.
  15393. */
  15394. onPoseUpdatedFromDeviceObservable: Observable<any>;
  15395. private _poseSet;
  15396. /**
  15397. * If the rig cameras be used as parent instead of this camera.
  15398. */
  15399. rigParenting: boolean;
  15400. private _lightOnControllers;
  15401. private _defaultHeight?;
  15402. /**
  15403. * Instantiates a WebVRFreeCamera.
  15404. * @param name The name of the WebVRFreeCamera
  15405. * @param position The starting anchor position for the camera
  15406. * @param scene The scene the camera belongs to
  15407. * @param webVROptions a set of customizable options for the webVRCamera
  15408. */
  15409. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  15410. /**
  15411. * Gets the device distance from the ground in meters.
  15412. * @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.
  15413. */
  15414. deviceDistanceToRoomGround(): number;
  15415. /**
  15416. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15417. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  15418. */
  15419. useStandingMatrix(callback?: (bool: boolean) => void): void;
  15420. /**
  15421. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15422. * @returns A promise with a boolean set to if the standing matrix is supported.
  15423. */
  15424. useStandingMatrixAsync(): Promise<boolean>;
  15425. /**
  15426. * Disposes the camera
  15427. */
  15428. dispose(): void;
  15429. /**
  15430. * Gets a vrController by name.
  15431. * @param name The name of the controller to retreive
  15432. * @returns the controller matching the name specified or null if not found
  15433. */
  15434. getControllerByName(name: string): Nullable<WebVRController>;
  15435. private _leftController;
  15436. /**
  15437. * The controller corresponding to the users left hand.
  15438. */
  15439. readonly leftController: Nullable<WebVRController>;
  15440. private _rightController;
  15441. /**
  15442. * The controller corresponding to the users right hand.
  15443. */
  15444. readonly rightController: Nullable<WebVRController>;
  15445. /**
  15446. * Casts a ray forward from the vrCamera's gaze.
  15447. * @param length Length of the ray (default: 100)
  15448. * @returns the ray corresponding to the gaze
  15449. */
  15450. getForwardRay(length?: number): Ray;
  15451. /**
  15452. * @hidden
  15453. * Updates the camera based on device's frame data
  15454. */
  15455. _checkInputs(): void;
  15456. /**
  15457. * Updates the poseControlled values based on the input device pose.
  15458. * @param poseData Pose coming from the device
  15459. */
  15460. updateFromDevice(poseData: DevicePose): void;
  15461. private _htmlElementAttached;
  15462. private _detachIfAttached;
  15463. /**
  15464. * WebVR's attach control will start broadcasting frames to the device.
  15465. * Note that in certain browsers (chrome for example) this function must be called
  15466. * within a user-interaction callback. Example:
  15467. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  15468. *
  15469. * @param element html element to attach the vrDevice to
  15470. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  15471. */
  15472. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  15473. /**
  15474. * Detaches the camera from the html element and disables VR
  15475. *
  15476. * @param element html element to detach from
  15477. */
  15478. detachControl(element: HTMLElement): void;
  15479. /**
  15480. * @returns the name of this class
  15481. */
  15482. getClassName(): string;
  15483. /**
  15484. * Calls resetPose on the vrDisplay
  15485. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  15486. */
  15487. resetToCurrentRotation(): void;
  15488. /**
  15489. * @hidden
  15490. * Updates the rig cameras (left and right eye)
  15491. */
  15492. _updateRigCameras(): void;
  15493. private _workingVector;
  15494. private _oneVector;
  15495. private _workingMatrix;
  15496. private updateCacheCalled;
  15497. private _correctPositionIfNotTrackPosition;
  15498. /**
  15499. * @hidden
  15500. * Updates the cached values of the camera
  15501. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  15502. */
  15503. _updateCache(ignoreParentClass?: boolean): void;
  15504. /**
  15505. * @hidden
  15506. * Get current device position in babylon world
  15507. */
  15508. _computeDevicePosition(): void;
  15509. /**
  15510. * Updates the current device position and rotation in the babylon world
  15511. */
  15512. update(): void;
  15513. /**
  15514. * @hidden
  15515. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  15516. * @returns an identity matrix
  15517. */
  15518. _getViewMatrix(): Matrix;
  15519. private _tmpMatrix;
  15520. /**
  15521. * This function is called by the two RIG cameras.
  15522. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  15523. * @hidden
  15524. */
  15525. _getWebVRViewMatrix(): Matrix;
  15526. /** @hidden */
  15527. _getWebVRProjectionMatrix(): Matrix;
  15528. private _onGamepadConnectedObserver;
  15529. private _onGamepadDisconnectedObserver;
  15530. private _updateCacheWhenTrackingDisabledObserver;
  15531. /**
  15532. * Initializes the controllers and their meshes
  15533. */
  15534. initControllers(): void;
  15535. }
  15536. }
  15537. declare module "babylonjs/PostProcesses/postProcess" {
  15538. import { Nullable } from "babylonjs/types";
  15539. import { SmartArray } from "babylonjs/Misc/smartArray";
  15540. import { Observable } from "babylonjs/Misc/observable";
  15541. import { Vector2 } from "babylonjs/Maths/math.vector";
  15542. import { Camera } from "babylonjs/Cameras/camera";
  15543. import { Effect } from "babylonjs/Materials/effect";
  15544. import "babylonjs/Shaders/postprocess.vertex";
  15545. import { IInspectable } from "babylonjs/Misc/iInspectable";
  15546. import { Engine } from "babylonjs/Engines/engine";
  15547. import { Color4 } from "babylonjs/Maths/math.color";
  15548. import "babylonjs/Engines/Extensions/engine.renderTarget";
  15549. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15550. /**
  15551. * Size options for a post process
  15552. */
  15553. export type PostProcessOptions = {
  15554. width: number;
  15555. height: number;
  15556. };
  15557. /**
  15558. * PostProcess can be used to apply a shader to a texture after it has been rendered
  15559. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  15560. */
  15561. export class PostProcess {
  15562. /** Name of the PostProcess. */
  15563. name: string;
  15564. /**
  15565. * Gets or sets the unique id of the post process
  15566. */
  15567. uniqueId: number;
  15568. /**
  15569. * Width of the texture to apply the post process on
  15570. */
  15571. width: number;
  15572. /**
  15573. * Height of the texture to apply the post process on
  15574. */
  15575. height: number;
  15576. /**
  15577. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  15578. * @hidden
  15579. */
  15580. _outputTexture: Nullable<InternalTexture>;
  15581. /**
  15582. * Sampling mode used by the shader
  15583. * See https://doc.babylonjs.com/classes/3.1/texture
  15584. */
  15585. renderTargetSamplingMode: number;
  15586. /**
  15587. * Clear color to use when screen clearing
  15588. */
  15589. clearColor: Color4;
  15590. /**
  15591. * If the buffer needs to be cleared before applying the post process. (default: true)
  15592. * Should be set to false if shader will overwrite all previous pixels.
  15593. */
  15594. autoClear: boolean;
  15595. /**
  15596. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  15597. */
  15598. alphaMode: number;
  15599. /**
  15600. * Sets the setAlphaBlendConstants of the babylon engine
  15601. */
  15602. alphaConstants: Color4;
  15603. /**
  15604. * Animations to be used for the post processing
  15605. */
  15606. animations: import("babylonjs/Animations/animation").Animation[];
  15607. /**
  15608. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  15609. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  15610. */
  15611. enablePixelPerfectMode: boolean;
  15612. /**
  15613. * Force the postprocess to be applied without taking in account viewport
  15614. */
  15615. forceFullscreenViewport: boolean;
  15616. /**
  15617. * List of inspectable custom properties (used by the Inspector)
  15618. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  15619. */
  15620. inspectableCustomProperties: IInspectable[];
  15621. /**
  15622. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  15623. *
  15624. * | Value | Type | Description |
  15625. * | ----- | ----------------------------------- | ----------- |
  15626. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  15627. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  15628. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  15629. *
  15630. */
  15631. scaleMode: number;
  15632. /**
  15633. * Force textures to be a power of two (default: false)
  15634. */
  15635. alwaysForcePOT: boolean;
  15636. private _samples;
  15637. /**
  15638. * Number of sample textures (default: 1)
  15639. */
  15640. samples: number;
  15641. /**
  15642. * Modify the scale of the post process to be the same as the viewport (default: false)
  15643. */
  15644. adaptScaleToCurrentViewport: boolean;
  15645. private _camera;
  15646. private _scene;
  15647. private _engine;
  15648. private _options;
  15649. private _reusable;
  15650. private _textureType;
  15651. /**
  15652. * Smart array of input and output textures for the post process.
  15653. * @hidden
  15654. */
  15655. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  15656. /**
  15657. * The index in _textures that corresponds to the output texture.
  15658. * @hidden
  15659. */
  15660. _currentRenderTextureInd: number;
  15661. private _effect;
  15662. private _samplers;
  15663. private _fragmentUrl;
  15664. private _vertexUrl;
  15665. private _parameters;
  15666. private _scaleRatio;
  15667. protected _indexParameters: any;
  15668. private _shareOutputWithPostProcess;
  15669. private _texelSize;
  15670. private _forcedOutputTexture;
  15671. /**
  15672. * Returns the fragment url or shader name used in the post process.
  15673. * @returns the fragment url or name in the shader store.
  15674. */
  15675. getEffectName(): string;
  15676. /**
  15677. * An event triggered when the postprocess is activated.
  15678. */
  15679. onActivateObservable: Observable<Camera>;
  15680. private _onActivateObserver;
  15681. /**
  15682. * A function that is added to the onActivateObservable
  15683. */
  15684. onActivate: Nullable<(camera: Camera) => void>;
  15685. /**
  15686. * An event triggered when the postprocess changes its size.
  15687. */
  15688. onSizeChangedObservable: Observable<PostProcess>;
  15689. private _onSizeChangedObserver;
  15690. /**
  15691. * A function that is added to the onSizeChangedObservable
  15692. */
  15693. onSizeChanged: (postProcess: PostProcess) => void;
  15694. /**
  15695. * An event triggered when the postprocess applies its effect.
  15696. */
  15697. onApplyObservable: Observable<Effect>;
  15698. private _onApplyObserver;
  15699. /**
  15700. * A function that is added to the onApplyObservable
  15701. */
  15702. onApply: (effect: Effect) => void;
  15703. /**
  15704. * An event triggered before rendering the postprocess
  15705. */
  15706. onBeforeRenderObservable: Observable<Effect>;
  15707. private _onBeforeRenderObserver;
  15708. /**
  15709. * A function that is added to the onBeforeRenderObservable
  15710. */
  15711. onBeforeRender: (effect: Effect) => void;
  15712. /**
  15713. * An event triggered after rendering the postprocess
  15714. */
  15715. onAfterRenderObservable: Observable<Effect>;
  15716. private _onAfterRenderObserver;
  15717. /**
  15718. * A function that is added to the onAfterRenderObservable
  15719. */
  15720. onAfterRender: (efect: Effect) => void;
  15721. /**
  15722. * 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
  15723. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  15724. */
  15725. inputTexture: InternalTexture;
  15726. /**
  15727. * Gets the camera which post process is applied to.
  15728. * @returns The camera the post process is applied to.
  15729. */
  15730. getCamera(): Camera;
  15731. /**
  15732. * Gets the texel size of the postprocess.
  15733. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  15734. */
  15735. readonly texelSize: Vector2;
  15736. /**
  15737. * Creates a new instance PostProcess
  15738. * @param name The name of the PostProcess.
  15739. * @param fragmentUrl The url of the fragment shader to be used.
  15740. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  15741. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  15742. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15743. * @param camera The camera to apply the render pass to.
  15744. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15745. * @param engine The engine which the post process will be applied. (default: current engine)
  15746. * @param reusable If the post process can be reused on the same frame. (default: false)
  15747. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  15748. * @param textureType Type of textures used when performing the post process. (default: 0)
  15749. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  15750. * @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
  15751. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  15752. */
  15753. constructor(
  15754. /** Name of the PostProcess. */
  15755. 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);
  15756. /**
  15757. * Gets a string idenfifying the name of the class
  15758. * @returns "PostProcess" string
  15759. */
  15760. getClassName(): string;
  15761. /**
  15762. * Gets the engine which this post process belongs to.
  15763. * @returns The engine the post process was enabled with.
  15764. */
  15765. getEngine(): Engine;
  15766. /**
  15767. * The effect that is created when initializing the post process.
  15768. * @returns The created effect corresponding the the postprocess.
  15769. */
  15770. getEffect(): Effect;
  15771. /**
  15772. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  15773. * @param postProcess The post process to share the output with.
  15774. * @returns This post process.
  15775. */
  15776. shareOutputWith(postProcess: PostProcess): PostProcess;
  15777. /**
  15778. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  15779. * This should be called if the post process that shares output with this post process is disabled/disposed.
  15780. */
  15781. useOwnOutput(): void;
  15782. /**
  15783. * Updates the effect with the current post process compile time values and recompiles the shader.
  15784. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15785. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15786. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15787. * @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
  15788. * @param onCompiled Called when the shader has been compiled.
  15789. * @param onError Called if there is an error when compiling a shader.
  15790. */
  15791. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15792. /**
  15793. * The post process is reusable if it can be used multiple times within one frame.
  15794. * @returns If the post process is reusable
  15795. */
  15796. isReusable(): boolean;
  15797. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  15798. markTextureDirty(): void;
  15799. /**
  15800. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  15801. * 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.
  15802. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  15803. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  15804. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  15805. * @returns The target texture that was bound to be written to.
  15806. */
  15807. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  15808. /**
  15809. * If the post process is supported.
  15810. */
  15811. readonly isSupported: boolean;
  15812. /**
  15813. * The aspect ratio of the output texture.
  15814. */
  15815. readonly aspectRatio: number;
  15816. /**
  15817. * Get a value indicating if the post-process is ready to be used
  15818. * @returns true if the post-process is ready (shader is compiled)
  15819. */
  15820. isReady(): boolean;
  15821. /**
  15822. * Binds all textures and uniforms to the shader, this will be run on every pass.
  15823. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  15824. */
  15825. apply(): Nullable<Effect>;
  15826. private _disposeTextures;
  15827. /**
  15828. * Disposes the post process.
  15829. * @param camera The camera to dispose the post process on.
  15830. */
  15831. dispose(camera?: Camera): void;
  15832. }
  15833. }
  15834. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  15835. /** @hidden */
  15836. export var kernelBlurVaryingDeclaration: {
  15837. name: string;
  15838. shader: string;
  15839. };
  15840. }
  15841. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  15842. /** @hidden */
  15843. export var kernelBlurFragment: {
  15844. name: string;
  15845. shader: string;
  15846. };
  15847. }
  15848. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  15849. /** @hidden */
  15850. export var kernelBlurFragment2: {
  15851. name: string;
  15852. shader: string;
  15853. };
  15854. }
  15855. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  15856. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15857. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  15858. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  15859. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  15860. /** @hidden */
  15861. export var kernelBlurPixelShader: {
  15862. name: string;
  15863. shader: string;
  15864. };
  15865. }
  15866. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  15867. /** @hidden */
  15868. export var kernelBlurVertex: {
  15869. name: string;
  15870. shader: string;
  15871. };
  15872. }
  15873. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  15874. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15875. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  15876. /** @hidden */
  15877. export var kernelBlurVertexShader: {
  15878. name: string;
  15879. shader: string;
  15880. };
  15881. }
  15882. declare module "babylonjs/PostProcesses/blurPostProcess" {
  15883. import { Vector2 } from "babylonjs/Maths/math.vector";
  15884. import { Nullable } from "babylonjs/types";
  15885. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  15886. import { Camera } from "babylonjs/Cameras/camera";
  15887. import { Effect } from "babylonjs/Materials/effect";
  15888. import { Engine } from "babylonjs/Engines/engine";
  15889. import "babylonjs/Shaders/kernelBlur.fragment";
  15890. import "babylonjs/Shaders/kernelBlur.vertex";
  15891. /**
  15892. * The Blur Post Process which blurs an image based on a kernel and direction.
  15893. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  15894. */
  15895. export class BlurPostProcess extends PostProcess {
  15896. /** The direction in which to blur the image. */
  15897. direction: Vector2;
  15898. private blockCompilation;
  15899. protected _kernel: number;
  15900. protected _idealKernel: number;
  15901. protected _packedFloat: boolean;
  15902. private _staticDefines;
  15903. /**
  15904. * Sets the length in pixels of the blur sample region
  15905. */
  15906. /**
  15907. * Gets the length in pixels of the blur sample region
  15908. */
  15909. kernel: number;
  15910. /**
  15911. * Sets wether or not the blur needs to unpack/repack floats
  15912. */
  15913. /**
  15914. * Gets wether or not the blur is unpacking/repacking floats
  15915. */
  15916. packedFloat: boolean;
  15917. /**
  15918. * Creates a new instance BlurPostProcess
  15919. * @param name The name of the effect.
  15920. * @param direction The direction in which to blur the image.
  15921. * @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.
  15922. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15923. * @param camera The camera to apply the render pass to.
  15924. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15925. * @param engine The engine which the post process will be applied. (default: current engine)
  15926. * @param reusable If the post process can be reused on the same frame. (default: false)
  15927. * @param textureType Type of textures used when performing the post process. (default: 0)
  15928. * @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)
  15929. */
  15930. constructor(name: string,
  15931. /** The direction in which to blur the image. */
  15932. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  15933. /**
  15934. * Updates the effect with the current post process compile time values and recompiles the shader.
  15935. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15936. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15937. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15938. * @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
  15939. * @param onCompiled Called when the shader has been compiled.
  15940. * @param onError Called if there is an error when compiling a shader.
  15941. */
  15942. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15943. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15944. /**
  15945. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  15946. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  15947. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  15948. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  15949. * The gaps between physical kernels are compensated for in the weighting of the samples
  15950. * @param idealKernel Ideal blur kernel.
  15951. * @return Nearest best kernel.
  15952. */
  15953. protected _nearestBestKernel(idealKernel: number): number;
  15954. /**
  15955. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  15956. * @param x The point on the Gaussian distribution to sample.
  15957. * @return the value of the Gaussian function at x.
  15958. */
  15959. protected _gaussianWeight(x: number): number;
  15960. /**
  15961. * Generates a string that can be used as a floating point number in GLSL.
  15962. * @param x Value to print.
  15963. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  15964. * @return GLSL float string.
  15965. */
  15966. protected _glslFloat(x: number, decimalFigures?: number): string;
  15967. }
  15968. }
  15969. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  15970. import { Scene } from "babylonjs/scene";
  15971. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  15972. import { Plane } from "babylonjs/Maths/math.plane";
  15973. /**
  15974. * Mirror texture can be used to simulate the view from a mirror in a scene.
  15975. * It will dynamically be rendered every frame to adapt to the camera point of view.
  15976. * You can then easily use it as a reflectionTexture on a flat surface.
  15977. * In case the surface is not a plane, please consider relying on reflection probes.
  15978. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  15979. */
  15980. export class MirrorTexture extends RenderTargetTexture {
  15981. private scene;
  15982. /**
  15983. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  15984. * 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.
  15985. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  15986. */
  15987. mirrorPlane: Plane;
  15988. /**
  15989. * Define the blur ratio used to blur the reflection if needed.
  15990. */
  15991. blurRatio: number;
  15992. /**
  15993. * Define the adaptive blur kernel used to blur the reflection if needed.
  15994. * This will autocompute the closest best match for the `blurKernel`
  15995. */
  15996. adaptiveBlurKernel: number;
  15997. /**
  15998. * Define the blur kernel used to blur the reflection if needed.
  15999. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16000. */
  16001. blurKernel: number;
  16002. /**
  16003. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  16004. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16005. */
  16006. blurKernelX: number;
  16007. /**
  16008. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  16009. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16010. */
  16011. blurKernelY: number;
  16012. private _autoComputeBlurKernel;
  16013. protected _onRatioRescale(): void;
  16014. private _updateGammaSpace;
  16015. private _imageProcessingConfigChangeObserver;
  16016. private _transformMatrix;
  16017. private _mirrorMatrix;
  16018. private _savedViewMatrix;
  16019. private _blurX;
  16020. private _blurY;
  16021. private _adaptiveBlurKernel;
  16022. private _blurKernelX;
  16023. private _blurKernelY;
  16024. private _blurRatio;
  16025. /**
  16026. * Instantiates a Mirror Texture.
  16027. * Mirror texture can be used to simulate the view from a mirror in a scene.
  16028. * It will dynamically be rendered every frame to adapt to the camera point of view.
  16029. * You can then easily use it as a reflectionTexture on a flat surface.
  16030. * In case the surface is not a plane, please consider relying on reflection probes.
  16031. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  16032. * @param name
  16033. * @param size
  16034. * @param scene
  16035. * @param generateMipMaps
  16036. * @param type
  16037. * @param samplingMode
  16038. * @param generateDepthBuffer
  16039. */
  16040. constructor(name: string, size: number | {
  16041. width: number;
  16042. height: number;
  16043. } | {
  16044. ratio: number;
  16045. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  16046. private _preparePostProcesses;
  16047. /**
  16048. * Clone the mirror texture.
  16049. * @returns the cloned texture
  16050. */
  16051. clone(): MirrorTexture;
  16052. /**
  16053. * Serialize the texture to a JSON representation you could use in Parse later on
  16054. * @returns the serialized JSON representation
  16055. */
  16056. serialize(): any;
  16057. /**
  16058. * Dispose the texture and release its associated resources.
  16059. */
  16060. dispose(): void;
  16061. }
  16062. }
  16063. declare module "babylonjs/Materials/Textures/texture" {
  16064. import { Observable } from "babylonjs/Misc/observable";
  16065. import { Nullable } from "babylonjs/types";
  16066. import { Matrix } from "babylonjs/Maths/math.vector";
  16067. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16068. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16069. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  16070. import { Scene } from "babylonjs/scene";
  16071. /**
  16072. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16073. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16074. */
  16075. export class Texture extends BaseTexture {
  16076. /**
  16077. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  16078. */
  16079. static SerializeBuffers: boolean;
  16080. /** @hidden */
  16081. static _CubeTextureParser: (jsonTexture: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => import("babylonjs/Materials/Textures/cubeTexture").CubeTexture;
  16082. /** @hidden */
  16083. static _CreateMirror: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/mirrorTexture").MirrorTexture;
  16084. /** @hidden */
  16085. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture;
  16086. /** nearest is mag = nearest and min = nearest and mip = linear */
  16087. static readonly NEAREST_SAMPLINGMODE: number;
  16088. /** nearest is mag = nearest and min = nearest and mip = linear */
  16089. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  16090. /** Bilinear is mag = linear and min = linear and mip = nearest */
  16091. static readonly BILINEAR_SAMPLINGMODE: number;
  16092. /** Bilinear is mag = linear and min = linear and mip = nearest */
  16093. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  16094. /** Trilinear is mag = linear and min = linear and mip = linear */
  16095. static readonly TRILINEAR_SAMPLINGMODE: number;
  16096. /** Trilinear is mag = linear and min = linear and mip = linear */
  16097. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  16098. /** mag = nearest and min = nearest and mip = nearest */
  16099. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  16100. /** mag = nearest and min = linear and mip = nearest */
  16101. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  16102. /** mag = nearest and min = linear and mip = linear */
  16103. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  16104. /** mag = nearest and min = linear and mip = none */
  16105. static readonly NEAREST_LINEAR: number;
  16106. /** mag = nearest and min = nearest and mip = none */
  16107. static readonly NEAREST_NEAREST: number;
  16108. /** mag = linear and min = nearest and mip = nearest */
  16109. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  16110. /** mag = linear and min = nearest and mip = linear */
  16111. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  16112. /** mag = linear and min = linear and mip = none */
  16113. static readonly LINEAR_LINEAR: number;
  16114. /** mag = linear and min = nearest and mip = none */
  16115. static readonly LINEAR_NEAREST: number;
  16116. /** Explicit coordinates mode */
  16117. static readonly EXPLICIT_MODE: number;
  16118. /** Spherical coordinates mode */
  16119. static readonly SPHERICAL_MODE: number;
  16120. /** Planar coordinates mode */
  16121. static readonly PLANAR_MODE: number;
  16122. /** Cubic coordinates mode */
  16123. static readonly CUBIC_MODE: number;
  16124. /** Projection coordinates mode */
  16125. static readonly PROJECTION_MODE: number;
  16126. /** Inverse Cubic coordinates mode */
  16127. static readonly SKYBOX_MODE: number;
  16128. /** Inverse Cubic coordinates mode */
  16129. static readonly INVCUBIC_MODE: number;
  16130. /** Equirectangular coordinates mode */
  16131. static readonly EQUIRECTANGULAR_MODE: number;
  16132. /** Equirectangular Fixed coordinates mode */
  16133. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  16134. /** Equirectangular Fixed Mirrored coordinates mode */
  16135. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  16136. /** Texture is not repeating outside of 0..1 UVs */
  16137. static readonly CLAMP_ADDRESSMODE: number;
  16138. /** Texture is repeating outside of 0..1 UVs */
  16139. static readonly WRAP_ADDRESSMODE: number;
  16140. /** Texture is repeating and mirrored */
  16141. static readonly MIRROR_ADDRESSMODE: number;
  16142. /**
  16143. * 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
  16144. */
  16145. static UseSerializedUrlIfAny: boolean;
  16146. /**
  16147. * Define the url of the texture.
  16148. */
  16149. url: Nullable<string>;
  16150. /**
  16151. * Define an offset on the texture to offset the u coordinates of the UVs
  16152. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16153. */
  16154. uOffset: number;
  16155. /**
  16156. * Define an offset on the texture to offset the v coordinates of the UVs
  16157. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16158. */
  16159. vOffset: number;
  16160. /**
  16161. * Define an offset on the texture to scale the u coordinates of the UVs
  16162. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16163. */
  16164. uScale: number;
  16165. /**
  16166. * Define an offset on the texture to scale the v coordinates of the UVs
  16167. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16168. */
  16169. vScale: number;
  16170. /**
  16171. * Define an offset on the texture to rotate around the u coordinates of the UVs
  16172. * @see http://doc.babylonjs.com/how_to/more_materials
  16173. */
  16174. uAng: number;
  16175. /**
  16176. * Define an offset on the texture to rotate around the v coordinates of the UVs
  16177. * @see http://doc.babylonjs.com/how_to/more_materials
  16178. */
  16179. vAng: number;
  16180. /**
  16181. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  16182. * @see http://doc.babylonjs.com/how_to/more_materials
  16183. */
  16184. wAng: number;
  16185. /**
  16186. * Defines the center of rotation (U)
  16187. */
  16188. uRotationCenter: number;
  16189. /**
  16190. * Defines the center of rotation (V)
  16191. */
  16192. vRotationCenter: number;
  16193. /**
  16194. * Defines the center of rotation (W)
  16195. */
  16196. wRotationCenter: number;
  16197. /**
  16198. * Are mip maps generated for this texture or not.
  16199. */
  16200. readonly noMipmap: boolean;
  16201. /**
  16202. * List of inspectable custom properties (used by the Inspector)
  16203. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16204. */
  16205. inspectableCustomProperties: Nullable<IInspectable[]>;
  16206. private _noMipmap;
  16207. /** @hidden */
  16208. _invertY: boolean;
  16209. private _rowGenerationMatrix;
  16210. private _cachedTextureMatrix;
  16211. private _projectionModeMatrix;
  16212. private _t0;
  16213. private _t1;
  16214. private _t2;
  16215. private _cachedUOffset;
  16216. private _cachedVOffset;
  16217. private _cachedUScale;
  16218. private _cachedVScale;
  16219. private _cachedUAng;
  16220. private _cachedVAng;
  16221. private _cachedWAng;
  16222. private _cachedProjectionMatrixId;
  16223. private _cachedCoordinatesMode;
  16224. /** @hidden */
  16225. protected _initialSamplingMode: number;
  16226. /** @hidden */
  16227. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  16228. private _deleteBuffer;
  16229. protected _format: Nullable<number>;
  16230. private _delayedOnLoad;
  16231. private _delayedOnError;
  16232. private _mimeType?;
  16233. /**
  16234. * Observable triggered once the texture has been loaded.
  16235. */
  16236. onLoadObservable: Observable<Texture>;
  16237. protected _isBlocking: boolean;
  16238. /**
  16239. * Is the texture preventing material to render while loading.
  16240. * If false, a default texture will be used instead of the loading one during the preparation step.
  16241. */
  16242. isBlocking: boolean;
  16243. /**
  16244. * Get the current sampling mode associated with the texture.
  16245. */
  16246. readonly samplingMode: number;
  16247. /**
  16248. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  16249. */
  16250. readonly invertY: boolean;
  16251. /**
  16252. * Instantiates a new texture.
  16253. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16254. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16255. * @param url defines the url of the picture to load as a texture
  16256. * @param scene defines the scene or engine the texture will belong to
  16257. * @param noMipmap defines if the texture will require mip maps or not
  16258. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  16259. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16260. * @param onLoad defines a callback triggered when the texture has been loaded
  16261. * @param onError defines a callback triggered when an error occurred during the loading session
  16262. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  16263. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  16264. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16265. * @param mimeType defines an optional mime type information
  16266. */
  16267. 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);
  16268. /**
  16269. * Update the url (and optional buffer) of this texture if url was null during construction.
  16270. * @param url the url of the texture
  16271. * @param buffer the buffer of the texture (defaults to null)
  16272. * @param onLoad callback called when the texture is loaded (defaults to null)
  16273. */
  16274. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  16275. /**
  16276. * Finish the loading sequence of a texture flagged as delayed load.
  16277. * @hidden
  16278. */
  16279. delayLoad(): void;
  16280. private _prepareRowForTextureGeneration;
  16281. /**
  16282. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  16283. * @returns the transform matrix of the texture.
  16284. */
  16285. getTextureMatrix(): Matrix;
  16286. /**
  16287. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  16288. * @returns The reflection texture transform
  16289. */
  16290. getReflectionTextureMatrix(): Matrix;
  16291. /**
  16292. * Clones the texture.
  16293. * @returns the cloned texture
  16294. */
  16295. clone(): Texture;
  16296. /**
  16297. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  16298. * @returns The JSON representation of the texture
  16299. */
  16300. serialize(): any;
  16301. /**
  16302. * Get the current class name of the texture useful for serialization or dynamic coding.
  16303. * @returns "Texture"
  16304. */
  16305. getClassName(): string;
  16306. /**
  16307. * Dispose the texture and release its associated resources.
  16308. */
  16309. dispose(): void;
  16310. /**
  16311. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  16312. * @param parsedTexture Define the JSON representation of the texture
  16313. * @param scene Define the scene the parsed texture should be instantiated in
  16314. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  16315. * @returns The parsed texture if successful
  16316. */
  16317. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  16318. /**
  16319. * Creates a texture from its base 64 representation.
  16320. * @param data Define the base64 payload without the data: prefix
  16321. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16322. * @param scene Define the scene the texture should belong to
  16323. * @param noMipmap Forces the texture to not create mip map information if true
  16324. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16325. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16326. * @param onLoad define a callback triggered when the texture has been loaded
  16327. * @param onError define a callback triggered when an error occurred during the loading session
  16328. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16329. * @returns the created texture
  16330. */
  16331. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  16332. /**
  16333. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  16334. * @param data Define the base64 payload without the data: prefix
  16335. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16336. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  16337. * @param scene Define the scene the texture should belong to
  16338. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  16339. * @param noMipmap Forces the texture to not create mip map information if true
  16340. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16341. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16342. * @param onLoad define a callback triggered when the texture has been loaded
  16343. * @param onError define a callback triggered when an error occurred during the loading session
  16344. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16345. * @returns the created texture
  16346. */
  16347. 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;
  16348. }
  16349. }
  16350. declare module "babylonjs/PostProcesses/postProcessManager" {
  16351. import { Nullable } from "babylonjs/types";
  16352. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16353. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  16354. import { Scene } from "babylonjs/scene";
  16355. /**
  16356. * PostProcessManager is used to manage one or more post processes or post process pipelines
  16357. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  16358. */
  16359. export class PostProcessManager {
  16360. private _scene;
  16361. private _indexBuffer;
  16362. private _vertexBuffers;
  16363. /**
  16364. * Creates a new instance PostProcess
  16365. * @param scene The scene that the post process is associated with.
  16366. */
  16367. constructor(scene: Scene);
  16368. private _prepareBuffers;
  16369. private _buildIndexBuffer;
  16370. /**
  16371. * Rebuilds the vertex buffers of the manager.
  16372. * @hidden
  16373. */
  16374. _rebuild(): void;
  16375. /**
  16376. * Prepares a frame to be run through a post process.
  16377. * @param sourceTexture The input texture to the post procesess. (default: null)
  16378. * @param postProcesses An array of post processes to be run. (default: null)
  16379. * @returns True if the post processes were able to be run.
  16380. * @hidden
  16381. */
  16382. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  16383. /**
  16384. * Manually render a set of post processes to a texture.
  16385. * @param postProcesses An array of post processes to be run.
  16386. * @param targetTexture The target texture to render to.
  16387. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  16388. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  16389. * @param lodLevel defines which lod of the texture to render to
  16390. */
  16391. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  16392. /**
  16393. * Finalize the result of the output of the postprocesses.
  16394. * @param doNotPresent If true the result will not be displayed to the screen.
  16395. * @param targetTexture The target texture to render to.
  16396. * @param faceIndex The index of the face to bind the target texture to.
  16397. * @param postProcesses The array of post processes to render.
  16398. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  16399. * @hidden
  16400. */
  16401. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  16402. /**
  16403. * Disposes of the post process manager.
  16404. */
  16405. dispose(): void;
  16406. }
  16407. }
  16408. declare module "babylonjs/Misc/gradients" {
  16409. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16410. /** Interface used by value gradients (color, factor, ...) */
  16411. export interface IValueGradient {
  16412. /**
  16413. * Gets or sets the gradient value (between 0 and 1)
  16414. */
  16415. gradient: number;
  16416. }
  16417. /** Class used to store color4 gradient */
  16418. export class ColorGradient implements IValueGradient {
  16419. /**
  16420. * Gets or sets the gradient value (between 0 and 1)
  16421. */
  16422. gradient: number;
  16423. /**
  16424. * Gets or sets first associated color
  16425. */
  16426. color1: Color4;
  16427. /**
  16428. * Gets or sets second associated color
  16429. */
  16430. color2?: Color4;
  16431. /**
  16432. * Will get a color picked randomly between color1 and color2.
  16433. * If color2 is undefined then color1 will be used
  16434. * @param result defines the target Color4 to store the result in
  16435. */
  16436. getColorToRef(result: Color4): void;
  16437. }
  16438. /** Class used to store color 3 gradient */
  16439. export class Color3Gradient implements IValueGradient {
  16440. /**
  16441. * Gets or sets the gradient value (between 0 and 1)
  16442. */
  16443. gradient: number;
  16444. /**
  16445. * Gets or sets the associated color
  16446. */
  16447. color: Color3;
  16448. }
  16449. /** Class used to store factor gradient */
  16450. export class FactorGradient implements IValueGradient {
  16451. /**
  16452. * Gets or sets the gradient value (between 0 and 1)
  16453. */
  16454. gradient: number;
  16455. /**
  16456. * Gets or sets first associated factor
  16457. */
  16458. factor1: number;
  16459. /**
  16460. * Gets or sets second associated factor
  16461. */
  16462. factor2?: number;
  16463. /**
  16464. * Will get a number picked randomly between factor1 and factor2.
  16465. * If factor2 is undefined then factor1 will be used
  16466. * @returns the picked number
  16467. */
  16468. getFactor(): number;
  16469. }
  16470. /**
  16471. * Helper used to simplify some generic gradient tasks
  16472. */
  16473. export class GradientHelper {
  16474. /**
  16475. * Gets the current gradient from an array of IValueGradient
  16476. * @param ratio defines the current ratio to get
  16477. * @param gradients defines the array of IValueGradient
  16478. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  16479. */
  16480. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  16481. }
  16482. }
  16483. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  16484. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16485. import { Nullable } from "babylonjs/types";
  16486. module "babylonjs/Engines/thinEngine" {
  16487. interface ThinEngine {
  16488. /**
  16489. * Creates a dynamic texture
  16490. * @param width defines the width of the texture
  16491. * @param height defines the height of the texture
  16492. * @param generateMipMaps defines if the engine should generate the mip levels
  16493. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  16494. * @returns the dynamic texture inside an InternalTexture
  16495. */
  16496. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  16497. /**
  16498. * Update the content of a dynamic texture
  16499. * @param texture defines the texture to update
  16500. * @param canvas defines the canvas containing the source
  16501. * @param invertY defines if data must be stored with Y axis inverted
  16502. * @param premulAlpha defines if alpha is stored as premultiplied
  16503. * @param format defines the format of the data
  16504. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  16505. */
  16506. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  16507. }
  16508. }
  16509. }
  16510. declare module "babylonjs/Misc/canvasGenerator" {
  16511. /**
  16512. * Helper class used to generate a canvas to manipulate images
  16513. */
  16514. export class CanvasGenerator {
  16515. /**
  16516. * Create a new canvas (or offscreen canvas depending on the context)
  16517. * @param width defines the expected width
  16518. * @param height defines the expected height
  16519. * @return a new canvas or offscreen canvas
  16520. */
  16521. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  16522. }
  16523. }
  16524. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  16525. import { Scene } from "babylonjs/scene";
  16526. import { Texture } from "babylonjs/Materials/Textures/texture";
  16527. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  16528. /**
  16529. * A class extending Texture allowing drawing on a texture
  16530. * @see http://doc.babylonjs.com/how_to/dynamictexture
  16531. */
  16532. export class DynamicTexture extends Texture {
  16533. private _generateMipMaps;
  16534. private _canvas;
  16535. private _context;
  16536. private _engine;
  16537. /**
  16538. * Creates a DynamicTexture
  16539. * @param name defines the name of the texture
  16540. * @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
  16541. * @param scene defines the scene where you want the texture
  16542. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  16543. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  16544. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  16545. */
  16546. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  16547. /**
  16548. * Get the current class name of the texture useful for serialization or dynamic coding.
  16549. * @returns "DynamicTexture"
  16550. */
  16551. getClassName(): string;
  16552. /**
  16553. * Gets the current state of canRescale
  16554. */
  16555. readonly canRescale: boolean;
  16556. private _recreate;
  16557. /**
  16558. * Scales the texture
  16559. * @param ratio the scale factor to apply to both width and height
  16560. */
  16561. scale(ratio: number): void;
  16562. /**
  16563. * Resizes the texture
  16564. * @param width the new width
  16565. * @param height the new height
  16566. */
  16567. scaleTo(width: number, height: number): void;
  16568. /**
  16569. * Gets the context of the canvas used by the texture
  16570. * @returns the canvas context of the dynamic texture
  16571. */
  16572. getContext(): CanvasRenderingContext2D;
  16573. /**
  16574. * Clears the texture
  16575. */
  16576. clear(): void;
  16577. /**
  16578. * Updates the texture
  16579. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  16580. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  16581. */
  16582. update(invertY?: boolean, premulAlpha?: boolean): void;
  16583. /**
  16584. * Draws text onto the texture
  16585. * @param text defines the text to be drawn
  16586. * @param x defines the placement of the text from the left
  16587. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  16588. * @param font defines the font to be used with font-style, font-size, font-name
  16589. * @param color defines the color used for the text
  16590. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  16591. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  16592. * @param update defines whether texture is immediately update (default is true)
  16593. */
  16594. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  16595. /**
  16596. * Clones the texture
  16597. * @returns the clone of the texture.
  16598. */
  16599. clone(): DynamicTexture;
  16600. /**
  16601. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  16602. * @returns a serialized dynamic texture object
  16603. */
  16604. serialize(): any;
  16605. /** @hidden */
  16606. _rebuild(): void;
  16607. }
  16608. }
  16609. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  16610. import { Scene } from "babylonjs/scene";
  16611. import { ISceneComponent } from "babylonjs/sceneComponent";
  16612. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16613. module "babylonjs/abstractScene" {
  16614. interface AbstractScene {
  16615. /**
  16616. * The list of procedural textures added to the scene
  16617. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16618. */
  16619. proceduralTextures: Array<ProceduralTexture>;
  16620. }
  16621. }
  16622. /**
  16623. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  16624. * in a given scene.
  16625. */
  16626. export class ProceduralTextureSceneComponent implements ISceneComponent {
  16627. /**
  16628. * The component name helpfull to identify the component in the list of scene components.
  16629. */
  16630. readonly name: string;
  16631. /**
  16632. * The scene the component belongs to.
  16633. */
  16634. scene: Scene;
  16635. /**
  16636. * Creates a new instance of the component for the given scene
  16637. * @param scene Defines the scene to register the component in
  16638. */
  16639. constructor(scene: Scene);
  16640. /**
  16641. * Registers the component in a given scene
  16642. */
  16643. register(): void;
  16644. /**
  16645. * Rebuilds the elements related to this component in case of
  16646. * context lost for instance.
  16647. */
  16648. rebuild(): void;
  16649. /**
  16650. * Disposes the component and the associated ressources.
  16651. */
  16652. dispose(): void;
  16653. private _beforeClear;
  16654. }
  16655. }
  16656. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  16657. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16658. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  16659. module "babylonjs/Engines/thinEngine" {
  16660. interface ThinEngine {
  16661. /**
  16662. * Creates a new render target cube texture
  16663. * @param size defines the size of the texture
  16664. * @param options defines the options used to create the texture
  16665. * @returns a new render target cube texture stored in an InternalTexture
  16666. */
  16667. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  16668. }
  16669. }
  16670. }
  16671. declare module "babylonjs/Shaders/procedural.vertex" {
  16672. /** @hidden */
  16673. export var proceduralVertexShader: {
  16674. name: string;
  16675. shader: string;
  16676. };
  16677. }
  16678. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  16679. import { Observable } from "babylonjs/Misc/observable";
  16680. import { Nullable } from "babylonjs/types";
  16681. import { Scene } from "babylonjs/scene";
  16682. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  16683. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  16684. import { Effect } from "babylonjs/Materials/effect";
  16685. import { Texture } from "babylonjs/Materials/Textures/texture";
  16686. import "babylonjs/Engines/Extensions/engine.renderTarget";
  16687. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  16688. import "babylonjs/Shaders/procedural.vertex";
  16689. /**
  16690. * 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.
  16691. * This is the base class of any Procedural texture and contains most of the shareable code.
  16692. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16693. */
  16694. export class ProceduralTexture extends Texture {
  16695. isCube: boolean;
  16696. /**
  16697. * Define if the texture is enabled or not (disabled texture will not render)
  16698. */
  16699. isEnabled: boolean;
  16700. /**
  16701. * Define if the texture must be cleared before rendering (default is true)
  16702. */
  16703. autoClear: boolean;
  16704. /**
  16705. * Callback called when the texture is generated
  16706. */
  16707. onGenerated: () => void;
  16708. /**
  16709. * Event raised when the texture is generated
  16710. */
  16711. onGeneratedObservable: Observable<ProceduralTexture>;
  16712. /** @hidden */
  16713. _generateMipMaps: boolean;
  16714. /** @hidden **/
  16715. _effect: Effect;
  16716. /** @hidden */
  16717. _textures: {
  16718. [key: string]: Texture;
  16719. };
  16720. private _size;
  16721. private _currentRefreshId;
  16722. private _refreshRate;
  16723. private _vertexBuffers;
  16724. private _indexBuffer;
  16725. private _uniforms;
  16726. private _samplers;
  16727. private _fragment;
  16728. private _floats;
  16729. private _ints;
  16730. private _floatsArrays;
  16731. private _colors3;
  16732. private _colors4;
  16733. private _vectors2;
  16734. private _vectors3;
  16735. private _matrices;
  16736. private _fallbackTexture;
  16737. private _fallbackTextureUsed;
  16738. private _engine;
  16739. private _cachedDefines;
  16740. private _contentUpdateId;
  16741. private _contentData;
  16742. /**
  16743. * Instantiates a new procedural texture.
  16744. * 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.
  16745. * This is the base class of any Procedural texture and contains most of the shareable code.
  16746. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16747. * @param name Define the name of the texture
  16748. * @param size Define the size of the texture to create
  16749. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  16750. * @param scene Define the scene the texture belongs to
  16751. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  16752. * @param generateMipMaps Define if the texture should creates mip maps or not
  16753. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  16754. */
  16755. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  16756. /**
  16757. * The effect that is created when initializing the post process.
  16758. * @returns The created effect corresponding the the postprocess.
  16759. */
  16760. getEffect(): Effect;
  16761. /**
  16762. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  16763. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  16764. */
  16765. getContent(): Nullable<ArrayBufferView>;
  16766. private _createIndexBuffer;
  16767. /** @hidden */
  16768. _rebuild(): void;
  16769. /**
  16770. * Resets the texture in order to recreate its associated resources.
  16771. * This can be called in case of context loss
  16772. */
  16773. reset(): void;
  16774. protected _getDefines(): string;
  16775. /**
  16776. * Is the texture ready to be used ? (rendered at least once)
  16777. * @returns true if ready, otherwise, false.
  16778. */
  16779. isReady(): boolean;
  16780. /**
  16781. * Resets the refresh counter of the texture and start bak from scratch.
  16782. * Could be useful to regenerate the texture if it is setup to render only once.
  16783. */
  16784. resetRefreshCounter(): void;
  16785. /**
  16786. * Set the fragment shader to use in order to render the texture.
  16787. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  16788. */
  16789. setFragment(fragment: any): void;
  16790. /**
  16791. * Define the refresh rate of the texture or the rendering frequency.
  16792. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  16793. */
  16794. refreshRate: number;
  16795. /** @hidden */
  16796. _shouldRender(): boolean;
  16797. /**
  16798. * Get the size the texture is rendering at.
  16799. * @returns the size (texture is always squared)
  16800. */
  16801. getRenderSize(): number;
  16802. /**
  16803. * Resize the texture to new value.
  16804. * @param size Define the new size the texture should have
  16805. * @param generateMipMaps Define whether the new texture should create mip maps
  16806. */
  16807. resize(size: number, generateMipMaps: boolean): void;
  16808. private _checkUniform;
  16809. /**
  16810. * Set a texture in the shader program used to render.
  16811. * @param name Define the name of the uniform samplers as defined in the shader
  16812. * @param texture Define the texture to bind to this sampler
  16813. * @return the texture itself allowing "fluent" like uniform updates
  16814. */
  16815. setTexture(name: string, texture: Texture): ProceduralTexture;
  16816. /**
  16817. * Set a float in the shader.
  16818. * @param name Define the name of the uniform as defined in the shader
  16819. * @param value Define the value to give to the uniform
  16820. * @return the texture itself allowing "fluent" like uniform updates
  16821. */
  16822. setFloat(name: string, value: number): ProceduralTexture;
  16823. /**
  16824. * Set a int in the shader.
  16825. * @param name Define the name of the uniform as defined in the shader
  16826. * @param value Define the value to give to the uniform
  16827. * @return the texture itself allowing "fluent" like uniform updates
  16828. */
  16829. setInt(name: string, value: number): ProceduralTexture;
  16830. /**
  16831. * Set an array of floats in the shader.
  16832. * @param name Define the name of the uniform as defined in the shader
  16833. * @param value Define the value to give to the uniform
  16834. * @return the texture itself allowing "fluent" like uniform updates
  16835. */
  16836. setFloats(name: string, value: number[]): ProceduralTexture;
  16837. /**
  16838. * Set a vec3 in the shader from a Color3.
  16839. * @param name Define the name of the uniform as defined in the shader
  16840. * @param value Define the value to give to the uniform
  16841. * @return the texture itself allowing "fluent" like uniform updates
  16842. */
  16843. setColor3(name: string, value: Color3): ProceduralTexture;
  16844. /**
  16845. * Set a vec4 in the shader from a Color4.
  16846. * @param name Define the name of the uniform as defined in the shader
  16847. * @param value Define the value to give to the uniform
  16848. * @return the texture itself allowing "fluent" like uniform updates
  16849. */
  16850. setColor4(name: string, value: Color4): ProceduralTexture;
  16851. /**
  16852. * Set a vec2 in the shader from a Vector2.
  16853. * @param name Define the name of the uniform as defined in the shader
  16854. * @param value Define the value to give to the uniform
  16855. * @return the texture itself allowing "fluent" like uniform updates
  16856. */
  16857. setVector2(name: string, value: Vector2): ProceduralTexture;
  16858. /**
  16859. * Set a vec3 in the shader from a Vector3.
  16860. * @param name Define the name of the uniform as defined in the shader
  16861. * @param value Define the value to give to the uniform
  16862. * @return the texture itself allowing "fluent" like uniform updates
  16863. */
  16864. setVector3(name: string, value: Vector3): ProceduralTexture;
  16865. /**
  16866. * Set a mat4 in the shader from a MAtrix.
  16867. * @param name Define the name of the uniform as defined in the shader
  16868. * @param value Define the value to give to the uniform
  16869. * @return the texture itself allowing "fluent" like uniform updates
  16870. */
  16871. setMatrix(name: string, value: Matrix): ProceduralTexture;
  16872. /**
  16873. * Render the texture to its associated render target.
  16874. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  16875. */
  16876. render(useCameraPostProcess?: boolean): void;
  16877. /**
  16878. * Clone the texture.
  16879. * @returns the cloned texture
  16880. */
  16881. clone(): ProceduralTexture;
  16882. /**
  16883. * Dispose the texture and release its asoociated resources.
  16884. */
  16885. dispose(): void;
  16886. }
  16887. }
  16888. declare module "babylonjs/Particles/baseParticleSystem" {
  16889. import { Nullable } from "babylonjs/types";
  16890. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  16891. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16892. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  16893. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16894. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16895. import { Scene } from "babylonjs/scene";
  16896. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  16897. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  16898. import { Texture } from "babylonjs/Materials/Textures/texture";
  16899. import { Color4 } from "babylonjs/Maths/math.color";
  16900. import { Animation } from "babylonjs/Animations/animation";
  16901. /**
  16902. * This represents the base class for particle system in Babylon.
  16903. * 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.
  16904. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  16905. * @example https://doc.babylonjs.com/babylon101/particles
  16906. */
  16907. export class BaseParticleSystem {
  16908. /**
  16909. * Source color is added to the destination color without alpha affecting the result
  16910. */
  16911. static BLENDMODE_ONEONE: number;
  16912. /**
  16913. * Blend current color and particle color using particle’s alpha
  16914. */
  16915. static BLENDMODE_STANDARD: number;
  16916. /**
  16917. * Add current color and particle color multiplied by particle’s alpha
  16918. */
  16919. static BLENDMODE_ADD: number;
  16920. /**
  16921. * Multiply current color with particle color
  16922. */
  16923. static BLENDMODE_MULTIPLY: number;
  16924. /**
  16925. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  16926. */
  16927. static BLENDMODE_MULTIPLYADD: number;
  16928. /**
  16929. * List of animations used by the particle system.
  16930. */
  16931. animations: Animation[];
  16932. /**
  16933. * The id of the Particle system.
  16934. */
  16935. id: string;
  16936. /**
  16937. * The friendly name of the Particle system.
  16938. */
  16939. name: string;
  16940. /**
  16941. * The rendering group used by the Particle system to chose when to render.
  16942. */
  16943. renderingGroupId: number;
  16944. /**
  16945. * The emitter represents the Mesh or position we are attaching the particle system to.
  16946. */
  16947. emitter: Nullable<AbstractMesh | Vector3>;
  16948. /**
  16949. * The maximum number of particles to emit per frame
  16950. */
  16951. emitRate: number;
  16952. /**
  16953. * If you want to launch only a few particles at once, that can be done, as well.
  16954. */
  16955. manualEmitCount: number;
  16956. /**
  16957. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  16958. */
  16959. updateSpeed: number;
  16960. /**
  16961. * The amount of time the particle system is running (depends of the overall update speed).
  16962. */
  16963. targetStopDuration: number;
  16964. /**
  16965. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  16966. */
  16967. disposeOnStop: boolean;
  16968. /**
  16969. * Minimum power of emitting particles.
  16970. */
  16971. minEmitPower: number;
  16972. /**
  16973. * Maximum power of emitting particles.
  16974. */
  16975. maxEmitPower: number;
  16976. /**
  16977. * Minimum life time of emitting particles.
  16978. */
  16979. minLifeTime: number;
  16980. /**
  16981. * Maximum life time of emitting particles.
  16982. */
  16983. maxLifeTime: number;
  16984. /**
  16985. * Minimum Size of emitting particles.
  16986. */
  16987. minSize: number;
  16988. /**
  16989. * Maximum Size of emitting particles.
  16990. */
  16991. maxSize: number;
  16992. /**
  16993. * Minimum scale of emitting particles on X axis.
  16994. */
  16995. minScaleX: number;
  16996. /**
  16997. * Maximum scale of emitting particles on X axis.
  16998. */
  16999. maxScaleX: number;
  17000. /**
  17001. * Minimum scale of emitting particles on Y axis.
  17002. */
  17003. minScaleY: number;
  17004. /**
  17005. * Maximum scale of emitting particles on Y axis.
  17006. */
  17007. maxScaleY: number;
  17008. /**
  17009. * Gets or sets the minimal initial rotation in radians.
  17010. */
  17011. minInitialRotation: number;
  17012. /**
  17013. * Gets or sets the maximal initial rotation in radians.
  17014. */
  17015. maxInitialRotation: number;
  17016. /**
  17017. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  17018. */
  17019. minAngularSpeed: number;
  17020. /**
  17021. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  17022. */
  17023. maxAngularSpeed: number;
  17024. /**
  17025. * The texture used to render each particle. (this can be a spritesheet)
  17026. */
  17027. particleTexture: Nullable<Texture>;
  17028. /**
  17029. * The layer mask we are rendering the particles through.
  17030. */
  17031. layerMask: number;
  17032. /**
  17033. * This can help using your own shader to render the particle system.
  17034. * The according effect will be created
  17035. */
  17036. customShader: any;
  17037. /**
  17038. * By default particle system starts as soon as they are created. This prevents the
  17039. * automatic start to happen and let you decide when to start emitting particles.
  17040. */
  17041. preventAutoStart: boolean;
  17042. private _noiseTexture;
  17043. /**
  17044. * Gets or sets a texture used to add random noise to particle positions
  17045. */
  17046. noiseTexture: Nullable<ProceduralTexture>;
  17047. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  17048. noiseStrength: Vector3;
  17049. /**
  17050. * Callback triggered when the particle animation is ending.
  17051. */
  17052. onAnimationEnd: Nullable<() => void>;
  17053. /**
  17054. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  17055. */
  17056. blendMode: number;
  17057. /**
  17058. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  17059. * to override the particles.
  17060. */
  17061. forceDepthWrite: boolean;
  17062. /** 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 */
  17063. preWarmCycles: number;
  17064. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  17065. preWarmStepOffset: number;
  17066. /**
  17067. * 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)
  17068. */
  17069. spriteCellChangeSpeed: number;
  17070. /**
  17071. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  17072. */
  17073. startSpriteCellID: number;
  17074. /**
  17075. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  17076. */
  17077. endSpriteCellID: number;
  17078. /**
  17079. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  17080. */
  17081. spriteCellWidth: number;
  17082. /**
  17083. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  17084. */
  17085. spriteCellHeight: number;
  17086. /**
  17087. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  17088. */
  17089. spriteRandomStartCell: boolean;
  17090. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  17091. translationPivot: Vector2;
  17092. /** @hidden */
  17093. protected _isAnimationSheetEnabled: boolean;
  17094. /**
  17095. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  17096. */
  17097. beginAnimationOnStart: boolean;
  17098. /**
  17099. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  17100. */
  17101. beginAnimationFrom: number;
  17102. /**
  17103. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  17104. */
  17105. beginAnimationTo: number;
  17106. /**
  17107. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  17108. */
  17109. beginAnimationLoop: boolean;
  17110. /**
  17111. * Gets or sets a world offset applied to all particles
  17112. */
  17113. worldOffset: Vector3;
  17114. /**
  17115. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  17116. */
  17117. isAnimationSheetEnabled: boolean;
  17118. /**
  17119. * Get hosting scene
  17120. * @returns the scene
  17121. */
  17122. getScene(): Scene;
  17123. /**
  17124. * You can use gravity if you want to give an orientation to your particles.
  17125. */
  17126. gravity: Vector3;
  17127. protected _colorGradients: Nullable<Array<ColorGradient>>;
  17128. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  17129. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  17130. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  17131. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  17132. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  17133. protected _dragGradients: Nullable<Array<FactorGradient>>;
  17134. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  17135. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  17136. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  17137. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  17138. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  17139. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  17140. /**
  17141. * Defines the delay in milliseconds before starting the system (0 by default)
  17142. */
  17143. startDelay: number;
  17144. /**
  17145. * Gets the current list of drag gradients.
  17146. * You must use addDragGradient and removeDragGradient to udpate this list
  17147. * @returns the list of drag gradients
  17148. */
  17149. getDragGradients(): Nullable<Array<FactorGradient>>;
  17150. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  17151. limitVelocityDamping: number;
  17152. /**
  17153. * Gets the current list of limit velocity gradients.
  17154. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  17155. * @returns the list of limit velocity gradients
  17156. */
  17157. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  17158. /**
  17159. * Gets the current list of color gradients.
  17160. * You must use addColorGradient and removeColorGradient to udpate this list
  17161. * @returns the list of color gradients
  17162. */
  17163. getColorGradients(): Nullable<Array<ColorGradient>>;
  17164. /**
  17165. * Gets the current list of size gradients.
  17166. * You must use addSizeGradient and removeSizeGradient to udpate this list
  17167. * @returns the list of size gradients
  17168. */
  17169. getSizeGradients(): Nullable<Array<FactorGradient>>;
  17170. /**
  17171. * Gets the current list of color remap gradients.
  17172. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  17173. * @returns the list of color remap gradients
  17174. */
  17175. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  17176. /**
  17177. * Gets the current list of alpha remap gradients.
  17178. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  17179. * @returns the list of alpha remap gradients
  17180. */
  17181. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  17182. /**
  17183. * Gets the current list of life time gradients.
  17184. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  17185. * @returns the list of life time gradients
  17186. */
  17187. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  17188. /**
  17189. * Gets the current list of angular speed gradients.
  17190. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  17191. * @returns the list of angular speed gradients
  17192. */
  17193. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  17194. /**
  17195. * Gets the current list of velocity gradients.
  17196. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  17197. * @returns the list of velocity gradients
  17198. */
  17199. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  17200. /**
  17201. * Gets the current list of start size gradients.
  17202. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  17203. * @returns the list of start size gradients
  17204. */
  17205. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  17206. /**
  17207. * Gets the current list of emit rate gradients.
  17208. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  17209. * @returns the list of emit rate gradients
  17210. */
  17211. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  17212. /**
  17213. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17214. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17215. */
  17216. direction1: Vector3;
  17217. /**
  17218. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17219. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17220. */
  17221. direction2: Vector3;
  17222. /**
  17223. * 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.
  17224. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17225. */
  17226. minEmitBox: Vector3;
  17227. /**
  17228. * 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.
  17229. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17230. */
  17231. maxEmitBox: Vector3;
  17232. /**
  17233. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  17234. */
  17235. color1: Color4;
  17236. /**
  17237. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  17238. */
  17239. color2: Color4;
  17240. /**
  17241. * Color the particle will have at the end of its lifetime
  17242. */
  17243. colorDead: Color4;
  17244. /**
  17245. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  17246. */
  17247. textureMask: Color4;
  17248. /**
  17249. * The particle emitter type defines the emitter used by the particle system.
  17250. * It can be for example box, sphere, or cone...
  17251. */
  17252. particleEmitterType: IParticleEmitterType;
  17253. /** @hidden */
  17254. _isSubEmitter: boolean;
  17255. /**
  17256. * Gets or sets the billboard mode to use when isBillboardBased = true.
  17257. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  17258. */
  17259. billboardMode: number;
  17260. protected _isBillboardBased: boolean;
  17261. /**
  17262. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  17263. */
  17264. isBillboardBased: boolean;
  17265. /**
  17266. * The scene the particle system belongs to.
  17267. */
  17268. protected _scene: Scene;
  17269. /**
  17270. * Local cache of defines for image processing.
  17271. */
  17272. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  17273. /**
  17274. * Default configuration related to image processing available in the standard Material.
  17275. */
  17276. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  17277. /**
  17278. * Gets the image processing configuration used either in this material.
  17279. */
  17280. /**
  17281. * Sets the Default image processing configuration used either in the this material.
  17282. *
  17283. * If sets to null, the scene one is in use.
  17284. */
  17285. imageProcessingConfiguration: ImageProcessingConfiguration;
  17286. /**
  17287. * Attaches a new image processing configuration to the Standard Material.
  17288. * @param configuration
  17289. */
  17290. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  17291. /** @hidden */
  17292. protected _reset(): void;
  17293. /** @hidden */
  17294. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  17295. /**
  17296. * Instantiates a particle system.
  17297. * 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.
  17298. * @param name The name of the particle system
  17299. */
  17300. constructor(name: string);
  17301. /**
  17302. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  17303. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17304. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17305. * @returns the emitter
  17306. */
  17307. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  17308. /**
  17309. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  17310. * @param radius The radius of the hemisphere to emit from
  17311. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17312. * @returns the emitter
  17313. */
  17314. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  17315. /**
  17316. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  17317. * @param radius The radius of the sphere to emit from
  17318. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17319. * @returns the emitter
  17320. */
  17321. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  17322. /**
  17323. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  17324. * @param radius The radius of the sphere to emit from
  17325. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  17326. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  17327. * @returns the emitter
  17328. */
  17329. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  17330. /**
  17331. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  17332. * @param radius The radius of the emission cylinder
  17333. * @param height The height of the emission cylinder
  17334. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  17335. * @param directionRandomizer How much to randomize the particle direction [0-1]
  17336. * @returns the emitter
  17337. */
  17338. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  17339. /**
  17340. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  17341. * @param radius The radius of the cylinder to emit from
  17342. * @param height The height of the emission cylinder
  17343. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  17344. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  17345. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  17346. * @returns the emitter
  17347. */
  17348. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  17349. /**
  17350. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  17351. * @param radius The radius of the cone to emit from
  17352. * @param angle The base angle of the cone
  17353. * @returns the emitter
  17354. */
  17355. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  17356. /**
  17357. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  17358. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17359. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17360. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17361. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17362. * @returns the emitter
  17363. */
  17364. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  17365. }
  17366. }
  17367. declare module "babylonjs/Particles/subEmitter" {
  17368. import { Scene } from "babylonjs/scene";
  17369. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17370. /**
  17371. * Type of sub emitter
  17372. */
  17373. export enum SubEmitterType {
  17374. /**
  17375. * Attached to the particle over it's lifetime
  17376. */
  17377. ATTACHED = 0,
  17378. /**
  17379. * Created when the particle dies
  17380. */
  17381. END = 1
  17382. }
  17383. /**
  17384. * Sub emitter class used to emit particles from an existing particle
  17385. */
  17386. export class SubEmitter {
  17387. /**
  17388. * the particle system to be used by the sub emitter
  17389. */
  17390. particleSystem: ParticleSystem;
  17391. /**
  17392. * Type of the submitter (Default: END)
  17393. */
  17394. type: SubEmitterType;
  17395. /**
  17396. * 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)
  17397. * Note: This only is supported when using an emitter of type Mesh
  17398. */
  17399. inheritDirection: boolean;
  17400. /**
  17401. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  17402. */
  17403. inheritedVelocityAmount: number;
  17404. /**
  17405. * Creates a sub emitter
  17406. * @param particleSystem the particle system to be used by the sub emitter
  17407. */
  17408. constructor(
  17409. /**
  17410. * the particle system to be used by the sub emitter
  17411. */
  17412. particleSystem: ParticleSystem);
  17413. /**
  17414. * Clones the sub emitter
  17415. * @returns the cloned sub emitter
  17416. */
  17417. clone(): SubEmitter;
  17418. /**
  17419. * Serialize current object to a JSON object
  17420. * @returns the serialized object
  17421. */
  17422. serialize(): any;
  17423. /** @hidden */
  17424. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  17425. /**
  17426. * Creates a new SubEmitter from a serialized JSON version
  17427. * @param serializationObject defines the JSON object to read from
  17428. * @param scene defines the hosting scene
  17429. * @param rootUrl defines the rootUrl for data loading
  17430. * @returns a new SubEmitter
  17431. */
  17432. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  17433. /** Release associated resources */
  17434. dispose(): void;
  17435. }
  17436. }
  17437. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  17438. /** @hidden */
  17439. export var clipPlaneFragmentDeclaration: {
  17440. name: string;
  17441. shader: string;
  17442. };
  17443. }
  17444. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  17445. /** @hidden */
  17446. export var imageProcessingDeclaration: {
  17447. name: string;
  17448. shader: string;
  17449. };
  17450. }
  17451. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  17452. /** @hidden */
  17453. export var imageProcessingFunctions: {
  17454. name: string;
  17455. shader: string;
  17456. };
  17457. }
  17458. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  17459. /** @hidden */
  17460. export var clipPlaneFragment: {
  17461. name: string;
  17462. shader: string;
  17463. };
  17464. }
  17465. declare module "babylonjs/Shaders/particles.fragment" {
  17466. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17467. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  17468. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  17469. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  17470. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17471. /** @hidden */
  17472. export var particlesPixelShader: {
  17473. name: string;
  17474. shader: string;
  17475. };
  17476. }
  17477. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  17478. /** @hidden */
  17479. export var clipPlaneVertexDeclaration: {
  17480. name: string;
  17481. shader: string;
  17482. };
  17483. }
  17484. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  17485. /** @hidden */
  17486. export var clipPlaneVertex: {
  17487. name: string;
  17488. shader: string;
  17489. };
  17490. }
  17491. declare module "babylonjs/Shaders/particles.vertex" {
  17492. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17493. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17494. /** @hidden */
  17495. export var particlesVertexShader: {
  17496. name: string;
  17497. shader: string;
  17498. };
  17499. }
  17500. declare module "babylonjs/Particles/particleSystem" {
  17501. import { Nullable } from "babylonjs/types";
  17502. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  17503. import { Observable } from "babylonjs/Misc/observable";
  17504. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17505. import { Effect } from "babylonjs/Materials/effect";
  17506. import { Scene, IDisposable } from "babylonjs/scene";
  17507. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17508. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  17509. import { Particle } from "babylonjs/Particles/particle";
  17510. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17511. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  17512. import "babylonjs/Shaders/particles.fragment";
  17513. import "babylonjs/Shaders/particles.vertex";
  17514. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  17515. /**
  17516. * This represents a particle system in Babylon.
  17517. * 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.
  17518. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  17519. * @example https://doc.babylonjs.com/babylon101/particles
  17520. */
  17521. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  17522. /**
  17523. * Billboard mode will only apply to Y axis
  17524. */
  17525. static readonly BILLBOARDMODE_Y: number;
  17526. /**
  17527. * Billboard mode will apply to all axes
  17528. */
  17529. static readonly BILLBOARDMODE_ALL: number;
  17530. /**
  17531. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  17532. */
  17533. static readonly BILLBOARDMODE_STRETCHED: number;
  17534. /**
  17535. * This function can be defined to provide custom update for active particles.
  17536. * This function will be called instead of regular update (age, position, color, etc.).
  17537. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  17538. */
  17539. updateFunction: (particles: Particle[]) => void;
  17540. private _emitterWorldMatrix;
  17541. /**
  17542. * This function can be defined to specify initial direction for every new particle.
  17543. * It by default use the emitterType defined function
  17544. */
  17545. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  17546. /**
  17547. * This function can be defined to specify initial position for every new particle.
  17548. * It by default use the emitterType defined function
  17549. */
  17550. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  17551. /**
  17552. * @hidden
  17553. */
  17554. _inheritedVelocityOffset: Vector3;
  17555. /**
  17556. * An event triggered when the system is disposed
  17557. */
  17558. onDisposeObservable: Observable<ParticleSystem>;
  17559. private _onDisposeObserver;
  17560. /**
  17561. * Sets a callback that will be triggered when the system is disposed
  17562. */
  17563. onDispose: () => void;
  17564. private _particles;
  17565. private _epsilon;
  17566. private _capacity;
  17567. private _stockParticles;
  17568. private _newPartsExcess;
  17569. private _vertexData;
  17570. private _vertexBuffer;
  17571. private _vertexBuffers;
  17572. private _spriteBuffer;
  17573. private _indexBuffer;
  17574. private _effect;
  17575. private _customEffect;
  17576. private _cachedDefines;
  17577. private _scaledColorStep;
  17578. private _colorDiff;
  17579. private _scaledDirection;
  17580. private _scaledGravity;
  17581. private _currentRenderId;
  17582. private _alive;
  17583. private _useInstancing;
  17584. private _started;
  17585. private _stopped;
  17586. private _actualFrame;
  17587. private _scaledUpdateSpeed;
  17588. private _vertexBufferSize;
  17589. /** @hidden */
  17590. _currentEmitRateGradient: Nullable<FactorGradient>;
  17591. /** @hidden */
  17592. _currentEmitRate1: number;
  17593. /** @hidden */
  17594. _currentEmitRate2: number;
  17595. /** @hidden */
  17596. _currentStartSizeGradient: Nullable<FactorGradient>;
  17597. /** @hidden */
  17598. _currentStartSize1: number;
  17599. /** @hidden */
  17600. _currentStartSize2: number;
  17601. private readonly _rawTextureWidth;
  17602. private _rampGradientsTexture;
  17603. private _useRampGradients;
  17604. /** Gets or sets a boolean indicating that ramp gradients must be used
  17605. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  17606. */
  17607. useRampGradients: boolean;
  17608. /**
  17609. * 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.
  17610. * 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: [])
  17611. */
  17612. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  17613. private _subEmitters;
  17614. /**
  17615. * @hidden
  17616. * If the particle systems emitter should be disposed when the particle system is disposed
  17617. */
  17618. _disposeEmitterOnDispose: boolean;
  17619. /**
  17620. * The current active Sub-systems, this property is used by the root particle system only.
  17621. */
  17622. activeSubSystems: Array<ParticleSystem>;
  17623. private _rootParticleSystem;
  17624. /**
  17625. * Gets the current list of active particles
  17626. */
  17627. readonly particles: Particle[];
  17628. /**
  17629. * Returns the string "ParticleSystem"
  17630. * @returns a string containing the class name
  17631. */
  17632. getClassName(): string;
  17633. /**
  17634. * Instantiates a particle system.
  17635. * 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.
  17636. * @param name The name of the particle system
  17637. * @param capacity The max number of particles alive at the same time
  17638. * @param scene The scene the particle system belongs to
  17639. * @param customEffect a custom effect used to change the way particles are rendered by default
  17640. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  17641. * @param epsilon Offset used to render the particles
  17642. */
  17643. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  17644. private _addFactorGradient;
  17645. private _removeFactorGradient;
  17646. /**
  17647. * Adds a new life time gradient
  17648. * @param gradient defines the gradient to use (between 0 and 1)
  17649. * @param factor defines the life time factor to affect to the specified gradient
  17650. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17651. * @returns the current particle system
  17652. */
  17653. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17654. /**
  17655. * Remove a specific life time gradient
  17656. * @param gradient defines the gradient to remove
  17657. * @returns the current particle system
  17658. */
  17659. removeLifeTimeGradient(gradient: number): IParticleSystem;
  17660. /**
  17661. * Adds a new size gradient
  17662. * @param gradient defines the gradient to use (between 0 and 1)
  17663. * @param factor defines the size factor to affect to the specified gradient
  17664. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17665. * @returns the current particle system
  17666. */
  17667. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17668. /**
  17669. * Remove a specific size gradient
  17670. * @param gradient defines the gradient to remove
  17671. * @returns the current particle system
  17672. */
  17673. removeSizeGradient(gradient: number): IParticleSystem;
  17674. /**
  17675. * Adds a new color remap gradient
  17676. * @param gradient defines the gradient to use (between 0 and 1)
  17677. * @param min defines the color remap minimal range
  17678. * @param max defines the color remap maximal range
  17679. * @returns the current particle system
  17680. */
  17681. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17682. /**
  17683. * Remove a specific color remap gradient
  17684. * @param gradient defines the gradient to remove
  17685. * @returns the current particle system
  17686. */
  17687. removeColorRemapGradient(gradient: number): IParticleSystem;
  17688. /**
  17689. * Adds a new alpha remap gradient
  17690. * @param gradient defines the gradient to use (between 0 and 1)
  17691. * @param min defines the alpha remap minimal range
  17692. * @param max defines the alpha remap maximal range
  17693. * @returns the current particle system
  17694. */
  17695. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17696. /**
  17697. * Remove a specific alpha remap gradient
  17698. * @param gradient defines the gradient to remove
  17699. * @returns the current particle system
  17700. */
  17701. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  17702. /**
  17703. * Adds a new angular speed gradient
  17704. * @param gradient defines the gradient to use (between 0 and 1)
  17705. * @param factor defines the angular speed to affect to the specified gradient
  17706. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17707. * @returns the current particle system
  17708. */
  17709. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17710. /**
  17711. * Remove a specific angular speed gradient
  17712. * @param gradient defines the gradient to remove
  17713. * @returns the current particle system
  17714. */
  17715. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  17716. /**
  17717. * Adds a new velocity gradient
  17718. * @param gradient defines the gradient to use (between 0 and 1)
  17719. * @param factor defines the velocity to affect to the specified gradient
  17720. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17721. * @returns the current particle system
  17722. */
  17723. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17724. /**
  17725. * Remove a specific velocity gradient
  17726. * @param gradient defines the gradient to remove
  17727. * @returns the current particle system
  17728. */
  17729. removeVelocityGradient(gradient: number): IParticleSystem;
  17730. /**
  17731. * Adds a new limit velocity gradient
  17732. * @param gradient defines the gradient to use (between 0 and 1)
  17733. * @param factor defines the limit velocity value to affect to the specified gradient
  17734. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17735. * @returns the current particle system
  17736. */
  17737. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17738. /**
  17739. * Remove a specific limit velocity gradient
  17740. * @param gradient defines the gradient to remove
  17741. * @returns the current particle system
  17742. */
  17743. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  17744. /**
  17745. * Adds a new drag gradient
  17746. * @param gradient defines the gradient to use (between 0 and 1)
  17747. * @param factor defines the drag value to affect to the specified gradient
  17748. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17749. * @returns the current particle system
  17750. */
  17751. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17752. /**
  17753. * Remove a specific drag gradient
  17754. * @param gradient defines the gradient to remove
  17755. * @returns the current particle system
  17756. */
  17757. removeDragGradient(gradient: number): IParticleSystem;
  17758. /**
  17759. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  17760. * @param gradient defines the gradient to use (between 0 and 1)
  17761. * @param factor defines the emit rate value to affect to the specified gradient
  17762. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17763. * @returns the current particle system
  17764. */
  17765. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17766. /**
  17767. * Remove a specific emit rate gradient
  17768. * @param gradient defines the gradient to remove
  17769. * @returns the current particle system
  17770. */
  17771. removeEmitRateGradient(gradient: number): IParticleSystem;
  17772. /**
  17773. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  17774. * @param gradient defines the gradient to use (between 0 and 1)
  17775. * @param factor defines the start size value to affect to the specified gradient
  17776. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17777. * @returns the current particle system
  17778. */
  17779. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17780. /**
  17781. * Remove a specific start size gradient
  17782. * @param gradient defines the gradient to remove
  17783. * @returns the current particle system
  17784. */
  17785. removeStartSizeGradient(gradient: number): IParticleSystem;
  17786. private _createRampGradientTexture;
  17787. /**
  17788. * Gets the current list of ramp gradients.
  17789. * You must use addRampGradient and removeRampGradient to udpate this list
  17790. * @returns the list of ramp gradients
  17791. */
  17792. getRampGradients(): Nullable<Array<Color3Gradient>>;
  17793. /**
  17794. * Adds a new ramp gradient used to remap particle colors
  17795. * @param gradient defines the gradient to use (between 0 and 1)
  17796. * @param color defines the color to affect to the specified gradient
  17797. * @returns the current particle system
  17798. */
  17799. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  17800. /**
  17801. * Remove a specific ramp gradient
  17802. * @param gradient defines the gradient to remove
  17803. * @returns the current particle system
  17804. */
  17805. removeRampGradient(gradient: number): ParticleSystem;
  17806. /**
  17807. * Adds a new color gradient
  17808. * @param gradient defines the gradient to use (between 0 and 1)
  17809. * @param color1 defines the color to affect to the specified gradient
  17810. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  17811. * @returns this particle system
  17812. */
  17813. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  17814. /**
  17815. * Remove a specific color gradient
  17816. * @param gradient defines the gradient to remove
  17817. * @returns this particle system
  17818. */
  17819. removeColorGradient(gradient: number): IParticleSystem;
  17820. private _fetchR;
  17821. protected _reset(): void;
  17822. private _resetEffect;
  17823. private _createVertexBuffers;
  17824. private _createIndexBuffer;
  17825. /**
  17826. * Gets the maximum number of particles active at the same time.
  17827. * @returns The max number of active particles.
  17828. */
  17829. getCapacity(): number;
  17830. /**
  17831. * Gets whether there are still active particles in the system.
  17832. * @returns True if it is alive, otherwise false.
  17833. */
  17834. isAlive(): boolean;
  17835. /**
  17836. * Gets if the system has been started. (Note: this will still be true after stop is called)
  17837. * @returns True if it has been started, otherwise false.
  17838. */
  17839. isStarted(): boolean;
  17840. private _prepareSubEmitterInternalArray;
  17841. /**
  17842. * Starts the particle system and begins to emit
  17843. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  17844. */
  17845. start(delay?: number): void;
  17846. /**
  17847. * Stops the particle system.
  17848. * @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.
  17849. */
  17850. stop(stopSubEmitters?: boolean): void;
  17851. /**
  17852. * Remove all active particles
  17853. */
  17854. reset(): void;
  17855. /**
  17856. * @hidden (for internal use only)
  17857. */
  17858. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  17859. /**
  17860. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  17861. * Its lifetime will start back at 0.
  17862. */
  17863. recycleParticle: (particle: Particle) => void;
  17864. private _stopSubEmitters;
  17865. private _createParticle;
  17866. private _removeFromRoot;
  17867. private _emitFromParticle;
  17868. private _update;
  17869. /** @hidden */
  17870. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  17871. /** @hidden */
  17872. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  17873. /** @hidden */
  17874. private _getEffect;
  17875. /**
  17876. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  17877. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  17878. */
  17879. animate(preWarmOnly?: boolean): void;
  17880. private _appendParticleVertices;
  17881. /**
  17882. * Rebuilds the particle system.
  17883. */
  17884. rebuild(): void;
  17885. /**
  17886. * Is this system ready to be used/rendered
  17887. * @return true if the system is ready
  17888. */
  17889. isReady(): boolean;
  17890. private _render;
  17891. /**
  17892. * Renders the particle system in its current state.
  17893. * @returns the current number of particles
  17894. */
  17895. render(): number;
  17896. /**
  17897. * Disposes the particle system and free the associated resources
  17898. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  17899. */
  17900. dispose(disposeTexture?: boolean): void;
  17901. /**
  17902. * Clones the particle system.
  17903. * @param name The name of the cloned object
  17904. * @param newEmitter The new emitter to use
  17905. * @returns the cloned particle system
  17906. */
  17907. clone(name: string, newEmitter: any): ParticleSystem;
  17908. /**
  17909. * Serializes the particle system to a JSON object.
  17910. * @returns the JSON object
  17911. */
  17912. serialize(): any;
  17913. /** @hidden */
  17914. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  17915. /** @hidden */
  17916. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  17917. /**
  17918. * Parses a JSON object to create a particle system.
  17919. * @param parsedParticleSystem The JSON object to parse
  17920. * @param scene The scene to create the particle system in
  17921. * @param rootUrl The root url to use to load external dependencies like texture
  17922. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  17923. * @returns the Parsed particle system
  17924. */
  17925. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  17926. }
  17927. }
  17928. declare module "babylonjs/Particles/particle" {
  17929. import { Nullable } from "babylonjs/types";
  17930. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  17931. import { Color4 } from "babylonjs/Maths/math.color";
  17932. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17933. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17934. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  17935. /**
  17936. * A particle represents one of the element emitted by a particle system.
  17937. * This is mainly define by its coordinates, direction, velocity and age.
  17938. */
  17939. export class Particle {
  17940. /**
  17941. * The particle system the particle belongs to.
  17942. */
  17943. particleSystem: ParticleSystem;
  17944. private static _Count;
  17945. /**
  17946. * Unique ID of the particle
  17947. */
  17948. id: number;
  17949. /**
  17950. * The world position of the particle in the scene.
  17951. */
  17952. position: Vector3;
  17953. /**
  17954. * The world direction of the particle in the scene.
  17955. */
  17956. direction: Vector3;
  17957. /**
  17958. * The color of the particle.
  17959. */
  17960. color: Color4;
  17961. /**
  17962. * The color change of the particle per step.
  17963. */
  17964. colorStep: Color4;
  17965. /**
  17966. * Defines how long will the life of the particle be.
  17967. */
  17968. lifeTime: number;
  17969. /**
  17970. * The current age of the particle.
  17971. */
  17972. age: number;
  17973. /**
  17974. * The current size of the particle.
  17975. */
  17976. size: number;
  17977. /**
  17978. * The current scale of the particle.
  17979. */
  17980. scale: Vector2;
  17981. /**
  17982. * The current angle of the particle.
  17983. */
  17984. angle: number;
  17985. /**
  17986. * Defines how fast is the angle changing.
  17987. */
  17988. angularSpeed: number;
  17989. /**
  17990. * Defines the cell index used by the particle to be rendered from a sprite.
  17991. */
  17992. cellIndex: number;
  17993. /**
  17994. * The information required to support color remapping
  17995. */
  17996. remapData: Vector4;
  17997. /** @hidden */
  17998. _randomCellOffset?: number;
  17999. /** @hidden */
  18000. _initialDirection: Nullable<Vector3>;
  18001. /** @hidden */
  18002. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  18003. /** @hidden */
  18004. _initialStartSpriteCellID: number;
  18005. /** @hidden */
  18006. _initialEndSpriteCellID: number;
  18007. /** @hidden */
  18008. _currentColorGradient: Nullable<ColorGradient>;
  18009. /** @hidden */
  18010. _currentColor1: Color4;
  18011. /** @hidden */
  18012. _currentColor2: Color4;
  18013. /** @hidden */
  18014. _currentSizeGradient: Nullable<FactorGradient>;
  18015. /** @hidden */
  18016. _currentSize1: number;
  18017. /** @hidden */
  18018. _currentSize2: number;
  18019. /** @hidden */
  18020. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  18021. /** @hidden */
  18022. _currentAngularSpeed1: number;
  18023. /** @hidden */
  18024. _currentAngularSpeed2: number;
  18025. /** @hidden */
  18026. _currentVelocityGradient: Nullable<FactorGradient>;
  18027. /** @hidden */
  18028. _currentVelocity1: number;
  18029. /** @hidden */
  18030. _currentVelocity2: number;
  18031. /** @hidden */
  18032. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  18033. /** @hidden */
  18034. _currentLimitVelocity1: number;
  18035. /** @hidden */
  18036. _currentLimitVelocity2: number;
  18037. /** @hidden */
  18038. _currentDragGradient: Nullable<FactorGradient>;
  18039. /** @hidden */
  18040. _currentDrag1: number;
  18041. /** @hidden */
  18042. _currentDrag2: number;
  18043. /** @hidden */
  18044. _randomNoiseCoordinates1: Vector3;
  18045. /** @hidden */
  18046. _randomNoiseCoordinates2: Vector3;
  18047. /**
  18048. * Creates a new instance Particle
  18049. * @param particleSystem the particle system the particle belongs to
  18050. */
  18051. constructor(
  18052. /**
  18053. * The particle system the particle belongs to.
  18054. */
  18055. particleSystem: ParticleSystem);
  18056. private updateCellInfoFromSystem;
  18057. /**
  18058. * Defines how the sprite cell index is updated for the particle
  18059. */
  18060. updateCellIndex(): void;
  18061. /** @hidden */
  18062. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  18063. /** @hidden */
  18064. _inheritParticleInfoToSubEmitters(): void;
  18065. /** @hidden */
  18066. _reset(): void;
  18067. /**
  18068. * Copy the properties of particle to another one.
  18069. * @param other the particle to copy the information to.
  18070. */
  18071. copyTo(other: Particle): void;
  18072. }
  18073. }
  18074. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  18075. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18076. import { Effect } from "babylonjs/Materials/effect";
  18077. import { Particle } from "babylonjs/Particles/particle";
  18078. /**
  18079. * Particle emitter represents a volume emitting particles.
  18080. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  18081. */
  18082. export interface IParticleEmitterType {
  18083. /**
  18084. * Called by the particle System when the direction is computed for the created particle.
  18085. * @param worldMatrix is the world matrix of the particle system
  18086. * @param directionToUpdate is the direction vector to update with the result
  18087. * @param particle is the particle we are computed the direction for
  18088. */
  18089. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18090. /**
  18091. * Called by the particle System when the position is computed for the created particle.
  18092. * @param worldMatrix is the world matrix of the particle system
  18093. * @param positionToUpdate is the position vector to update with the result
  18094. * @param particle is the particle we are computed the position for
  18095. */
  18096. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18097. /**
  18098. * Clones the current emitter and returns a copy of it
  18099. * @returns the new emitter
  18100. */
  18101. clone(): IParticleEmitterType;
  18102. /**
  18103. * Called by the GPUParticleSystem to setup the update shader
  18104. * @param effect defines the update shader
  18105. */
  18106. applyToShader(effect: Effect): void;
  18107. /**
  18108. * Returns a string to use to update the GPU particles update shader
  18109. * @returns the effect defines string
  18110. */
  18111. getEffectDefines(): string;
  18112. /**
  18113. * Returns a string representing the class name
  18114. * @returns a string containing the class name
  18115. */
  18116. getClassName(): string;
  18117. /**
  18118. * Serializes the particle system to a JSON object.
  18119. * @returns the JSON object
  18120. */
  18121. serialize(): any;
  18122. /**
  18123. * Parse properties from a JSON object
  18124. * @param serializationObject defines the JSON object
  18125. */
  18126. parse(serializationObject: any): void;
  18127. }
  18128. }
  18129. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  18130. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18131. import { Effect } from "babylonjs/Materials/effect";
  18132. import { Particle } from "babylonjs/Particles/particle";
  18133. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18134. /**
  18135. * Particle emitter emitting particles from the inside of a box.
  18136. * It emits the particles randomly between 2 given directions.
  18137. */
  18138. export class BoxParticleEmitter implements IParticleEmitterType {
  18139. /**
  18140. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18141. */
  18142. direction1: Vector3;
  18143. /**
  18144. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18145. */
  18146. direction2: Vector3;
  18147. /**
  18148. * 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.
  18149. */
  18150. minEmitBox: Vector3;
  18151. /**
  18152. * 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.
  18153. */
  18154. maxEmitBox: Vector3;
  18155. /**
  18156. * Creates a new instance BoxParticleEmitter
  18157. */
  18158. constructor();
  18159. /**
  18160. * Called by the particle System when the direction is computed for the created particle.
  18161. * @param worldMatrix is the world matrix of the particle system
  18162. * @param directionToUpdate is the direction vector to update with the result
  18163. * @param particle is the particle we are computed the direction for
  18164. */
  18165. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18166. /**
  18167. * Called by the particle System when the position is computed for the created particle.
  18168. * @param worldMatrix is the world matrix of the particle system
  18169. * @param positionToUpdate is the position vector to update with the result
  18170. * @param particle is the particle we are computed the position for
  18171. */
  18172. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18173. /**
  18174. * Clones the current emitter and returns a copy of it
  18175. * @returns the new emitter
  18176. */
  18177. clone(): BoxParticleEmitter;
  18178. /**
  18179. * Called by the GPUParticleSystem to setup the update shader
  18180. * @param effect defines the update shader
  18181. */
  18182. applyToShader(effect: Effect): void;
  18183. /**
  18184. * Returns a string to use to update the GPU particles update shader
  18185. * @returns a string containng the defines string
  18186. */
  18187. getEffectDefines(): string;
  18188. /**
  18189. * Returns the string "BoxParticleEmitter"
  18190. * @returns a string containing the class name
  18191. */
  18192. getClassName(): string;
  18193. /**
  18194. * Serializes the particle system to a JSON object.
  18195. * @returns the JSON object
  18196. */
  18197. serialize(): any;
  18198. /**
  18199. * Parse properties from a JSON object
  18200. * @param serializationObject defines the JSON object
  18201. */
  18202. parse(serializationObject: any): void;
  18203. }
  18204. }
  18205. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  18206. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18207. import { Effect } from "babylonjs/Materials/effect";
  18208. import { Particle } from "babylonjs/Particles/particle";
  18209. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18210. /**
  18211. * Particle emitter emitting particles from the inside of a cone.
  18212. * It emits the particles alongside the cone volume from the base to the particle.
  18213. * The emission direction might be randomized.
  18214. */
  18215. export class ConeParticleEmitter implements IParticleEmitterType {
  18216. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  18217. directionRandomizer: number;
  18218. private _radius;
  18219. private _angle;
  18220. private _height;
  18221. /**
  18222. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  18223. */
  18224. radiusRange: number;
  18225. /**
  18226. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  18227. */
  18228. heightRange: number;
  18229. /**
  18230. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  18231. */
  18232. emitFromSpawnPointOnly: boolean;
  18233. /**
  18234. * Gets or sets the radius of the emission cone
  18235. */
  18236. radius: number;
  18237. /**
  18238. * Gets or sets the angle of the emission cone
  18239. */
  18240. angle: number;
  18241. private _buildHeight;
  18242. /**
  18243. * Creates a new instance ConeParticleEmitter
  18244. * @param radius the radius of the emission cone (1 by default)
  18245. * @param angle the cone base angle (PI by default)
  18246. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  18247. */
  18248. constructor(radius?: number, angle?: number,
  18249. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  18250. directionRandomizer?: number);
  18251. /**
  18252. * Called by the particle System when the direction is computed for the created particle.
  18253. * @param worldMatrix is the world matrix of the particle system
  18254. * @param directionToUpdate is the direction vector to update with the result
  18255. * @param particle is the particle we are computed the direction for
  18256. */
  18257. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18258. /**
  18259. * Called by the particle System when the position is computed for the created particle.
  18260. * @param worldMatrix is the world matrix of the particle system
  18261. * @param positionToUpdate is the position vector to update with the result
  18262. * @param particle is the particle we are computed the position for
  18263. */
  18264. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18265. /**
  18266. * Clones the current emitter and returns a copy of it
  18267. * @returns the new emitter
  18268. */
  18269. clone(): ConeParticleEmitter;
  18270. /**
  18271. * Called by the GPUParticleSystem to setup the update shader
  18272. * @param effect defines the update shader
  18273. */
  18274. applyToShader(effect: Effect): void;
  18275. /**
  18276. * Returns a string to use to update the GPU particles update shader
  18277. * @returns a string containng the defines string
  18278. */
  18279. getEffectDefines(): string;
  18280. /**
  18281. * Returns the string "ConeParticleEmitter"
  18282. * @returns a string containing the class name
  18283. */
  18284. getClassName(): string;
  18285. /**
  18286. * Serializes the particle system to a JSON object.
  18287. * @returns the JSON object
  18288. */
  18289. serialize(): any;
  18290. /**
  18291. * Parse properties from a JSON object
  18292. * @param serializationObject defines the JSON object
  18293. */
  18294. parse(serializationObject: any): void;
  18295. }
  18296. }
  18297. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  18298. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18299. import { Effect } from "babylonjs/Materials/effect";
  18300. import { Particle } from "babylonjs/Particles/particle";
  18301. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18302. /**
  18303. * Particle emitter emitting particles from the inside of a cylinder.
  18304. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  18305. */
  18306. export class CylinderParticleEmitter implements IParticleEmitterType {
  18307. /**
  18308. * The radius of the emission cylinder.
  18309. */
  18310. radius: number;
  18311. /**
  18312. * The height of the emission cylinder.
  18313. */
  18314. height: number;
  18315. /**
  18316. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18317. */
  18318. radiusRange: number;
  18319. /**
  18320. * How much to randomize the particle direction [0-1].
  18321. */
  18322. directionRandomizer: number;
  18323. /**
  18324. * Creates a new instance CylinderParticleEmitter
  18325. * @param radius the radius of the emission cylinder (1 by default)
  18326. * @param height the height of the emission cylinder (1 by default)
  18327. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18328. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18329. */
  18330. constructor(
  18331. /**
  18332. * The radius of the emission cylinder.
  18333. */
  18334. radius?: number,
  18335. /**
  18336. * The height of the emission cylinder.
  18337. */
  18338. height?: number,
  18339. /**
  18340. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18341. */
  18342. radiusRange?: number,
  18343. /**
  18344. * How much to randomize the particle direction [0-1].
  18345. */
  18346. directionRandomizer?: number);
  18347. /**
  18348. * Called by the particle System when the direction is computed for the created particle.
  18349. * @param worldMatrix is the world matrix of the particle system
  18350. * @param directionToUpdate is the direction vector to update with the result
  18351. * @param particle is the particle we are computed the direction for
  18352. */
  18353. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18354. /**
  18355. * Called by the particle System when the position is computed for the created particle.
  18356. * @param worldMatrix is the world matrix of the particle system
  18357. * @param positionToUpdate is the position vector to update with the result
  18358. * @param particle is the particle we are computed the position for
  18359. */
  18360. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18361. /**
  18362. * Clones the current emitter and returns a copy of it
  18363. * @returns the new emitter
  18364. */
  18365. clone(): CylinderParticleEmitter;
  18366. /**
  18367. * Called by the GPUParticleSystem to setup the update shader
  18368. * @param effect defines the update shader
  18369. */
  18370. applyToShader(effect: Effect): void;
  18371. /**
  18372. * Returns a string to use to update the GPU particles update shader
  18373. * @returns a string containng the defines string
  18374. */
  18375. getEffectDefines(): string;
  18376. /**
  18377. * Returns the string "CylinderParticleEmitter"
  18378. * @returns a string containing the class name
  18379. */
  18380. getClassName(): string;
  18381. /**
  18382. * Serializes the particle system to a JSON object.
  18383. * @returns the JSON object
  18384. */
  18385. serialize(): any;
  18386. /**
  18387. * Parse properties from a JSON object
  18388. * @param serializationObject defines the JSON object
  18389. */
  18390. parse(serializationObject: any): void;
  18391. }
  18392. /**
  18393. * Particle emitter emitting particles from the inside of a cylinder.
  18394. * It emits the particles randomly between two vectors.
  18395. */
  18396. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  18397. /**
  18398. * The min limit of the emission direction.
  18399. */
  18400. direction1: Vector3;
  18401. /**
  18402. * The max limit of the emission direction.
  18403. */
  18404. direction2: Vector3;
  18405. /**
  18406. * Creates a new instance CylinderDirectedParticleEmitter
  18407. * @param radius the radius of the emission cylinder (1 by default)
  18408. * @param height the height of the emission cylinder (1 by default)
  18409. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18410. * @param direction1 the min limit of the emission direction (up vector by default)
  18411. * @param direction2 the max limit of the emission direction (up vector by default)
  18412. */
  18413. constructor(radius?: number, height?: number, radiusRange?: number,
  18414. /**
  18415. * The min limit of the emission direction.
  18416. */
  18417. direction1?: Vector3,
  18418. /**
  18419. * The max limit of the emission direction.
  18420. */
  18421. direction2?: Vector3);
  18422. /**
  18423. * Called by the particle System when the direction is computed for the created particle.
  18424. * @param worldMatrix is the world matrix of the particle system
  18425. * @param directionToUpdate is the direction vector to update with the result
  18426. * @param particle is the particle we are computed the direction for
  18427. */
  18428. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18429. /**
  18430. * Clones the current emitter and returns a copy of it
  18431. * @returns the new emitter
  18432. */
  18433. clone(): CylinderDirectedParticleEmitter;
  18434. /**
  18435. * Called by the GPUParticleSystem to setup the update shader
  18436. * @param effect defines the update shader
  18437. */
  18438. applyToShader(effect: Effect): void;
  18439. /**
  18440. * Returns a string to use to update the GPU particles update shader
  18441. * @returns a string containng the defines string
  18442. */
  18443. getEffectDefines(): string;
  18444. /**
  18445. * Returns the string "CylinderDirectedParticleEmitter"
  18446. * @returns a string containing the class name
  18447. */
  18448. getClassName(): string;
  18449. /**
  18450. * Serializes the particle system to a JSON object.
  18451. * @returns the JSON object
  18452. */
  18453. serialize(): any;
  18454. /**
  18455. * Parse properties from a JSON object
  18456. * @param serializationObject defines the JSON object
  18457. */
  18458. parse(serializationObject: any): void;
  18459. }
  18460. }
  18461. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  18462. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18463. import { Effect } from "babylonjs/Materials/effect";
  18464. import { Particle } from "babylonjs/Particles/particle";
  18465. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18466. /**
  18467. * Particle emitter emitting particles from the inside of a hemisphere.
  18468. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  18469. */
  18470. export class HemisphericParticleEmitter implements IParticleEmitterType {
  18471. /**
  18472. * The radius of the emission hemisphere.
  18473. */
  18474. radius: number;
  18475. /**
  18476. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18477. */
  18478. radiusRange: number;
  18479. /**
  18480. * How much to randomize the particle direction [0-1].
  18481. */
  18482. directionRandomizer: number;
  18483. /**
  18484. * Creates a new instance HemisphericParticleEmitter
  18485. * @param radius the radius of the emission hemisphere (1 by default)
  18486. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18487. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18488. */
  18489. constructor(
  18490. /**
  18491. * The radius of the emission hemisphere.
  18492. */
  18493. radius?: number,
  18494. /**
  18495. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18496. */
  18497. radiusRange?: number,
  18498. /**
  18499. * How much to randomize the particle direction [0-1].
  18500. */
  18501. directionRandomizer?: number);
  18502. /**
  18503. * Called by the particle System when the direction is computed for the created particle.
  18504. * @param worldMatrix is the world matrix of the particle system
  18505. * @param directionToUpdate is the direction vector to update with the result
  18506. * @param particle is the particle we are computed the direction for
  18507. */
  18508. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18509. /**
  18510. * Called by the particle System when the position is computed for the created particle.
  18511. * @param worldMatrix is the world matrix of the particle system
  18512. * @param positionToUpdate is the position vector to update with the result
  18513. * @param particle is the particle we are computed the position for
  18514. */
  18515. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18516. /**
  18517. * Clones the current emitter and returns a copy of it
  18518. * @returns the new emitter
  18519. */
  18520. clone(): HemisphericParticleEmitter;
  18521. /**
  18522. * Called by the GPUParticleSystem to setup the update shader
  18523. * @param effect defines the update shader
  18524. */
  18525. applyToShader(effect: Effect): void;
  18526. /**
  18527. * Returns a string to use to update the GPU particles update shader
  18528. * @returns a string containng the defines string
  18529. */
  18530. getEffectDefines(): string;
  18531. /**
  18532. * Returns the string "HemisphericParticleEmitter"
  18533. * @returns a string containing the class name
  18534. */
  18535. getClassName(): string;
  18536. /**
  18537. * Serializes the particle system to a JSON object.
  18538. * @returns the JSON object
  18539. */
  18540. serialize(): any;
  18541. /**
  18542. * Parse properties from a JSON object
  18543. * @param serializationObject defines the JSON object
  18544. */
  18545. parse(serializationObject: any): void;
  18546. }
  18547. }
  18548. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  18549. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18550. import { Effect } from "babylonjs/Materials/effect";
  18551. import { Particle } from "babylonjs/Particles/particle";
  18552. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18553. /**
  18554. * Particle emitter emitting particles from a point.
  18555. * It emits the particles randomly between 2 given directions.
  18556. */
  18557. export class PointParticleEmitter implements IParticleEmitterType {
  18558. /**
  18559. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18560. */
  18561. direction1: Vector3;
  18562. /**
  18563. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18564. */
  18565. direction2: Vector3;
  18566. /**
  18567. * Creates a new instance PointParticleEmitter
  18568. */
  18569. constructor();
  18570. /**
  18571. * Called by the particle System when the direction is computed for the created particle.
  18572. * @param worldMatrix is the world matrix of the particle system
  18573. * @param directionToUpdate is the direction vector to update with the result
  18574. * @param particle is the particle we are computed the direction for
  18575. */
  18576. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18577. /**
  18578. * Called by the particle System when the position is computed for the created particle.
  18579. * @param worldMatrix is the world matrix of the particle system
  18580. * @param positionToUpdate is the position vector to update with the result
  18581. * @param particle is the particle we are computed the position for
  18582. */
  18583. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18584. /**
  18585. * Clones the current emitter and returns a copy of it
  18586. * @returns the new emitter
  18587. */
  18588. clone(): PointParticleEmitter;
  18589. /**
  18590. * Called by the GPUParticleSystem to setup the update shader
  18591. * @param effect defines the update shader
  18592. */
  18593. applyToShader(effect: Effect): void;
  18594. /**
  18595. * Returns a string to use to update the GPU particles update shader
  18596. * @returns a string containng the defines string
  18597. */
  18598. getEffectDefines(): string;
  18599. /**
  18600. * Returns the string "PointParticleEmitter"
  18601. * @returns a string containing the class name
  18602. */
  18603. getClassName(): string;
  18604. /**
  18605. * Serializes the particle system to a JSON object.
  18606. * @returns the JSON object
  18607. */
  18608. serialize(): any;
  18609. /**
  18610. * Parse properties from a JSON object
  18611. * @param serializationObject defines the JSON object
  18612. */
  18613. parse(serializationObject: any): void;
  18614. }
  18615. }
  18616. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  18617. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18618. import { Effect } from "babylonjs/Materials/effect";
  18619. import { Particle } from "babylonjs/Particles/particle";
  18620. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18621. /**
  18622. * Particle emitter emitting particles from the inside of a sphere.
  18623. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  18624. */
  18625. export class SphereParticleEmitter implements IParticleEmitterType {
  18626. /**
  18627. * The radius of the emission sphere.
  18628. */
  18629. radius: number;
  18630. /**
  18631. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18632. */
  18633. radiusRange: number;
  18634. /**
  18635. * How much to randomize the particle direction [0-1].
  18636. */
  18637. directionRandomizer: number;
  18638. /**
  18639. * Creates a new instance SphereParticleEmitter
  18640. * @param radius the radius of the emission sphere (1 by default)
  18641. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18642. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18643. */
  18644. constructor(
  18645. /**
  18646. * The radius of the emission sphere.
  18647. */
  18648. radius?: number,
  18649. /**
  18650. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18651. */
  18652. radiusRange?: number,
  18653. /**
  18654. * How much to randomize the particle direction [0-1].
  18655. */
  18656. directionRandomizer?: number);
  18657. /**
  18658. * Called by the particle System when the direction is computed for the created particle.
  18659. * @param worldMatrix is the world matrix of the particle system
  18660. * @param directionToUpdate is the direction vector to update with the result
  18661. * @param particle is the particle we are computed the direction for
  18662. */
  18663. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18664. /**
  18665. * Called by the particle System when the position is computed for the created particle.
  18666. * @param worldMatrix is the world matrix of the particle system
  18667. * @param positionToUpdate is the position vector to update with the result
  18668. * @param particle is the particle we are computed the position for
  18669. */
  18670. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18671. /**
  18672. * Clones the current emitter and returns a copy of it
  18673. * @returns the new emitter
  18674. */
  18675. clone(): SphereParticleEmitter;
  18676. /**
  18677. * Called by the GPUParticleSystem to setup the update shader
  18678. * @param effect defines the update shader
  18679. */
  18680. applyToShader(effect: Effect): void;
  18681. /**
  18682. * Returns a string to use to update the GPU particles update shader
  18683. * @returns a string containng the defines string
  18684. */
  18685. getEffectDefines(): string;
  18686. /**
  18687. * Returns the string "SphereParticleEmitter"
  18688. * @returns a string containing the class name
  18689. */
  18690. getClassName(): string;
  18691. /**
  18692. * Serializes the particle system to a JSON object.
  18693. * @returns the JSON object
  18694. */
  18695. serialize(): any;
  18696. /**
  18697. * Parse properties from a JSON object
  18698. * @param serializationObject defines the JSON object
  18699. */
  18700. parse(serializationObject: any): void;
  18701. }
  18702. /**
  18703. * Particle emitter emitting particles from the inside of a sphere.
  18704. * It emits the particles randomly between two vectors.
  18705. */
  18706. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  18707. /**
  18708. * The min limit of the emission direction.
  18709. */
  18710. direction1: Vector3;
  18711. /**
  18712. * The max limit of the emission direction.
  18713. */
  18714. direction2: Vector3;
  18715. /**
  18716. * Creates a new instance SphereDirectedParticleEmitter
  18717. * @param radius the radius of the emission sphere (1 by default)
  18718. * @param direction1 the min limit of the emission direction (up vector by default)
  18719. * @param direction2 the max limit of the emission direction (up vector by default)
  18720. */
  18721. constructor(radius?: number,
  18722. /**
  18723. * The min limit of the emission direction.
  18724. */
  18725. direction1?: Vector3,
  18726. /**
  18727. * The max limit of the emission direction.
  18728. */
  18729. direction2?: Vector3);
  18730. /**
  18731. * Called by the particle System when the direction is computed for the created particle.
  18732. * @param worldMatrix is the world matrix of the particle system
  18733. * @param directionToUpdate is the direction vector to update with the result
  18734. * @param particle is the particle we are computed the direction for
  18735. */
  18736. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18737. /**
  18738. * Clones the current emitter and returns a copy of it
  18739. * @returns the new emitter
  18740. */
  18741. clone(): SphereDirectedParticleEmitter;
  18742. /**
  18743. * Called by the GPUParticleSystem to setup the update shader
  18744. * @param effect defines the update shader
  18745. */
  18746. applyToShader(effect: Effect): void;
  18747. /**
  18748. * Returns a string to use to update the GPU particles update shader
  18749. * @returns a string containng the defines string
  18750. */
  18751. getEffectDefines(): string;
  18752. /**
  18753. * Returns the string "SphereDirectedParticleEmitter"
  18754. * @returns a string containing the class name
  18755. */
  18756. getClassName(): string;
  18757. /**
  18758. * Serializes the particle system to a JSON object.
  18759. * @returns the JSON object
  18760. */
  18761. serialize(): any;
  18762. /**
  18763. * Parse properties from a JSON object
  18764. * @param serializationObject defines the JSON object
  18765. */
  18766. parse(serializationObject: any): void;
  18767. }
  18768. }
  18769. declare module "babylonjs/Particles/EmitterTypes/index" {
  18770. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  18771. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  18772. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  18773. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  18774. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18775. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  18776. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  18777. }
  18778. declare module "babylonjs/Particles/IParticleSystem" {
  18779. import { Nullable } from "babylonjs/types";
  18780. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  18781. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  18782. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18783. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  18784. import { Texture } from "babylonjs/Materials/Textures/texture";
  18785. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  18786. import { Scene } from "babylonjs/scene";
  18787. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  18788. import { Animation } from "babylonjs/Animations/animation";
  18789. /**
  18790. * Interface representing a particle system in Babylon.js.
  18791. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  18792. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  18793. */
  18794. export interface IParticleSystem {
  18795. /**
  18796. * List of animations used by the particle system.
  18797. */
  18798. animations: Animation[];
  18799. /**
  18800. * The id of the Particle system.
  18801. */
  18802. id: string;
  18803. /**
  18804. * The name of the Particle system.
  18805. */
  18806. name: string;
  18807. /**
  18808. * The emitter represents the Mesh or position we are attaching the particle system to.
  18809. */
  18810. emitter: Nullable<AbstractMesh | Vector3>;
  18811. /**
  18812. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  18813. */
  18814. isBillboardBased: boolean;
  18815. /**
  18816. * The rendering group used by the Particle system to chose when to render.
  18817. */
  18818. renderingGroupId: number;
  18819. /**
  18820. * The layer mask we are rendering the particles through.
  18821. */
  18822. layerMask: number;
  18823. /**
  18824. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  18825. */
  18826. updateSpeed: number;
  18827. /**
  18828. * The amount of time the particle system is running (depends of the overall update speed).
  18829. */
  18830. targetStopDuration: number;
  18831. /**
  18832. * The texture used to render each particle. (this can be a spritesheet)
  18833. */
  18834. particleTexture: Nullable<Texture>;
  18835. /**
  18836. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  18837. */
  18838. blendMode: number;
  18839. /**
  18840. * Minimum life time of emitting particles.
  18841. */
  18842. minLifeTime: number;
  18843. /**
  18844. * Maximum life time of emitting particles.
  18845. */
  18846. maxLifeTime: number;
  18847. /**
  18848. * Minimum Size of emitting particles.
  18849. */
  18850. minSize: number;
  18851. /**
  18852. * Maximum Size of emitting particles.
  18853. */
  18854. maxSize: number;
  18855. /**
  18856. * Minimum scale of emitting particles on X axis.
  18857. */
  18858. minScaleX: number;
  18859. /**
  18860. * Maximum scale of emitting particles on X axis.
  18861. */
  18862. maxScaleX: number;
  18863. /**
  18864. * Minimum scale of emitting particles on Y axis.
  18865. */
  18866. minScaleY: number;
  18867. /**
  18868. * Maximum scale of emitting particles on Y axis.
  18869. */
  18870. maxScaleY: number;
  18871. /**
  18872. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  18873. */
  18874. color1: Color4;
  18875. /**
  18876. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  18877. */
  18878. color2: Color4;
  18879. /**
  18880. * Color the particle will have at the end of its lifetime.
  18881. */
  18882. colorDead: Color4;
  18883. /**
  18884. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  18885. */
  18886. emitRate: number;
  18887. /**
  18888. * You can use gravity if you want to give an orientation to your particles.
  18889. */
  18890. gravity: Vector3;
  18891. /**
  18892. * Minimum power of emitting particles.
  18893. */
  18894. minEmitPower: number;
  18895. /**
  18896. * Maximum power of emitting particles.
  18897. */
  18898. maxEmitPower: number;
  18899. /**
  18900. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  18901. */
  18902. minAngularSpeed: number;
  18903. /**
  18904. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  18905. */
  18906. maxAngularSpeed: number;
  18907. /**
  18908. * Gets or sets the minimal initial rotation in radians.
  18909. */
  18910. minInitialRotation: number;
  18911. /**
  18912. * Gets or sets the maximal initial rotation in radians.
  18913. */
  18914. maxInitialRotation: number;
  18915. /**
  18916. * The particle emitter type defines the emitter used by the particle system.
  18917. * It can be for example box, sphere, or cone...
  18918. */
  18919. particleEmitterType: Nullable<IParticleEmitterType>;
  18920. /**
  18921. * Defines the delay in milliseconds before starting the system (0 by default)
  18922. */
  18923. startDelay: number;
  18924. /**
  18925. * 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
  18926. */
  18927. preWarmCycles: number;
  18928. /**
  18929. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  18930. */
  18931. preWarmStepOffset: number;
  18932. /**
  18933. * 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)
  18934. */
  18935. spriteCellChangeSpeed: number;
  18936. /**
  18937. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  18938. */
  18939. startSpriteCellID: number;
  18940. /**
  18941. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  18942. */
  18943. endSpriteCellID: number;
  18944. /**
  18945. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  18946. */
  18947. spriteCellWidth: number;
  18948. /**
  18949. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  18950. */
  18951. spriteCellHeight: number;
  18952. /**
  18953. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  18954. */
  18955. spriteRandomStartCell: boolean;
  18956. /**
  18957. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  18958. */
  18959. isAnimationSheetEnabled: boolean;
  18960. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  18961. translationPivot: Vector2;
  18962. /**
  18963. * Gets or sets a texture used to add random noise to particle positions
  18964. */
  18965. noiseTexture: Nullable<BaseTexture>;
  18966. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  18967. noiseStrength: Vector3;
  18968. /**
  18969. * Gets or sets the billboard mode to use when isBillboardBased = true.
  18970. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  18971. */
  18972. billboardMode: number;
  18973. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  18974. limitVelocityDamping: number;
  18975. /**
  18976. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  18977. */
  18978. beginAnimationOnStart: boolean;
  18979. /**
  18980. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  18981. */
  18982. beginAnimationFrom: number;
  18983. /**
  18984. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  18985. */
  18986. beginAnimationTo: number;
  18987. /**
  18988. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  18989. */
  18990. beginAnimationLoop: boolean;
  18991. /**
  18992. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  18993. */
  18994. disposeOnStop: boolean;
  18995. /**
  18996. * Gets the maximum number of particles active at the same time.
  18997. * @returns The max number of active particles.
  18998. */
  18999. getCapacity(): number;
  19000. /**
  19001. * Gets if the system has been started. (Note: this will still be true after stop is called)
  19002. * @returns True if it has been started, otherwise false.
  19003. */
  19004. isStarted(): boolean;
  19005. /**
  19006. * Animates the particle system for this frame.
  19007. */
  19008. animate(): void;
  19009. /**
  19010. * Renders the particle system in its current state.
  19011. * @returns the current number of particles
  19012. */
  19013. render(): number;
  19014. /**
  19015. * Dispose the particle system and frees its associated resources.
  19016. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  19017. */
  19018. dispose(disposeTexture?: boolean): void;
  19019. /**
  19020. * Clones the particle system.
  19021. * @param name The name of the cloned object
  19022. * @param newEmitter The new emitter to use
  19023. * @returns the cloned particle system
  19024. */
  19025. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  19026. /**
  19027. * Serializes the particle system to a JSON object.
  19028. * @returns the JSON object
  19029. */
  19030. serialize(): any;
  19031. /**
  19032. * Rebuild the particle system
  19033. */
  19034. rebuild(): void;
  19035. /**
  19036. * Starts the particle system and begins to emit
  19037. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  19038. */
  19039. start(delay?: number): void;
  19040. /**
  19041. * Stops the particle system.
  19042. */
  19043. stop(): void;
  19044. /**
  19045. * Remove all active particles
  19046. */
  19047. reset(): void;
  19048. /**
  19049. * Is this system ready to be used/rendered
  19050. * @return true if the system is ready
  19051. */
  19052. isReady(): boolean;
  19053. /**
  19054. * Adds a new color gradient
  19055. * @param gradient defines the gradient to use (between 0 and 1)
  19056. * @param color1 defines the color to affect to the specified gradient
  19057. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  19058. * @returns the current particle system
  19059. */
  19060. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  19061. /**
  19062. * Remove a specific color gradient
  19063. * @param gradient defines the gradient to remove
  19064. * @returns the current particle system
  19065. */
  19066. removeColorGradient(gradient: number): IParticleSystem;
  19067. /**
  19068. * Adds a new size gradient
  19069. * @param gradient defines the gradient to use (between 0 and 1)
  19070. * @param factor defines the size factor to affect to the specified gradient
  19071. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19072. * @returns the current particle system
  19073. */
  19074. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19075. /**
  19076. * Remove a specific size gradient
  19077. * @param gradient defines the gradient to remove
  19078. * @returns the current particle system
  19079. */
  19080. removeSizeGradient(gradient: number): IParticleSystem;
  19081. /**
  19082. * Gets the current list of color gradients.
  19083. * You must use addColorGradient and removeColorGradient to udpate this list
  19084. * @returns the list of color gradients
  19085. */
  19086. getColorGradients(): Nullable<Array<ColorGradient>>;
  19087. /**
  19088. * Gets the current list of size gradients.
  19089. * You must use addSizeGradient and removeSizeGradient to udpate this list
  19090. * @returns the list of size gradients
  19091. */
  19092. getSizeGradients(): Nullable<Array<FactorGradient>>;
  19093. /**
  19094. * Gets the current list of angular speed gradients.
  19095. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  19096. * @returns the list of angular speed gradients
  19097. */
  19098. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  19099. /**
  19100. * Adds a new angular speed gradient
  19101. * @param gradient defines the gradient to use (between 0 and 1)
  19102. * @param factor defines the angular speed to affect to the specified gradient
  19103. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19104. * @returns the current particle system
  19105. */
  19106. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19107. /**
  19108. * Remove a specific angular speed gradient
  19109. * @param gradient defines the gradient to remove
  19110. * @returns the current particle system
  19111. */
  19112. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  19113. /**
  19114. * Gets the current list of velocity gradients.
  19115. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  19116. * @returns the list of velocity gradients
  19117. */
  19118. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  19119. /**
  19120. * Adds a new velocity gradient
  19121. * @param gradient defines the gradient to use (between 0 and 1)
  19122. * @param factor defines the velocity to affect to the specified gradient
  19123. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19124. * @returns the current particle system
  19125. */
  19126. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19127. /**
  19128. * Remove a specific velocity gradient
  19129. * @param gradient defines the gradient to remove
  19130. * @returns the current particle system
  19131. */
  19132. removeVelocityGradient(gradient: number): IParticleSystem;
  19133. /**
  19134. * Gets the current list of limit velocity gradients.
  19135. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  19136. * @returns the list of limit velocity gradients
  19137. */
  19138. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  19139. /**
  19140. * Adds a new limit velocity gradient
  19141. * @param gradient defines the gradient to use (between 0 and 1)
  19142. * @param factor defines the limit velocity to affect to the specified gradient
  19143. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19144. * @returns the current particle system
  19145. */
  19146. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19147. /**
  19148. * Remove a specific limit velocity gradient
  19149. * @param gradient defines the gradient to remove
  19150. * @returns the current particle system
  19151. */
  19152. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  19153. /**
  19154. * Adds a new drag gradient
  19155. * @param gradient defines the gradient to use (between 0 and 1)
  19156. * @param factor defines the drag to affect to the specified gradient
  19157. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19158. * @returns the current particle system
  19159. */
  19160. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19161. /**
  19162. * Remove a specific drag gradient
  19163. * @param gradient defines the gradient to remove
  19164. * @returns the current particle system
  19165. */
  19166. removeDragGradient(gradient: number): IParticleSystem;
  19167. /**
  19168. * Gets the current list of drag gradients.
  19169. * You must use addDragGradient and removeDragGradient to udpate this list
  19170. * @returns the list of drag gradients
  19171. */
  19172. getDragGradients(): Nullable<Array<FactorGradient>>;
  19173. /**
  19174. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  19175. * @param gradient defines the gradient to use (between 0 and 1)
  19176. * @param factor defines the emit rate to affect to the specified gradient
  19177. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19178. * @returns the current particle system
  19179. */
  19180. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19181. /**
  19182. * Remove a specific emit rate gradient
  19183. * @param gradient defines the gradient to remove
  19184. * @returns the current particle system
  19185. */
  19186. removeEmitRateGradient(gradient: number): IParticleSystem;
  19187. /**
  19188. * Gets the current list of emit rate gradients.
  19189. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  19190. * @returns the list of emit rate gradients
  19191. */
  19192. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  19193. /**
  19194. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  19195. * @param gradient defines the gradient to use (between 0 and 1)
  19196. * @param factor defines the start size to affect to the specified gradient
  19197. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19198. * @returns the current particle system
  19199. */
  19200. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19201. /**
  19202. * Remove a specific start size gradient
  19203. * @param gradient defines the gradient to remove
  19204. * @returns the current particle system
  19205. */
  19206. removeStartSizeGradient(gradient: number): IParticleSystem;
  19207. /**
  19208. * Gets the current list of start size gradients.
  19209. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  19210. * @returns the list of start size gradients
  19211. */
  19212. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  19213. /**
  19214. * Adds a new life time gradient
  19215. * @param gradient defines the gradient to use (between 0 and 1)
  19216. * @param factor defines the life time factor to affect to the specified gradient
  19217. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19218. * @returns the current particle system
  19219. */
  19220. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19221. /**
  19222. * Remove a specific life time gradient
  19223. * @param gradient defines the gradient to remove
  19224. * @returns the current particle system
  19225. */
  19226. removeLifeTimeGradient(gradient: number): IParticleSystem;
  19227. /**
  19228. * Gets the current list of life time gradients.
  19229. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  19230. * @returns the list of life time gradients
  19231. */
  19232. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  19233. /**
  19234. * Gets the current list of color gradients.
  19235. * You must use addColorGradient and removeColorGradient to udpate this list
  19236. * @returns the list of color gradients
  19237. */
  19238. getColorGradients(): Nullable<Array<ColorGradient>>;
  19239. /**
  19240. * Adds a new ramp gradient used to remap particle colors
  19241. * @param gradient defines the gradient to use (between 0 and 1)
  19242. * @param color defines the color to affect to the specified gradient
  19243. * @returns the current particle system
  19244. */
  19245. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  19246. /**
  19247. * Gets the current list of ramp gradients.
  19248. * You must use addRampGradient and removeRampGradient to udpate this list
  19249. * @returns the list of ramp gradients
  19250. */
  19251. getRampGradients(): Nullable<Array<Color3Gradient>>;
  19252. /** Gets or sets a boolean indicating that ramp gradients must be used
  19253. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  19254. */
  19255. useRampGradients: boolean;
  19256. /**
  19257. * Adds a new color remap gradient
  19258. * @param gradient defines the gradient to use (between 0 and 1)
  19259. * @param min defines the color remap minimal range
  19260. * @param max defines the color remap maximal range
  19261. * @returns the current particle system
  19262. */
  19263. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  19264. /**
  19265. * Gets the current list of color remap gradients.
  19266. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  19267. * @returns the list of color remap gradients
  19268. */
  19269. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  19270. /**
  19271. * Adds a new alpha remap gradient
  19272. * @param gradient defines the gradient to use (between 0 and 1)
  19273. * @param min defines the alpha remap minimal range
  19274. * @param max defines the alpha remap maximal range
  19275. * @returns the current particle system
  19276. */
  19277. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  19278. /**
  19279. * Gets the current list of alpha remap gradients.
  19280. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  19281. * @returns the list of alpha remap gradients
  19282. */
  19283. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  19284. /**
  19285. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  19286. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19287. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19288. * @returns the emitter
  19289. */
  19290. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  19291. /**
  19292. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  19293. * @param radius The radius of the hemisphere to emit from
  19294. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19295. * @returns the emitter
  19296. */
  19297. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  19298. /**
  19299. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  19300. * @param radius The radius of the sphere to emit from
  19301. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19302. * @returns the emitter
  19303. */
  19304. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  19305. /**
  19306. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  19307. * @param radius The radius of the sphere to emit from
  19308. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  19309. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  19310. * @returns the emitter
  19311. */
  19312. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19313. /**
  19314. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  19315. * @param radius The radius of the emission cylinder
  19316. * @param height The height of the emission cylinder
  19317. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  19318. * @param directionRandomizer How much to randomize the particle direction [0-1]
  19319. * @returns the emitter
  19320. */
  19321. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  19322. /**
  19323. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  19324. * @param radius The radius of the cylinder to emit from
  19325. * @param height The height of the emission cylinder
  19326. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  19327. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  19328. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  19329. * @returns the emitter
  19330. */
  19331. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19332. /**
  19333. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  19334. * @param radius The radius of the cone to emit from
  19335. * @param angle The base angle of the cone
  19336. * @returns the emitter
  19337. */
  19338. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  19339. /**
  19340. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  19341. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19342. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19343. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19344. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19345. * @returns the emitter
  19346. */
  19347. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  19348. /**
  19349. * Get hosting scene
  19350. * @returns the scene
  19351. */
  19352. getScene(): Scene;
  19353. }
  19354. }
  19355. declare module "babylonjs/Meshes/instancedMesh" {
  19356. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  19357. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  19358. import { Camera } from "babylonjs/Cameras/camera";
  19359. import { Node } from "babylonjs/node";
  19360. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19361. import { Mesh } from "babylonjs/Meshes/mesh";
  19362. import { Material } from "babylonjs/Materials/material";
  19363. import { Skeleton } from "babylonjs/Bones/skeleton";
  19364. import { Light } from "babylonjs/Lights/light";
  19365. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  19366. /**
  19367. * Creates an instance based on a source mesh.
  19368. */
  19369. export class InstancedMesh extends AbstractMesh {
  19370. private _sourceMesh;
  19371. private _currentLOD;
  19372. /** @hidden */
  19373. _indexInSourceMeshInstanceArray: number;
  19374. constructor(name: string, source: Mesh);
  19375. /**
  19376. * Returns the string "InstancedMesh".
  19377. */
  19378. getClassName(): string;
  19379. /** Gets the list of lights affecting that mesh */
  19380. readonly lightSources: Light[];
  19381. _resyncLightSources(): void;
  19382. _resyncLighSource(light: Light): void;
  19383. _removeLightSource(light: Light, dispose: boolean): void;
  19384. /**
  19385. * If the source mesh receives shadows
  19386. */
  19387. readonly receiveShadows: boolean;
  19388. /**
  19389. * The material of the source mesh
  19390. */
  19391. readonly material: Nullable<Material>;
  19392. /**
  19393. * Visibility of the source mesh
  19394. */
  19395. readonly visibility: number;
  19396. /**
  19397. * Skeleton of the source mesh
  19398. */
  19399. readonly skeleton: Nullable<Skeleton>;
  19400. /**
  19401. * Rendering ground id of the source mesh
  19402. */
  19403. renderingGroupId: number;
  19404. /**
  19405. * Returns the total number of vertices (integer).
  19406. */
  19407. getTotalVertices(): number;
  19408. /**
  19409. * Returns a positive integer : the total number of indices in this mesh geometry.
  19410. * @returns the numner of indices or zero if the mesh has no geometry.
  19411. */
  19412. getTotalIndices(): number;
  19413. /**
  19414. * The source mesh of the instance
  19415. */
  19416. readonly sourceMesh: Mesh;
  19417. /**
  19418. * Is this node ready to be used/rendered
  19419. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  19420. * @return {boolean} is it ready
  19421. */
  19422. isReady(completeCheck?: boolean): boolean;
  19423. /**
  19424. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  19425. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  19426. * @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.
  19427. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  19428. */
  19429. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  19430. /**
  19431. * Sets the vertex data of the mesh geometry for the requested `kind`.
  19432. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  19433. * The `data` are either a numeric array either a Float32Array.
  19434. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  19435. * 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).
  19436. * Note that a new underlying VertexBuffer object is created each call.
  19437. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  19438. *
  19439. * Possible `kind` values :
  19440. * - VertexBuffer.PositionKind
  19441. * - VertexBuffer.UVKind
  19442. * - VertexBuffer.UV2Kind
  19443. * - VertexBuffer.UV3Kind
  19444. * - VertexBuffer.UV4Kind
  19445. * - VertexBuffer.UV5Kind
  19446. * - VertexBuffer.UV6Kind
  19447. * - VertexBuffer.ColorKind
  19448. * - VertexBuffer.MatricesIndicesKind
  19449. * - VertexBuffer.MatricesIndicesExtraKind
  19450. * - VertexBuffer.MatricesWeightsKind
  19451. * - VertexBuffer.MatricesWeightsExtraKind
  19452. *
  19453. * Returns the Mesh.
  19454. */
  19455. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  19456. /**
  19457. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  19458. * If the mesh has no geometry, it is simply returned as it is.
  19459. * The `data` are either a numeric array either a Float32Array.
  19460. * No new underlying VertexBuffer object is created.
  19461. * 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.
  19462. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  19463. *
  19464. * Possible `kind` values :
  19465. * - VertexBuffer.PositionKind
  19466. * - VertexBuffer.UVKind
  19467. * - VertexBuffer.UV2Kind
  19468. * - VertexBuffer.UV3Kind
  19469. * - VertexBuffer.UV4Kind
  19470. * - VertexBuffer.UV5Kind
  19471. * - VertexBuffer.UV6Kind
  19472. * - VertexBuffer.ColorKind
  19473. * - VertexBuffer.MatricesIndicesKind
  19474. * - VertexBuffer.MatricesIndicesExtraKind
  19475. * - VertexBuffer.MatricesWeightsKind
  19476. * - VertexBuffer.MatricesWeightsExtraKind
  19477. *
  19478. * Returns the Mesh.
  19479. */
  19480. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  19481. /**
  19482. * Sets the mesh indices.
  19483. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  19484. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  19485. * This method creates a new index buffer each call.
  19486. * Returns the Mesh.
  19487. */
  19488. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  19489. /**
  19490. * Boolean : True if the mesh owns the requested kind of data.
  19491. */
  19492. isVerticesDataPresent(kind: string): boolean;
  19493. /**
  19494. * Returns an array of indices (IndicesArray).
  19495. */
  19496. getIndices(): Nullable<IndicesArray>;
  19497. readonly _positions: Nullable<Vector3[]>;
  19498. /**
  19499. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  19500. * This means the mesh underlying bounding box and sphere are recomputed.
  19501. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  19502. * @returns the current mesh
  19503. */
  19504. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  19505. /** @hidden */
  19506. _preActivate(): InstancedMesh;
  19507. /** @hidden */
  19508. _activate(renderId: number, intermediateRendering: boolean): boolean;
  19509. /** @hidden */
  19510. _postActivate(): void;
  19511. getWorldMatrix(): Matrix;
  19512. readonly isAnInstance: boolean;
  19513. /**
  19514. * Returns the current associated LOD AbstractMesh.
  19515. */
  19516. getLOD(camera: Camera): AbstractMesh;
  19517. /** @hidden */
  19518. _syncSubMeshes(): InstancedMesh;
  19519. /** @hidden */
  19520. _generatePointsArray(): boolean;
  19521. /**
  19522. * Creates a new InstancedMesh from the current mesh.
  19523. * - name (string) : the cloned mesh name
  19524. * - newParent (optional Node) : the optional Node to parent the clone to.
  19525. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  19526. *
  19527. * Returns the clone.
  19528. */
  19529. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  19530. /**
  19531. * Disposes the InstancedMesh.
  19532. * Returns nothing.
  19533. */
  19534. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  19535. }
  19536. module "babylonjs/Meshes/mesh" {
  19537. interface Mesh {
  19538. /**
  19539. * Register a custom buffer that will be instanced
  19540. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  19541. * @param kind defines the buffer kind
  19542. * @param stride defines the stride in floats
  19543. */
  19544. registerInstancedBuffer(kind: string, stride: number): void;
  19545. /** @hidden */
  19546. _userInstancedBuffersStorage: {
  19547. data: {
  19548. [key: string]: Float32Array;
  19549. };
  19550. sizes: {
  19551. [key: string]: number;
  19552. };
  19553. vertexBuffers: {
  19554. [key: string]: Nullable<VertexBuffer>;
  19555. };
  19556. strides: {
  19557. [key: string]: number;
  19558. };
  19559. };
  19560. }
  19561. }
  19562. module "babylonjs/Meshes/abstractMesh" {
  19563. interface AbstractMesh {
  19564. /**
  19565. * Object used to store instanced buffers defined by user
  19566. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  19567. */
  19568. instancedBuffers: {
  19569. [key: string]: any;
  19570. };
  19571. }
  19572. }
  19573. }
  19574. declare module "babylonjs/Materials/shaderMaterial" {
  19575. import { Scene } from "babylonjs/scene";
  19576. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  19577. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19578. import { Mesh } from "babylonjs/Meshes/mesh";
  19579. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  19580. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  19581. import { Texture } from "babylonjs/Materials/Textures/texture";
  19582. import { Material } from "babylonjs/Materials/material";
  19583. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  19584. /**
  19585. * Defines the options associated with the creation of a shader material.
  19586. */
  19587. export interface IShaderMaterialOptions {
  19588. /**
  19589. * Does the material work in alpha blend mode
  19590. */
  19591. needAlphaBlending: boolean;
  19592. /**
  19593. * Does the material work in alpha test mode
  19594. */
  19595. needAlphaTesting: boolean;
  19596. /**
  19597. * The list of attribute names used in the shader
  19598. */
  19599. attributes: string[];
  19600. /**
  19601. * The list of unifrom names used in the shader
  19602. */
  19603. uniforms: string[];
  19604. /**
  19605. * The list of UBO names used in the shader
  19606. */
  19607. uniformBuffers: string[];
  19608. /**
  19609. * The list of sampler names used in the shader
  19610. */
  19611. samplers: string[];
  19612. /**
  19613. * The list of defines used in the shader
  19614. */
  19615. defines: string[];
  19616. }
  19617. /**
  19618. * 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.
  19619. *
  19620. * This returned material effects how the mesh will look based on the code in the shaders.
  19621. *
  19622. * @see http://doc.babylonjs.com/how_to/shader_material
  19623. */
  19624. export class ShaderMaterial extends Material {
  19625. private _shaderPath;
  19626. private _options;
  19627. private _textures;
  19628. private _textureArrays;
  19629. private _floats;
  19630. private _ints;
  19631. private _floatsArrays;
  19632. private _colors3;
  19633. private _colors3Arrays;
  19634. private _colors4;
  19635. private _colors4Arrays;
  19636. private _vectors2;
  19637. private _vectors3;
  19638. private _vectors4;
  19639. private _matrices;
  19640. private _matrices3x3;
  19641. private _matrices2x2;
  19642. private _vectors2Arrays;
  19643. private _vectors3Arrays;
  19644. private _vectors4Arrays;
  19645. private _cachedWorldViewMatrix;
  19646. private _cachedWorldViewProjectionMatrix;
  19647. private _renderId;
  19648. /**
  19649. * Instantiate a new shader material.
  19650. * 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.
  19651. * This returned material effects how the mesh will look based on the code in the shaders.
  19652. * @see http://doc.babylonjs.com/how_to/shader_material
  19653. * @param name Define the name of the material in the scene
  19654. * @param scene Define the scene the material belongs to
  19655. * @param shaderPath Defines the route to the shader code in one of three ways:
  19656. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  19657. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  19658. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  19659. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  19660. * @param options Define the options used to create the shader
  19661. */
  19662. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  19663. /**
  19664. * Gets the options used to compile the shader.
  19665. * They can be modified to trigger a new compilation
  19666. */
  19667. readonly options: IShaderMaterialOptions;
  19668. /**
  19669. * Gets the current class name of the material e.g. "ShaderMaterial"
  19670. * Mainly use in serialization.
  19671. * @returns the class name
  19672. */
  19673. getClassName(): string;
  19674. /**
  19675. * Specifies if the material will require alpha blending
  19676. * @returns a boolean specifying if alpha blending is needed
  19677. */
  19678. needAlphaBlending(): boolean;
  19679. /**
  19680. * Specifies if this material should be rendered in alpha test mode
  19681. * @returns a boolean specifying if an alpha test is needed.
  19682. */
  19683. needAlphaTesting(): boolean;
  19684. private _checkUniform;
  19685. /**
  19686. * Set a texture in the shader.
  19687. * @param name Define the name of the uniform samplers as defined in the shader
  19688. * @param texture Define the texture to bind to this sampler
  19689. * @return the material itself allowing "fluent" like uniform updates
  19690. */
  19691. setTexture(name: string, texture: Texture): ShaderMaterial;
  19692. /**
  19693. * Set a texture array in the shader.
  19694. * @param name Define the name of the uniform sampler array as defined in the shader
  19695. * @param textures Define the list of textures to bind to this sampler
  19696. * @return the material itself allowing "fluent" like uniform updates
  19697. */
  19698. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  19699. /**
  19700. * Set a float in the shader.
  19701. * @param name Define the name of the uniform as defined in the shader
  19702. * @param value Define the value to give to the uniform
  19703. * @return the material itself allowing "fluent" like uniform updates
  19704. */
  19705. setFloat(name: string, value: number): ShaderMaterial;
  19706. /**
  19707. * Set a int in the shader.
  19708. * @param name Define the name of the uniform as defined in the shader
  19709. * @param value Define the value to give to the uniform
  19710. * @return the material itself allowing "fluent" like uniform updates
  19711. */
  19712. setInt(name: string, value: number): ShaderMaterial;
  19713. /**
  19714. * Set an array of floats in the shader.
  19715. * @param name Define the name of the uniform as defined in the shader
  19716. * @param value Define the value to give to the uniform
  19717. * @return the material itself allowing "fluent" like uniform updates
  19718. */
  19719. setFloats(name: string, value: number[]): ShaderMaterial;
  19720. /**
  19721. * Set a vec3 in the shader from a Color3.
  19722. * @param name Define the name of the uniform as defined in the shader
  19723. * @param value Define the value to give to the uniform
  19724. * @return the material itself allowing "fluent" like uniform updates
  19725. */
  19726. setColor3(name: string, value: Color3): ShaderMaterial;
  19727. /**
  19728. * Set a vec3 array in the shader from a Color3 array.
  19729. * @param name Define the name of the uniform as defined in the shader
  19730. * @param value Define the value to give to the uniform
  19731. * @return the material itself allowing "fluent" like uniform updates
  19732. */
  19733. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  19734. /**
  19735. * Set a vec4 in the shader from a Color4.
  19736. * @param name Define the name of the uniform as defined in the shader
  19737. * @param value Define the value to give to the uniform
  19738. * @return the material itself allowing "fluent" like uniform updates
  19739. */
  19740. setColor4(name: string, value: Color4): ShaderMaterial;
  19741. /**
  19742. * Set a vec4 array in the shader from a Color4 array.
  19743. * @param name Define the name of the uniform as defined in the shader
  19744. * @param value Define the value to give to the uniform
  19745. * @return the material itself allowing "fluent" like uniform updates
  19746. */
  19747. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  19748. /**
  19749. * Set a vec2 in the shader from a Vector2.
  19750. * @param name Define the name of the uniform as defined in the shader
  19751. * @param value Define the value to give to the uniform
  19752. * @return the material itself allowing "fluent" like uniform updates
  19753. */
  19754. setVector2(name: string, value: Vector2): ShaderMaterial;
  19755. /**
  19756. * Set a vec3 in the shader from a Vector3.
  19757. * @param name Define the name of the uniform as defined in the shader
  19758. * @param value Define the value to give to the uniform
  19759. * @return the material itself allowing "fluent" like uniform updates
  19760. */
  19761. setVector3(name: string, value: Vector3): ShaderMaterial;
  19762. /**
  19763. * Set a vec4 in the shader from a Vector4.
  19764. * @param name Define the name of the uniform as defined in the shader
  19765. * @param value Define the value to give to the uniform
  19766. * @return the material itself allowing "fluent" like uniform updates
  19767. */
  19768. setVector4(name: string, value: Vector4): ShaderMaterial;
  19769. /**
  19770. * Set a mat4 in the shader from a Matrix.
  19771. * @param name Define the name of the uniform as defined in the shader
  19772. * @param value Define the value to give to the uniform
  19773. * @return the material itself allowing "fluent" like uniform updates
  19774. */
  19775. setMatrix(name: string, value: Matrix): ShaderMaterial;
  19776. /**
  19777. * Set a mat3 in the shader from a Float32Array.
  19778. * @param name Define the name of the uniform as defined in the shader
  19779. * @param value Define the value to give to the uniform
  19780. * @return the material itself allowing "fluent" like uniform updates
  19781. */
  19782. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  19783. /**
  19784. * Set a mat2 in the shader from a Float32Array.
  19785. * @param name Define the name of the uniform as defined in the shader
  19786. * @param value Define the value to give to the uniform
  19787. * @return the material itself allowing "fluent" like uniform updates
  19788. */
  19789. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  19790. /**
  19791. * Set a vec2 array in the shader from a number array.
  19792. * @param name Define the name of the uniform as defined in the shader
  19793. * @param value Define the value to give to the uniform
  19794. * @return the material itself allowing "fluent" like uniform updates
  19795. */
  19796. setArray2(name: string, value: number[]): ShaderMaterial;
  19797. /**
  19798. * Set a vec3 array in the shader from a number array.
  19799. * @param name Define the name of the uniform as defined in the shader
  19800. * @param value Define the value to give to the uniform
  19801. * @return the material itself allowing "fluent" like uniform updates
  19802. */
  19803. setArray3(name: string, value: number[]): ShaderMaterial;
  19804. /**
  19805. * Set a vec4 array in the shader from a number array.
  19806. * @param name Define the name of the uniform as defined in the shader
  19807. * @param value Define the value to give to the uniform
  19808. * @return the material itself allowing "fluent" like uniform updates
  19809. */
  19810. setArray4(name: string, value: number[]): ShaderMaterial;
  19811. private _checkCache;
  19812. /**
  19813. * Specifies that the submesh is ready to be used
  19814. * @param mesh defines the mesh to check
  19815. * @param subMesh defines which submesh to check
  19816. * @param useInstances specifies that instances should be used
  19817. * @returns a boolean indicating that the submesh is ready or not
  19818. */
  19819. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  19820. /**
  19821. * Checks if the material is ready to render the requested mesh
  19822. * @param mesh Define the mesh to render
  19823. * @param useInstances Define whether or not the material is used with instances
  19824. * @returns true if ready, otherwise false
  19825. */
  19826. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  19827. /**
  19828. * Binds the world matrix to the material
  19829. * @param world defines the world transformation matrix
  19830. */
  19831. bindOnlyWorldMatrix(world: Matrix): void;
  19832. /**
  19833. * Binds the material to the mesh
  19834. * @param world defines the world transformation matrix
  19835. * @param mesh defines the mesh to bind the material to
  19836. */
  19837. bind(world: Matrix, mesh?: Mesh): void;
  19838. /**
  19839. * Gets the active textures from the material
  19840. * @returns an array of textures
  19841. */
  19842. getActiveTextures(): BaseTexture[];
  19843. /**
  19844. * Specifies if the material uses a texture
  19845. * @param texture defines the texture to check against the material
  19846. * @returns a boolean specifying if the material uses the texture
  19847. */
  19848. hasTexture(texture: BaseTexture): boolean;
  19849. /**
  19850. * Makes a duplicate of the material, and gives it a new name
  19851. * @param name defines the new name for the duplicated material
  19852. * @returns the cloned material
  19853. */
  19854. clone(name: string): ShaderMaterial;
  19855. /**
  19856. * Disposes the material
  19857. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  19858. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  19859. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  19860. */
  19861. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  19862. /**
  19863. * Serializes this material in a JSON representation
  19864. * @returns the serialized material object
  19865. */
  19866. serialize(): any;
  19867. /**
  19868. * Creates a shader material from parsed shader material data
  19869. * @param source defines the JSON represnetation of the material
  19870. * @param scene defines the hosting scene
  19871. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  19872. * @returns a new material
  19873. */
  19874. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  19875. }
  19876. }
  19877. declare module "babylonjs/Shaders/color.fragment" {
  19878. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  19879. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  19880. /** @hidden */
  19881. export var colorPixelShader: {
  19882. name: string;
  19883. shader: string;
  19884. };
  19885. }
  19886. declare module "babylonjs/Shaders/color.vertex" {
  19887. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  19888. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  19889. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  19890. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  19891. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  19892. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  19893. /** @hidden */
  19894. export var colorVertexShader: {
  19895. name: string;
  19896. shader: string;
  19897. };
  19898. }
  19899. declare module "babylonjs/Meshes/linesMesh" {
  19900. import { Nullable } from "babylonjs/types";
  19901. import { Scene } from "babylonjs/scene";
  19902. import { Color3 } from "babylonjs/Maths/math.color";
  19903. import { Node } from "babylonjs/node";
  19904. import { SubMesh } from "babylonjs/Meshes/subMesh";
  19905. import { Mesh } from "babylonjs/Meshes/mesh";
  19906. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  19907. import { Effect } from "babylonjs/Materials/effect";
  19908. import { Material } from "babylonjs/Materials/material";
  19909. import "babylonjs/Shaders/color.fragment";
  19910. import "babylonjs/Shaders/color.vertex";
  19911. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19912. /**
  19913. * Line mesh
  19914. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  19915. */
  19916. export class LinesMesh extends Mesh {
  19917. /**
  19918. * If vertex color should be applied to the mesh
  19919. */
  19920. readonly useVertexColor?: boolean | undefined;
  19921. /**
  19922. * If vertex alpha should be applied to the mesh
  19923. */
  19924. readonly useVertexAlpha?: boolean | undefined;
  19925. /**
  19926. * Color of the line (Default: White)
  19927. */
  19928. color: Color3;
  19929. /**
  19930. * Alpha of the line (Default: 1)
  19931. */
  19932. alpha: number;
  19933. /**
  19934. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  19935. * This margin is expressed in world space coordinates, so its value may vary.
  19936. * Default value is 0.1
  19937. */
  19938. intersectionThreshold: number;
  19939. private _colorShader;
  19940. private color4;
  19941. /**
  19942. * Creates a new LinesMesh
  19943. * @param name defines the name
  19944. * @param scene defines the hosting scene
  19945. * @param parent defines the parent mesh if any
  19946. * @param source defines the optional source LinesMesh used to clone data from
  19947. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  19948. * When false, achieved by calling a clone(), also passing False.
  19949. * This will make creation of children, recursive.
  19950. * @param useVertexColor defines if this LinesMesh supports vertex color
  19951. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  19952. */
  19953. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  19954. /**
  19955. * If vertex color should be applied to the mesh
  19956. */
  19957. useVertexColor?: boolean | undefined,
  19958. /**
  19959. * If vertex alpha should be applied to the mesh
  19960. */
  19961. useVertexAlpha?: boolean | undefined);
  19962. private _addClipPlaneDefine;
  19963. private _removeClipPlaneDefine;
  19964. isReady(): boolean;
  19965. /**
  19966. * Returns the string "LineMesh"
  19967. */
  19968. getClassName(): string;
  19969. /**
  19970. * @hidden
  19971. */
  19972. /**
  19973. * @hidden
  19974. */
  19975. material: Material;
  19976. /**
  19977. * @hidden
  19978. */
  19979. readonly checkCollisions: boolean;
  19980. /** @hidden */
  19981. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  19982. /** @hidden */
  19983. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  19984. /**
  19985. * Disposes of the line mesh
  19986. * @param doNotRecurse If children should be disposed
  19987. */
  19988. dispose(doNotRecurse?: boolean): void;
  19989. /**
  19990. * Returns a new LineMesh object cloned from the current one.
  19991. */
  19992. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  19993. /**
  19994. * Creates a new InstancedLinesMesh object from the mesh model.
  19995. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  19996. * @param name defines the name of the new instance
  19997. * @returns a new InstancedLinesMesh
  19998. */
  19999. createInstance(name: string): InstancedLinesMesh;
  20000. }
  20001. /**
  20002. * Creates an instance based on a source LinesMesh
  20003. */
  20004. export class InstancedLinesMesh extends InstancedMesh {
  20005. /**
  20006. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  20007. * This margin is expressed in world space coordinates, so its value may vary.
  20008. * Initilized with the intersectionThreshold value of the source LinesMesh
  20009. */
  20010. intersectionThreshold: number;
  20011. constructor(name: string, source: LinesMesh);
  20012. /**
  20013. * Returns the string "InstancedLinesMesh".
  20014. */
  20015. getClassName(): string;
  20016. }
  20017. }
  20018. declare module "babylonjs/Shaders/line.fragment" {
  20019. /** @hidden */
  20020. export var linePixelShader: {
  20021. name: string;
  20022. shader: string;
  20023. };
  20024. }
  20025. declare module "babylonjs/Shaders/line.vertex" {
  20026. /** @hidden */
  20027. export var lineVertexShader: {
  20028. name: string;
  20029. shader: string;
  20030. };
  20031. }
  20032. declare module "babylonjs/Rendering/edgesRenderer" {
  20033. import { Nullable } from "babylonjs/types";
  20034. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  20035. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20036. import { Vector3 } from "babylonjs/Maths/math.vector";
  20037. import { IDisposable } from "babylonjs/scene";
  20038. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  20039. import "babylonjs/Shaders/line.fragment";
  20040. import "babylonjs/Shaders/line.vertex";
  20041. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  20042. module "babylonjs/Meshes/abstractMesh" {
  20043. interface AbstractMesh {
  20044. /**
  20045. * Gets the edgesRenderer associated with the mesh
  20046. */
  20047. edgesRenderer: Nullable<EdgesRenderer>;
  20048. }
  20049. }
  20050. module "babylonjs/Meshes/linesMesh" {
  20051. interface LinesMesh {
  20052. /**
  20053. * Enables the edge rendering mode on the mesh.
  20054. * This mode makes the mesh edges visible
  20055. * @param epsilon defines the maximal distance between two angles to detect a face
  20056. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  20057. * @returns the currentAbstractMesh
  20058. * @see https://www.babylonjs-playground.com/#19O9TU#0
  20059. */
  20060. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  20061. }
  20062. }
  20063. module "babylonjs/Meshes/linesMesh" {
  20064. interface InstancedLinesMesh {
  20065. /**
  20066. * Enables the edge rendering mode on the mesh.
  20067. * This mode makes the mesh edges visible
  20068. * @param epsilon defines the maximal distance between two angles to detect a face
  20069. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  20070. * @returns the current InstancedLinesMesh
  20071. * @see https://www.babylonjs-playground.com/#19O9TU#0
  20072. */
  20073. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  20074. }
  20075. }
  20076. /**
  20077. * Defines the minimum contract an Edges renderer should follow.
  20078. */
  20079. export interface IEdgesRenderer extends IDisposable {
  20080. /**
  20081. * Gets or sets a boolean indicating if the edgesRenderer is active
  20082. */
  20083. isEnabled: boolean;
  20084. /**
  20085. * Renders the edges of the attached mesh,
  20086. */
  20087. render(): void;
  20088. /**
  20089. * Checks wether or not the edges renderer is ready to render.
  20090. * @return true if ready, otherwise false.
  20091. */
  20092. isReady(): boolean;
  20093. }
  20094. /**
  20095. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  20096. */
  20097. export class EdgesRenderer implements IEdgesRenderer {
  20098. /**
  20099. * Define the size of the edges with an orthographic camera
  20100. */
  20101. edgesWidthScalerForOrthographic: number;
  20102. /**
  20103. * Define the size of the edges with a perspective camera
  20104. */
  20105. edgesWidthScalerForPerspective: number;
  20106. protected _source: AbstractMesh;
  20107. protected _linesPositions: number[];
  20108. protected _linesNormals: number[];
  20109. protected _linesIndices: number[];
  20110. protected _epsilon: number;
  20111. protected _indicesCount: number;
  20112. protected _lineShader: ShaderMaterial;
  20113. protected _ib: DataBuffer;
  20114. protected _buffers: {
  20115. [key: string]: Nullable<VertexBuffer>;
  20116. };
  20117. protected _checkVerticesInsteadOfIndices: boolean;
  20118. private _meshRebuildObserver;
  20119. private _meshDisposeObserver;
  20120. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  20121. isEnabled: boolean;
  20122. /**
  20123. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  20124. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  20125. * @param source Mesh used to create edges
  20126. * @param epsilon sum of angles in adjacency to check for edge
  20127. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  20128. * @param generateEdgesLines - should generate Lines or only prepare resources.
  20129. */
  20130. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  20131. protected _prepareRessources(): void;
  20132. /** @hidden */
  20133. _rebuild(): void;
  20134. /**
  20135. * Releases the required resources for the edges renderer
  20136. */
  20137. dispose(): void;
  20138. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  20139. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  20140. /**
  20141. * Checks if the pair of p0 and p1 is en edge
  20142. * @param faceIndex
  20143. * @param edge
  20144. * @param faceNormals
  20145. * @param p0
  20146. * @param p1
  20147. * @private
  20148. */
  20149. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  20150. /**
  20151. * push line into the position, normal and index buffer
  20152. * @protected
  20153. */
  20154. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  20155. /**
  20156. * Generates lines edges from adjacencjes
  20157. * @private
  20158. */
  20159. _generateEdgesLines(): void;
  20160. /**
  20161. * Checks wether or not the edges renderer is ready to render.
  20162. * @return true if ready, otherwise false.
  20163. */
  20164. isReady(): boolean;
  20165. /**
  20166. * Renders the edges of the attached mesh,
  20167. */
  20168. render(): void;
  20169. }
  20170. /**
  20171. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  20172. */
  20173. export class LineEdgesRenderer extends EdgesRenderer {
  20174. /**
  20175. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  20176. * @param source LineMesh used to generate edges
  20177. * @param epsilon not important (specified angle for edge detection)
  20178. * @param checkVerticesInsteadOfIndices not important for LineMesh
  20179. */
  20180. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  20181. /**
  20182. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  20183. */
  20184. _generateEdgesLines(): void;
  20185. }
  20186. }
  20187. declare module "babylonjs/Rendering/renderingGroup" {
  20188. import { SmartArray } from "babylonjs/Misc/smartArray";
  20189. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20190. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20191. import { Nullable } from "babylonjs/types";
  20192. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  20193. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  20194. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  20195. import { Material } from "babylonjs/Materials/material";
  20196. import { Scene } from "babylonjs/scene";
  20197. /**
  20198. * This represents the object necessary to create a rendering group.
  20199. * This is exclusively used and created by the rendering manager.
  20200. * To modify the behavior, you use the available helpers in your scene or meshes.
  20201. * @hidden
  20202. */
  20203. export class RenderingGroup {
  20204. index: number;
  20205. private static _zeroVector;
  20206. private _scene;
  20207. private _opaqueSubMeshes;
  20208. private _transparentSubMeshes;
  20209. private _alphaTestSubMeshes;
  20210. private _depthOnlySubMeshes;
  20211. private _particleSystems;
  20212. private _spriteManagers;
  20213. private _opaqueSortCompareFn;
  20214. private _alphaTestSortCompareFn;
  20215. private _transparentSortCompareFn;
  20216. private _renderOpaque;
  20217. private _renderAlphaTest;
  20218. private _renderTransparent;
  20219. /** @hidden */
  20220. _edgesRenderers: SmartArray<IEdgesRenderer>;
  20221. onBeforeTransparentRendering: () => void;
  20222. /**
  20223. * Set the opaque sort comparison function.
  20224. * If null the sub meshes will be render in the order they were created
  20225. */
  20226. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20227. /**
  20228. * Set the alpha test sort comparison function.
  20229. * If null the sub meshes will be render in the order they were created
  20230. */
  20231. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20232. /**
  20233. * Set the transparent sort comparison function.
  20234. * If null the sub meshes will be render in the order they were created
  20235. */
  20236. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20237. /**
  20238. * Creates a new rendering group.
  20239. * @param index The rendering group index
  20240. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  20241. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  20242. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  20243. */
  20244. 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>);
  20245. /**
  20246. * Render all the sub meshes contained in the group.
  20247. * @param customRenderFunction Used to override the default render behaviour of the group.
  20248. * @returns true if rendered some submeshes.
  20249. */
  20250. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  20251. /**
  20252. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  20253. * @param subMeshes The submeshes to render
  20254. */
  20255. private renderOpaqueSorted;
  20256. /**
  20257. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  20258. * @param subMeshes The submeshes to render
  20259. */
  20260. private renderAlphaTestSorted;
  20261. /**
  20262. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  20263. * @param subMeshes The submeshes to render
  20264. */
  20265. private renderTransparentSorted;
  20266. /**
  20267. * Renders the submeshes in a specified order.
  20268. * @param subMeshes The submeshes to sort before render
  20269. * @param sortCompareFn The comparison function use to sort
  20270. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  20271. * @param transparent Specifies to activate blending if true
  20272. */
  20273. private static renderSorted;
  20274. /**
  20275. * Renders the submeshes in the order they were dispatched (no sort applied).
  20276. * @param subMeshes The submeshes to render
  20277. */
  20278. private static renderUnsorted;
  20279. /**
  20280. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20281. * are rendered back to front if in the same alpha index.
  20282. *
  20283. * @param a The first submesh
  20284. * @param b The second submesh
  20285. * @returns The result of the comparison
  20286. */
  20287. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  20288. /**
  20289. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20290. * are rendered back to front.
  20291. *
  20292. * @param a The first submesh
  20293. * @param b The second submesh
  20294. * @returns The result of the comparison
  20295. */
  20296. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  20297. /**
  20298. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20299. * are rendered front to back (prevent overdraw).
  20300. *
  20301. * @param a The first submesh
  20302. * @param b The second submesh
  20303. * @returns The result of the comparison
  20304. */
  20305. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  20306. /**
  20307. * Resets the different lists of submeshes to prepare a new frame.
  20308. */
  20309. prepare(): void;
  20310. dispose(): void;
  20311. /**
  20312. * Inserts the submesh in its correct queue depending on its material.
  20313. * @param subMesh The submesh to dispatch
  20314. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20315. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20316. */
  20317. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20318. dispatchSprites(spriteManager: ISpriteManager): void;
  20319. dispatchParticles(particleSystem: IParticleSystem): void;
  20320. private _renderParticles;
  20321. private _renderSprites;
  20322. }
  20323. }
  20324. declare module "babylonjs/Rendering/renderingManager" {
  20325. import { Nullable } from "babylonjs/types";
  20326. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20327. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20328. import { SmartArray } from "babylonjs/Misc/smartArray";
  20329. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  20330. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  20331. import { Material } from "babylonjs/Materials/material";
  20332. import { Scene } from "babylonjs/scene";
  20333. import { Camera } from "babylonjs/Cameras/camera";
  20334. /**
  20335. * Interface describing the different options available in the rendering manager
  20336. * regarding Auto Clear between groups.
  20337. */
  20338. export interface IRenderingManagerAutoClearSetup {
  20339. /**
  20340. * Defines whether or not autoclear is enable.
  20341. */
  20342. autoClear: boolean;
  20343. /**
  20344. * Defines whether or not to autoclear the depth buffer.
  20345. */
  20346. depth: boolean;
  20347. /**
  20348. * Defines whether or not to autoclear the stencil buffer.
  20349. */
  20350. stencil: boolean;
  20351. }
  20352. /**
  20353. * This class is used by the onRenderingGroupObservable
  20354. */
  20355. export class RenderingGroupInfo {
  20356. /**
  20357. * The Scene that being rendered
  20358. */
  20359. scene: Scene;
  20360. /**
  20361. * The camera currently used for the rendering pass
  20362. */
  20363. camera: Nullable<Camera>;
  20364. /**
  20365. * The ID of the renderingGroup being processed
  20366. */
  20367. renderingGroupId: number;
  20368. }
  20369. /**
  20370. * This is the manager responsible of all the rendering for meshes sprites and particles.
  20371. * It is enable to manage the different groups as well as the different necessary sort functions.
  20372. * This should not be used directly aside of the few static configurations
  20373. */
  20374. export class RenderingManager {
  20375. /**
  20376. * The max id used for rendering groups (not included)
  20377. */
  20378. static MAX_RENDERINGGROUPS: number;
  20379. /**
  20380. * The min id used for rendering groups (included)
  20381. */
  20382. static MIN_RENDERINGGROUPS: number;
  20383. /**
  20384. * Used to globally prevent autoclearing scenes.
  20385. */
  20386. static AUTOCLEAR: boolean;
  20387. /**
  20388. * @hidden
  20389. */
  20390. _useSceneAutoClearSetup: boolean;
  20391. private _scene;
  20392. private _renderingGroups;
  20393. private _depthStencilBufferAlreadyCleaned;
  20394. private _autoClearDepthStencil;
  20395. private _customOpaqueSortCompareFn;
  20396. private _customAlphaTestSortCompareFn;
  20397. private _customTransparentSortCompareFn;
  20398. private _renderingGroupInfo;
  20399. /**
  20400. * Instantiates a new rendering group for a particular scene
  20401. * @param scene Defines the scene the groups belongs to
  20402. */
  20403. constructor(scene: Scene);
  20404. private _clearDepthStencilBuffer;
  20405. /**
  20406. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  20407. * @hidden
  20408. */
  20409. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  20410. /**
  20411. * Resets the different information of the group to prepare a new frame
  20412. * @hidden
  20413. */
  20414. reset(): void;
  20415. /**
  20416. * Dispose and release the group and its associated resources.
  20417. * @hidden
  20418. */
  20419. dispose(): void;
  20420. /**
  20421. * Clear the info related to rendering groups preventing retention points during dispose.
  20422. */
  20423. freeRenderingGroups(): void;
  20424. private _prepareRenderingGroup;
  20425. /**
  20426. * Add a sprite manager to the rendering manager in order to render it this frame.
  20427. * @param spriteManager Define the sprite manager to render
  20428. */
  20429. dispatchSprites(spriteManager: ISpriteManager): void;
  20430. /**
  20431. * Add a particle system to the rendering manager in order to render it this frame.
  20432. * @param particleSystem Define the particle system to render
  20433. */
  20434. dispatchParticles(particleSystem: IParticleSystem): void;
  20435. /**
  20436. * Add a submesh to the manager in order to render it this frame
  20437. * @param subMesh The submesh to dispatch
  20438. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20439. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20440. */
  20441. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20442. /**
  20443. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20444. * This allowed control for front to back rendering or reversly depending of the special needs.
  20445. *
  20446. * @param renderingGroupId The rendering group id corresponding to its index
  20447. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20448. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20449. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20450. */
  20451. 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;
  20452. /**
  20453. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20454. *
  20455. * @param renderingGroupId The rendering group id corresponding to its index
  20456. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20457. * @param depth Automatically clears depth between groups if true and autoClear is true.
  20458. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  20459. */
  20460. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  20461. /**
  20462. * Gets the current auto clear configuration for one rendering group of the rendering
  20463. * manager.
  20464. * @param index the rendering group index to get the information for
  20465. * @returns The auto clear setup for the requested rendering group
  20466. */
  20467. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  20468. }
  20469. }
  20470. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  20471. import { Observable } from "babylonjs/Misc/observable";
  20472. import { SmartArray } from "babylonjs/Misc/smartArray";
  20473. import { Nullable } from "babylonjs/types";
  20474. import { Camera } from "babylonjs/Cameras/camera";
  20475. import { Scene } from "babylonjs/scene";
  20476. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20477. import { Color4 } from "babylonjs/Maths/math.color";
  20478. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  20479. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20480. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20481. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20482. import { Texture } from "babylonjs/Materials/Textures/texture";
  20483. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20484. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  20485. import "babylonjs/Engines/Extensions/engine.renderTarget";
  20486. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  20487. import { Engine } from "babylonjs/Engines/engine";
  20488. /**
  20489. * This Helps creating a texture that will be created from a camera in your scene.
  20490. * It is basically a dynamic texture that could be used to create special effects for instance.
  20491. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  20492. */
  20493. export class RenderTargetTexture extends Texture {
  20494. isCube: boolean;
  20495. /**
  20496. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  20497. */
  20498. static readonly REFRESHRATE_RENDER_ONCE: number;
  20499. /**
  20500. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  20501. */
  20502. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  20503. /**
  20504. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  20505. * the central point of your effect and can save a lot of performances.
  20506. */
  20507. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  20508. /**
  20509. * Use this predicate to dynamically define the list of mesh you want to render.
  20510. * If set, the renderList property will be overwritten.
  20511. */
  20512. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  20513. private _renderList;
  20514. /**
  20515. * Use this list to define the list of mesh you want to render.
  20516. */
  20517. renderList: Nullable<Array<AbstractMesh>>;
  20518. private _hookArray;
  20519. /**
  20520. * Define if particles should be rendered in your texture.
  20521. */
  20522. renderParticles: boolean;
  20523. /**
  20524. * Define if sprites should be rendered in your texture.
  20525. */
  20526. renderSprites: boolean;
  20527. /**
  20528. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  20529. */
  20530. coordinatesMode: number;
  20531. /**
  20532. * Define the camera used to render the texture.
  20533. */
  20534. activeCamera: Nullable<Camera>;
  20535. /**
  20536. * Override the render function of the texture with your own one.
  20537. */
  20538. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  20539. /**
  20540. * Define if camera post processes should be use while rendering the texture.
  20541. */
  20542. useCameraPostProcesses: boolean;
  20543. /**
  20544. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  20545. */
  20546. ignoreCameraViewport: boolean;
  20547. private _postProcessManager;
  20548. private _postProcesses;
  20549. private _resizeObserver;
  20550. /**
  20551. * An event triggered when the texture is unbind.
  20552. */
  20553. onBeforeBindObservable: Observable<RenderTargetTexture>;
  20554. /**
  20555. * An event triggered when the texture is unbind.
  20556. */
  20557. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  20558. private _onAfterUnbindObserver;
  20559. /**
  20560. * Set a after unbind callback in the texture.
  20561. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  20562. */
  20563. onAfterUnbind: () => void;
  20564. /**
  20565. * An event triggered before rendering the texture
  20566. */
  20567. onBeforeRenderObservable: Observable<number>;
  20568. private _onBeforeRenderObserver;
  20569. /**
  20570. * Set a before render callback in the texture.
  20571. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  20572. */
  20573. onBeforeRender: (faceIndex: number) => void;
  20574. /**
  20575. * An event triggered after rendering the texture
  20576. */
  20577. onAfterRenderObservable: Observable<number>;
  20578. private _onAfterRenderObserver;
  20579. /**
  20580. * Set a after render callback in the texture.
  20581. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  20582. */
  20583. onAfterRender: (faceIndex: number) => void;
  20584. /**
  20585. * An event triggered after the texture clear
  20586. */
  20587. onClearObservable: Observable<Engine>;
  20588. private _onClearObserver;
  20589. /**
  20590. * Set a clear callback in the texture.
  20591. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  20592. */
  20593. onClear: (Engine: Engine) => void;
  20594. /**
  20595. * An event triggered when the texture is resized.
  20596. */
  20597. onResizeObservable: Observable<RenderTargetTexture>;
  20598. /**
  20599. * Define the clear color of the Render Target if it should be different from the scene.
  20600. */
  20601. clearColor: Color4;
  20602. protected _size: number | {
  20603. width: number;
  20604. height: number;
  20605. };
  20606. protected _initialSizeParameter: number | {
  20607. width: number;
  20608. height: number;
  20609. } | {
  20610. ratio: number;
  20611. };
  20612. protected _sizeRatio: Nullable<number>;
  20613. /** @hidden */
  20614. _generateMipMaps: boolean;
  20615. protected _renderingManager: RenderingManager;
  20616. /** @hidden */
  20617. _waitingRenderList: string[];
  20618. protected _doNotChangeAspectRatio: boolean;
  20619. protected _currentRefreshId: number;
  20620. protected _refreshRate: number;
  20621. protected _textureMatrix: Matrix;
  20622. protected _samples: number;
  20623. protected _renderTargetOptions: RenderTargetCreationOptions;
  20624. /**
  20625. * Gets render target creation options that were used.
  20626. */
  20627. readonly renderTargetOptions: RenderTargetCreationOptions;
  20628. protected _engine: Engine;
  20629. protected _onRatioRescale(): void;
  20630. /**
  20631. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  20632. * It must define where the camera used to render the texture is set
  20633. */
  20634. boundingBoxPosition: Vector3;
  20635. private _boundingBoxSize;
  20636. /**
  20637. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  20638. * When defined, the cubemap will switch to local mode
  20639. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  20640. * @example https://www.babylonjs-playground.com/#RNASML
  20641. */
  20642. boundingBoxSize: Vector3;
  20643. /**
  20644. * In case the RTT has been created with a depth texture, get the associated
  20645. * depth texture.
  20646. * Otherwise, return null.
  20647. */
  20648. depthStencilTexture: Nullable<InternalTexture>;
  20649. /**
  20650. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  20651. * or used a shadow, depth texture...
  20652. * @param name The friendly name of the texture
  20653. * @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)
  20654. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  20655. * @param generateMipMaps True if mip maps need to be generated after render.
  20656. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  20657. * @param type The type of the buffer in the RTT (int, half float, float...)
  20658. * @param isCube True if a cube texture needs to be created
  20659. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  20660. * @param generateDepthBuffer True to generate a depth buffer
  20661. * @param generateStencilBuffer True to generate a stencil buffer
  20662. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  20663. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  20664. * @param delayAllocation if the texture allocation should be delayed (default: false)
  20665. */
  20666. constructor(name: string, size: number | {
  20667. width: number;
  20668. height: number;
  20669. } | {
  20670. ratio: number;
  20671. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  20672. /**
  20673. * Creates a depth stencil texture.
  20674. * This is only available in WebGL 2 or with the depth texture extension available.
  20675. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  20676. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  20677. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  20678. */
  20679. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  20680. private _processSizeParameter;
  20681. /**
  20682. * Define the number of samples to use in case of MSAA.
  20683. * It defaults to one meaning no MSAA has been enabled.
  20684. */
  20685. samples: number;
  20686. /**
  20687. * Resets the refresh counter of the texture and start bak from scratch.
  20688. * Could be useful to regenerate the texture if it is setup to render only once.
  20689. */
  20690. resetRefreshCounter(): void;
  20691. /**
  20692. * Define the refresh rate of the texture or the rendering frequency.
  20693. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  20694. */
  20695. refreshRate: number;
  20696. /**
  20697. * Adds a post process to the render target rendering passes.
  20698. * @param postProcess define the post process to add
  20699. */
  20700. addPostProcess(postProcess: PostProcess): void;
  20701. /**
  20702. * Clear all the post processes attached to the render target
  20703. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  20704. */
  20705. clearPostProcesses(dispose?: boolean): void;
  20706. /**
  20707. * Remove one of the post process from the list of attached post processes to the texture
  20708. * @param postProcess define the post process to remove from the list
  20709. */
  20710. removePostProcess(postProcess: PostProcess): void;
  20711. /** @hidden */
  20712. _shouldRender(): boolean;
  20713. /**
  20714. * Gets the actual render size of the texture.
  20715. * @returns the width of the render size
  20716. */
  20717. getRenderSize(): number;
  20718. /**
  20719. * Gets the actual render width of the texture.
  20720. * @returns the width of the render size
  20721. */
  20722. getRenderWidth(): number;
  20723. /**
  20724. * Gets the actual render height of the texture.
  20725. * @returns the height of the render size
  20726. */
  20727. getRenderHeight(): number;
  20728. /**
  20729. * Get if the texture can be rescaled or not.
  20730. */
  20731. readonly canRescale: boolean;
  20732. /**
  20733. * Resize the texture using a ratio.
  20734. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  20735. */
  20736. scale(ratio: number): void;
  20737. /**
  20738. * Get the texture reflection matrix used to rotate/transform the reflection.
  20739. * @returns the reflection matrix
  20740. */
  20741. getReflectionTextureMatrix(): Matrix;
  20742. /**
  20743. * Resize the texture to a new desired size.
  20744. * Be carrefull as it will recreate all the data in the new texture.
  20745. * @param size Define the new size. It can be:
  20746. * - a number for squared texture,
  20747. * - an object containing { width: number, height: number }
  20748. * - or an object containing a ratio { ratio: number }
  20749. */
  20750. resize(size: number | {
  20751. width: number;
  20752. height: number;
  20753. } | {
  20754. ratio: number;
  20755. }): void;
  20756. /**
  20757. * Renders all the objects from the render list into the texture.
  20758. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  20759. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  20760. */
  20761. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  20762. private _bestReflectionRenderTargetDimension;
  20763. /**
  20764. * @hidden
  20765. * @param faceIndex face index to bind to if this is a cubetexture
  20766. */
  20767. _bindFrameBuffer(faceIndex?: number): void;
  20768. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  20769. private renderToTarget;
  20770. /**
  20771. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20772. * This allowed control for front to back rendering or reversly depending of the special needs.
  20773. *
  20774. * @param renderingGroupId The rendering group id corresponding to its index
  20775. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20776. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20777. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20778. */
  20779. 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;
  20780. /**
  20781. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20782. *
  20783. * @param renderingGroupId The rendering group id corresponding to its index
  20784. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20785. */
  20786. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  20787. /**
  20788. * Clones the texture.
  20789. * @returns the cloned texture
  20790. */
  20791. clone(): RenderTargetTexture;
  20792. /**
  20793. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  20794. * @returns The JSON representation of the texture
  20795. */
  20796. serialize(): any;
  20797. /**
  20798. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  20799. */
  20800. disposeFramebufferObjects(): void;
  20801. /**
  20802. * Dispose the texture and release its associated resources.
  20803. */
  20804. dispose(): void;
  20805. /** @hidden */
  20806. _rebuild(): void;
  20807. /**
  20808. * Clear the info related to rendering groups preventing retention point in material dispose.
  20809. */
  20810. freeRenderingGroups(): void;
  20811. /**
  20812. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20813. * @returns the view count
  20814. */
  20815. getViewCount(): number;
  20816. }
  20817. }
  20818. declare module "babylonjs/Materials/material" {
  20819. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  20820. import { SmartArray } from "babylonjs/Misc/smartArray";
  20821. import { Observable } from "babylonjs/Misc/observable";
  20822. import { Nullable } from "babylonjs/types";
  20823. import { Scene } from "babylonjs/scene";
  20824. import { Matrix } from "babylonjs/Maths/math.vector";
  20825. import { BaseSubMesh, SubMesh } from "babylonjs/Meshes/subMesh";
  20826. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20827. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20828. import { Effect } from "babylonjs/Materials/effect";
  20829. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20830. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20831. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20832. import { IInspectable } from "babylonjs/Misc/iInspectable";
  20833. import { Mesh } from "babylonjs/Meshes/mesh";
  20834. import { Animation } from "babylonjs/Animations/animation";
  20835. /**
  20836. * Options for compiling materials.
  20837. */
  20838. export interface IMaterialCompilationOptions {
  20839. /**
  20840. * Defines whether clip planes are enabled.
  20841. */
  20842. clipPlane: boolean;
  20843. /**
  20844. * Defines whether instances are enabled.
  20845. */
  20846. useInstances: boolean;
  20847. }
  20848. /**
  20849. * Base class for the main features of a material in Babylon.js
  20850. */
  20851. export class Material implements IAnimatable {
  20852. /**
  20853. * Returns the triangle fill mode
  20854. */
  20855. static readonly TriangleFillMode: number;
  20856. /**
  20857. * Returns the wireframe mode
  20858. */
  20859. static readonly WireFrameFillMode: number;
  20860. /**
  20861. * Returns the point fill mode
  20862. */
  20863. static readonly PointFillMode: number;
  20864. /**
  20865. * Returns the point list draw mode
  20866. */
  20867. static readonly PointListDrawMode: number;
  20868. /**
  20869. * Returns the line list draw mode
  20870. */
  20871. static readonly LineListDrawMode: number;
  20872. /**
  20873. * Returns the line loop draw mode
  20874. */
  20875. static readonly LineLoopDrawMode: number;
  20876. /**
  20877. * Returns the line strip draw mode
  20878. */
  20879. static readonly LineStripDrawMode: number;
  20880. /**
  20881. * Returns the triangle strip draw mode
  20882. */
  20883. static readonly TriangleStripDrawMode: number;
  20884. /**
  20885. * Returns the triangle fan draw mode
  20886. */
  20887. static readonly TriangleFanDrawMode: number;
  20888. /**
  20889. * Stores the clock-wise side orientation
  20890. */
  20891. static readonly ClockWiseSideOrientation: number;
  20892. /**
  20893. * Stores the counter clock-wise side orientation
  20894. */
  20895. static readonly CounterClockWiseSideOrientation: number;
  20896. /**
  20897. * The dirty texture flag value
  20898. */
  20899. static readonly TextureDirtyFlag: number;
  20900. /**
  20901. * The dirty light flag value
  20902. */
  20903. static readonly LightDirtyFlag: number;
  20904. /**
  20905. * The dirty fresnel flag value
  20906. */
  20907. static readonly FresnelDirtyFlag: number;
  20908. /**
  20909. * The dirty attribute flag value
  20910. */
  20911. static readonly AttributesDirtyFlag: number;
  20912. /**
  20913. * The dirty misc flag value
  20914. */
  20915. static readonly MiscDirtyFlag: number;
  20916. /**
  20917. * The all dirty flag value
  20918. */
  20919. static readonly AllDirtyFlag: number;
  20920. /**
  20921. * The ID of the material
  20922. */
  20923. id: string;
  20924. /**
  20925. * Gets or sets the unique id of the material
  20926. */
  20927. uniqueId: number;
  20928. /**
  20929. * The name of the material
  20930. */
  20931. name: string;
  20932. /**
  20933. * Gets or sets user defined metadata
  20934. */
  20935. metadata: any;
  20936. /**
  20937. * For internal use only. Please do not use.
  20938. */
  20939. reservedDataStore: any;
  20940. /**
  20941. * Specifies if the ready state should be checked on each call
  20942. */
  20943. checkReadyOnEveryCall: boolean;
  20944. /**
  20945. * Specifies if the ready state should be checked once
  20946. */
  20947. checkReadyOnlyOnce: boolean;
  20948. /**
  20949. * The state of the material
  20950. */
  20951. state: string;
  20952. /**
  20953. * The alpha value of the material
  20954. */
  20955. protected _alpha: number;
  20956. /**
  20957. * List of inspectable custom properties (used by the Inspector)
  20958. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  20959. */
  20960. inspectableCustomProperties: IInspectable[];
  20961. /**
  20962. * Sets the alpha value of the material
  20963. */
  20964. /**
  20965. * Gets the alpha value of the material
  20966. */
  20967. alpha: number;
  20968. /**
  20969. * Specifies if back face culling is enabled
  20970. */
  20971. protected _backFaceCulling: boolean;
  20972. /**
  20973. * Sets the back-face culling state
  20974. */
  20975. /**
  20976. * Gets the back-face culling state
  20977. */
  20978. backFaceCulling: boolean;
  20979. /**
  20980. * Stores the value for side orientation
  20981. */
  20982. sideOrientation: number;
  20983. /**
  20984. * Callback triggered when the material is compiled
  20985. */
  20986. onCompiled: Nullable<(effect: Effect) => void>;
  20987. /**
  20988. * Callback triggered when an error occurs
  20989. */
  20990. onError: Nullable<(effect: Effect, errors: string) => void>;
  20991. /**
  20992. * Callback triggered to get the render target textures
  20993. */
  20994. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  20995. /**
  20996. * Gets a boolean indicating that current material needs to register RTT
  20997. */
  20998. readonly hasRenderTargetTextures: boolean;
  20999. /**
  21000. * Specifies if the material should be serialized
  21001. */
  21002. doNotSerialize: boolean;
  21003. /**
  21004. * @hidden
  21005. */
  21006. _storeEffectOnSubMeshes: boolean;
  21007. /**
  21008. * Stores the animations for the material
  21009. */
  21010. animations: Nullable<Array<Animation>>;
  21011. /**
  21012. * An event triggered when the material is disposed
  21013. */
  21014. onDisposeObservable: Observable<Material>;
  21015. /**
  21016. * An observer which watches for dispose events
  21017. */
  21018. private _onDisposeObserver;
  21019. private _onUnBindObservable;
  21020. /**
  21021. * Called during a dispose event
  21022. */
  21023. onDispose: () => void;
  21024. private _onBindObservable;
  21025. /**
  21026. * An event triggered when the material is bound
  21027. */
  21028. readonly onBindObservable: Observable<AbstractMesh>;
  21029. /**
  21030. * An observer which watches for bind events
  21031. */
  21032. private _onBindObserver;
  21033. /**
  21034. * Called during a bind event
  21035. */
  21036. onBind: (Mesh: AbstractMesh) => void;
  21037. /**
  21038. * An event triggered when the material is unbound
  21039. */
  21040. readonly onUnBindObservable: Observable<Material>;
  21041. /**
  21042. * Stores the value of the alpha mode
  21043. */
  21044. private _alphaMode;
  21045. /**
  21046. * Sets the value of the alpha mode.
  21047. *
  21048. * | Value | Type | Description |
  21049. * | --- | --- | --- |
  21050. * | 0 | ALPHA_DISABLE | |
  21051. * | 1 | ALPHA_ADD | |
  21052. * | 2 | ALPHA_COMBINE | |
  21053. * | 3 | ALPHA_SUBTRACT | |
  21054. * | 4 | ALPHA_MULTIPLY | |
  21055. * | 5 | ALPHA_MAXIMIZED | |
  21056. * | 6 | ALPHA_ONEONE | |
  21057. * | 7 | ALPHA_PREMULTIPLIED | |
  21058. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  21059. * | 9 | ALPHA_INTERPOLATE | |
  21060. * | 10 | ALPHA_SCREENMODE | |
  21061. *
  21062. */
  21063. /**
  21064. * Gets the value of the alpha mode
  21065. */
  21066. alphaMode: number;
  21067. /**
  21068. * Stores the state of the need depth pre-pass value
  21069. */
  21070. private _needDepthPrePass;
  21071. /**
  21072. * Sets the need depth pre-pass value
  21073. */
  21074. /**
  21075. * Gets the depth pre-pass value
  21076. */
  21077. needDepthPrePass: boolean;
  21078. /**
  21079. * Specifies if depth writing should be disabled
  21080. */
  21081. disableDepthWrite: boolean;
  21082. /**
  21083. * Specifies if depth writing should be forced
  21084. */
  21085. forceDepthWrite: boolean;
  21086. /**
  21087. * Specifies if there should be a separate pass for culling
  21088. */
  21089. separateCullingPass: boolean;
  21090. /**
  21091. * Stores the state specifing if fog should be enabled
  21092. */
  21093. private _fogEnabled;
  21094. /**
  21095. * Sets the state for enabling fog
  21096. */
  21097. /**
  21098. * Gets the value of the fog enabled state
  21099. */
  21100. fogEnabled: boolean;
  21101. /**
  21102. * Stores the size of points
  21103. */
  21104. pointSize: number;
  21105. /**
  21106. * Stores the z offset value
  21107. */
  21108. zOffset: number;
  21109. /**
  21110. * Gets a value specifying if wireframe mode is enabled
  21111. */
  21112. /**
  21113. * Sets the state of wireframe mode
  21114. */
  21115. wireframe: boolean;
  21116. /**
  21117. * Gets the value specifying if point clouds are enabled
  21118. */
  21119. /**
  21120. * Sets the state of point cloud mode
  21121. */
  21122. pointsCloud: boolean;
  21123. /**
  21124. * Gets the material fill mode
  21125. */
  21126. /**
  21127. * Sets the material fill mode
  21128. */
  21129. fillMode: number;
  21130. /**
  21131. * @hidden
  21132. * Stores the effects for the material
  21133. */
  21134. _effect: Nullable<Effect>;
  21135. /**
  21136. * @hidden
  21137. * Specifies if the material was previously ready
  21138. */
  21139. _wasPreviouslyReady: boolean;
  21140. /**
  21141. * Specifies if uniform buffers should be used
  21142. */
  21143. private _useUBO;
  21144. /**
  21145. * Stores a reference to the scene
  21146. */
  21147. private _scene;
  21148. /**
  21149. * Stores the fill mode state
  21150. */
  21151. private _fillMode;
  21152. /**
  21153. * Specifies if the depth write state should be cached
  21154. */
  21155. private _cachedDepthWriteState;
  21156. /**
  21157. * Stores the uniform buffer
  21158. */
  21159. protected _uniformBuffer: UniformBuffer;
  21160. /** @hidden */
  21161. _indexInSceneMaterialArray: number;
  21162. /** @hidden */
  21163. meshMap: Nullable<{
  21164. [id: string]: AbstractMesh | undefined;
  21165. }>;
  21166. /**
  21167. * Creates a material instance
  21168. * @param name defines the name of the material
  21169. * @param scene defines the scene to reference
  21170. * @param doNotAdd specifies if the material should be added to the scene
  21171. */
  21172. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  21173. /**
  21174. * Returns a string representation of the current material
  21175. * @param fullDetails defines a boolean indicating which levels of logging is desired
  21176. * @returns a string with material information
  21177. */
  21178. toString(fullDetails?: boolean): string;
  21179. /**
  21180. * Gets the class name of the material
  21181. * @returns a string with the class name of the material
  21182. */
  21183. getClassName(): string;
  21184. /**
  21185. * Specifies if updates for the material been locked
  21186. */
  21187. readonly isFrozen: boolean;
  21188. /**
  21189. * Locks updates for the material
  21190. */
  21191. freeze(): void;
  21192. /**
  21193. * Unlocks updates for the material
  21194. */
  21195. unfreeze(): void;
  21196. /**
  21197. * Specifies if the material is ready to be used
  21198. * @param mesh defines the mesh to check
  21199. * @param useInstances specifies if instances should be used
  21200. * @returns a boolean indicating if the material is ready to be used
  21201. */
  21202. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  21203. /**
  21204. * Specifies that the submesh is ready to be used
  21205. * @param mesh defines the mesh to check
  21206. * @param subMesh defines which submesh to check
  21207. * @param useInstances specifies that instances should be used
  21208. * @returns a boolean indicating that the submesh is ready or not
  21209. */
  21210. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21211. /**
  21212. * Returns the material effect
  21213. * @returns the effect associated with the material
  21214. */
  21215. getEffect(): Nullable<Effect>;
  21216. /**
  21217. * Returns the current scene
  21218. * @returns a Scene
  21219. */
  21220. getScene(): Scene;
  21221. /**
  21222. * Specifies if the material will require alpha blending
  21223. * @returns a boolean specifying if alpha blending is needed
  21224. */
  21225. needAlphaBlending(): boolean;
  21226. /**
  21227. * Specifies if the mesh will require alpha blending
  21228. * @param mesh defines the mesh to check
  21229. * @returns a boolean specifying if alpha blending is needed for the mesh
  21230. */
  21231. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  21232. /**
  21233. * Specifies if this material should be rendered in alpha test mode
  21234. * @returns a boolean specifying if an alpha test is needed.
  21235. */
  21236. needAlphaTesting(): boolean;
  21237. /**
  21238. * Gets the texture used for the alpha test
  21239. * @returns the texture to use for alpha testing
  21240. */
  21241. getAlphaTestTexture(): Nullable<BaseTexture>;
  21242. /**
  21243. * Marks the material to indicate that it needs to be re-calculated
  21244. */
  21245. markDirty(): void;
  21246. /** @hidden */
  21247. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  21248. /**
  21249. * Binds the material to the mesh
  21250. * @param world defines the world transformation matrix
  21251. * @param mesh defines the mesh to bind the material to
  21252. */
  21253. bind(world: Matrix, mesh?: Mesh): void;
  21254. /**
  21255. * Binds the submesh to the material
  21256. * @param world defines the world transformation matrix
  21257. * @param mesh defines the mesh containing the submesh
  21258. * @param subMesh defines the submesh to bind the material to
  21259. */
  21260. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  21261. /**
  21262. * Binds the world matrix to the material
  21263. * @param world defines the world transformation matrix
  21264. */
  21265. bindOnlyWorldMatrix(world: Matrix): void;
  21266. /**
  21267. * Binds the scene's uniform buffer to the effect.
  21268. * @param effect defines the effect to bind to the scene uniform buffer
  21269. * @param sceneUbo defines the uniform buffer storing scene data
  21270. */
  21271. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  21272. /**
  21273. * Binds the view matrix to the effect
  21274. * @param effect defines the effect to bind the view matrix to
  21275. */
  21276. bindView(effect: Effect): void;
  21277. /**
  21278. * Binds the view projection matrix to the effect
  21279. * @param effect defines the effect to bind the view projection matrix to
  21280. */
  21281. bindViewProjection(effect: Effect): void;
  21282. /**
  21283. * Specifies if material alpha testing should be turned on for the mesh
  21284. * @param mesh defines the mesh to check
  21285. */
  21286. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  21287. /**
  21288. * Processes to execute after binding the material to a mesh
  21289. * @param mesh defines the rendered mesh
  21290. */
  21291. protected _afterBind(mesh?: Mesh): void;
  21292. /**
  21293. * Unbinds the material from the mesh
  21294. */
  21295. unbind(): void;
  21296. /**
  21297. * Gets the active textures from the material
  21298. * @returns an array of textures
  21299. */
  21300. getActiveTextures(): BaseTexture[];
  21301. /**
  21302. * Specifies if the material uses a texture
  21303. * @param texture defines the texture to check against the material
  21304. * @returns a boolean specifying if the material uses the texture
  21305. */
  21306. hasTexture(texture: BaseTexture): boolean;
  21307. /**
  21308. * Makes a duplicate of the material, and gives it a new name
  21309. * @param name defines the new name for the duplicated material
  21310. * @returns the cloned material
  21311. */
  21312. clone(name: string): Nullable<Material>;
  21313. /**
  21314. * Gets the meshes bound to the material
  21315. * @returns an array of meshes bound to the material
  21316. */
  21317. getBindedMeshes(): AbstractMesh[];
  21318. /**
  21319. * Force shader compilation
  21320. * @param mesh defines the mesh associated with this material
  21321. * @param onCompiled defines a function to execute once the material is compiled
  21322. * @param options defines the options to configure the compilation
  21323. * @param onError defines a function to execute if the material fails compiling
  21324. */
  21325. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  21326. /**
  21327. * Force shader compilation
  21328. * @param mesh defines the mesh that will use this material
  21329. * @param options defines additional options for compiling the shaders
  21330. * @returns a promise that resolves when the compilation completes
  21331. */
  21332. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  21333. private static readonly _AllDirtyCallBack;
  21334. private static readonly _ImageProcessingDirtyCallBack;
  21335. private static readonly _TextureDirtyCallBack;
  21336. private static readonly _FresnelDirtyCallBack;
  21337. private static readonly _MiscDirtyCallBack;
  21338. private static readonly _LightsDirtyCallBack;
  21339. private static readonly _AttributeDirtyCallBack;
  21340. private static _FresnelAndMiscDirtyCallBack;
  21341. private static _TextureAndMiscDirtyCallBack;
  21342. private static readonly _DirtyCallbackArray;
  21343. private static readonly _RunDirtyCallBacks;
  21344. /**
  21345. * Marks a define in the material to indicate that it needs to be re-computed
  21346. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  21347. */
  21348. markAsDirty(flag: number): void;
  21349. /**
  21350. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  21351. * @param func defines a function which checks material defines against the submeshes
  21352. */
  21353. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  21354. /**
  21355. * Indicates that we need to re-calculated for all submeshes
  21356. */
  21357. protected _markAllSubMeshesAsAllDirty(): void;
  21358. /**
  21359. * Indicates that image processing needs to be re-calculated for all submeshes
  21360. */
  21361. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  21362. /**
  21363. * Indicates that textures need to be re-calculated for all submeshes
  21364. */
  21365. protected _markAllSubMeshesAsTexturesDirty(): void;
  21366. /**
  21367. * Indicates that fresnel needs to be re-calculated for all submeshes
  21368. */
  21369. protected _markAllSubMeshesAsFresnelDirty(): void;
  21370. /**
  21371. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  21372. */
  21373. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  21374. /**
  21375. * Indicates that lights need to be re-calculated for all submeshes
  21376. */
  21377. protected _markAllSubMeshesAsLightsDirty(): void;
  21378. /**
  21379. * Indicates that attributes need to be re-calculated for all submeshes
  21380. */
  21381. protected _markAllSubMeshesAsAttributesDirty(): void;
  21382. /**
  21383. * Indicates that misc needs to be re-calculated for all submeshes
  21384. */
  21385. protected _markAllSubMeshesAsMiscDirty(): void;
  21386. /**
  21387. * Indicates that textures and misc need to be re-calculated for all submeshes
  21388. */
  21389. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  21390. /**
  21391. * Disposes the material
  21392. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  21393. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  21394. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  21395. */
  21396. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  21397. /** @hidden */
  21398. private releaseVertexArrayObject;
  21399. /**
  21400. * Serializes this material
  21401. * @returns the serialized material object
  21402. */
  21403. serialize(): any;
  21404. /**
  21405. * Creates a material from parsed material data
  21406. * @param parsedMaterial defines parsed material data
  21407. * @param scene defines the hosting scene
  21408. * @param rootUrl defines the root URL to use to load textures
  21409. * @returns a new material
  21410. */
  21411. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  21412. }
  21413. }
  21414. declare module "babylonjs/Materials/multiMaterial" {
  21415. import { Nullable } from "babylonjs/types";
  21416. import { Scene } from "babylonjs/scene";
  21417. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21418. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  21419. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21420. import { Material } from "babylonjs/Materials/material";
  21421. /**
  21422. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21423. * separate meshes. This can be use to improve performances.
  21424. * @see http://doc.babylonjs.com/how_to/multi_materials
  21425. */
  21426. export class MultiMaterial extends Material {
  21427. private _subMaterials;
  21428. /**
  21429. * Gets or Sets the list of Materials used within the multi material.
  21430. * They need to be ordered according to the submeshes order in the associated mesh
  21431. */
  21432. subMaterials: Nullable<Material>[];
  21433. /**
  21434. * Function used to align with Node.getChildren()
  21435. * @returns the list of Materials used within the multi material
  21436. */
  21437. getChildren(): Nullable<Material>[];
  21438. /**
  21439. * Instantiates a new Multi Material
  21440. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21441. * separate meshes. This can be use to improve performances.
  21442. * @see http://doc.babylonjs.com/how_to/multi_materials
  21443. * @param name Define the name in the scene
  21444. * @param scene Define the scene the material belongs to
  21445. */
  21446. constructor(name: string, scene: Scene);
  21447. private _hookArray;
  21448. /**
  21449. * Get one of the submaterial by its index in the submaterials array
  21450. * @param index The index to look the sub material at
  21451. * @returns The Material if the index has been defined
  21452. */
  21453. getSubMaterial(index: number): Nullable<Material>;
  21454. /**
  21455. * Get the list of active textures for the whole sub materials list.
  21456. * @returns All the textures that will be used during the rendering
  21457. */
  21458. getActiveTextures(): BaseTexture[];
  21459. /**
  21460. * Gets the current class name of the material e.g. "MultiMaterial"
  21461. * Mainly use in serialization.
  21462. * @returns the class name
  21463. */
  21464. getClassName(): string;
  21465. /**
  21466. * Checks if the material is ready to render the requested sub mesh
  21467. * @param mesh Define the mesh the submesh belongs to
  21468. * @param subMesh Define the sub mesh to look readyness for
  21469. * @param useInstances Define whether or not the material is used with instances
  21470. * @returns true if ready, otherwise false
  21471. */
  21472. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21473. /**
  21474. * Clones the current material and its related sub materials
  21475. * @param name Define the name of the newly cloned material
  21476. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  21477. * @returns the cloned material
  21478. */
  21479. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  21480. /**
  21481. * Serializes the materials into a JSON representation.
  21482. * @returns the JSON representation
  21483. */
  21484. serialize(): any;
  21485. /**
  21486. * Dispose the material and release its associated resources
  21487. * @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)
  21488. * @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)
  21489. * @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)
  21490. */
  21491. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  21492. /**
  21493. * Creates a MultiMaterial from parsed MultiMaterial data.
  21494. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  21495. * @param scene defines the hosting scene
  21496. * @returns a new MultiMaterial
  21497. */
  21498. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  21499. }
  21500. }
  21501. declare module "babylonjs/Meshes/subMesh" {
  21502. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  21503. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  21504. import { Engine } from "babylonjs/Engines/engine";
  21505. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  21506. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21507. import { Effect } from "babylonjs/Materials/effect";
  21508. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21509. import { Plane } from "babylonjs/Maths/math.plane";
  21510. import { Collider } from "babylonjs/Collisions/collider";
  21511. import { Material } from "babylonjs/Materials/material";
  21512. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  21513. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21514. import { Mesh } from "babylonjs/Meshes/mesh";
  21515. import { Ray } from "babylonjs/Culling/ray";
  21516. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  21517. /**
  21518. * Base class for submeshes
  21519. */
  21520. export class BaseSubMesh {
  21521. /** @hidden */
  21522. _materialDefines: Nullable<MaterialDefines>;
  21523. /** @hidden */
  21524. _materialEffect: Nullable<Effect>;
  21525. /**
  21526. * Gets associated effect
  21527. */
  21528. readonly effect: Nullable<Effect>;
  21529. /**
  21530. * Sets associated effect (effect used to render this submesh)
  21531. * @param effect defines the effect to associate with
  21532. * @param defines defines the set of defines used to compile this effect
  21533. */
  21534. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  21535. }
  21536. /**
  21537. * Defines a subdivision inside a mesh
  21538. */
  21539. export class SubMesh extends BaseSubMesh implements ICullable {
  21540. /** the material index to use */
  21541. materialIndex: number;
  21542. /** vertex index start */
  21543. verticesStart: number;
  21544. /** vertices count */
  21545. verticesCount: number;
  21546. /** index start */
  21547. indexStart: number;
  21548. /** indices count */
  21549. indexCount: number;
  21550. /** @hidden */
  21551. _linesIndexCount: number;
  21552. private _mesh;
  21553. private _renderingMesh;
  21554. private _boundingInfo;
  21555. private _linesIndexBuffer;
  21556. /** @hidden */
  21557. _lastColliderWorldVertices: Nullable<Vector3[]>;
  21558. /** @hidden */
  21559. _trianglePlanes: Plane[];
  21560. /** @hidden */
  21561. _lastColliderTransformMatrix: Nullable<Matrix>;
  21562. /** @hidden */
  21563. _renderId: number;
  21564. /** @hidden */
  21565. _alphaIndex: number;
  21566. /** @hidden */
  21567. _distanceToCamera: number;
  21568. /** @hidden */
  21569. _id: number;
  21570. private _currentMaterial;
  21571. /**
  21572. * Add a new submesh to a mesh
  21573. * @param materialIndex defines the material index to use
  21574. * @param verticesStart defines vertex index start
  21575. * @param verticesCount defines vertices count
  21576. * @param indexStart defines index start
  21577. * @param indexCount defines indices count
  21578. * @param mesh defines the parent mesh
  21579. * @param renderingMesh defines an optional rendering mesh
  21580. * @param createBoundingBox defines if bounding box should be created for this submesh
  21581. * @returns the new submesh
  21582. */
  21583. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  21584. /**
  21585. * Creates a new submesh
  21586. * @param materialIndex defines the material index to use
  21587. * @param verticesStart defines vertex index start
  21588. * @param verticesCount defines vertices count
  21589. * @param indexStart defines index start
  21590. * @param indexCount defines indices count
  21591. * @param mesh defines the parent mesh
  21592. * @param renderingMesh defines an optional rendering mesh
  21593. * @param createBoundingBox defines if bounding box should be created for this submesh
  21594. */
  21595. constructor(
  21596. /** the material index to use */
  21597. materialIndex: number,
  21598. /** vertex index start */
  21599. verticesStart: number,
  21600. /** vertices count */
  21601. verticesCount: number,
  21602. /** index start */
  21603. indexStart: number,
  21604. /** indices count */
  21605. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  21606. /**
  21607. * Returns true if this submesh covers the entire parent mesh
  21608. * @ignorenaming
  21609. */
  21610. readonly IsGlobal: boolean;
  21611. /**
  21612. * Returns the submesh BoudingInfo object
  21613. * @returns current bounding info (or mesh's one if the submesh is global)
  21614. */
  21615. getBoundingInfo(): BoundingInfo;
  21616. /**
  21617. * Sets the submesh BoundingInfo
  21618. * @param boundingInfo defines the new bounding info to use
  21619. * @returns the SubMesh
  21620. */
  21621. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  21622. /**
  21623. * Returns the mesh of the current submesh
  21624. * @return the parent mesh
  21625. */
  21626. getMesh(): AbstractMesh;
  21627. /**
  21628. * Returns the rendering mesh of the submesh
  21629. * @returns the rendering mesh (could be different from parent mesh)
  21630. */
  21631. getRenderingMesh(): Mesh;
  21632. /**
  21633. * Returns the submesh material
  21634. * @returns null or the current material
  21635. */
  21636. getMaterial(): Nullable<Material>;
  21637. /**
  21638. * Sets a new updated BoundingInfo object to the submesh
  21639. * @param data defines an optional position array to use to determine the bounding info
  21640. * @returns the SubMesh
  21641. */
  21642. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  21643. /** @hidden */
  21644. _checkCollision(collider: Collider): boolean;
  21645. /**
  21646. * Updates the submesh BoundingInfo
  21647. * @param world defines the world matrix to use to update the bounding info
  21648. * @returns the submesh
  21649. */
  21650. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  21651. /**
  21652. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  21653. * @param frustumPlanes defines the frustum planes
  21654. * @returns true if the submesh is intersecting with the frustum
  21655. */
  21656. isInFrustum(frustumPlanes: Plane[]): boolean;
  21657. /**
  21658. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  21659. * @param frustumPlanes defines the frustum planes
  21660. * @returns true if the submesh is inside the frustum
  21661. */
  21662. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  21663. /**
  21664. * Renders the submesh
  21665. * @param enableAlphaMode defines if alpha needs to be used
  21666. * @returns the submesh
  21667. */
  21668. render(enableAlphaMode: boolean): SubMesh;
  21669. /**
  21670. * @hidden
  21671. */
  21672. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  21673. /**
  21674. * Checks if the submesh intersects with a ray
  21675. * @param ray defines the ray to test
  21676. * @returns true is the passed ray intersects the submesh bounding box
  21677. */
  21678. canIntersects(ray: Ray): boolean;
  21679. /**
  21680. * Intersects current submesh with a ray
  21681. * @param ray defines the ray to test
  21682. * @param positions defines mesh's positions array
  21683. * @param indices defines mesh's indices array
  21684. * @param fastCheck defines if only bounding info should be used
  21685. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  21686. * @returns intersection info or null if no intersection
  21687. */
  21688. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  21689. /** @hidden */
  21690. private _intersectLines;
  21691. /** @hidden */
  21692. private _intersectUnIndexedLines;
  21693. /** @hidden */
  21694. private _intersectTriangles;
  21695. /** @hidden */
  21696. private _intersectUnIndexedTriangles;
  21697. /** @hidden */
  21698. _rebuild(): void;
  21699. /**
  21700. * Creates a new submesh from the passed mesh
  21701. * @param newMesh defines the new hosting mesh
  21702. * @param newRenderingMesh defines an optional rendering mesh
  21703. * @returns the new submesh
  21704. */
  21705. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  21706. /**
  21707. * Release associated resources
  21708. */
  21709. dispose(): void;
  21710. /**
  21711. * Gets the class name
  21712. * @returns the string "SubMesh".
  21713. */
  21714. getClassName(): string;
  21715. /**
  21716. * Creates a new submesh from indices data
  21717. * @param materialIndex the index of the main mesh material
  21718. * @param startIndex the index where to start the copy in the mesh indices array
  21719. * @param indexCount the number of indices to copy then from the startIndex
  21720. * @param mesh the main mesh to create the submesh from
  21721. * @param renderingMesh the optional rendering mesh
  21722. * @returns a new submesh
  21723. */
  21724. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  21725. }
  21726. }
  21727. declare module "babylonjs/Loading/sceneLoaderFlags" {
  21728. /**
  21729. * Class used to represent data loading progression
  21730. */
  21731. export class SceneLoaderFlags {
  21732. private static _ForceFullSceneLoadingForIncremental;
  21733. private static _ShowLoadingScreen;
  21734. private static _CleanBoneMatrixWeights;
  21735. private static _loggingLevel;
  21736. /**
  21737. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  21738. */
  21739. static ForceFullSceneLoadingForIncremental: boolean;
  21740. /**
  21741. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  21742. */
  21743. static ShowLoadingScreen: boolean;
  21744. /**
  21745. * Defines the current logging level (while loading the scene)
  21746. * @ignorenaming
  21747. */
  21748. static loggingLevel: number;
  21749. /**
  21750. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  21751. */
  21752. static CleanBoneMatrixWeights: boolean;
  21753. }
  21754. }
  21755. declare module "babylonjs/Meshes/geometry" {
  21756. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  21757. import { Scene } from "babylonjs/scene";
  21758. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  21759. import { Engine } from "babylonjs/Engines/engine";
  21760. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  21761. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  21762. import { Effect } from "babylonjs/Materials/effect";
  21763. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21764. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21765. import { Mesh } from "babylonjs/Meshes/mesh";
  21766. /**
  21767. * Class used to store geometry data (vertex buffers + index buffer)
  21768. */
  21769. export class Geometry implements IGetSetVerticesData {
  21770. /**
  21771. * Gets or sets the ID of the geometry
  21772. */
  21773. id: string;
  21774. /**
  21775. * Gets or sets the unique ID of the geometry
  21776. */
  21777. uniqueId: number;
  21778. /**
  21779. * Gets the delay loading state of the geometry (none by default which means not delayed)
  21780. */
  21781. delayLoadState: number;
  21782. /**
  21783. * Gets the file containing the data to load when running in delay load state
  21784. */
  21785. delayLoadingFile: Nullable<string>;
  21786. /**
  21787. * Callback called when the geometry is updated
  21788. */
  21789. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  21790. private _scene;
  21791. private _engine;
  21792. private _meshes;
  21793. private _totalVertices;
  21794. /** @hidden */
  21795. _indices: IndicesArray;
  21796. /** @hidden */
  21797. _vertexBuffers: {
  21798. [key: string]: VertexBuffer;
  21799. };
  21800. private _isDisposed;
  21801. private _extend;
  21802. private _boundingBias;
  21803. /** @hidden */
  21804. _delayInfo: Array<string>;
  21805. private _indexBuffer;
  21806. private _indexBufferIsUpdatable;
  21807. /** @hidden */
  21808. _boundingInfo: Nullable<BoundingInfo>;
  21809. /** @hidden */
  21810. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  21811. /** @hidden */
  21812. _softwareSkinningFrameId: number;
  21813. private _vertexArrayObjects;
  21814. private _updatable;
  21815. /** @hidden */
  21816. _positions: Nullable<Vector3[]>;
  21817. /**
  21818. * 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
  21819. */
  21820. /**
  21821. * 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
  21822. */
  21823. boundingBias: Vector2;
  21824. /**
  21825. * Static function used to attach a new empty geometry to a mesh
  21826. * @param mesh defines the mesh to attach the geometry to
  21827. * @returns the new Geometry
  21828. */
  21829. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  21830. /**
  21831. * Creates a new geometry
  21832. * @param id defines the unique ID
  21833. * @param scene defines the hosting scene
  21834. * @param vertexData defines the VertexData used to get geometry data
  21835. * @param updatable defines if geometry must be updatable (false by default)
  21836. * @param mesh defines the mesh that will be associated with the geometry
  21837. */
  21838. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  21839. /**
  21840. * Gets the current extend of the geometry
  21841. */
  21842. readonly extend: {
  21843. minimum: Vector3;
  21844. maximum: Vector3;
  21845. };
  21846. /**
  21847. * Gets the hosting scene
  21848. * @returns the hosting Scene
  21849. */
  21850. getScene(): Scene;
  21851. /**
  21852. * Gets the hosting engine
  21853. * @returns the hosting Engine
  21854. */
  21855. getEngine(): Engine;
  21856. /**
  21857. * Defines if the geometry is ready to use
  21858. * @returns true if the geometry is ready to be used
  21859. */
  21860. isReady(): boolean;
  21861. /**
  21862. * Gets a value indicating that the geometry should not be serialized
  21863. */
  21864. readonly doNotSerialize: boolean;
  21865. /** @hidden */
  21866. _rebuild(): void;
  21867. /**
  21868. * Affects all geometry data in one call
  21869. * @param vertexData defines the geometry data
  21870. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  21871. */
  21872. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  21873. /**
  21874. * Set specific vertex data
  21875. * @param kind defines the data kind (Position, normal, etc...)
  21876. * @param data defines the vertex data to use
  21877. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  21878. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  21879. */
  21880. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  21881. /**
  21882. * Removes a specific vertex data
  21883. * @param kind defines the data kind (Position, normal, etc...)
  21884. */
  21885. removeVerticesData(kind: string): void;
  21886. /**
  21887. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  21888. * @param buffer defines the vertex buffer to use
  21889. * @param totalVertices defines the total number of vertices for position kind (could be null)
  21890. */
  21891. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  21892. /**
  21893. * Update a specific vertex buffer
  21894. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  21895. * It will do nothing if the buffer is not updatable
  21896. * @param kind defines the data kind (Position, normal, etc...)
  21897. * @param data defines the data to use
  21898. * @param offset defines the offset in the target buffer where to store the data
  21899. * @param useBytes set to true if the offset is in bytes
  21900. */
  21901. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  21902. /**
  21903. * Update a specific vertex buffer
  21904. * This function will create a new buffer if the current one is not updatable
  21905. * @param kind defines the data kind (Position, normal, etc...)
  21906. * @param data defines the data to use
  21907. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  21908. */
  21909. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  21910. private _updateBoundingInfo;
  21911. /** @hidden */
  21912. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  21913. /**
  21914. * Gets total number of vertices
  21915. * @returns the total number of vertices
  21916. */
  21917. getTotalVertices(): number;
  21918. /**
  21919. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  21920. * @param kind defines the data kind (Position, normal, etc...)
  21921. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  21922. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21923. * @returns a float array containing vertex data
  21924. */
  21925. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  21926. /**
  21927. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  21928. * @param kind defines the data kind (Position, normal, etc...)
  21929. * @returns true if the vertex buffer with the specified kind is updatable
  21930. */
  21931. isVertexBufferUpdatable(kind: string): boolean;
  21932. /**
  21933. * Gets a specific vertex buffer
  21934. * @param kind defines the data kind (Position, normal, etc...)
  21935. * @returns a VertexBuffer
  21936. */
  21937. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  21938. /**
  21939. * Returns all vertex buffers
  21940. * @return an object holding all vertex buffers indexed by kind
  21941. */
  21942. getVertexBuffers(): Nullable<{
  21943. [key: string]: VertexBuffer;
  21944. }>;
  21945. /**
  21946. * Gets a boolean indicating if specific vertex buffer is present
  21947. * @param kind defines the data kind (Position, normal, etc...)
  21948. * @returns true if data is present
  21949. */
  21950. isVerticesDataPresent(kind: string): boolean;
  21951. /**
  21952. * Gets a list of all attached data kinds (Position, normal, etc...)
  21953. * @returns a list of string containing all kinds
  21954. */
  21955. getVerticesDataKinds(): string[];
  21956. /**
  21957. * Update index buffer
  21958. * @param indices defines the indices to store in the index buffer
  21959. * @param offset defines the offset in the target buffer where to store the data
  21960. * @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)
  21961. */
  21962. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  21963. /**
  21964. * Creates a new index buffer
  21965. * @param indices defines the indices to store in the index buffer
  21966. * @param totalVertices defines the total number of vertices (could be null)
  21967. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  21968. */
  21969. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  21970. /**
  21971. * Return the total number of indices
  21972. * @returns the total number of indices
  21973. */
  21974. getTotalIndices(): number;
  21975. /**
  21976. * Gets the index buffer array
  21977. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  21978. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21979. * @returns the index buffer array
  21980. */
  21981. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  21982. /**
  21983. * Gets the index buffer
  21984. * @return the index buffer
  21985. */
  21986. getIndexBuffer(): Nullable<DataBuffer>;
  21987. /** @hidden */
  21988. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  21989. /**
  21990. * Release the associated resources for a specific mesh
  21991. * @param mesh defines the source mesh
  21992. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  21993. */
  21994. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  21995. /**
  21996. * Apply current geometry to a given mesh
  21997. * @param mesh defines the mesh to apply geometry to
  21998. */
  21999. applyToMesh(mesh: Mesh): void;
  22000. private _updateExtend;
  22001. private _applyToMesh;
  22002. private notifyUpdate;
  22003. /**
  22004. * Load the geometry if it was flagged as delay loaded
  22005. * @param scene defines the hosting scene
  22006. * @param onLoaded defines a callback called when the geometry is loaded
  22007. */
  22008. load(scene: Scene, onLoaded?: () => void): void;
  22009. private _queueLoad;
  22010. /**
  22011. * Invert the geometry to move from a right handed system to a left handed one.
  22012. */
  22013. toLeftHanded(): void;
  22014. /** @hidden */
  22015. _resetPointsArrayCache(): void;
  22016. /** @hidden */
  22017. _generatePointsArray(): boolean;
  22018. /**
  22019. * Gets a value indicating if the geometry is disposed
  22020. * @returns true if the geometry was disposed
  22021. */
  22022. isDisposed(): boolean;
  22023. private _disposeVertexArrayObjects;
  22024. /**
  22025. * Free all associated resources
  22026. */
  22027. dispose(): void;
  22028. /**
  22029. * Clone the current geometry into a new geometry
  22030. * @param id defines the unique ID of the new geometry
  22031. * @returns a new geometry object
  22032. */
  22033. copy(id: string): Geometry;
  22034. /**
  22035. * Serialize the current geometry info (and not the vertices data) into a JSON object
  22036. * @return a JSON representation of the current geometry data (without the vertices data)
  22037. */
  22038. serialize(): any;
  22039. private toNumberArray;
  22040. /**
  22041. * Serialize all vertices data into a JSON oject
  22042. * @returns a JSON representation of the current geometry data
  22043. */
  22044. serializeVerticeData(): any;
  22045. /**
  22046. * Extracts a clone of a mesh geometry
  22047. * @param mesh defines the source mesh
  22048. * @param id defines the unique ID of the new geometry object
  22049. * @returns the new geometry object
  22050. */
  22051. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  22052. /**
  22053. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  22054. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  22055. * Be aware Math.random() could cause collisions, but:
  22056. * "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"
  22057. * @returns a string containing a new GUID
  22058. */
  22059. static RandomId(): string;
  22060. /** @hidden */
  22061. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  22062. private static _CleanMatricesWeights;
  22063. /**
  22064. * Create a new geometry from persisted data (Using .babylon file format)
  22065. * @param parsedVertexData defines the persisted data
  22066. * @param scene defines the hosting scene
  22067. * @param rootUrl defines the root url to use to load assets (like delayed data)
  22068. * @returns the new geometry object
  22069. */
  22070. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  22071. }
  22072. }
  22073. declare module "babylonjs/Meshes/mesh.vertexData" {
  22074. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  22075. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  22076. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  22077. import { Geometry } from "babylonjs/Meshes/geometry";
  22078. import { Mesh } from "babylonjs/Meshes/mesh";
  22079. /**
  22080. * Define an interface for all classes that will get and set the data on vertices
  22081. */
  22082. export interface IGetSetVerticesData {
  22083. /**
  22084. * Gets a boolean indicating if specific vertex data is present
  22085. * @param kind defines the vertex data kind to use
  22086. * @returns true is data kind is present
  22087. */
  22088. isVerticesDataPresent(kind: string): boolean;
  22089. /**
  22090. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  22091. * @param kind defines the data kind (Position, normal, etc...)
  22092. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  22093. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22094. * @returns a float array containing vertex data
  22095. */
  22096. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  22097. /**
  22098. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  22099. * @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.
  22100. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22101. * @returns the indices array or an empty array if the mesh has no geometry
  22102. */
  22103. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  22104. /**
  22105. * Set specific vertex data
  22106. * @param kind defines the data kind (Position, normal, etc...)
  22107. * @param data defines the vertex data to use
  22108. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  22109. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  22110. */
  22111. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  22112. /**
  22113. * Update a specific associated vertex buffer
  22114. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  22115. * - VertexBuffer.PositionKind
  22116. * - VertexBuffer.UVKind
  22117. * - VertexBuffer.UV2Kind
  22118. * - VertexBuffer.UV3Kind
  22119. * - VertexBuffer.UV4Kind
  22120. * - VertexBuffer.UV5Kind
  22121. * - VertexBuffer.UV6Kind
  22122. * - VertexBuffer.ColorKind
  22123. * - VertexBuffer.MatricesIndicesKind
  22124. * - VertexBuffer.MatricesIndicesExtraKind
  22125. * - VertexBuffer.MatricesWeightsKind
  22126. * - VertexBuffer.MatricesWeightsExtraKind
  22127. * @param data defines the data source
  22128. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  22129. * @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)
  22130. */
  22131. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  22132. /**
  22133. * Creates a new index buffer
  22134. * @param indices defines the indices to store in the index buffer
  22135. * @param totalVertices defines the total number of vertices (could be null)
  22136. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  22137. */
  22138. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  22139. }
  22140. /**
  22141. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  22142. */
  22143. export class VertexData {
  22144. /**
  22145. * Mesh side orientation : usually the external or front surface
  22146. */
  22147. static readonly FRONTSIDE: number;
  22148. /**
  22149. * Mesh side orientation : usually the internal or back surface
  22150. */
  22151. static readonly BACKSIDE: number;
  22152. /**
  22153. * Mesh side orientation : both internal and external or front and back surfaces
  22154. */
  22155. static readonly DOUBLESIDE: number;
  22156. /**
  22157. * Mesh side orientation : by default, `FRONTSIDE`
  22158. */
  22159. static readonly DEFAULTSIDE: number;
  22160. /**
  22161. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  22162. */
  22163. positions: Nullable<FloatArray>;
  22164. /**
  22165. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  22166. */
  22167. normals: Nullable<FloatArray>;
  22168. /**
  22169. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  22170. */
  22171. tangents: Nullable<FloatArray>;
  22172. /**
  22173. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22174. */
  22175. uvs: Nullable<FloatArray>;
  22176. /**
  22177. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22178. */
  22179. uvs2: Nullable<FloatArray>;
  22180. /**
  22181. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22182. */
  22183. uvs3: Nullable<FloatArray>;
  22184. /**
  22185. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22186. */
  22187. uvs4: Nullable<FloatArray>;
  22188. /**
  22189. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22190. */
  22191. uvs5: Nullable<FloatArray>;
  22192. /**
  22193. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22194. */
  22195. uvs6: Nullable<FloatArray>;
  22196. /**
  22197. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  22198. */
  22199. colors: Nullable<FloatArray>;
  22200. /**
  22201. * 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).
  22202. */
  22203. matricesIndices: Nullable<FloatArray>;
  22204. /**
  22205. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  22206. */
  22207. matricesWeights: Nullable<FloatArray>;
  22208. /**
  22209. * An array extending the number of possible indices
  22210. */
  22211. matricesIndicesExtra: Nullable<FloatArray>;
  22212. /**
  22213. * An array extending the number of possible weights when the number of indices is extended
  22214. */
  22215. matricesWeightsExtra: Nullable<FloatArray>;
  22216. /**
  22217. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  22218. */
  22219. indices: Nullable<IndicesArray>;
  22220. /**
  22221. * Uses the passed data array to set the set the values for the specified kind of data
  22222. * @param data a linear array of floating numbers
  22223. * @param kind the type of data that is being set, eg positions, colors etc
  22224. */
  22225. set(data: FloatArray, kind: string): void;
  22226. /**
  22227. * Associates the vertexData to the passed Mesh.
  22228. * Sets it as updatable or not (default `false`)
  22229. * @param mesh the mesh the vertexData is applied to
  22230. * @param updatable when used and having the value true allows new data to update the vertexData
  22231. * @returns the VertexData
  22232. */
  22233. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  22234. /**
  22235. * Associates the vertexData to the passed Geometry.
  22236. * Sets it as updatable or not (default `false`)
  22237. * @param geometry the geometry the vertexData is applied to
  22238. * @param updatable when used and having the value true allows new data to update the vertexData
  22239. * @returns VertexData
  22240. */
  22241. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  22242. /**
  22243. * Updates the associated mesh
  22244. * @param mesh the mesh to be updated
  22245. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  22246. * @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
  22247. * @returns VertexData
  22248. */
  22249. updateMesh(mesh: Mesh): VertexData;
  22250. /**
  22251. * Updates the associated geometry
  22252. * @param geometry the geometry to be updated
  22253. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  22254. * @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
  22255. * @returns VertexData.
  22256. */
  22257. updateGeometry(geometry: Geometry): VertexData;
  22258. private _applyTo;
  22259. private _update;
  22260. /**
  22261. * Transforms each position and each normal of the vertexData according to the passed Matrix
  22262. * @param matrix the transforming matrix
  22263. * @returns the VertexData
  22264. */
  22265. transform(matrix: Matrix): VertexData;
  22266. /**
  22267. * Merges the passed VertexData into the current one
  22268. * @param other the VertexData to be merged into the current one
  22269. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  22270. * @returns the modified VertexData
  22271. */
  22272. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  22273. private _mergeElement;
  22274. private _validate;
  22275. /**
  22276. * Serializes the VertexData
  22277. * @returns a serialized object
  22278. */
  22279. serialize(): any;
  22280. /**
  22281. * Extracts the vertexData from a mesh
  22282. * @param mesh the mesh from which to extract the VertexData
  22283. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  22284. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  22285. * @returns the object VertexData associated to the passed mesh
  22286. */
  22287. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  22288. /**
  22289. * Extracts the vertexData from the geometry
  22290. * @param geometry the geometry from which to extract the VertexData
  22291. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  22292. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  22293. * @returns the object VertexData associated to the passed mesh
  22294. */
  22295. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  22296. private static _ExtractFrom;
  22297. /**
  22298. * Creates the VertexData for a Ribbon
  22299. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  22300. * * pathArray array of paths, each of which an array of successive Vector3
  22301. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  22302. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  22303. * * 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
  22304. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22305. * * 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)
  22306. * * 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)
  22307. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  22308. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  22309. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  22310. * @returns the VertexData of the ribbon
  22311. */
  22312. static CreateRibbon(options: {
  22313. pathArray: Vector3[][];
  22314. closeArray?: boolean;
  22315. closePath?: boolean;
  22316. offset?: number;
  22317. sideOrientation?: number;
  22318. frontUVs?: Vector4;
  22319. backUVs?: Vector4;
  22320. invertUV?: boolean;
  22321. uvs?: Vector2[];
  22322. colors?: Color4[];
  22323. }): VertexData;
  22324. /**
  22325. * Creates the VertexData for a box
  22326. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22327. * * size sets the width, height and depth of the box to the value of size, optional default 1
  22328. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  22329. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  22330. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  22331. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22332. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22333. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22334. * * 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)
  22335. * * 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)
  22336. * @returns the VertexData of the box
  22337. */
  22338. static CreateBox(options: {
  22339. size?: number;
  22340. width?: number;
  22341. height?: number;
  22342. depth?: number;
  22343. faceUV?: Vector4[];
  22344. faceColors?: Color4[];
  22345. sideOrientation?: number;
  22346. frontUVs?: Vector4;
  22347. backUVs?: Vector4;
  22348. }): VertexData;
  22349. /**
  22350. * Creates the VertexData for a tiled box
  22351. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22352. * * faceTiles sets the pattern, tile size and number of tiles for a face
  22353. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22354. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22355. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22356. * @returns the VertexData of the box
  22357. */
  22358. static CreateTiledBox(options: {
  22359. pattern?: number;
  22360. width?: number;
  22361. height?: number;
  22362. depth?: number;
  22363. tileSize?: number;
  22364. tileWidth?: number;
  22365. tileHeight?: number;
  22366. alignHorizontal?: number;
  22367. alignVertical?: number;
  22368. faceUV?: Vector4[];
  22369. faceColors?: Color4[];
  22370. sideOrientation?: number;
  22371. }): VertexData;
  22372. /**
  22373. * Creates the VertexData for a tiled plane
  22374. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22375. * * pattern a limited pattern arrangement depending on the number
  22376. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  22377. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  22378. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  22379. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22380. * * 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)
  22381. * * 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)
  22382. * @returns the VertexData of the tiled plane
  22383. */
  22384. static CreateTiledPlane(options: {
  22385. pattern?: number;
  22386. tileSize?: number;
  22387. tileWidth?: number;
  22388. tileHeight?: number;
  22389. size?: number;
  22390. width?: number;
  22391. height?: number;
  22392. alignHorizontal?: number;
  22393. alignVertical?: number;
  22394. sideOrientation?: number;
  22395. frontUVs?: Vector4;
  22396. backUVs?: Vector4;
  22397. }): VertexData;
  22398. /**
  22399. * Creates the VertexData for an ellipsoid, defaults to a sphere
  22400. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22401. * * segments sets the number of horizontal strips optional, default 32
  22402. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  22403. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  22404. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  22405. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  22406. * * 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
  22407. * * 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
  22408. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22409. * * 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)
  22410. * * 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)
  22411. * @returns the VertexData of the ellipsoid
  22412. */
  22413. static CreateSphere(options: {
  22414. segments?: number;
  22415. diameter?: number;
  22416. diameterX?: number;
  22417. diameterY?: number;
  22418. diameterZ?: number;
  22419. arc?: number;
  22420. slice?: number;
  22421. sideOrientation?: number;
  22422. frontUVs?: Vector4;
  22423. backUVs?: Vector4;
  22424. }): VertexData;
  22425. /**
  22426. * Creates the VertexData for a cylinder, cone or prism
  22427. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22428. * * height sets the height (y direction) of the cylinder, optional, default 2
  22429. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  22430. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  22431. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  22432. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22433. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  22434. * * 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
  22435. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22436. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22437. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  22438. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  22439. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22440. * * 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)
  22441. * * 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)
  22442. * @returns the VertexData of the cylinder, cone or prism
  22443. */
  22444. static CreateCylinder(options: {
  22445. height?: number;
  22446. diameterTop?: number;
  22447. diameterBottom?: number;
  22448. diameter?: number;
  22449. tessellation?: number;
  22450. subdivisions?: number;
  22451. arc?: number;
  22452. faceColors?: Color4[];
  22453. faceUV?: Vector4[];
  22454. hasRings?: boolean;
  22455. enclose?: boolean;
  22456. sideOrientation?: number;
  22457. frontUVs?: Vector4;
  22458. backUVs?: Vector4;
  22459. }): VertexData;
  22460. /**
  22461. * Creates the VertexData for a torus
  22462. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22463. * * diameter the diameter of the torus, optional default 1
  22464. * * thickness the diameter of the tube forming the torus, optional default 0.5
  22465. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22466. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22467. * * 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)
  22468. * * 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)
  22469. * @returns the VertexData of the torus
  22470. */
  22471. static CreateTorus(options: {
  22472. diameter?: number;
  22473. thickness?: number;
  22474. tessellation?: number;
  22475. sideOrientation?: number;
  22476. frontUVs?: Vector4;
  22477. backUVs?: Vector4;
  22478. }): VertexData;
  22479. /**
  22480. * Creates the VertexData of the LineSystem
  22481. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  22482. * - lines an array of lines, each line being an array of successive Vector3
  22483. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  22484. * @returns the VertexData of the LineSystem
  22485. */
  22486. static CreateLineSystem(options: {
  22487. lines: Vector3[][];
  22488. colors?: Nullable<Color4[][]>;
  22489. }): VertexData;
  22490. /**
  22491. * Create the VertexData for a DashedLines
  22492. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  22493. * - points an array successive Vector3
  22494. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  22495. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  22496. * - dashNb the intended total number of dashes, optional, default 200
  22497. * @returns the VertexData for the DashedLines
  22498. */
  22499. static CreateDashedLines(options: {
  22500. points: Vector3[];
  22501. dashSize?: number;
  22502. gapSize?: number;
  22503. dashNb?: number;
  22504. }): VertexData;
  22505. /**
  22506. * Creates the VertexData for a Ground
  22507. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22508. * - width the width (x direction) of the ground, optional, default 1
  22509. * - height the height (z direction) of the ground, optional, default 1
  22510. * - subdivisions the number of subdivisions per side, optional, default 1
  22511. * @returns the VertexData of the Ground
  22512. */
  22513. static CreateGround(options: {
  22514. width?: number;
  22515. height?: number;
  22516. subdivisions?: number;
  22517. subdivisionsX?: number;
  22518. subdivisionsY?: number;
  22519. }): VertexData;
  22520. /**
  22521. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  22522. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22523. * * xmin the ground minimum X coordinate, optional, default -1
  22524. * * zmin the ground minimum Z coordinate, optional, default -1
  22525. * * xmax the ground maximum X coordinate, optional, default 1
  22526. * * zmax the ground maximum Z coordinate, optional, default 1
  22527. * * 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}
  22528. * * 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}
  22529. * @returns the VertexData of the TiledGround
  22530. */
  22531. static CreateTiledGround(options: {
  22532. xmin: number;
  22533. zmin: number;
  22534. xmax: number;
  22535. zmax: number;
  22536. subdivisions?: {
  22537. w: number;
  22538. h: number;
  22539. };
  22540. precision?: {
  22541. w: number;
  22542. h: number;
  22543. };
  22544. }): VertexData;
  22545. /**
  22546. * Creates the VertexData of the Ground designed from a heightmap
  22547. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  22548. * * width the width (x direction) of the ground
  22549. * * height the height (z direction) of the ground
  22550. * * subdivisions the number of subdivisions per side
  22551. * * minHeight the minimum altitude on the ground, optional, default 0
  22552. * * maxHeight the maximum altitude on the ground, optional default 1
  22553. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  22554. * * buffer the array holding the image color data
  22555. * * bufferWidth the width of image
  22556. * * bufferHeight the height of image
  22557. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  22558. * @returns the VertexData of the Ground designed from a heightmap
  22559. */
  22560. static CreateGroundFromHeightMap(options: {
  22561. width: number;
  22562. height: number;
  22563. subdivisions: number;
  22564. minHeight: number;
  22565. maxHeight: number;
  22566. colorFilter: Color3;
  22567. buffer: Uint8Array;
  22568. bufferWidth: number;
  22569. bufferHeight: number;
  22570. alphaFilter: number;
  22571. }): VertexData;
  22572. /**
  22573. * Creates the VertexData for a Plane
  22574. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  22575. * * size sets the width and height of the plane to the value of size, optional default 1
  22576. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  22577. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  22578. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22579. * * 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)
  22580. * * 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)
  22581. * @returns the VertexData of the box
  22582. */
  22583. static CreatePlane(options: {
  22584. size?: number;
  22585. width?: number;
  22586. height?: number;
  22587. sideOrientation?: number;
  22588. frontUVs?: Vector4;
  22589. backUVs?: Vector4;
  22590. }): VertexData;
  22591. /**
  22592. * Creates the VertexData of the Disc or regular Polygon
  22593. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  22594. * * radius the radius of the disc, optional default 0.5
  22595. * * tessellation the number of polygon sides, optional, default 64
  22596. * * 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
  22597. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22598. * * 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)
  22599. * * 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)
  22600. * @returns the VertexData of the box
  22601. */
  22602. static CreateDisc(options: {
  22603. radius?: number;
  22604. tessellation?: number;
  22605. arc?: number;
  22606. sideOrientation?: number;
  22607. frontUVs?: Vector4;
  22608. backUVs?: Vector4;
  22609. }): VertexData;
  22610. /**
  22611. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  22612. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  22613. * @param polygon a mesh built from polygonTriangulation.build()
  22614. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22615. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22616. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22617. * @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)
  22618. * @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)
  22619. * @returns the VertexData of the Polygon
  22620. */
  22621. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  22622. /**
  22623. * Creates the VertexData of the IcoSphere
  22624. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  22625. * * radius the radius of the IcoSphere, optional default 1
  22626. * * radiusX allows stretching in the x direction, optional, default radius
  22627. * * radiusY allows stretching in the y direction, optional, default radius
  22628. * * radiusZ allows stretching in the z direction, optional, default radius
  22629. * * flat when true creates a flat shaded mesh, optional, default true
  22630. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22631. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22632. * * 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)
  22633. * * 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)
  22634. * @returns the VertexData of the IcoSphere
  22635. */
  22636. static CreateIcoSphere(options: {
  22637. radius?: number;
  22638. radiusX?: number;
  22639. radiusY?: number;
  22640. radiusZ?: number;
  22641. flat?: boolean;
  22642. subdivisions?: number;
  22643. sideOrientation?: number;
  22644. frontUVs?: Vector4;
  22645. backUVs?: Vector4;
  22646. }): VertexData;
  22647. /**
  22648. * Creates the VertexData for a Polyhedron
  22649. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  22650. * * type provided types are:
  22651. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  22652. * * 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)
  22653. * * size the size of the IcoSphere, optional default 1
  22654. * * sizeX allows stretching in the x direction, optional, default size
  22655. * * sizeY allows stretching in the y direction, optional, default size
  22656. * * sizeZ allows stretching in the z direction, optional, default size
  22657. * * 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
  22658. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22659. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22660. * * flat when true creates a flat shaded mesh, optional, default true
  22661. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22662. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22663. * * 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)
  22664. * * 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)
  22665. * @returns the VertexData of the Polyhedron
  22666. */
  22667. static CreatePolyhedron(options: {
  22668. type?: number;
  22669. size?: number;
  22670. sizeX?: number;
  22671. sizeY?: number;
  22672. sizeZ?: number;
  22673. custom?: any;
  22674. faceUV?: Vector4[];
  22675. faceColors?: Color4[];
  22676. flat?: boolean;
  22677. sideOrientation?: number;
  22678. frontUVs?: Vector4;
  22679. backUVs?: Vector4;
  22680. }): VertexData;
  22681. /**
  22682. * Creates the VertexData for a TorusKnot
  22683. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  22684. * * radius the radius of the torus knot, optional, default 2
  22685. * * tube the thickness of the tube, optional, default 0.5
  22686. * * radialSegments the number of sides on each tube segments, optional, default 32
  22687. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  22688. * * p the number of windings around the z axis, optional, default 2
  22689. * * q the number of windings around the x axis, optional, default 3
  22690. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22691. * * 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)
  22692. * * 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)
  22693. * @returns the VertexData of the Torus Knot
  22694. */
  22695. static CreateTorusKnot(options: {
  22696. radius?: number;
  22697. tube?: number;
  22698. radialSegments?: number;
  22699. tubularSegments?: number;
  22700. p?: number;
  22701. q?: number;
  22702. sideOrientation?: number;
  22703. frontUVs?: Vector4;
  22704. backUVs?: Vector4;
  22705. }): VertexData;
  22706. /**
  22707. * Compute normals for given positions and indices
  22708. * @param positions an array of vertex positions, [...., x, y, z, ......]
  22709. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  22710. * @param normals an array of vertex normals, [...., x, y, z, ......]
  22711. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  22712. * * facetNormals : optional array of facet normals (vector3)
  22713. * * facetPositions : optional array of facet positions (vector3)
  22714. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  22715. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  22716. * * bInfo : optional bounding info, required for facetPartitioning computation
  22717. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  22718. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  22719. * * useRightHandedSystem: optional boolean to for right handed system computation
  22720. * * depthSort : optional boolean to enable the facet depth sort computation
  22721. * * distanceTo : optional Vector3 to compute the facet depth from this location
  22722. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  22723. */
  22724. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  22725. facetNormals?: any;
  22726. facetPositions?: any;
  22727. facetPartitioning?: any;
  22728. ratio?: number;
  22729. bInfo?: any;
  22730. bbSize?: Vector3;
  22731. subDiv?: any;
  22732. useRightHandedSystem?: boolean;
  22733. depthSort?: boolean;
  22734. distanceTo?: Vector3;
  22735. depthSortedFacets?: any;
  22736. }): void;
  22737. /** @hidden */
  22738. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  22739. /**
  22740. * Applies VertexData created from the imported parameters to the geometry
  22741. * @param parsedVertexData the parsed data from an imported file
  22742. * @param geometry the geometry to apply the VertexData to
  22743. */
  22744. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  22745. }
  22746. }
  22747. declare module "babylonjs/Morph/morphTarget" {
  22748. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  22749. import { Observable } from "babylonjs/Misc/observable";
  22750. import { Nullable, FloatArray } from "babylonjs/types";
  22751. import { Scene } from "babylonjs/scene";
  22752. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22753. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  22754. /**
  22755. * Defines a target to use with MorphTargetManager
  22756. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22757. */
  22758. export class MorphTarget implements IAnimatable {
  22759. /** defines the name of the target */
  22760. name: string;
  22761. /**
  22762. * Gets or sets the list of animations
  22763. */
  22764. animations: import("babylonjs/Animations/animation").Animation[];
  22765. private _scene;
  22766. private _positions;
  22767. private _normals;
  22768. private _tangents;
  22769. private _uvs;
  22770. private _influence;
  22771. private _uniqueId;
  22772. /**
  22773. * Observable raised when the influence changes
  22774. */
  22775. onInfluenceChanged: Observable<boolean>;
  22776. /** @hidden */
  22777. _onDataLayoutChanged: Observable<void>;
  22778. /**
  22779. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  22780. */
  22781. influence: number;
  22782. /**
  22783. * Gets or sets the id of the morph Target
  22784. */
  22785. id: string;
  22786. private _animationPropertiesOverride;
  22787. /**
  22788. * Gets or sets the animation properties override
  22789. */
  22790. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  22791. /**
  22792. * Creates a new MorphTarget
  22793. * @param name defines the name of the target
  22794. * @param influence defines the influence to use
  22795. * @param scene defines the scene the morphtarget belongs to
  22796. */
  22797. constructor(
  22798. /** defines the name of the target */
  22799. name: string, influence?: number, scene?: Nullable<Scene>);
  22800. /**
  22801. * Gets the unique ID of this manager
  22802. */
  22803. readonly uniqueId: number;
  22804. /**
  22805. * Gets a boolean defining if the target contains position data
  22806. */
  22807. readonly hasPositions: boolean;
  22808. /**
  22809. * Gets a boolean defining if the target contains normal data
  22810. */
  22811. readonly hasNormals: boolean;
  22812. /**
  22813. * Gets a boolean defining if the target contains tangent data
  22814. */
  22815. readonly hasTangents: boolean;
  22816. /**
  22817. * Gets a boolean defining if the target contains texture coordinates data
  22818. */
  22819. readonly hasUVs: boolean;
  22820. /**
  22821. * Affects position data to this target
  22822. * @param data defines the position data to use
  22823. */
  22824. setPositions(data: Nullable<FloatArray>): void;
  22825. /**
  22826. * Gets the position data stored in this target
  22827. * @returns a FloatArray containing the position data (or null if not present)
  22828. */
  22829. getPositions(): Nullable<FloatArray>;
  22830. /**
  22831. * Affects normal data to this target
  22832. * @param data defines the normal data to use
  22833. */
  22834. setNormals(data: Nullable<FloatArray>): void;
  22835. /**
  22836. * Gets the normal data stored in this target
  22837. * @returns a FloatArray containing the normal data (or null if not present)
  22838. */
  22839. getNormals(): Nullable<FloatArray>;
  22840. /**
  22841. * Affects tangent data to this target
  22842. * @param data defines the tangent data to use
  22843. */
  22844. setTangents(data: Nullable<FloatArray>): void;
  22845. /**
  22846. * Gets the tangent data stored in this target
  22847. * @returns a FloatArray containing the tangent data (or null if not present)
  22848. */
  22849. getTangents(): Nullable<FloatArray>;
  22850. /**
  22851. * Affects texture coordinates data to this target
  22852. * @param data defines the texture coordinates data to use
  22853. */
  22854. setUVs(data: Nullable<FloatArray>): void;
  22855. /**
  22856. * Gets the texture coordinates data stored in this target
  22857. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  22858. */
  22859. getUVs(): Nullable<FloatArray>;
  22860. /**
  22861. * Clone the current target
  22862. * @returns a new MorphTarget
  22863. */
  22864. clone(): MorphTarget;
  22865. /**
  22866. * Serializes the current target into a Serialization object
  22867. * @returns the serialized object
  22868. */
  22869. serialize(): any;
  22870. /**
  22871. * Returns the string "MorphTarget"
  22872. * @returns "MorphTarget"
  22873. */
  22874. getClassName(): string;
  22875. /**
  22876. * Creates a new target from serialized data
  22877. * @param serializationObject defines the serialized data to use
  22878. * @returns a new MorphTarget
  22879. */
  22880. static Parse(serializationObject: any): MorphTarget;
  22881. /**
  22882. * Creates a MorphTarget from mesh data
  22883. * @param mesh defines the source mesh
  22884. * @param name defines the name to use for the new target
  22885. * @param influence defines the influence to attach to the target
  22886. * @returns a new MorphTarget
  22887. */
  22888. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  22889. }
  22890. }
  22891. declare module "babylonjs/Morph/morphTargetManager" {
  22892. import { Nullable } from "babylonjs/types";
  22893. import { Scene } from "babylonjs/scene";
  22894. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  22895. /**
  22896. * This class is used to deform meshes using morphing between different targets
  22897. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22898. */
  22899. export class MorphTargetManager {
  22900. private _targets;
  22901. private _targetInfluenceChangedObservers;
  22902. private _targetDataLayoutChangedObservers;
  22903. private _activeTargets;
  22904. private _scene;
  22905. private _influences;
  22906. private _supportsNormals;
  22907. private _supportsTangents;
  22908. private _supportsUVs;
  22909. private _vertexCount;
  22910. private _uniqueId;
  22911. private _tempInfluences;
  22912. /**
  22913. * Gets or sets a boolean indicating if normals must be morphed
  22914. */
  22915. enableNormalMorphing: boolean;
  22916. /**
  22917. * Gets or sets a boolean indicating if tangents must be morphed
  22918. */
  22919. enableTangentMorphing: boolean;
  22920. /**
  22921. * Gets or sets a boolean indicating if UV must be morphed
  22922. */
  22923. enableUVMorphing: boolean;
  22924. /**
  22925. * Creates a new MorphTargetManager
  22926. * @param scene defines the current scene
  22927. */
  22928. constructor(scene?: Nullable<Scene>);
  22929. /**
  22930. * Gets the unique ID of this manager
  22931. */
  22932. readonly uniqueId: number;
  22933. /**
  22934. * Gets the number of vertices handled by this manager
  22935. */
  22936. readonly vertexCount: number;
  22937. /**
  22938. * Gets a boolean indicating if this manager supports morphing of normals
  22939. */
  22940. readonly supportsNormals: boolean;
  22941. /**
  22942. * Gets a boolean indicating if this manager supports morphing of tangents
  22943. */
  22944. readonly supportsTangents: boolean;
  22945. /**
  22946. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  22947. */
  22948. readonly supportsUVs: boolean;
  22949. /**
  22950. * Gets the number of targets stored in this manager
  22951. */
  22952. readonly numTargets: number;
  22953. /**
  22954. * Gets the number of influencers (ie. the number of targets with influences > 0)
  22955. */
  22956. readonly numInfluencers: number;
  22957. /**
  22958. * Gets the list of influences (one per target)
  22959. */
  22960. readonly influences: Float32Array;
  22961. /**
  22962. * Gets the active target at specified index. An active target is a target with an influence > 0
  22963. * @param index defines the index to check
  22964. * @returns the requested target
  22965. */
  22966. getActiveTarget(index: number): MorphTarget;
  22967. /**
  22968. * Gets the target at specified index
  22969. * @param index defines the index to check
  22970. * @returns the requested target
  22971. */
  22972. getTarget(index: number): MorphTarget;
  22973. /**
  22974. * Add a new target to this manager
  22975. * @param target defines the target to add
  22976. */
  22977. addTarget(target: MorphTarget): void;
  22978. /**
  22979. * Removes a target from the manager
  22980. * @param target defines the target to remove
  22981. */
  22982. removeTarget(target: MorphTarget): void;
  22983. /**
  22984. * Clone the current manager
  22985. * @returns a new MorphTargetManager
  22986. */
  22987. clone(): MorphTargetManager;
  22988. /**
  22989. * Serializes the current manager into a Serialization object
  22990. * @returns the serialized object
  22991. */
  22992. serialize(): any;
  22993. private _syncActiveTargets;
  22994. /**
  22995. * Syncrhonize the targets with all the meshes using this morph target manager
  22996. */
  22997. synchronize(): void;
  22998. /**
  22999. * Creates a new MorphTargetManager from serialized data
  23000. * @param serializationObject defines the serialized data
  23001. * @param scene defines the hosting scene
  23002. * @returns the new MorphTargetManager
  23003. */
  23004. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  23005. }
  23006. }
  23007. declare module "babylonjs/Meshes/meshLODLevel" {
  23008. import { Mesh } from "babylonjs/Meshes/mesh";
  23009. import { Nullable } from "babylonjs/types";
  23010. /**
  23011. * Class used to represent a specific level of detail of a mesh
  23012. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  23013. */
  23014. export class MeshLODLevel {
  23015. /** Defines the distance where this level should start being displayed */
  23016. distance: number;
  23017. /** Defines the mesh to use to render this level */
  23018. mesh: Nullable<Mesh>;
  23019. /**
  23020. * Creates a new LOD level
  23021. * @param distance defines the distance where this level should star being displayed
  23022. * @param mesh defines the mesh to use to render this level
  23023. */
  23024. constructor(
  23025. /** Defines the distance where this level should start being displayed */
  23026. distance: number,
  23027. /** Defines the mesh to use to render this level */
  23028. mesh: Nullable<Mesh>);
  23029. }
  23030. }
  23031. declare module "babylonjs/Meshes/groundMesh" {
  23032. import { Scene } from "babylonjs/scene";
  23033. import { Vector3 } from "babylonjs/Maths/math.vector";
  23034. import { Mesh } from "babylonjs/Meshes/mesh";
  23035. /**
  23036. * Mesh representing the gorund
  23037. */
  23038. export class GroundMesh extends Mesh {
  23039. /** If octree should be generated */
  23040. generateOctree: boolean;
  23041. private _heightQuads;
  23042. /** @hidden */
  23043. _subdivisionsX: number;
  23044. /** @hidden */
  23045. _subdivisionsY: number;
  23046. /** @hidden */
  23047. _width: number;
  23048. /** @hidden */
  23049. _height: number;
  23050. /** @hidden */
  23051. _minX: number;
  23052. /** @hidden */
  23053. _maxX: number;
  23054. /** @hidden */
  23055. _minZ: number;
  23056. /** @hidden */
  23057. _maxZ: number;
  23058. constructor(name: string, scene: Scene);
  23059. /**
  23060. * "GroundMesh"
  23061. * @returns "GroundMesh"
  23062. */
  23063. getClassName(): string;
  23064. /**
  23065. * The minimum of x and y subdivisions
  23066. */
  23067. readonly subdivisions: number;
  23068. /**
  23069. * X subdivisions
  23070. */
  23071. readonly subdivisionsX: number;
  23072. /**
  23073. * Y subdivisions
  23074. */
  23075. readonly subdivisionsY: number;
  23076. /**
  23077. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  23078. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  23079. * @param chunksCount the number of subdivisions for x and y
  23080. * @param octreeBlocksSize (Default: 32)
  23081. */
  23082. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  23083. /**
  23084. * Returns a height (y) value in the Worl system :
  23085. * the ground altitude at the coordinates (x, z) expressed in the World system.
  23086. * @param x x coordinate
  23087. * @param z z coordinate
  23088. * @returns the ground y position if (x, z) are outside the ground surface.
  23089. */
  23090. getHeightAtCoordinates(x: number, z: number): number;
  23091. /**
  23092. * Returns a normalized vector (Vector3) orthogonal to the ground
  23093. * at the ground coordinates (x, z) expressed in the World system.
  23094. * @param x x coordinate
  23095. * @param z z coordinate
  23096. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  23097. */
  23098. getNormalAtCoordinates(x: number, z: number): Vector3;
  23099. /**
  23100. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  23101. * at the ground coordinates (x, z) expressed in the World system.
  23102. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  23103. * @param x x coordinate
  23104. * @param z z coordinate
  23105. * @param ref vector to store the result
  23106. * @returns the GroundMesh.
  23107. */
  23108. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  23109. /**
  23110. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  23111. * if the ground has been updated.
  23112. * This can be used in the render loop.
  23113. * @returns the GroundMesh.
  23114. */
  23115. updateCoordinateHeights(): GroundMesh;
  23116. private _getFacetAt;
  23117. private _initHeightQuads;
  23118. private _computeHeightQuads;
  23119. /**
  23120. * Serializes this ground mesh
  23121. * @param serializationObject object to write serialization to
  23122. */
  23123. serialize(serializationObject: any): void;
  23124. /**
  23125. * Parses a serialized ground mesh
  23126. * @param parsedMesh the serialized mesh
  23127. * @param scene the scene to create the ground mesh in
  23128. * @returns the created ground mesh
  23129. */
  23130. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  23131. }
  23132. }
  23133. declare module "babylonjs/Physics/physicsJoint" {
  23134. import { Vector3 } from "babylonjs/Maths/math.vector";
  23135. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  23136. /**
  23137. * Interface for Physics-Joint data
  23138. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23139. */
  23140. export interface PhysicsJointData {
  23141. /**
  23142. * The main pivot of the joint
  23143. */
  23144. mainPivot?: Vector3;
  23145. /**
  23146. * The connected pivot of the joint
  23147. */
  23148. connectedPivot?: Vector3;
  23149. /**
  23150. * The main axis of the joint
  23151. */
  23152. mainAxis?: Vector3;
  23153. /**
  23154. * The connected axis of the joint
  23155. */
  23156. connectedAxis?: Vector3;
  23157. /**
  23158. * The collision of the joint
  23159. */
  23160. collision?: boolean;
  23161. /**
  23162. * Native Oimo/Cannon/Energy data
  23163. */
  23164. nativeParams?: any;
  23165. }
  23166. /**
  23167. * This is a holder class for the physics joint created by the physics plugin
  23168. * It holds a set of functions to control the underlying joint
  23169. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23170. */
  23171. export class PhysicsJoint {
  23172. /**
  23173. * The type of the physics joint
  23174. */
  23175. type: number;
  23176. /**
  23177. * The data for the physics joint
  23178. */
  23179. jointData: PhysicsJointData;
  23180. private _physicsJoint;
  23181. protected _physicsPlugin: IPhysicsEnginePlugin;
  23182. /**
  23183. * Initializes the physics joint
  23184. * @param type The type of the physics joint
  23185. * @param jointData The data for the physics joint
  23186. */
  23187. constructor(
  23188. /**
  23189. * The type of the physics joint
  23190. */
  23191. type: number,
  23192. /**
  23193. * The data for the physics joint
  23194. */
  23195. jointData: PhysicsJointData);
  23196. /**
  23197. * Gets the physics joint
  23198. */
  23199. /**
  23200. * Sets the physics joint
  23201. */
  23202. physicsJoint: any;
  23203. /**
  23204. * Sets the physics plugin
  23205. */
  23206. physicsPlugin: IPhysicsEnginePlugin;
  23207. /**
  23208. * Execute a function that is physics-plugin specific.
  23209. * @param {Function} func the function that will be executed.
  23210. * It accepts two parameters: the physics world and the physics joint
  23211. */
  23212. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  23213. /**
  23214. * Distance-Joint type
  23215. */
  23216. static DistanceJoint: number;
  23217. /**
  23218. * Hinge-Joint type
  23219. */
  23220. static HingeJoint: number;
  23221. /**
  23222. * Ball-and-Socket joint type
  23223. */
  23224. static BallAndSocketJoint: number;
  23225. /**
  23226. * Wheel-Joint type
  23227. */
  23228. static WheelJoint: number;
  23229. /**
  23230. * Slider-Joint type
  23231. */
  23232. static SliderJoint: number;
  23233. /**
  23234. * Prismatic-Joint type
  23235. */
  23236. static PrismaticJoint: number;
  23237. /**
  23238. * Universal-Joint type
  23239. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  23240. */
  23241. static UniversalJoint: number;
  23242. /**
  23243. * Hinge-Joint 2 type
  23244. */
  23245. static Hinge2Joint: number;
  23246. /**
  23247. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  23248. */
  23249. static PointToPointJoint: number;
  23250. /**
  23251. * Spring-Joint type
  23252. */
  23253. static SpringJoint: number;
  23254. /**
  23255. * Lock-Joint type
  23256. */
  23257. static LockJoint: number;
  23258. }
  23259. /**
  23260. * A class representing a physics distance joint
  23261. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23262. */
  23263. export class DistanceJoint extends PhysicsJoint {
  23264. /**
  23265. *
  23266. * @param jointData The data for the Distance-Joint
  23267. */
  23268. constructor(jointData: DistanceJointData);
  23269. /**
  23270. * Update the predefined distance.
  23271. * @param maxDistance The maximum preferred distance
  23272. * @param minDistance The minimum preferred distance
  23273. */
  23274. updateDistance(maxDistance: number, minDistance?: number): void;
  23275. }
  23276. /**
  23277. * Represents a Motor-Enabled Joint
  23278. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23279. */
  23280. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  23281. /**
  23282. * Initializes the Motor-Enabled Joint
  23283. * @param type The type of the joint
  23284. * @param jointData The physica joint data for the joint
  23285. */
  23286. constructor(type: number, jointData: PhysicsJointData);
  23287. /**
  23288. * Set the motor values.
  23289. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23290. * @param force the force to apply
  23291. * @param maxForce max force for this motor.
  23292. */
  23293. setMotor(force?: number, maxForce?: number): void;
  23294. /**
  23295. * Set the motor's limits.
  23296. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23297. * @param upperLimit The upper limit of the motor
  23298. * @param lowerLimit The lower limit of the motor
  23299. */
  23300. setLimit(upperLimit: number, lowerLimit?: number): void;
  23301. }
  23302. /**
  23303. * This class represents a single physics Hinge-Joint
  23304. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23305. */
  23306. export class HingeJoint extends MotorEnabledJoint {
  23307. /**
  23308. * Initializes the Hinge-Joint
  23309. * @param jointData The joint data for the Hinge-Joint
  23310. */
  23311. constructor(jointData: PhysicsJointData);
  23312. /**
  23313. * Set the motor values.
  23314. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23315. * @param {number} force the force to apply
  23316. * @param {number} maxForce max force for this motor.
  23317. */
  23318. setMotor(force?: number, maxForce?: number): void;
  23319. /**
  23320. * Set the motor's limits.
  23321. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23322. * @param upperLimit The upper limit of the motor
  23323. * @param lowerLimit The lower limit of the motor
  23324. */
  23325. setLimit(upperLimit: number, lowerLimit?: number): void;
  23326. }
  23327. /**
  23328. * This class represents a dual hinge physics joint (same as wheel joint)
  23329. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23330. */
  23331. export class Hinge2Joint extends MotorEnabledJoint {
  23332. /**
  23333. * Initializes the Hinge2-Joint
  23334. * @param jointData The joint data for the Hinge2-Joint
  23335. */
  23336. constructor(jointData: PhysicsJointData);
  23337. /**
  23338. * Set the motor values.
  23339. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23340. * @param {number} targetSpeed the speed the motor is to reach
  23341. * @param {number} maxForce max force for this motor.
  23342. * @param {motorIndex} the motor's index, 0 or 1.
  23343. */
  23344. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  23345. /**
  23346. * Set the motor limits.
  23347. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23348. * @param {number} upperLimit the upper limit
  23349. * @param {number} lowerLimit lower limit
  23350. * @param {motorIndex} the motor's index, 0 or 1.
  23351. */
  23352. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23353. }
  23354. /**
  23355. * Interface for a motor enabled joint
  23356. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23357. */
  23358. export interface IMotorEnabledJoint {
  23359. /**
  23360. * Physics joint
  23361. */
  23362. physicsJoint: any;
  23363. /**
  23364. * Sets the motor of the motor-enabled joint
  23365. * @param force The force of the motor
  23366. * @param maxForce The maximum force of the motor
  23367. * @param motorIndex The index of the motor
  23368. */
  23369. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  23370. /**
  23371. * Sets the limit of the motor
  23372. * @param upperLimit The upper limit of the motor
  23373. * @param lowerLimit The lower limit of the motor
  23374. * @param motorIndex The index of the motor
  23375. */
  23376. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23377. }
  23378. /**
  23379. * Joint data for a Distance-Joint
  23380. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23381. */
  23382. export interface DistanceJointData extends PhysicsJointData {
  23383. /**
  23384. * Max distance the 2 joint objects can be apart
  23385. */
  23386. maxDistance: number;
  23387. }
  23388. /**
  23389. * Joint data from a spring joint
  23390. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23391. */
  23392. export interface SpringJointData extends PhysicsJointData {
  23393. /**
  23394. * Length of the spring
  23395. */
  23396. length: number;
  23397. /**
  23398. * Stiffness of the spring
  23399. */
  23400. stiffness: number;
  23401. /**
  23402. * Damping of the spring
  23403. */
  23404. damping: number;
  23405. /** this callback will be called when applying the force to the impostors. */
  23406. forceApplicationCallback: () => void;
  23407. }
  23408. }
  23409. declare module "babylonjs/Physics/physicsRaycastResult" {
  23410. import { Vector3 } from "babylonjs/Maths/math.vector";
  23411. /**
  23412. * Holds the data for the raycast result
  23413. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23414. */
  23415. export class PhysicsRaycastResult {
  23416. private _hasHit;
  23417. private _hitDistance;
  23418. private _hitNormalWorld;
  23419. private _hitPointWorld;
  23420. private _rayFromWorld;
  23421. private _rayToWorld;
  23422. /**
  23423. * Gets if there was a hit
  23424. */
  23425. readonly hasHit: boolean;
  23426. /**
  23427. * Gets the distance from the hit
  23428. */
  23429. readonly hitDistance: number;
  23430. /**
  23431. * Gets the hit normal/direction in the world
  23432. */
  23433. readonly hitNormalWorld: Vector3;
  23434. /**
  23435. * Gets the hit point in the world
  23436. */
  23437. readonly hitPointWorld: Vector3;
  23438. /**
  23439. * Gets the ray "start point" of the ray in the world
  23440. */
  23441. readonly rayFromWorld: Vector3;
  23442. /**
  23443. * Gets the ray "end point" of the ray in the world
  23444. */
  23445. readonly rayToWorld: Vector3;
  23446. /**
  23447. * Sets the hit data (normal & point in world space)
  23448. * @param hitNormalWorld defines the normal in world space
  23449. * @param hitPointWorld defines the point in world space
  23450. */
  23451. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  23452. /**
  23453. * Sets the distance from the start point to the hit point
  23454. * @param distance
  23455. */
  23456. setHitDistance(distance: number): void;
  23457. /**
  23458. * Calculates the distance manually
  23459. */
  23460. calculateHitDistance(): void;
  23461. /**
  23462. * Resets all the values to default
  23463. * @param from The from point on world space
  23464. * @param to The to point on world space
  23465. */
  23466. reset(from?: Vector3, to?: Vector3): void;
  23467. }
  23468. /**
  23469. * Interface for the size containing width and height
  23470. */
  23471. interface IXYZ {
  23472. /**
  23473. * X
  23474. */
  23475. x: number;
  23476. /**
  23477. * Y
  23478. */
  23479. y: number;
  23480. /**
  23481. * Z
  23482. */
  23483. z: number;
  23484. }
  23485. }
  23486. declare module "babylonjs/Physics/IPhysicsEngine" {
  23487. import { Nullable } from "babylonjs/types";
  23488. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  23489. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23490. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  23491. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  23492. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  23493. /**
  23494. * Interface used to describe a physics joint
  23495. */
  23496. export interface PhysicsImpostorJoint {
  23497. /** Defines the main impostor to which the joint is linked */
  23498. mainImpostor: PhysicsImpostor;
  23499. /** Defines the impostor that is connected to the main impostor using this joint */
  23500. connectedImpostor: PhysicsImpostor;
  23501. /** Defines the joint itself */
  23502. joint: PhysicsJoint;
  23503. }
  23504. /** @hidden */
  23505. export interface IPhysicsEnginePlugin {
  23506. world: any;
  23507. name: string;
  23508. setGravity(gravity: Vector3): void;
  23509. setTimeStep(timeStep: number): void;
  23510. getTimeStep(): number;
  23511. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  23512. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23513. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23514. generatePhysicsBody(impostor: PhysicsImpostor): void;
  23515. removePhysicsBody(impostor: PhysicsImpostor): void;
  23516. generateJoint(joint: PhysicsImpostorJoint): void;
  23517. removeJoint(joint: PhysicsImpostorJoint): void;
  23518. isSupported(): boolean;
  23519. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  23520. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  23521. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23522. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23523. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23524. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23525. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  23526. getBodyMass(impostor: PhysicsImpostor): number;
  23527. getBodyFriction(impostor: PhysicsImpostor): number;
  23528. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  23529. getBodyRestitution(impostor: PhysicsImpostor): number;
  23530. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  23531. getBodyPressure?(impostor: PhysicsImpostor): number;
  23532. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  23533. getBodyStiffness?(impostor: PhysicsImpostor): number;
  23534. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  23535. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  23536. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  23537. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  23538. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  23539. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23540. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23541. sleepBody(impostor: PhysicsImpostor): void;
  23542. wakeUpBody(impostor: PhysicsImpostor): void;
  23543. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23544. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  23545. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  23546. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23547. getRadius(impostor: PhysicsImpostor): number;
  23548. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  23549. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  23550. dispose(): void;
  23551. }
  23552. /**
  23553. * Interface used to define a physics engine
  23554. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  23555. */
  23556. export interface IPhysicsEngine {
  23557. /**
  23558. * Gets the gravity vector used by the simulation
  23559. */
  23560. gravity: Vector3;
  23561. /**
  23562. * Sets the gravity vector used by the simulation
  23563. * @param gravity defines the gravity vector to use
  23564. */
  23565. setGravity(gravity: Vector3): void;
  23566. /**
  23567. * Set the time step of the physics engine.
  23568. * Default is 1/60.
  23569. * To slow it down, enter 1/600 for example.
  23570. * To speed it up, 1/30
  23571. * @param newTimeStep the new timestep to apply to this world.
  23572. */
  23573. setTimeStep(newTimeStep: number): void;
  23574. /**
  23575. * Get the time step of the physics engine.
  23576. * @returns the current time step
  23577. */
  23578. getTimeStep(): number;
  23579. /**
  23580. * Release all resources
  23581. */
  23582. dispose(): void;
  23583. /**
  23584. * Gets the name of the current physics plugin
  23585. * @returns the name of the plugin
  23586. */
  23587. getPhysicsPluginName(): string;
  23588. /**
  23589. * Adding a new impostor for the impostor tracking.
  23590. * This will be done by the impostor itself.
  23591. * @param impostor the impostor to add
  23592. */
  23593. addImpostor(impostor: PhysicsImpostor): void;
  23594. /**
  23595. * Remove an impostor from the engine.
  23596. * This impostor and its mesh will not longer be updated by the physics engine.
  23597. * @param impostor the impostor to remove
  23598. */
  23599. removeImpostor(impostor: PhysicsImpostor): void;
  23600. /**
  23601. * Add a joint to the physics engine
  23602. * @param mainImpostor defines the main impostor to which the joint is added.
  23603. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  23604. * @param joint defines the joint that will connect both impostors.
  23605. */
  23606. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23607. /**
  23608. * Removes a joint from the simulation
  23609. * @param mainImpostor defines the impostor used with the joint
  23610. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  23611. * @param joint defines the joint to remove
  23612. */
  23613. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23614. /**
  23615. * Gets the current plugin used to run the simulation
  23616. * @returns current plugin
  23617. */
  23618. getPhysicsPlugin(): IPhysicsEnginePlugin;
  23619. /**
  23620. * Gets the list of physic impostors
  23621. * @returns an array of PhysicsImpostor
  23622. */
  23623. getImpostors(): Array<PhysicsImpostor>;
  23624. /**
  23625. * Gets the impostor for a physics enabled object
  23626. * @param object defines the object impersonated by the impostor
  23627. * @returns the PhysicsImpostor or null if not found
  23628. */
  23629. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  23630. /**
  23631. * Gets the impostor for a physics body object
  23632. * @param body defines physics body used by the impostor
  23633. * @returns the PhysicsImpostor or null if not found
  23634. */
  23635. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  23636. /**
  23637. * Does a raycast in the physics world
  23638. * @param from when should the ray start?
  23639. * @param to when should the ray end?
  23640. * @returns PhysicsRaycastResult
  23641. */
  23642. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23643. /**
  23644. * Called by the scene. No need to call it.
  23645. * @param delta defines the timespam between frames
  23646. */
  23647. _step(delta: number): void;
  23648. }
  23649. }
  23650. declare module "babylonjs/Physics/physicsImpostor" {
  23651. import { Nullable, IndicesArray } from "babylonjs/types";
  23652. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  23653. import { TransformNode } from "babylonjs/Meshes/transformNode";
  23654. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23655. import { Scene } from "babylonjs/scene";
  23656. import { Bone } from "babylonjs/Bones/bone";
  23657. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  23658. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  23659. import { Space } from "babylonjs/Maths/math.axis";
  23660. /**
  23661. * The interface for the physics imposter parameters
  23662. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23663. */
  23664. export interface PhysicsImpostorParameters {
  23665. /**
  23666. * The mass of the physics imposter
  23667. */
  23668. mass: number;
  23669. /**
  23670. * The friction of the physics imposter
  23671. */
  23672. friction?: number;
  23673. /**
  23674. * The coefficient of restitution of the physics imposter
  23675. */
  23676. restitution?: number;
  23677. /**
  23678. * The native options of the physics imposter
  23679. */
  23680. nativeOptions?: any;
  23681. /**
  23682. * Specifies if the parent should be ignored
  23683. */
  23684. ignoreParent?: boolean;
  23685. /**
  23686. * Specifies if bi-directional transformations should be disabled
  23687. */
  23688. disableBidirectionalTransformation?: boolean;
  23689. /**
  23690. * The pressure inside the physics imposter, soft object only
  23691. */
  23692. pressure?: number;
  23693. /**
  23694. * The stiffness the physics imposter, soft object only
  23695. */
  23696. stiffness?: number;
  23697. /**
  23698. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  23699. */
  23700. velocityIterations?: number;
  23701. /**
  23702. * The number of iterations used in maintaining consistent vertex positions, soft object only
  23703. */
  23704. positionIterations?: number;
  23705. /**
  23706. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  23707. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  23708. * Add to fix multiple points
  23709. */
  23710. fixedPoints?: number;
  23711. /**
  23712. * The collision margin around a soft object
  23713. */
  23714. margin?: number;
  23715. /**
  23716. * The collision margin around a soft object
  23717. */
  23718. damping?: number;
  23719. /**
  23720. * The path for a rope based on an extrusion
  23721. */
  23722. path?: any;
  23723. /**
  23724. * The shape of an extrusion used for a rope based on an extrusion
  23725. */
  23726. shape?: any;
  23727. }
  23728. /**
  23729. * Interface for a physics-enabled object
  23730. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23731. */
  23732. export interface IPhysicsEnabledObject {
  23733. /**
  23734. * The position of the physics-enabled object
  23735. */
  23736. position: Vector3;
  23737. /**
  23738. * The rotation of the physics-enabled object
  23739. */
  23740. rotationQuaternion: Nullable<Quaternion>;
  23741. /**
  23742. * The scale of the physics-enabled object
  23743. */
  23744. scaling: Vector3;
  23745. /**
  23746. * The rotation of the physics-enabled object
  23747. */
  23748. rotation?: Vector3;
  23749. /**
  23750. * The parent of the physics-enabled object
  23751. */
  23752. parent?: any;
  23753. /**
  23754. * The bounding info of the physics-enabled object
  23755. * @returns The bounding info of the physics-enabled object
  23756. */
  23757. getBoundingInfo(): BoundingInfo;
  23758. /**
  23759. * Computes the world matrix
  23760. * @param force Specifies if the world matrix should be computed by force
  23761. * @returns A world matrix
  23762. */
  23763. computeWorldMatrix(force: boolean): Matrix;
  23764. /**
  23765. * Gets the world matrix
  23766. * @returns A world matrix
  23767. */
  23768. getWorldMatrix?(): Matrix;
  23769. /**
  23770. * Gets the child meshes
  23771. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  23772. * @returns An array of abstract meshes
  23773. */
  23774. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  23775. /**
  23776. * Gets the vertex data
  23777. * @param kind The type of vertex data
  23778. * @returns A nullable array of numbers, or a float32 array
  23779. */
  23780. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  23781. /**
  23782. * Gets the indices from the mesh
  23783. * @returns A nullable array of index arrays
  23784. */
  23785. getIndices?(): Nullable<IndicesArray>;
  23786. /**
  23787. * Gets the scene from the mesh
  23788. * @returns the indices array or null
  23789. */
  23790. getScene?(): Scene;
  23791. /**
  23792. * Gets the absolute position from the mesh
  23793. * @returns the absolute position
  23794. */
  23795. getAbsolutePosition(): Vector3;
  23796. /**
  23797. * Gets the absolute pivot point from the mesh
  23798. * @returns the absolute pivot point
  23799. */
  23800. getAbsolutePivotPoint(): Vector3;
  23801. /**
  23802. * Rotates the mesh
  23803. * @param axis The axis of rotation
  23804. * @param amount The amount of rotation
  23805. * @param space The space of the rotation
  23806. * @returns The rotation transform node
  23807. */
  23808. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  23809. /**
  23810. * Translates the mesh
  23811. * @param axis The axis of translation
  23812. * @param distance The distance of translation
  23813. * @param space The space of the translation
  23814. * @returns The transform node
  23815. */
  23816. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  23817. /**
  23818. * Sets the absolute position of the mesh
  23819. * @param absolutePosition The absolute position of the mesh
  23820. * @returns The transform node
  23821. */
  23822. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  23823. /**
  23824. * Gets the class name of the mesh
  23825. * @returns The class name
  23826. */
  23827. getClassName(): string;
  23828. }
  23829. /**
  23830. * Represents a physics imposter
  23831. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23832. */
  23833. export class PhysicsImpostor {
  23834. /**
  23835. * The physics-enabled object used as the physics imposter
  23836. */
  23837. object: IPhysicsEnabledObject;
  23838. /**
  23839. * The type of the physics imposter
  23840. */
  23841. type: number;
  23842. private _options;
  23843. private _scene?;
  23844. /**
  23845. * The default object size of the imposter
  23846. */
  23847. static DEFAULT_OBJECT_SIZE: Vector3;
  23848. /**
  23849. * The identity quaternion of the imposter
  23850. */
  23851. static IDENTITY_QUATERNION: Quaternion;
  23852. /** @hidden */
  23853. _pluginData: any;
  23854. private _physicsEngine;
  23855. private _physicsBody;
  23856. private _bodyUpdateRequired;
  23857. private _onBeforePhysicsStepCallbacks;
  23858. private _onAfterPhysicsStepCallbacks;
  23859. /** @hidden */
  23860. _onPhysicsCollideCallbacks: Array<{
  23861. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  23862. otherImpostors: Array<PhysicsImpostor>;
  23863. }>;
  23864. private _deltaPosition;
  23865. private _deltaRotation;
  23866. private _deltaRotationConjugated;
  23867. /** @hidden */
  23868. _isFromLine: boolean;
  23869. private _parent;
  23870. private _isDisposed;
  23871. private static _tmpVecs;
  23872. private static _tmpQuat;
  23873. /**
  23874. * Specifies if the physics imposter is disposed
  23875. */
  23876. readonly isDisposed: boolean;
  23877. /**
  23878. * Gets the mass of the physics imposter
  23879. */
  23880. mass: number;
  23881. /**
  23882. * Gets the coefficient of friction
  23883. */
  23884. /**
  23885. * Sets the coefficient of friction
  23886. */
  23887. friction: number;
  23888. /**
  23889. * Gets the coefficient of restitution
  23890. */
  23891. /**
  23892. * Sets the coefficient of restitution
  23893. */
  23894. restitution: number;
  23895. /**
  23896. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  23897. */
  23898. /**
  23899. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  23900. */
  23901. pressure: number;
  23902. /**
  23903. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  23904. */
  23905. /**
  23906. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  23907. */
  23908. stiffness: number;
  23909. /**
  23910. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  23911. */
  23912. /**
  23913. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  23914. */
  23915. velocityIterations: number;
  23916. /**
  23917. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  23918. */
  23919. /**
  23920. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  23921. */
  23922. positionIterations: number;
  23923. /**
  23924. * The unique id of the physics imposter
  23925. * set by the physics engine when adding this impostor to the array
  23926. */
  23927. uniqueId: number;
  23928. /**
  23929. * @hidden
  23930. */
  23931. soft: boolean;
  23932. /**
  23933. * @hidden
  23934. */
  23935. segments: number;
  23936. private _joints;
  23937. /**
  23938. * Initializes the physics imposter
  23939. * @param object The physics-enabled object used as the physics imposter
  23940. * @param type The type of the physics imposter
  23941. * @param _options The options for the physics imposter
  23942. * @param _scene The Babylon scene
  23943. */
  23944. constructor(
  23945. /**
  23946. * The physics-enabled object used as the physics imposter
  23947. */
  23948. object: IPhysicsEnabledObject,
  23949. /**
  23950. * The type of the physics imposter
  23951. */
  23952. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  23953. /**
  23954. * This function will completly initialize this impostor.
  23955. * It will create a new body - but only if this mesh has no parent.
  23956. * If it has, this impostor will not be used other than to define the impostor
  23957. * of the child mesh.
  23958. * @hidden
  23959. */
  23960. _init(): void;
  23961. private _getPhysicsParent;
  23962. /**
  23963. * Should a new body be generated.
  23964. * @returns boolean specifying if body initialization is required
  23965. */
  23966. isBodyInitRequired(): boolean;
  23967. /**
  23968. * Sets the updated scaling
  23969. * @param updated Specifies if the scaling is updated
  23970. */
  23971. setScalingUpdated(): void;
  23972. /**
  23973. * Force a regeneration of this or the parent's impostor's body.
  23974. * Use under cautious - This will remove all joints already implemented.
  23975. */
  23976. forceUpdate(): void;
  23977. /**
  23978. * Gets the body that holds this impostor. Either its own, or its parent.
  23979. */
  23980. /**
  23981. * Set the physics body. Used mainly by the physics engine/plugin
  23982. */
  23983. physicsBody: any;
  23984. /**
  23985. * Get the parent of the physics imposter
  23986. * @returns Physics imposter or null
  23987. */
  23988. /**
  23989. * Sets the parent of the physics imposter
  23990. */
  23991. parent: Nullable<PhysicsImpostor>;
  23992. /**
  23993. * Resets the update flags
  23994. */
  23995. resetUpdateFlags(): void;
  23996. /**
  23997. * Gets the object extend size
  23998. * @returns the object extend size
  23999. */
  24000. getObjectExtendSize(): Vector3;
  24001. /**
  24002. * Gets the object center
  24003. * @returns The object center
  24004. */
  24005. getObjectCenter(): Vector3;
  24006. /**
  24007. * Get a specific parametes from the options parameter
  24008. * @param paramName The object parameter name
  24009. * @returns The object parameter
  24010. */
  24011. getParam(paramName: string): any;
  24012. /**
  24013. * Sets a specific parameter in the options given to the physics plugin
  24014. * @param paramName The parameter name
  24015. * @param value The value of the parameter
  24016. */
  24017. setParam(paramName: string, value: number): void;
  24018. /**
  24019. * Specifically change the body's mass option. Won't recreate the physics body object
  24020. * @param mass The mass of the physics imposter
  24021. */
  24022. setMass(mass: number): void;
  24023. /**
  24024. * Gets the linear velocity
  24025. * @returns linear velocity or null
  24026. */
  24027. getLinearVelocity(): Nullable<Vector3>;
  24028. /**
  24029. * Sets the linear velocity
  24030. * @param velocity linear velocity or null
  24031. */
  24032. setLinearVelocity(velocity: Nullable<Vector3>): void;
  24033. /**
  24034. * Gets the angular velocity
  24035. * @returns angular velocity or null
  24036. */
  24037. getAngularVelocity(): Nullable<Vector3>;
  24038. /**
  24039. * Sets the angular velocity
  24040. * @param velocity The velocity or null
  24041. */
  24042. setAngularVelocity(velocity: Nullable<Vector3>): void;
  24043. /**
  24044. * Execute a function with the physics plugin native code
  24045. * Provide a function the will have two variables - the world object and the physics body object
  24046. * @param func The function to execute with the physics plugin native code
  24047. */
  24048. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  24049. /**
  24050. * Register a function that will be executed before the physics world is stepping forward
  24051. * @param func The function to execute before the physics world is stepped forward
  24052. */
  24053. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24054. /**
  24055. * Unregister a function that will be executed before the physics world is stepping forward
  24056. * @param func The function to execute before the physics world is stepped forward
  24057. */
  24058. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24059. /**
  24060. * Register a function that will be executed after the physics step
  24061. * @param func The function to execute after physics step
  24062. */
  24063. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24064. /**
  24065. * Unregisters a function that will be executed after the physics step
  24066. * @param func The function to execute after physics step
  24067. */
  24068. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24069. /**
  24070. * register a function that will be executed when this impostor collides against a different body
  24071. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  24072. * @param func Callback that is executed on collision
  24073. */
  24074. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  24075. /**
  24076. * Unregisters the physics imposter on contact
  24077. * @param collideAgainst The physics object to collide against
  24078. * @param func Callback to execute on collision
  24079. */
  24080. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  24081. private _tmpQuat;
  24082. private _tmpQuat2;
  24083. /**
  24084. * Get the parent rotation
  24085. * @returns The parent rotation
  24086. */
  24087. getParentsRotation(): Quaternion;
  24088. /**
  24089. * this function is executed by the physics engine.
  24090. */
  24091. beforeStep: () => void;
  24092. /**
  24093. * this function is executed by the physics engine
  24094. */
  24095. afterStep: () => void;
  24096. /**
  24097. * Legacy collision detection event support
  24098. */
  24099. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  24100. /**
  24101. * event and body object due to cannon's event-based architecture.
  24102. */
  24103. onCollide: (e: {
  24104. body: any;
  24105. }) => void;
  24106. /**
  24107. * Apply a force
  24108. * @param force The force to apply
  24109. * @param contactPoint The contact point for the force
  24110. * @returns The physics imposter
  24111. */
  24112. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  24113. /**
  24114. * Apply an impulse
  24115. * @param force The impulse force
  24116. * @param contactPoint The contact point for the impulse force
  24117. * @returns The physics imposter
  24118. */
  24119. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  24120. /**
  24121. * A help function to create a joint
  24122. * @param otherImpostor A physics imposter used to create a joint
  24123. * @param jointType The type of joint
  24124. * @param jointData The data for the joint
  24125. * @returns The physics imposter
  24126. */
  24127. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  24128. /**
  24129. * Add a joint to this impostor with a different impostor
  24130. * @param otherImpostor A physics imposter used to add a joint
  24131. * @param joint The joint to add
  24132. * @returns The physics imposter
  24133. */
  24134. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  24135. /**
  24136. * Add an anchor to a cloth impostor
  24137. * @param otherImpostor rigid impostor to anchor to
  24138. * @param width ratio across width from 0 to 1
  24139. * @param height ratio up height from 0 to 1
  24140. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  24141. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  24142. * @returns impostor the soft imposter
  24143. */
  24144. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  24145. /**
  24146. * Add a hook to a rope impostor
  24147. * @param otherImpostor rigid impostor to anchor to
  24148. * @param length ratio across rope from 0 to 1
  24149. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  24150. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  24151. * @returns impostor the rope imposter
  24152. */
  24153. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  24154. /**
  24155. * Will keep this body still, in a sleep mode.
  24156. * @returns the physics imposter
  24157. */
  24158. sleep(): PhysicsImpostor;
  24159. /**
  24160. * Wake the body up.
  24161. * @returns The physics imposter
  24162. */
  24163. wakeUp(): PhysicsImpostor;
  24164. /**
  24165. * Clones the physics imposter
  24166. * @param newObject The physics imposter clones to this physics-enabled object
  24167. * @returns A nullable physics imposter
  24168. */
  24169. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  24170. /**
  24171. * Disposes the physics imposter
  24172. */
  24173. dispose(): void;
  24174. /**
  24175. * Sets the delta position
  24176. * @param position The delta position amount
  24177. */
  24178. setDeltaPosition(position: Vector3): void;
  24179. /**
  24180. * Sets the delta rotation
  24181. * @param rotation The delta rotation amount
  24182. */
  24183. setDeltaRotation(rotation: Quaternion): void;
  24184. /**
  24185. * Gets the box size of the physics imposter and stores the result in the input parameter
  24186. * @param result Stores the box size
  24187. * @returns The physics imposter
  24188. */
  24189. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  24190. /**
  24191. * Gets the radius of the physics imposter
  24192. * @returns Radius of the physics imposter
  24193. */
  24194. getRadius(): number;
  24195. /**
  24196. * Sync a bone with this impostor
  24197. * @param bone The bone to sync to the impostor.
  24198. * @param boneMesh The mesh that the bone is influencing.
  24199. * @param jointPivot The pivot of the joint / bone in local space.
  24200. * @param distToJoint Optional distance from the impostor to the joint.
  24201. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  24202. */
  24203. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  24204. /**
  24205. * Sync impostor to a bone
  24206. * @param bone The bone that the impostor will be synced to.
  24207. * @param boneMesh The mesh that the bone is influencing.
  24208. * @param jointPivot The pivot of the joint / bone in local space.
  24209. * @param distToJoint Optional distance from the impostor to the joint.
  24210. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  24211. * @param boneAxis Optional vector3 axis the bone is aligned with
  24212. */
  24213. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  24214. /**
  24215. * No-Imposter type
  24216. */
  24217. static NoImpostor: number;
  24218. /**
  24219. * Sphere-Imposter type
  24220. */
  24221. static SphereImpostor: number;
  24222. /**
  24223. * Box-Imposter type
  24224. */
  24225. static BoxImpostor: number;
  24226. /**
  24227. * Plane-Imposter type
  24228. */
  24229. static PlaneImpostor: number;
  24230. /**
  24231. * Mesh-imposter type
  24232. */
  24233. static MeshImpostor: number;
  24234. /**
  24235. * Capsule-Impostor type (Ammo.js plugin only)
  24236. */
  24237. static CapsuleImpostor: number;
  24238. /**
  24239. * Cylinder-Imposter type
  24240. */
  24241. static CylinderImpostor: number;
  24242. /**
  24243. * Particle-Imposter type
  24244. */
  24245. static ParticleImpostor: number;
  24246. /**
  24247. * Heightmap-Imposter type
  24248. */
  24249. static HeightmapImpostor: number;
  24250. /**
  24251. * ConvexHull-Impostor type (Ammo.js plugin only)
  24252. */
  24253. static ConvexHullImpostor: number;
  24254. /**
  24255. * Rope-Imposter type
  24256. */
  24257. static RopeImpostor: number;
  24258. /**
  24259. * Cloth-Imposter type
  24260. */
  24261. static ClothImpostor: number;
  24262. /**
  24263. * Softbody-Imposter type
  24264. */
  24265. static SoftbodyImpostor: number;
  24266. }
  24267. }
  24268. declare module "babylonjs/Meshes/mesh" {
  24269. import { Observable } from "babylonjs/Misc/observable";
  24270. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  24271. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  24272. import { Camera } from "babylonjs/Cameras/camera";
  24273. import { Scene } from "babylonjs/scene";
  24274. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  24275. import { Color4 } from "babylonjs/Maths/math.color";
  24276. import { Engine } from "babylonjs/Engines/engine";
  24277. import { Node } from "babylonjs/node";
  24278. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  24279. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  24280. import { Buffer } from "babylonjs/Meshes/buffer";
  24281. import { Geometry } from "babylonjs/Meshes/geometry";
  24282. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24283. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24284. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  24285. import { Effect } from "babylonjs/Materials/effect";
  24286. import { Material } from "babylonjs/Materials/material";
  24287. import { Skeleton } from "babylonjs/Bones/skeleton";
  24288. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  24289. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  24290. import { Path3D } from "babylonjs/Maths/math.path";
  24291. import { Plane } from "babylonjs/Maths/math.plane";
  24292. import { TransformNode } from "babylonjs/Meshes/transformNode";
  24293. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  24294. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  24295. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  24296. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  24297. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  24298. /**
  24299. * @hidden
  24300. **/
  24301. export class _CreationDataStorage {
  24302. closePath?: boolean;
  24303. closeArray?: boolean;
  24304. idx: number[];
  24305. dashSize: number;
  24306. gapSize: number;
  24307. path3D: Path3D;
  24308. pathArray: Vector3[][];
  24309. arc: number;
  24310. radius: number;
  24311. cap: number;
  24312. tessellation: number;
  24313. }
  24314. /**
  24315. * @hidden
  24316. **/
  24317. class _InstanceDataStorage {
  24318. visibleInstances: any;
  24319. batchCache: _InstancesBatch;
  24320. instancesBufferSize: number;
  24321. instancesBuffer: Nullable<Buffer>;
  24322. instancesData: Float32Array;
  24323. overridenInstanceCount: number;
  24324. isFrozen: boolean;
  24325. previousBatch: Nullable<_InstancesBatch>;
  24326. hardwareInstancedRendering: boolean;
  24327. sideOrientation: number;
  24328. }
  24329. /**
  24330. * @hidden
  24331. **/
  24332. export class _InstancesBatch {
  24333. mustReturn: boolean;
  24334. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  24335. renderSelf: boolean[];
  24336. hardwareInstancedRendering: boolean[];
  24337. }
  24338. /**
  24339. * Class used to represent renderable models
  24340. */
  24341. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  24342. /**
  24343. * Mesh side orientation : usually the external or front surface
  24344. */
  24345. static readonly FRONTSIDE: number;
  24346. /**
  24347. * Mesh side orientation : usually the internal or back surface
  24348. */
  24349. static readonly BACKSIDE: number;
  24350. /**
  24351. * Mesh side orientation : both internal and external or front and back surfaces
  24352. */
  24353. static readonly DOUBLESIDE: number;
  24354. /**
  24355. * Mesh side orientation : by default, `FRONTSIDE`
  24356. */
  24357. static readonly DEFAULTSIDE: number;
  24358. /**
  24359. * Mesh cap setting : no cap
  24360. */
  24361. static readonly NO_CAP: number;
  24362. /**
  24363. * Mesh cap setting : one cap at the beginning of the mesh
  24364. */
  24365. static readonly CAP_START: number;
  24366. /**
  24367. * Mesh cap setting : one cap at the end of the mesh
  24368. */
  24369. static readonly CAP_END: number;
  24370. /**
  24371. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  24372. */
  24373. static readonly CAP_ALL: number;
  24374. /**
  24375. * Mesh pattern setting : no flip or rotate
  24376. */
  24377. static readonly NO_FLIP: number;
  24378. /**
  24379. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  24380. */
  24381. static readonly FLIP_TILE: number;
  24382. /**
  24383. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  24384. */
  24385. static readonly ROTATE_TILE: number;
  24386. /**
  24387. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  24388. */
  24389. static readonly FLIP_ROW: number;
  24390. /**
  24391. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  24392. */
  24393. static readonly ROTATE_ROW: number;
  24394. /**
  24395. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  24396. */
  24397. static readonly FLIP_N_ROTATE_TILE: number;
  24398. /**
  24399. * Mesh pattern setting : rotate pattern and rotate
  24400. */
  24401. static readonly FLIP_N_ROTATE_ROW: number;
  24402. /**
  24403. * Mesh tile positioning : part tiles same on left/right or top/bottom
  24404. */
  24405. static readonly CENTER: number;
  24406. /**
  24407. * Mesh tile positioning : part tiles on left
  24408. */
  24409. static readonly LEFT: number;
  24410. /**
  24411. * Mesh tile positioning : part tiles on right
  24412. */
  24413. static readonly RIGHT: number;
  24414. /**
  24415. * Mesh tile positioning : part tiles on top
  24416. */
  24417. static readonly TOP: number;
  24418. /**
  24419. * Mesh tile positioning : part tiles on bottom
  24420. */
  24421. static readonly BOTTOM: number;
  24422. /**
  24423. * Gets the default side orientation.
  24424. * @param orientation the orientation to value to attempt to get
  24425. * @returns the default orientation
  24426. * @hidden
  24427. */
  24428. static _GetDefaultSideOrientation(orientation?: number): number;
  24429. private _internalMeshDataInfo;
  24430. /**
  24431. * An event triggered before rendering the mesh
  24432. */
  24433. readonly onBeforeRenderObservable: Observable<Mesh>;
  24434. /**
  24435. * An event triggered before binding the mesh
  24436. */
  24437. readonly onBeforeBindObservable: Observable<Mesh>;
  24438. /**
  24439. * An event triggered after rendering the mesh
  24440. */
  24441. readonly onAfterRenderObservable: Observable<Mesh>;
  24442. /**
  24443. * An event triggered before drawing the mesh
  24444. */
  24445. readonly onBeforeDrawObservable: Observable<Mesh>;
  24446. private _onBeforeDrawObserver;
  24447. /**
  24448. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  24449. */
  24450. onBeforeDraw: () => void;
  24451. readonly hasInstances: boolean;
  24452. /**
  24453. * Gets the delay loading state of the mesh (when delay loading is turned on)
  24454. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  24455. */
  24456. delayLoadState: number;
  24457. /**
  24458. * Gets the list of instances created from this mesh
  24459. * it is not supposed to be modified manually.
  24460. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  24461. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  24462. */
  24463. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  24464. /**
  24465. * Gets the file containing delay loading data for this mesh
  24466. */
  24467. delayLoadingFile: string;
  24468. /** @hidden */
  24469. _binaryInfo: any;
  24470. /**
  24471. * User defined function used to change how LOD level selection is done
  24472. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  24473. */
  24474. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  24475. /**
  24476. * Gets or sets the morph target manager
  24477. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  24478. */
  24479. morphTargetManager: Nullable<MorphTargetManager>;
  24480. /** @hidden */
  24481. _creationDataStorage: Nullable<_CreationDataStorage>;
  24482. /** @hidden */
  24483. _geometry: Nullable<Geometry>;
  24484. /** @hidden */
  24485. _delayInfo: Array<string>;
  24486. /** @hidden */
  24487. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  24488. /** @hidden */
  24489. _instanceDataStorage: _InstanceDataStorage;
  24490. private _effectiveMaterial;
  24491. /** @hidden */
  24492. _shouldGenerateFlatShading: boolean;
  24493. /** @hidden */
  24494. _originalBuilderSideOrientation: number;
  24495. /**
  24496. * Use this property to change the original side orientation defined at construction time
  24497. */
  24498. overrideMaterialSideOrientation: Nullable<number>;
  24499. /**
  24500. * Gets the source mesh (the one used to clone this one from)
  24501. */
  24502. readonly source: Nullable<Mesh>;
  24503. /**
  24504. * Gets or sets a boolean indicating that this mesh does not use index buffer
  24505. */
  24506. isUnIndexed: boolean;
  24507. /**
  24508. * @constructor
  24509. * @param name The value used by scene.getMeshByName() to do a lookup.
  24510. * @param scene The scene to add this mesh to.
  24511. * @param parent The parent of this mesh, if it has one
  24512. * @param source An optional Mesh from which geometry is shared, cloned.
  24513. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  24514. * When false, achieved by calling a clone(), also passing False.
  24515. * This will make creation of children, recursive.
  24516. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  24517. */
  24518. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  24519. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  24520. doNotInstantiate: boolean;
  24521. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  24522. /**
  24523. * Gets the class name
  24524. * @returns the string "Mesh".
  24525. */
  24526. getClassName(): string;
  24527. /** @hidden */
  24528. readonly _isMesh: boolean;
  24529. /**
  24530. * Returns a description of this mesh
  24531. * @param fullDetails define if full details about this mesh must be used
  24532. * @returns a descriptive string representing this mesh
  24533. */
  24534. toString(fullDetails?: boolean): string;
  24535. /** @hidden */
  24536. _unBindEffect(): void;
  24537. /**
  24538. * Gets a boolean indicating if this mesh has LOD
  24539. */
  24540. readonly hasLODLevels: boolean;
  24541. /**
  24542. * Gets the list of MeshLODLevel associated with the current mesh
  24543. * @returns an array of MeshLODLevel
  24544. */
  24545. getLODLevels(): MeshLODLevel[];
  24546. private _sortLODLevels;
  24547. /**
  24548. * Add a mesh as LOD level triggered at the given distance.
  24549. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24550. * @param distance The distance from the center of the object to show this level
  24551. * @param mesh The mesh to be added as LOD level (can be null)
  24552. * @return This mesh (for chaining)
  24553. */
  24554. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  24555. /**
  24556. * Returns the LOD level mesh at the passed distance or null if not found.
  24557. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24558. * @param distance The distance from the center of the object to show this level
  24559. * @returns a Mesh or `null`
  24560. */
  24561. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  24562. /**
  24563. * Remove a mesh from the LOD array
  24564. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24565. * @param mesh defines the mesh to be removed
  24566. * @return This mesh (for chaining)
  24567. */
  24568. removeLODLevel(mesh: Mesh): Mesh;
  24569. /**
  24570. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  24571. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24572. * @param camera defines the camera to use to compute distance
  24573. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  24574. * @return This mesh (for chaining)
  24575. */
  24576. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  24577. /**
  24578. * Gets the mesh internal Geometry object
  24579. */
  24580. readonly geometry: Nullable<Geometry>;
  24581. /**
  24582. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  24583. * @returns the total number of vertices
  24584. */
  24585. getTotalVertices(): number;
  24586. /**
  24587. * Returns the content of an associated vertex buffer
  24588. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24589. * - VertexBuffer.PositionKind
  24590. * - VertexBuffer.UVKind
  24591. * - VertexBuffer.UV2Kind
  24592. * - VertexBuffer.UV3Kind
  24593. * - VertexBuffer.UV4Kind
  24594. * - VertexBuffer.UV5Kind
  24595. * - VertexBuffer.UV6Kind
  24596. * - VertexBuffer.ColorKind
  24597. * - VertexBuffer.MatricesIndicesKind
  24598. * - VertexBuffer.MatricesIndicesExtraKind
  24599. * - VertexBuffer.MatricesWeightsKind
  24600. * - VertexBuffer.MatricesWeightsExtraKind
  24601. * @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
  24602. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  24603. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  24604. */
  24605. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  24606. /**
  24607. * Returns the mesh VertexBuffer object from the requested `kind`
  24608. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24609. * - VertexBuffer.PositionKind
  24610. * - VertexBuffer.NormalKind
  24611. * - VertexBuffer.UVKind
  24612. * - VertexBuffer.UV2Kind
  24613. * - VertexBuffer.UV3Kind
  24614. * - VertexBuffer.UV4Kind
  24615. * - VertexBuffer.UV5Kind
  24616. * - VertexBuffer.UV6Kind
  24617. * - VertexBuffer.ColorKind
  24618. * - VertexBuffer.MatricesIndicesKind
  24619. * - VertexBuffer.MatricesIndicesExtraKind
  24620. * - VertexBuffer.MatricesWeightsKind
  24621. * - VertexBuffer.MatricesWeightsExtraKind
  24622. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  24623. */
  24624. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  24625. /**
  24626. * Tests if a specific vertex buffer is associated with this mesh
  24627. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24628. * - VertexBuffer.PositionKind
  24629. * - VertexBuffer.NormalKind
  24630. * - VertexBuffer.UVKind
  24631. * - VertexBuffer.UV2Kind
  24632. * - VertexBuffer.UV3Kind
  24633. * - VertexBuffer.UV4Kind
  24634. * - VertexBuffer.UV5Kind
  24635. * - VertexBuffer.UV6Kind
  24636. * - VertexBuffer.ColorKind
  24637. * - VertexBuffer.MatricesIndicesKind
  24638. * - VertexBuffer.MatricesIndicesExtraKind
  24639. * - VertexBuffer.MatricesWeightsKind
  24640. * - VertexBuffer.MatricesWeightsExtraKind
  24641. * @returns a boolean
  24642. */
  24643. isVerticesDataPresent(kind: string): boolean;
  24644. /**
  24645. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  24646. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24647. * - VertexBuffer.PositionKind
  24648. * - VertexBuffer.UVKind
  24649. * - VertexBuffer.UV2Kind
  24650. * - VertexBuffer.UV3Kind
  24651. * - VertexBuffer.UV4Kind
  24652. * - VertexBuffer.UV5Kind
  24653. * - VertexBuffer.UV6Kind
  24654. * - VertexBuffer.ColorKind
  24655. * - VertexBuffer.MatricesIndicesKind
  24656. * - VertexBuffer.MatricesIndicesExtraKind
  24657. * - VertexBuffer.MatricesWeightsKind
  24658. * - VertexBuffer.MatricesWeightsExtraKind
  24659. * @returns a boolean
  24660. */
  24661. isVertexBufferUpdatable(kind: string): boolean;
  24662. /**
  24663. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  24664. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24665. * - VertexBuffer.PositionKind
  24666. * - VertexBuffer.NormalKind
  24667. * - VertexBuffer.UVKind
  24668. * - VertexBuffer.UV2Kind
  24669. * - VertexBuffer.UV3Kind
  24670. * - VertexBuffer.UV4Kind
  24671. * - VertexBuffer.UV5Kind
  24672. * - VertexBuffer.UV6Kind
  24673. * - VertexBuffer.ColorKind
  24674. * - VertexBuffer.MatricesIndicesKind
  24675. * - VertexBuffer.MatricesIndicesExtraKind
  24676. * - VertexBuffer.MatricesWeightsKind
  24677. * - VertexBuffer.MatricesWeightsExtraKind
  24678. * @returns an array of strings
  24679. */
  24680. getVerticesDataKinds(): string[];
  24681. /**
  24682. * Returns a positive integer : the total number of indices in this mesh geometry.
  24683. * @returns the numner of indices or zero if the mesh has no geometry.
  24684. */
  24685. getTotalIndices(): number;
  24686. /**
  24687. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  24688. * @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.
  24689. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  24690. * @returns the indices array or an empty array if the mesh has no geometry
  24691. */
  24692. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  24693. readonly isBlocked: boolean;
  24694. /**
  24695. * Determine if the current mesh is ready to be rendered
  24696. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  24697. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  24698. * @returns true if all associated assets are ready (material, textures, shaders)
  24699. */
  24700. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  24701. /**
  24702. * 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.
  24703. */
  24704. readonly areNormalsFrozen: boolean;
  24705. /**
  24706. * 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.
  24707. * @returns the current mesh
  24708. */
  24709. freezeNormals(): Mesh;
  24710. /**
  24711. * 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
  24712. * @returns the current mesh
  24713. */
  24714. unfreezeNormals(): Mesh;
  24715. /**
  24716. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  24717. */
  24718. overridenInstanceCount: number;
  24719. /** @hidden */
  24720. _preActivate(): Mesh;
  24721. /** @hidden */
  24722. _preActivateForIntermediateRendering(renderId: number): Mesh;
  24723. /** @hidden */
  24724. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  24725. /**
  24726. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  24727. * This means the mesh underlying bounding box and sphere are recomputed.
  24728. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  24729. * @returns the current mesh
  24730. */
  24731. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  24732. /** @hidden */
  24733. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  24734. /**
  24735. * This function will subdivide the mesh into multiple submeshes
  24736. * @param count defines the expected number of submeshes
  24737. */
  24738. subdivide(count: number): void;
  24739. /**
  24740. * Copy a FloatArray into a specific associated vertex buffer
  24741. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24742. * - VertexBuffer.PositionKind
  24743. * - VertexBuffer.UVKind
  24744. * - VertexBuffer.UV2Kind
  24745. * - VertexBuffer.UV3Kind
  24746. * - VertexBuffer.UV4Kind
  24747. * - VertexBuffer.UV5Kind
  24748. * - VertexBuffer.UV6Kind
  24749. * - VertexBuffer.ColorKind
  24750. * - VertexBuffer.MatricesIndicesKind
  24751. * - VertexBuffer.MatricesIndicesExtraKind
  24752. * - VertexBuffer.MatricesWeightsKind
  24753. * - VertexBuffer.MatricesWeightsExtraKind
  24754. * @param data defines the data source
  24755. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24756. * @param stride defines the data stride size (can be null)
  24757. * @returns the current mesh
  24758. */
  24759. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  24760. /**
  24761. * Delete a vertex buffer associated with this mesh
  24762. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  24763. * - VertexBuffer.PositionKind
  24764. * - VertexBuffer.UVKind
  24765. * - VertexBuffer.UV2Kind
  24766. * - VertexBuffer.UV3Kind
  24767. * - VertexBuffer.UV4Kind
  24768. * - VertexBuffer.UV5Kind
  24769. * - VertexBuffer.UV6Kind
  24770. * - VertexBuffer.ColorKind
  24771. * - VertexBuffer.MatricesIndicesKind
  24772. * - VertexBuffer.MatricesIndicesExtraKind
  24773. * - VertexBuffer.MatricesWeightsKind
  24774. * - VertexBuffer.MatricesWeightsExtraKind
  24775. */
  24776. removeVerticesData(kind: string): void;
  24777. /**
  24778. * Flags an associated vertex buffer as updatable
  24779. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  24780. * - VertexBuffer.PositionKind
  24781. * - VertexBuffer.UVKind
  24782. * - VertexBuffer.UV2Kind
  24783. * - VertexBuffer.UV3Kind
  24784. * - VertexBuffer.UV4Kind
  24785. * - VertexBuffer.UV5Kind
  24786. * - VertexBuffer.UV6Kind
  24787. * - VertexBuffer.ColorKind
  24788. * - VertexBuffer.MatricesIndicesKind
  24789. * - VertexBuffer.MatricesIndicesExtraKind
  24790. * - VertexBuffer.MatricesWeightsKind
  24791. * - VertexBuffer.MatricesWeightsExtraKind
  24792. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24793. */
  24794. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  24795. /**
  24796. * Sets the mesh global Vertex Buffer
  24797. * @param buffer defines the buffer to use
  24798. * @returns the current mesh
  24799. */
  24800. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  24801. /**
  24802. * Update a specific associated vertex buffer
  24803. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24804. * - VertexBuffer.PositionKind
  24805. * - VertexBuffer.UVKind
  24806. * - VertexBuffer.UV2Kind
  24807. * - VertexBuffer.UV3Kind
  24808. * - VertexBuffer.UV4Kind
  24809. * - VertexBuffer.UV5Kind
  24810. * - VertexBuffer.UV6Kind
  24811. * - VertexBuffer.ColorKind
  24812. * - VertexBuffer.MatricesIndicesKind
  24813. * - VertexBuffer.MatricesIndicesExtraKind
  24814. * - VertexBuffer.MatricesWeightsKind
  24815. * - VertexBuffer.MatricesWeightsExtraKind
  24816. * @param data defines the data source
  24817. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  24818. * @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)
  24819. * @returns the current mesh
  24820. */
  24821. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  24822. /**
  24823. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  24824. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  24825. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  24826. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  24827. * @returns the current mesh
  24828. */
  24829. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  24830. /**
  24831. * Creates a un-shared specific occurence of the geometry for the mesh.
  24832. * @returns the current mesh
  24833. */
  24834. makeGeometryUnique(): Mesh;
  24835. /**
  24836. * Set the index buffer of this mesh
  24837. * @param indices defines the source data
  24838. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  24839. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  24840. * @returns the current mesh
  24841. */
  24842. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  24843. /**
  24844. * Update the current index buffer
  24845. * @param indices defines the source data
  24846. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  24847. * @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)
  24848. * @returns the current mesh
  24849. */
  24850. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  24851. /**
  24852. * Invert the geometry to move from a right handed system to a left handed one.
  24853. * @returns the current mesh
  24854. */
  24855. toLeftHanded(): Mesh;
  24856. /** @hidden */
  24857. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  24858. /** @hidden */
  24859. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  24860. /**
  24861. * Registers for this mesh a javascript function called just before the rendering process
  24862. * @param func defines the function to call before rendering this mesh
  24863. * @returns the current mesh
  24864. */
  24865. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  24866. /**
  24867. * Disposes a previously registered javascript function called before the rendering
  24868. * @param func defines the function to remove
  24869. * @returns the current mesh
  24870. */
  24871. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  24872. /**
  24873. * Registers for this mesh a javascript function called just after the rendering is complete
  24874. * @param func defines the function to call after rendering this mesh
  24875. * @returns the current mesh
  24876. */
  24877. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  24878. /**
  24879. * Disposes a previously registered javascript function called after the rendering.
  24880. * @param func defines the function to remove
  24881. * @returns the current mesh
  24882. */
  24883. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  24884. /** @hidden */
  24885. _getInstancesRenderList(subMeshId: number): _InstancesBatch;
  24886. /** @hidden */
  24887. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  24888. /** @hidden */
  24889. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  24890. /** @hidden */
  24891. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  24892. /** @hidden */
  24893. _rebuild(): void;
  24894. /** @hidden */
  24895. _freeze(): void;
  24896. /** @hidden */
  24897. _unFreeze(): void;
  24898. /**
  24899. * 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
  24900. * @param subMesh defines the subMesh to render
  24901. * @param enableAlphaMode defines if alpha mode can be changed
  24902. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  24903. * @returns the current mesh
  24904. */
  24905. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  24906. private _onBeforeDraw;
  24907. /**
  24908. * Renormalize the mesh and patch it up if there are no weights
  24909. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  24910. * However in the case of zero weights then we set just a single influence to 1.
  24911. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  24912. */
  24913. cleanMatrixWeights(): void;
  24914. private normalizeSkinFourWeights;
  24915. private normalizeSkinWeightsAndExtra;
  24916. /**
  24917. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  24918. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  24919. * the user know there was an issue with importing the mesh
  24920. * @returns a validation object with skinned, valid and report string
  24921. */
  24922. validateSkinning(): {
  24923. skinned: boolean;
  24924. valid: boolean;
  24925. report: string;
  24926. };
  24927. /** @hidden */
  24928. _checkDelayState(): Mesh;
  24929. private _queueLoad;
  24930. /**
  24931. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  24932. * A mesh is in the frustum if its bounding box intersects the frustum
  24933. * @param frustumPlanes defines the frustum to test
  24934. * @returns true if the mesh is in the frustum planes
  24935. */
  24936. isInFrustum(frustumPlanes: Plane[]): boolean;
  24937. /**
  24938. * Sets the mesh material by the material or multiMaterial `id` property
  24939. * @param id is a string identifying the material or the multiMaterial
  24940. * @returns the current mesh
  24941. */
  24942. setMaterialByID(id: string): Mesh;
  24943. /**
  24944. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  24945. * @returns an array of IAnimatable
  24946. */
  24947. getAnimatables(): IAnimatable[];
  24948. /**
  24949. * Modifies the mesh geometry according to the passed transformation matrix.
  24950. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  24951. * The mesh normals are modified using the same transformation.
  24952. * Note that, under the hood, this method sets a new VertexBuffer each call.
  24953. * @param transform defines the transform matrix to use
  24954. * @see http://doc.babylonjs.com/resources/baking_transformations
  24955. * @returns the current mesh
  24956. */
  24957. bakeTransformIntoVertices(transform: Matrix): Mesh;
  24958. /**
  24959. * Modifies the mesh geometry according to its own current World Matrix.
  24960. * The mesh World Matrix is then reset.
  24961. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  24962. * Note that, under the hood, this method sets a new VertexBuffer each call.
  24963. * @see http://doc.babylonjs.com/resources/baking_transformations
  24964. * @returns the current mesh
  24965. */
  24966. bakeCurrentTransformIntoVertices(): Mesh;
  24967. /** @hidden */
  24968. readonly _positions: Nullable<Vector3[]>;
  24969. /** @hidden */
  24970. _resetPointsArrayCache(): Mesh;
  24971. /** @hidden */
  24972. _generatePointsArray(): boolean;
  24973. /**
  24974. * Returns a new Mesh object generated from the current mesh properties.
  24975. * This method must not get confused with createInstance()
  24976. * @param name is a string, the name given to the new mesh
  24977. * @param newParent can be any Node object (default `null`)
  24978. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  24979. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  24980. * @returns a new mesh
  24981. */
  24982. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  24983. /**
  24984. * Releases resources associated with this mesh.
  24985. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  24986. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  24987. */
  24988. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  24989. /** @hidden */
  24990. _disposeInstanceSpecificData(): void;
  24991. /**
  24992. * Modifies the mesh geometry according to a displacement map.
  24993. * 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.
  24994. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  24995. * @param url is a string, the URL from the image file is to be downloaded.
  24996. * @param minHeight is the lower limit of the displacement.
  24997. * @param maxHeight is the upper limit of the displacement.
  24998. * @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.
  24999. * @param uvOffset is an optional vector2 used to offset UV.
  25000. * @param uvScale is an optional vector2 used to scale UV.
  25001. * @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.
  25002. * @returns the Mesh.
  25003. */
  25004. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  25005. /**
  25006. * Modifies the mesh geometry according to a displacementMap buffer.
  25007. * 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.
  25008. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  25009. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  25010. * @param heightMapWidth is the width of the buffer image.
  25011. * @param heightMapHeight is the height of the buffer image.
  25012. * @param minHeight is the lower limit of the displacement.
  25013. * @param maxHeight is the upper limit of the displacement.
  25014. * @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.
  25015. * @param uvOffset is an optional vector2 used to offset UV.
  25016. * @param uvScale is an optional vector2 used to scale UV.
  25017. * @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.
  25018. * @returns the Mesh.
  25019. */
  25020. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  25021. /**
  25022. * Modify the mesh to get a flat shading rendering.
  25023. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  25024. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  25025. * @returns current mesh
  25026. */
  25027. convertToFlatShadedMesh(): Mesh;
  25028. /**
  25029. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  25030. * In other words, more vertices, no more indices and a single bigger VBO.
  25031. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  25032. * @returns current mesh
  25033. */
  25034. convertToUnIndexedMesh(): Mesh;
  25035. /**
  25036. * Inverses facet orientations.
  25037. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25038. * @param flipNormals will also inverts the normals
  25039. * @returns current mesh
  25040. */
  25041. flipFaces(flipNormals?: boolean): Mesh;
  25042. /**
  25043. * Increase the number of facets and hence vertices in a mesh
  25044. * Vertex normals are interpolated from existing vertex normals
  25045. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25046. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  25047. */
  25048. increaseVertices(numberPerEdge: number): void;
  25049. /**
  25050. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  25051. * This will undo any application of covertToFlatShadedMesh
  25052. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25053. */
  25054. forceSharedVertices(): void;
  25055. /** @hidden */
  25056. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  25057. /** @hidden */
  25058. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  25059. /**
  25060. * Creates a new InstancedMesh object from the mesh model.
  25061. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  25062. * @param name defines the name of the new instance
  25063. * @returns a new InstancedMesh
  25064. */
  25065. createInstance(name: string): InstancedMesh;
  25066. /**
  25067. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  25068. * After this call, all the mesh instances have the same submeshes than the current mesh.
  25069. * @returns the current mesh
  25070. */
  25071. synchronizeInstances(): Mesh;
  25072. /**
  25073. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  25074. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  25075. * This should be used together with the simplification to avoid disappearing triangles.
  25076. * @param successCallback an optional success callback to be called after the optimization finished.
  25077. * @returns the current mesh
  25078. */
  25079. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  25080. /**
  25081. * Serialize current mesh
  25082. * @param serializationObject defines the object which will receive the serialization data
  25083. */
  25084. serialize(serializationObject: any): void;
  25085. /** @hidden */
  25086. _syncGeometryWithMorphTargetManager(): void;
  25087. /** @hidden */
  25088. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  25089. /**
  25090. * Returns a new Mesh object parsed from the source provided.
  25091. * @param parsedMesh is the source
  25092. * @param scene defines the hosting scene
  25093. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  25094. * @returns a new Mesh
  25095. */
  25096. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  25097. /**
  25098. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  25099. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25100. * @param name defines the name of the mesh to create
  25101. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  25102. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  25103. * @param closePath creates a seam between the first and the last points of each path of the path array
  25104. * @param offset is taken in account only if the `pathArray` is containing a single path
  25105. * @param scene defines the hosting scene
  25106. * @param updatable defines if the mesh must be flagged as updatable
  25107. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25108. * @param instance defines an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#ribbon)
  25109. * @returns a new Mesh
  25110. */
  25111. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25112. /**
  25113. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  25114. * @param name defines the name of the mesh to create
  25115. * @param radius sets the radius size (float) of the polygon (default 0.5)
  25116. * @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
  25117. * @param scene defines the hosting scene
  25118. * @param updatable defines if the mesh must be flagged as updatable
  25119. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25120. * @returns a new Mesh
  25121. */
  25122. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  25123. /**
  25124. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  25125. * @param name defines the name of the mesh to create
  25126. * @param size sets the size (float) of each box side (default 1)
  25127. * @param scene defines the hosting scene
  25128. * @param updatable defines if the mesh must be flagged as updatable
  25129. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25130. * @returns a new Mesh
  25131. */
  25132. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  25133. /**
  25134. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  25135. * @param name defines the name of the mesh to create
  25136. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  25137. * @param diameter sets the diameter size (float) of the sphere (default 1)
  25138. * @param scene defines the hosting scene
  25139. * @param updatable defines if the mesh must be flagged as updatable
  25140. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25141. * @returns a new Mesh
  25142. */
  25143. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25144. /**
  25145. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  25146. * @param name defines the name of the mesh to create
  25147. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  25148. * @param diameter sets the diameter size (float) of the sphere (default 1)
  25149. * @param scene defines the hosting scene
  25150. * @returns a new Mesh
  25151. */
  25152. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  25153. /**
  25154. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  25155. * @param name defines the name of the mesh to create
  25156. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  25157. * @param diameterTop set the top cap diameter (floats, default 1)
  25158. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  25159. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  25160. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  25161. * @param scene defines the hosting scene
  25162. * @param updatable defines if the mesh must be flagged as updatable
  25163. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25164. * @returns a new Mesh
  25165. */
  25166. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  25167. /**
  25168. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  25169. * @param name defines the name of the mesh to create
  25170. * @param diameter sets the diameter size (float) of the torus (default 1)
  25171. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  25172. * @param tessellation sets the number of torus sides (postive integer, default 16)
  25173. * @param scene defines the hosting scene
  25174. * @param updatable defines if the mesh must be flagged as updatable
  25175. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25176. * @returns a new Mesh
  25177. */
  25178. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25179. /**
  25180. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  25181. * @param name defines the name of the mesh to create
  25182. * @param radius sets the global radius size (float) of the torus knot (default 2)
  25183. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  25184. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  25185. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  25186. * @param p the number of windings on X axis (positive integers, default 2)
  25187. * @param q the number of windings on Y axis (positive integers, default 3)
  25188. * @param scene defines the hosting scene
  25189. * @param updatable defines if the mesh must be flagged as updatable
  25190. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25191. * @returns a new Mesh
  25192. */
  25193. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25194. /**
  25195. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  25196. * @param name defines the name of the mesh to create
  25197. * @param points is an array successive Vector3
  25198. * @param scene defines the hosting scene
  25199. * @param updatable defines if the mesh must be flagged as updatable
  25200. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines).
  25201. * @returns a new Mesh
  25202. */
  25203. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  25204. /**
  25205. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  25206. * @param name defines the name of the mesh to create
  25207. * @param points is an array successive Vector3
  25208. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  25209. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  25210. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  25211. * @param scene defines the hosting scene
  25212. * @param updatable defines if the mesh must be flagged as updatable
  25213. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines)
  25214. * @returns a new Mesh
  25215. */
  25216. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  25217. /**
  25218. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  25219. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  25220. * 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.
  25221. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25222. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  25223. * Remember you can only change the shape positions, not their number when updating a polygon.
  25224. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  25225. * @param name defines the name of the mesh to create
  25226. * @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
  25227. * @param scene defines the hosting scene
  25228. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  25229. * @param updatable defines if the mesh must be flagged as updatable
  25230. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25231. * @param earcutInjection can be used to inject your own earcut reference
  25232. * @returns a new Mesh
  25233. */
  25234. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  25235. /**
  25236. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  25237. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  25238. * @param name defines the name of the mesh to create
  25239. * @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
  25240. * @param depth defines the height of extrusion
  25241. * @param scene defines the hosting scene
  25242. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  25243. * @param updatable defines if the mesh must be flagged as updatable
  25244. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25245. * @param earcutInjection can be used to inject your own earcut reference
  25246. * @returns a new Mesh
  25247. */
  25248. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  25249. /**
  25250. * Creates an extruded shape mesh.
  25251. * 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
  25252. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25253. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  25254. * @param name defines the name of the mesh to create
  25255. * @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
  25256. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  25257. * @param scale is the value to scale the shape
  25258. * @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
  25259. * @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
  25260. * @param scene defines the hosting scene
  25261. * @param updatable defines if the mesh must be flagged as updatable
  25262. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25263. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#extruded-shape)
  25264. * @returns a new Mesh
  25265. */
  25266. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25267. /**
  25268. * Creates an custom extruded shape mesh.
  25269. * The custom extrusion is a parametric shape.
  25270. * It has no predefined shape. Its final shape will depend on the input parameters.
  25271. * Please consider using the same method from the MeshBuilder class instead
  25272. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  25273. * @param name defines the name of the mesh to create
  25274. * @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
  25275. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  25276. * @param scaleFunction is a custom Javascript function called on each path point
  25277. * @param rotationFunction is a custom Javascript function called on each path point
  25278. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  25279. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  25280. * @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
  25281. * @param scene defines the hosting scene
  25282. * @param updatable defines if the mesh must be flagged as updatable
  25283. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25284. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape)
  25285. * @returns a new Mesh
  25286. */
  25287. 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;
  25288. /**
  25289. * Creates lathe mesh.
  25290. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  25291. * Please consider using the same method from the MeshBuilder class instead
  25292. * @param name defines the name of the mesh to create
  25293. * @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
  25294. * @param radius is the radius value of the lathe
  25295. * @param tessellation is the side number of the lathe.
  25296. * @param scene defines the hosting scene
  25297. * @param updatable defines if the mesh must be flagged as updatable
  25298. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25299. * @returns a new Mesh
  25300. */
  25301. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25302. /**
  25303. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  25304. * @param name defines the name of the mesh to create
  25305. * @param size sets the size (float) of both sides of the plane at once (default 1)
  25306. * @param scene defines the hosting scene
  25307. * @param updatable defines if the mesh must be flagged as updatable
  25308. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25309. * @returns a new Mesh
  25310. */
  25311. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25312. /**
  25313. * Creates a ground mesh.
  25314. * Please consider using the same method from the MeshBuilder class instead
  25315. * @param name defines the name of the mesh to create
  25316. * @param width set the width of the ground
  25317. * @param height set the height of the ground
  25318. * @param subdivisions sets the number of subdivisions per side
  25319. * @param scene defines the hosting scene
  25320. * @param updatable defines if the mesh must be flagged as updatable
  25321. * @returns a new Mesh
  25322. */
  25323. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  25324. /**
  25325. * Creates a tiled ground mesh.
  25326. * Please consider using the same method from the MeshBuilder class instead
  25327. * @param name defines the name of the mesh to create
  25328. * @param xmin set the ground minimum X coordinate
  25329. * @param zmin set the ground minimum Y coordinate
  25330. * @param xmax set the ground maximum X coordinate
  25331. * @param zmax set the ground maximum Z coordinate
  25332. * @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
  25333. * @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
  25334. * @param scene defines the hosting scene
  25335. * @param updatable defines if the mesh must be flagged as updatable
  25336. * @returns a new Mesh
  25337. */
  25338. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  25339. w: number;
  25340. h: number;
  25341. }, precision: {
  25342. w: number;
  25343. h: number;
  25344. }, scene: Scene, updatable?: boolean): Mesh;
  25345. /**
  25346. * Creates a ground mesh from a height map.
  25347. * Please consider using the same method from the MeshBuilder class instead
  25348. * @see http://doc.babylonjs.com/babylon101/height_map
  25349. * @param name defines the name of the mesh to create
  25350. * @param url sets the URL of the height map image resource
  25351. * @param width set the ground width size
  25352. * @param height set the ground height size
  25353. * @param subdivisions sets the number of subdivision per side
  25354. * @param minHeight is the minimum altitude on the ground
  25355. * @param maxHeight is the maximum altitude on the ground
  25356. * @param scene defines the hosting scene
  25357. * @param updatable defines if the mesh must be flagged as updatable
  25358. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  25359. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  25360. * @returns a new Mesh
  25361. */
  25362. 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;
  25363. /**
  25364. * Creates a tube mesh.
  25365. * The tube is a parametric shape.
  25366. * It has no predefined shape. Its final shape will depend on the input parameters.
  25367. * Please consider using the same method from the MeshBuilder class instead
  25368. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25369. * @param name defines the name of the mesh to create
  25370. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  25371. * @param radius sets the tube radius size
  25372. * @param tessellation is the number of sides on the tubular surface
  25373. * @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
  25374. * @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
  25375. * @param scene defines the hosting scene
  25376. * @param updatable defines if the mesh must be flagged as updatable
  25377. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25378. * @param instance is an instance of an existing Tube object to be updated with the passed `pathArray` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#tube)
  25379. * @returns a new Mesh
  25380. */
  25381. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  25382. (i: number, distance: number): number;
  25383. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25384. /**
  25385. * Creates a polyhedron mesh.
  25386. * Please consider using the same method from the MeshBuilder class instead.
  25387. * * 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
  25388. * * The parameter `size` (positive float, default 1) sets the polygon size
  25389. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  25390. * * 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`
  25391. * * 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
  25392. * * 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)`)
  25393. * * 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
  25394. * * 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
  25395. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25396. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  25397. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25398. * @param name defines the name of the mesh to create
  25399. * @param options defines the options used to create the mesh
  25400. * @param scene defines the hosting scene
  25401. * @returns a new Mesh
  25402. */
  25403. static CreatePolyhedron(name: string, options: {
  25404. type?: number;
  25405. size?: number;
  25406. sizeX?: number;
  25407. sizeY?: number;
  25408. sizeZ?: number;
  25409. custom?: any;
  25410. faceUV?: Vector4[];
  25411. faceColors?: Color4[];
  25412. updatable?: boolean;
  25413. sideOrientation?: number;
  25414. }, scene: Scene): Mesh;
  25415. /**
  25416. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  25417. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  25418. * * 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`)
  25419. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  25420. * * 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
  25421. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25422. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  25423. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25424. * @param name defines the name of the mesh
  25425. * @param options defines the options used to create the mesh
  25426. * @param scene defines the hosting scene
  25427. * @returns a new Mesh
  25428. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  25429. */
  25430. static CreateIcoSphere(name: string, options: {
  25431. radius?: number;
  25432. flat?: boolean;
  25433. subdivisions?: number;
  25434. sideOrientation?: number;
  25435. updatable?: boolean;
  25436. }, scene: Scene): Mesh;
  25437. /**
  25438. * Creates a decal mesh.
  25439. * Please consider using the same method from the MeshBuilder class instead.
  25440. * A decal is a mesh usually applied as a model onto the surface of another mesh
  25441. * @param name defines the name of the mesh
  25442. * @param sourceMesh defines the mesh receiving the decal
  25443. * @param position sets the position of the decal in world coordinates
  25444. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  25445. * @param size sets the decal scaling
  25446. * @param angle sets the angle to rotate the decal
  25447. * @returns a new Mesh
  25448. */
  25449. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  25450. /**
  25451. * Prepare internal position array for software CPU skinning
  25452. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  25453. */
  25454. setPositionsForCPUSkinning(): Float32Array;
  25455. /**
  25456. * Prepare internal normal array for software CPU skinning
  25457. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  25458. */
  25459. setNormalsForCPUSkinning(): Float32Array;
  25460. /**
  25461. * Updates the vertex buffer by applying transformation from the bones
  25462. * @param skeleton defines the skeleton to apply to current mesh
  25463. * @returns the current mesh
  25464. */
  25465. applySkeleton(skeleton: Skeleton): Mesh;
  25466. /**
  25467. * 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
  25468. * @param meshes defines the list of meshes to scan
  25469. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  25470. */
  25471. static MinMax(meshes: AbstractMesh[]): {
  25472. min: Vector3;
  25473. max: Vector3;
  25474. };
  25475. /**
  25476. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  25477. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  25478. * @returns a vector3
  25479. */
  25480. static Center(meshesOrMinMaxVector: {
  25481. min: Vector3;
  25482. max: Vector3;
  25483. } | AbstractMesh[]): Vector3;
  25484. /**
  25485. * Merge the array of meshes into a single mesh for performance reasons.
  25486. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  25487. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  25488. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  25489. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  25490. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  25491. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  25492. * @returns a new mesh
  25493. */
  25494. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  25495. /** @hidden */
  25496. addInstance(instance: InstancedMesh): void;
  25497. /** @hidden */
  25498. removeInstance(instance: InstancedMesh): void;
  25499. }
  25500. }
  25501. declare module "babylonjs/Cameras/camera" {
  25502. import { SmartArray } from "babylonjs/Misc/smartArray";
  25503. import { Observable } from "babylonjs/Misc/observable";
  25504. import { Nullable } from "babylonjs/types";
  25505. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  25506. import { Scene } from "babylonjs/scene";
  25507. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  25508. import { Node } from "babylonjs/node";
  25509. import { Mesh } from "babylonjs/Meshes/mesh";
  25510. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25511. import { ICullable } from "babylonjs/Culling/boundingInfo";
  25512. import { Viewport } from "babylonjs/Maths/math.viewport";
  25513. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25514. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25515. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  25516. import { Ray } from "babylonjs/Culling/ray";
  25517. /**
  25518. * This is the base class of all the camera used in the application.
  25519. * @see http://doc.babylonjs.com/features/cameras
  25520. */
  25521. export class Camera extends Node {
  25522. /** @hidden */
  25523. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  25524. /**
  25525. * This is the default projection mode used by the cameras.
  25526. * It helps recreating a feeling of perspective and better appreciate depth.
  25527. * This is the best way to simulate real life cameras.
  25528. */
  25529. static readonly PERSPECTIVE_CAMERA: number;
  25530. /**
  25531. * This helps creating camera with an orthographic mode.
  25532. * 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.
  25533. */
  25534. static readonly ORTHOGRAPHIC_CAMERA: number;
  25535. /**
  25536. * This is the default FOV mode for perspective cameras.
  25537. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  25538. */
  25539. static readonly FOVMODE_VERTICAL_FIXED: number;
  25540. /**
  25541. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  25542. */
  25543. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  25544. /**
  25545. * This specifies ther is no need for a camera rig.
  25546. * Basically only one eye is rendered corresponding to the camera.
  25547. */
  25548. static readonly RIG_MODE_NONE: number;
  25549. /**
  25550. * Simulates a camera Rig with one blue eye and one red eye.
  25551. * This can be use with 3d blue and red glasses.
  25552. */
  25553. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  25554. /**
  25555. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  25556. */
  25557. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  25558. /**
  25559. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  25560. */
  25561. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  25562. /**
  25563. * Defines that both eyes of the camera will be rendered over under each other.
  25564. */
  25565. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  25566. /**
  25567. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  25568. */
  25569. static readonly RIG_MODE_VR: number;
  25570. /**
  25571. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  25572. */
  25573. static readonly RIG_MODE_WEBVR: number;
  25574. /**
  25575. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  25576. */
  25577. static readonly RIG_MODE_CUSTOM: number;
  25578. /**
  25579. * Defines if by default attaching controls should prevent the default javascript event to continue.
  25580. */
  25581. static ForceAttachControlToAlwaysPreventDefault: boolean;
  25582. /**
  25583. * Define the input manager associated with the camera.
  25584. */
  25585. inputs: CameraInputsManager<Camera>;
  25586. /** @hidden */
  25587. _position: Vector3;
  25588. /**
  25589. * Define the current local position of the camera in the scene
  25590. */
  25591. position: Vector3;
  25592. /**
  25593. * The vector the camera should consider as up.
  25594. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  25595. */
  25596. upVector: Vector3;
  25597. /**
  25598. * Define the current limit on the left side for an orthographic camera
  25599. * In scene unit
  25600. */
  25601. orthoLeft: Nullable<number>;
  25602. /**
  25603. * Define the current limit on the right side for an orthographic camera
  25604. * In scene unit
  25605. */
  25606. orthoRight: Nullable<number>;
  25607. /**
  25608. * Define the current limit on the bottom side for an orthographic camera
  25609. * In scene unit
  25610. */
  25611. orthoBottom: Nullable<number>;
  25612. /**
  25613. * Define the current limit on the top side for an orthographic camera
  25614. * In scene unit
  25615. */
  25616. orthoTop: Nullable<number>;
  25617. /**
  25618. * Field Of View is set in Radians. (default is 0.8)
  25619. */
  25620. fov: number;
  25621. /**
  25622. * Define the minimum distance the camera can see from.
  25623. * This is important to note that the depth buffer are not infinite and the closer it starts
  25624. * the more your scene might encounter depth fighting issue.
  25625. */
  25626. minZ: number;
  25627. /**
  25628. * Define the maximum distance the camera can see to.
  25629. * This is important to note that the depth buffer are not infinite and the further it end
  25630. * the more your scene might encounter depth fighting issue.
  25631. */
  25632. maxZ: number;
  25633. /**
  25634. * Define the default inertia of the camera.
  25635. * This helps giving a smooth feeling to the camera movement.
  25636. */
  25637. inertia: number;
  25638. /**
  25639. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  25640. */
  25641. mode: number;
  25642. /**
  25643. * Define wether the camera is intermediate.
  25644. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  25645. */
  25646. isIntermediate: boolean;
  25647. /**
  25648. * Define the viewport of the camera.
  25649. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  25650. */
  25651. viewport: Viewport;
  25652. /**
  25653. * Restricts the camera to viewing objects with the same layerMask.
  25654. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  25655. */
  25656. layerMask: number;
  25657. /**
  25658. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  25659. */
  25660. fovMode: number;
  25661. /**
  25662. * Rig mode of the camera.
  25663. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  25664. * This is normally controlled byt the camera themselves as internal use.
  25665. */
  25666. cameraRigMode: number;
  25667. /**
  25668. * Defines the distance between both "eyes" in case of a RIG
  25669. */
  25670. interaxialDistance: number;
  25671. /**
  25672. * Defines if stereoscopic rendering is done side by side or over under.
  25673. */
  25674. isStereoscopicSideBySide: boolean;
  25675. /**
  25676. * 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
  25677. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  25678. * else in the scene. (Eg. security camera)
  25679. *
  25680. * 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)
  25681. */
  25682. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  25683. /**
  25684. * When set, the camera will render to this render target instead of the default canvas
  25685. *
  25686. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  25687. */
  25688. outputRenderTarget: Nullable<RenderTargetTexture>;
  25689. /**
  25690. * Observable triggered when the camera view matrix has changed.
  25691. */
  25692. onViewMatrixChangedObservable: Observable<Camera>;
  25693. /**
  25694. * Observable triggered when the camera Projection matrix has changed.
  25695. */
  25696. onProjectionMatrixChangedObservable: Observable<Camera>;
  25697. /**
  25698. * Observable triggered when the inputs have been processed.
  25699. */
  25700. onAfterCheckInputsObservable: Observable<Camera>;
  25701. /**
  25702. * Observable triggered when reset has been called and applied to the camera.
  25703. */
  25704. onRestoreStateObservable: Observable<Camera>;
  25705. /** @hidden */
  25706. _cameraRigParams: any;
  25707. /** @hidden */
  25708. _rigCameras: Camera[];
  25709. /** @hidden */
  25710. _rigPostProcess: Nullable<PostProcess>;
  25711. protected _webvrViewMatrix: Matrix;
  25712. /** @hidden */
  25713. _skipRendering: boolean;
  25714. /** @hidden */
  25715. _projectionMatrix: Matrix;
  25716. /** @hidden */
  25717. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  25718. /** @hidden */
  25719. _activeMeshes: SmartArray<AbstractMesh>;
  25720. protected _globalPosition: Vector3;
  25721. /** @hidden */
  25722. _computedViewMatrix: Matrix;
  25723. private _doNotComputeProjectionMatrix;
  25724. private _transformMatrix;
  25725. private _frustumPlanes;
  25726. private _refreshFrustumPlanes;
  25727. private _storedFov;
  25728. private _stateStored;
  25729. /**
  25730. * Instantiates a new camera object.
  25731. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  25732. * @see http://doc.babylonjs.com/features/cameras
  25733. * @param name Defines the name of the camera in the scene
  25734. * @param position Defines the position of the camera
  25735. * @param scene Defines the scene the camera belongs too
  25736. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  25737. */
  25738. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  25739. /**
  25740. * Store current camera state (fov, position, etc..)
  25741. * @returns the camera
  25742. */
  25743. storeState(): Camera;
  25744. /**
  25745. * Restores the camera state values if it has been stored. You must call storeState() first
  25746. */
  25747. protected _restoreStateValues(): boolean;
  25748. /**
  25749. * Restored camera state. You must call storeState() first.
  25750. * @returns true if restored and false otherwise
  25751. */
  25752. restoreState(): boolean;
  25753. /**
  25754. * Gets the class name of the camera.
  25755. * @returns the class name
  25756. */
  25757. getClassName(): string;
  25758. /** @hidden */
  25759. readonly _isCamera: boolean;
  25760. /**
  25761. * Gets a string representation of the camera useful for debug purpose.
  25762. * @param fullDetails Defines that a more verboe level of logging is required
  25763. * @returns the string representation
  25764. */
  25765. toString(fullDetails?: boolean): string;
  25766. /**
  25767. * Gets the current world space position of the camera.
  25768. */
  25769. readonly globalPosition: Vector3;
  25770. /**
  25771. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  25772. * @returns the active meshe list
  25773. */
  25774. getActiveMeshes(): SmartArray<AbstractMesh>;
  25775. /**
  25776. * Check wether a mesh is part of the current active mesh list of the camera
  25777. * @param mesh Defines the mesh to check
  25778. * @returns true if active, false otherwise
  25779. */
  25780. isActiveMesh(mesh: Mesh): boolean;
  25781. /**
  25782. * Is this camera ready to be used/rendered
  25783. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  25784. * @return true if the camera is ready
  25785. */
  25786. isReady(completeCheck?: boolean): boolean;
  25787. /** @hidden */
  25788. _initCache(): void;
  25789. /** @hidden */
  25790. _updateCache(ignoreParentClass?: boolean): void;
  25791. /** @hidden */
  25792. _isSynchronized(): boolean;
  25793. /** @hidden */
  25794. _isSynchronizedViewMatrix(): boolean;
  25795. /** @hidden */
  25796. _isSynchronizedProjectionMatrix(): boolean;
  25797. /**
  25798. * Attach the input controls to a specific dom element to get the input from.
  25799. * @param element Defines the element the controls should be listened from
  25800. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  25801. */
  25802. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  25803. /**
  25804. * Detach the current controls from the specified dom element.
  25805. * @param element Defines the element to stop listening the inputs from
  25806. */
  25807. detachControl(element: HTMLElement): void;
  25808. /**
  25809. * Update the camera state according to the different inputs gathered during the frame.
  25810. */
  25811. update(): void;
  25812. /** @hidden */
  25813. _checkInputs(): void;
  25814. /** @hidden */
  25815. readonly rigCameras: Camera[];
  25816. /**
  25817. * Gets the post process used by the rig cameras
  25818. */
  25819. readonly rigPostProcess: Nullable<PostProcess>;
  25820. /**
  25821. * Internal, gets the first post proces.
  25822. * @returns the first post process to be run on this camera.
  25823. */
  25824. _getFirstPostProcess(): Nullable<PostProcess>;
  25825. private _cascadePostProcessesToRigCams;
  25826. /**
  25827. * Attach a post process to the camera.
  25828. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25829. * @param postProcess The post process to attach to the camera
  25830. * @param insertAt The position of the post process in case several of them are in use in the scene
  25831. * @returns the position the post process has been inserted at
  25832. */
  25833. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  25834. /**
  25835. * Detach a post process to the camera.
  25836. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25837. * @param postProcess The post process to detach from the camera
  25838. */
  25839. detachPostProcess(postProcess: PostProcess): void;
  25840. /**
  25841. * Gets the current world matrix of the camera
  25842. */
  25843. getWorldMatrix(): Matrix;
  25844. /** @hidden */
  25845. _getViewMatrix(): Matrix;
  25846. /**
  25847. * Gets the current view matrix of the camera.
  25848. * @param force forces the camera to recompute the matrix without looking at the cached state
  25849. * @returns the view matrix
  25850. */
  25851. getViewMatrix(force?: boolean): Matrix;
  25852. /**
  25853. * Freeze the projection matrix.
  25854. * It will prevent the cache check of the camera projection compute and can speed up perf
  25855. * if no parameter of the camera are meant to change
  25856. * @param projection Defines manually a projection if necessary
  25857. */
  25858. freezeProjectionMatrix(projection?: Matrix): void;
  25859. /**
  25860. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  25861. */
  25862. unfreezeProjectionMatrix(): void;
  25863. /**
  25864. * Gets the current projection matrix of the camera.
  25865. * @param force forces the camera to recompute the matrix without looking at the cached state
  25866. * @returns the projection matrix
  25867. */
  25868. getProjectionMatrix(force?: boolean): Matrix;
  25869. /**
  25870. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  25871. * @returns a Matrix
  25872. */
  25873. getTransformationMatrix(): Matrix;
  25874. private _updateFrustumPlanes;
  25875. /**
  25876. * Checks if a cullable object (mesh...) is in the camera frustum
  25877. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  25878. * @param target The object to check
  25879. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  25880. * @returns true if the object is in frustum otherwise false
  25881. */
  25882. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  25883. /**
  25884. * Checks if a cullable object (mesh...) is in the camera frustum
  25885. * Unlike isInFrustum this cheks the full bounding box
  25886. * @param target The object to check
  25887. * @returns true if the object is in frustum otherwise false
  25888. */
  25889. isCompletelyInFrustum(target: ICullable): boolean;
  25890. /**
  25891. * Gets a ray in the forward direction from the camera.
  25892. * @param length Defines the length of the ray to create
  25893. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  25894. * @param origin Defines the start point of the ray which defaults to the camera position
  25895. * @returns the forward ray
  25896. */
  25897. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  25898. /**
  25899. * Releases resources associated with this node.
  25900. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  25901. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  25902. */
  25903. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  25904. /** @hidden */
  25905. _isLeftCamera: boolean;
  25906. /**
  25907. * Gets the left camera of a rig setup in case of Rigged Camera
  25908. */
  25909. readonly isLeftCamera: boolean;
  25910. /** @hidden */
  25911. _isRightCamera: boolean;
  25912. /**
  25913. * Gets the right camera of a rig setup in case of Rigged Camera
  25914. */
  25915. readonly isRightCamera: boolean;
  25916. /**
  25917. * Gets the left camera of a rig setup in case of Rigged Camera
  25918. */
  25919. readonly leftCamera: Nullable<FreeCamera>;
  25920. /**
  25921. * Gets the right camera of a rig setup in case of Rigged Camera
  25922. */
  25923. readonly rightCamera: Nullable<FreeCamera>;
  25924. /**
  25925. * Gets the left camera target of a rig setup in case of Rigged Camera
  25926. * @returns the target position
  25927. */
  25928. getLeftTarget(): Nullable<Vector3>;
  25929. /**
  25930. * Gets the right camera target of a rig setup in case of Rigged Camera
  25931. * @returns the target position
  25932. */
  25933. getRightTarget(): Nullable<Vector3>;
  25934. /**
  25935. * @hidden
  25936. */
  25937. setCameraRigMode(mode: number, rigParams: any): void;
  25938. /** @hidden */
  25939. static _setStereoscopicRigMode(camera: Camera): void;
  25940. /** @hidden */
  25941. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  25942. /** @hidden */
  25943. static _setVRRigMode(camera: Camera, rigParams: any): void;
  25944. /** @hidden */
  25945. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  25946. /** @hidden */
  25947. _getVRProjectionMatrix(): Matrix;
  25948. protected _updateCameraRotationMatrix(): void;
  25949. protected _updateWebVRCameraRotationMatrix(): void;
  25950. /**
  25951. * This function MUST be overwritten by the different WebVR cameras available.
  25952. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  25953. * @hidden
  25954. */
  25955. _getWebVRProjectionMatrix(): Matrix;
  25956. /**
  25957. * This function MUST be overwritten by the different WebVR cameras available.
  25958. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  25959. * @hidden
  25960. */
  25961. _getWebVRViewMatrix(): Matrix;
  25962. /** @hidden */
  25963. setCameraRigParameter(name: string, value: any): void;
  25964. /**
  25965. * needs to be overridden by children so sub has required properties to be copied
  25966. * @hidden
  25967. */
  25968. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  25969. /**
  25970. * May need to be overridden by children
  25971. * @hidden
  25972. */
  25973. _updateRigCameras(): void;
  25974. /** @hidden */
  25975. _setupInputs(): void;
  25976. /**
  25977. * Serialiaze the camera setup to a json represention
  25978. * @returns the JSON representation
  25979. */
  25980. serialize(): any;
  25981. /**
  25982. * Clones the current camera.
  25983. * @param name The cloned camera name
  25984. * @returns the cloned camera
  25985. */
  25986. clone(name: string): Camera;
  25987. /**
  25988. * Gets the direction of the camera relative to a given local axis.
  25989. * @param localAxis Defines the reference axis to provide a relative direction.
  25990. * @return the direction
  25991. */
  25992. getDirection(localAxis: Vector3): Vector3;
  25993. /**
  25994. * Returns the current camera absolute rotation
  25995. */
  25996. readonly absoluteRotation: Quaternion;
  25997. /**
  25998. * Gets the direction of the camera relative to a given local axis into a passed vector.
  25999. * @param localAxis Defines the reference axis to provide a relative direction.
  26000. * @param result Defines the vector to store the result in
  26001. */
  26002. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  26003. /**
  26004. * Gets a camera constructor for a given camera type
  26005. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  26006. * @param name The name of the camera the result will be able to instantiate
  26007. * @param scene The scene the result will construct the camera in
  26008. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  26009. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  26010. * @returns a factory method to construc the camera
  26011. */
  26012. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  26013. /**
  26014. * Compute the world matrix of the camera.
  26015. * @returns the camera world matrix
  26016. */
  26017. computeWorldMatrix(): Matrix;
  26018. /**
  26019. * Parse a JSON and creates the camera from the parsed information
  26020. * @param parsedCamera The JSON to parse
  26021. * @param scene The scene to instantiate the camera in
  26022. * @returns the newly constructed camera
  26023. */
  26024. static Parse(parsedCamera: any, scene: Scene): Camera;
  26025. }
  26026. }
  26027. declare module "babylonjs/Meshes/Builders/discBuilder" {
  26028. import { Nullable } from "babylonjs/types";
  26029. import { Scene } from "babylonjs/scene";
  26030. import { Vector4 } from "babylonjs/Maths/math.vector";
  26031. import { Mesh } from "babylonjs/Meshes/mesh";
  26032. /**
  26033. * Class containing static functions to help procedurally build meshes
  26034. */
  26035. export class DiscBuilder {
  26036. /**
  26037. * Creates a plane polygonal mesh. By default, this is a disc
  26038. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  26039. * * 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
  26040. * * 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
  26041. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  26042. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  26043. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  26044. * @param name defines the name of the mesh
  26045. * @param options defines the options used to create the mesh
  26046. * @param scene defines the hosting scene
  26047. * @returns the plane polygonal mesh
  26048. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  26049. */
  26050. static CreateDisc(name: string, options: {
  26051. radius?: number;
  26052. tessellation?: number;
  26053. arc?: number;
  26054. updatable?: boolean;
  26055. sideOrientation?: number;
  26056. frontUVs?: Vector4;
  26057. backUVs?: Vector4;
  26058. }, scene?: Nullable<Scene>): Mesh;
  26059. }
  26060. }
  26061. declare module "babylonjs/Particles/solidParticleSystem" {
  26062. import { Vector3 } from "babylonjs/Maths/math.vector";
  26063. import { Mesh } from "babylonjs/Meshes/mesh";
  26064. import { Scene, IDisposable } from "babylonjs/scene";
  26065. import { DepthSortedParticle, SolidParticle } from "babylonjs/Particles/solidParticle";
  26066. /**
  26067. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  26068. *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.
  26069. * The SPS is also a particle system. It provides some methods to manage the particles.
  26070. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  26071. *
  26072. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  26073. */
  26074. export class SolidParticleSystem implements IDisposable {
  26075. /**
  26076. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  26077. * Example : var p = SPS.particles[i];
  26078. */
  26079. particles: SolidParticle[];
  26080. /**
  26081. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  26082. */
  26083. nbParticles: number;
  26084. /**
  26085. * If the particles must ever face the camera (default false). Useful for planar particles.
  26086. */
  26087. billboard: boolean;
  26088. /**
  26089. * Recompute normals when adding a shape
  26090. */
  26091. recomputeNormals: boolean;
  26092. /**
  26093. * This a counter ofr your own usage. It's not set by any SPS functions.
  26094. */
  26095. counter: number;
  26096. /**
  26097. * The SPS name. This name is also given to the underlying mesh.
  26098. */
  26099. name: string;
  26100. /**
  26101. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  26102. */
  26103. mesh: Mesh;
  26104. /**
  26105. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  26106. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  26107. */
  26108. vars: any;
  26109. /**
  26110. * This array is populated when the SPS is set as 'pickable'.
  26111. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  26112. * Each element of this array is an object `{idx: int, faceId: int}`.
  26113. * `idx` is the picked particle index in the `SPS.particles` array
  26114. * `faceId` is the picked face index counted within this particle.
  26115. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  26116. */
  26117. pickedParticles: {
  26118. idx: number;
  26119. faceId: number;
  26120. }[];
  26121. /**
  26122. * This array is populated when `enableDepthSort` is set to true.
  26123. * Each element of this array is an instance of the class DepthSortedParticle.
  26124. */
  26125. depthSortedParticles: DepthSortedParticle[];
  26126. /**
  26127. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  26128. * @hidden
  26129. */
  26130. _bSphereOnly: boolean;
  26131. /**
  26132. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  26133. * @hidden
  26134. */
  26135. _bSphereRadiusFactor: number;
  26136. private _scene;
  26137. private _positions;
  26138. private _indices;
  26139. private _normals;
  26140. private _colors;
  26141. private _uvs;
  26142. private _indices32;
  26143. private _positions32;
  26144. private _normals32;
  26145. private _fixedNormal32;
  26146. private _colors32;
  26147. private _uvs32;
  26148. private _index;
  26149. private _updatable;
  26150. private _pickable;
  26151. private _isVisibilityBoxLocked;
  26152. private _alwaysVisible;
  26153. private _depthSort;
  26154. private _expandable;
  26155. private _shapeCounter;
  26156. private _copy;
  26157. private _color;
  26158. private _computeParticleColor;
  26159. private _computeParticleTexture;
  26160. private _computeParticleRotation;
  26161. private _computeParticleVertex;
  26162. private _computeBoundingBox;
  26163. private _depthSortParticles;
  26164. private _camera;
  26165. private _mustUnrotateFixedNormals;
  26166. private _particlesIntersect;
  26167. private _needs32Bits;
  26168. private _isNotBuilt;
  26169. /**
  26170. * Creates a SPS (Solid Particle System) object.
  26171. * @param name (String) is the SPS name, this will be the underlying mesh name.
  26172. * @param scene (Scene) is the scene in which the SPS is added.
  26173. * @param options defines the options of the sps e.g.
  26174. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  26175. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  26176. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  26177. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  26178. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  26179. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  26180. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  26181. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  26182. */
  26183. constructor(name: string, scene: Scene, options?: {
  26184. updatable?: boolean;
  26185. isPickable?: boolean;
  26186. enableDepthSort?: boolean;
  26187. particleIntersection?: boolean;
  26188. boundingSphereOnly?: boolean;
  26189. bSphereRadiusFactor?: number;
  26190. expandable?: boolean;
  26191. });
  26192. /**
  26193. * Builds the SPS underlying mesh. Returns a standard Mesh.
  26194. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  26195. * @returns the created mesh
  26196. */
  26197. buildMesh(): Mesh;
  26198. /**
  26199. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  26200. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  26201. * Thus the particles generated from `digest()` have their property `position` set yet.
  26202. * @param mesh ( Mesh ) is the mesh to be digested
  26203. * @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
  26204. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  26205. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  26206. * @returns the current SPS
  26207. */
  26208. digest(mesh: Mesh, options?: {
  26209. facetNb?: number;
  26210. number?: number;
  26211. delta?: number;
  26212. }): SolidParticleSystem;
  26213. private _unrotateFixedNormals;
  26214. private _resetCopy;
  26215. private _meshBuilder;
  26216. private _posToShape;
  26217. private _uvsToShapeUV;
  26218. private _addParticle;
  26219. /**
  26220. * Adds some particles to the SPS from the model shape. Returns the shape id.
  26221. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  26222. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  26223. * @param nb (positive integer) the number of particles to be created from this model
  26224. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  26225. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  26226. * @returns the number of shapes in the system
  26227. */
  26228. addShape(mesh: Mesh, nb: number, options?: {
  26229. positionFunction?: any;
  26230. vertexFunction?: any;
  26231. }): number;
  26232. private _rebuildParticle;
  26233. /**
  26234. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  26235. * @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.
  26236. * @returns the SPS.
  26237. */
  26238. rebuildMesh(reset?: boolean): SolidParticleSystem;
  26239. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  26240. * Returns an array with the removed particles.
  26241. * 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.
  26242. * The SPS can't be empty so at least one particle needs to remain in place.
  26243. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  26244. * @param start index of the first particle to remove
  26245. * @param end index of the last particle to remove (included)
  26246. * @returns an array populated with the removed particles
  26247. */
  26248. removeParticles(start: number, end: number): SolidParticle[];
  26249. /**
  26250. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  26251. * This method calls `updateParticle()` for each particle of the SPS.
  26252. * For an animated SPS, it is usually called within the render loop.
  26253. * 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.
  26254. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  26255. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  26256. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  26257. * @returns the SPS.
  26258. */
  26259. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  26260. /**
  26261. * Disposes the SPS.
  26262. */
  26263. dispose(): void;
  26264. /**
  26265. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  26266. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26267. * @returns the SPS.
  26268. */
  26269. refreshVisibleSize(): SolidParticleSystem;
  26270. /**
  26271. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  26272. * @param size the size (float) of the visibility box
  26273. * note : this doesn't lock the SPS mesh bounding box.
  26274. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26275. */
  26276. setVisibilityBox(size: number): void;
  26277. /**
  26278. * Gets whether the SPS as always visible or not
  26279. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26280. */
  26281. /**
  26282. * Sets the SPS as always visible or not
  26283. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26284. */
  26285. isAlwaysVisible: boolean;
  26286. /**
  26287. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  26288. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26289. */
  26290. /**
  26291. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  26292. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26293. */
  26294. isVisibilityBoxLocked: boolean;
  26295. /**
  26296. * Tells to `setParticles()` to compute the particle rotations or not.
  26297. * Default value : true. The SPS is faster when it's set to false.
  26298. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  26299. */
  26300. /**
  26301. * Gets if `setParticles()` computes the particle rotations or not.
  26302. * Default value : true. The SPS is faster when it's set to false.
  26303. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  26304. */
  26305. computeParticleRotation: boolean;
  26306. /**
  26307. * Tells to `setParticles()` to compute the particle colors or not.
  26308. * Default value : true. The SPS is faster when it's set to false.
  26309. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  26310. */
  26311. /**
  26312. * Gets if `setParticles()` computes the particle colors or not.
  26313. * Default value : true. The SPS is faster when it's set to false.
  26314. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  26315. */
  26316. computeParticleColor: boolean;
  26317. /**
  26318. * Gets if `setParticles()` computes the particle textures or not.
  26319. * Default value : true. The SPS is faster when it's set to false.
  26320. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  26321. */
  26322. computeParticleTexture: boolean;
  26323. /**
  26324. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  26325. * Default value : false. The SPS is faster when it's set to false.
  26326. * Note : the particle custom vertex positions aren't stored values.
  26327. */
  26328. /**
  26329. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  26330. * Default value : false. The SPS is faster when it's set to false.
  26331. * Note : the particle custom vertex positions aren't stored values.
  26332. */
  26333. computeParticleVertex: boolean;
  26334. /**
  26335. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  26336. */
  26337. /**
  26338. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  26339. */
  26340. computeBoundingBox: boolean;
  26341. /**
  26342. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  26343. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  26344. * Default : `true`
  26345. */
  26346. /**
  26347. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  26348. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  26349. * Default : `true`
  26350. */
  26351. depthSortParticles: boolean;
  26352. /**
  26353. * Gets if the SPS is created as expandable at construction time.
  26354. * Default : `false`
  26355. */
  26356. readonly expandable: boolean;
  26357. /**
  26358. * This function does nothing. It may be overwritten to set all the particle first values.
  26359. * The SPS doesn't call this function, you may have to call it by your own.
  26360. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26361. */
  26362. initParticles(): void;
  26363. /**
  26364. * This function does nothing. It may be overwritten to recycle a particle.
  26365. * The SPS doesn't call this function, you may have to call it by your own.
  26366. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26367. * @param particle The particle to recycle
  26368. * @returns the recycled particle
  26369. */
  26370. recycleParticle(particle: SolidParticle): SolidParticle;
  26371. /**
  26372. * Updates a particle : this function should be overwritten by the user.
  26373. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  26374. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26375. * @example : just set a particle position or velocity and recycle conditions
  26376. * @param particle The particle to update
  26377. * @returns the updated particle
  26378. */
  26379. updateParticle(particle: SolidParticle): SolidParticle;
  26380. /**
  26381. * Updates a vertex of a particle : it can be overwritten by the user.
  26382. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  26383. * @param particle the current particle
  26384. * @param vertex the current index of the current particle
  26385. * @param pt the index of the current vertex in the particle shape
  26386. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  26387. * @example : just set a vertex particle position
  26388. * @returns the updated vertex
  26389. */
  26390. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  26391. /**
  26392. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  26393. * This does nothing and may be overwritten by the user.
  26394. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26395. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26396. * @param update the boolean update value actually passed to setParticles()
  26397. */
  26398. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26399. /**
  26400. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  26401. * This will be passed three parameters.
  26402. * This does nothing and may be overwritten by the user.
  26403. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26404. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26405. * @param update the boolean update value actually passed to setParticles()
  26406. */
  26407. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26408. }
  26409. }
  26410. declare module "babylonjs/Particles/solidParticle" {
  26411. import { Nullable } from "babylonjs/types";
  26412. import { Vector3, Matrix, Quaternion, Vector4 } from "babylonjs/Maths/math.vector";
  26413. import { Color4 } from "babylonjs/Maths/math.color";
  26414. import { Mesh } from "babylonjs/Meshes/mesh";
  26415. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26416. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  26417. import { Plane } from "babylonjs/Maths/math.plane";
  26418. /**
  26419. * Represents one particle of a solid particle system.
  26420. */
  26421. export class SolidParticle {
  26422. /**
  26423. * particle global index
  26424. */
  26425. idx: number;
  26426. /**
  26427. * The color of the particle
  26428. */
  26429. color: Nullable<Color4>;
  26430. /**
  26431. * The world space position of the particle.
  26432. */
  26433. position: Vector3;
  26434. /**
  26435. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  26436. */
  26437. rotation: Vector3;
  26438. /**
  26439. * The world space rotation quaternion of the particle.
  26440. */
  26441. rotationQuaternion: Nullable<Quaternion>;
  26442. /**
  26443. * The scaling of the particle.
  26444. */
  26445. scaling: Vector3;
  26446. /**
  26447. * The uvs of the particle.
  26448. */
  26449. uvs: Vector4;
  26450. /**
  26451. * The current speed of the particle.
  26452. */
  26453. velocity: Vector3;
  26454. /**
  26455. * The pivot point in the particle local space.
  26456. */
  26457. pivot: Vector3;
  26458. /**
  26459. * Must the particle be translated from its pivot point in its local space ?
  26460. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  26461. * Default : false
  26462. */
  26463. translateFromPivot: boolean;
  26464. /**
  26465. * Is the particle active or not ?
  26466. */
  26467. alive: boolean;
  26468. /**
  26469. * Is the particle visible or not ?
  26470. */
  26471. isVisible: boolean;
  26472. /**
  26473. * Index of this particle in the global "positions" array (Internal use)
  26474. * @hidden
  26475. */
  26476. _pos: number;
  26477. /**
  26478. * @hidden Index of this particle in the global "indices" array (Internal use)
  26479. */
  26480. _ind: number;
  26481. /**
  26482. * @hidden ModelShape of this particle (Internal use)
  26483. */
  26484. _model: ModelShape;
  26485. /**
  26486. * ModelShape id of this particle
  26487. */
  26488. shapeId: number;
  26489. /**
  26490. * Index of the particle in its shape id
  26491. */
  26492. idxInShape: number;
  26493. /**
  26494. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  26495. */
  26496. _modelBoundingInfo: BoundingInfo;
  26497. /**
  26498. * @hidden Particle BoundingInfo object (Internal use)
  26499. */
  26500. _boundingInfo: BoundingInfo;
  26501. /**
  26502. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  26503. */
  26504. _sps: SolidParticleSystem;
  26505. /**
  26506. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  26507. */
  26508. _stillInvisible: boolean;
  26509. /**
  26510. * @hidden Last computed particle rotation matrix
  26511. */
  26512. _rotationMatrix: number[];
  26513. /**
  26514. * Parent particle Id, if any.
  26515. * Default null.
  26516. */
  26517. parentId: Nullable<number>;
  26518. /**
  26519. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  26520. * The possible values are :
  26521. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26522. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26523. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26524. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26525. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26526. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  26527. * */
  26528. cullingStrategy: number;
  26529. /**
  26530. * @hidden Internal global position in the SPS.
  26531. */
  26532. _globalPosition: Vector3;
  26533. /**
  26534. * Creates a Solid Particle object.
  26535. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  26536. * @param particleIndex (integer) is the particle index in the Solid Particle System pool. It's also the particle identifier.
  26537. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  26538. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  26539. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  26540. * @param shapeId (integer) is the model shape identifier in the SPS.
  26541. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  26542. * @param sps defines the sps it is associated to
  26543. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  26544. */
  26545. constructor(particleIndex: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  26546. /**
  26547. * Legacy support, changed scale to scaling
  26548. */
  26549. /**
  26550. * Legacy support, changed scale to scaling
  26551. */
  26552. scale: Vector3;
  26553. /**
  26554. * Legacy support, changed quaternion to rotationQuaternion
  26555. */
  26556. /**
  26557. * Legacy support, changed quaternion to rotationQuaternion
  26558. */
  26559. quaternion: Nullable<Quaternion>;
  26560. /**
  26561. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  26562. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  26563. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  26564. * @returns true if it intersects
  26565. */
  26566. intersectsMesh(target: Mesh | SolidParticle): boolean;
  26567. /**
  26568. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  26569. * A particle is in the frustum if its bounding box intersects the frustum
  26570. * @param frustumPlanes defines the frustum to test
  26571. * @returns true if the particle is in the frustum planes
  26572. */
  26573. isInFrustum(frustumPlanes: Plane[]): boolean;
  26574. /**
  26575. * get the rotation matrix of the particle
  26576. * @hidden
  26577. */
  26578. getRotationMatrix(m: Matrix): void;
  26579. }
  26580. /**
  26581. * Represents the shape of the model used by one particle of a solid particle system.
  26582. * SPS internal tool, don't use it manually.
  26583. */
  26584. export class ModelShape {
  26585. /**
  26586. * The shape id
  26587. * @hidden
  26588. */
  26589. shapeID: number;
  26590. /**
  26591. * flat array of model positions (internal use)
  26592. * @hidden
  26593. */
  26594. _shape: Vector3[];
  26595. /**
  26596. * flat array of model UVs (internal use)
  26597. * @hidden
  26598. */
  26599. _shapeUV: number[];
  26600. /**
  26601. * color array of the model
  26602. * @hidden
  26603. */
  26604. _shapeColors: number[];
  26605. /**
  26606. * indices array of the model
  26607. * @hidden
  26608. */
  26609. _indices: number[];
  26610. /**
  26611. * normals array of the model
  26612. * @hidden
  26613. */
  26614. _normals: number[];
  26615. /**
  26616. * length of the shape in the model indices array (internal use)
  26617. * @hidden
  26618. */
  26619. _indicesLength: number;
  26620. /**
  26621. * Custom position function (internal use)
  26622. * @hidden
  26623. */
  26624. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  26625. /**
  26626. * Custom vertex function (internal use)
  26627. * @hidden
  26628. */
  26629. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  26630. /**
  26631. * 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.
  26632. * SPS internal tool, don't use it manually.
  26633. * @hidden
  26634. */
  26635. 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>);
  26636. }
  26637. /**
  26638. * Represents a Depth Sorted Particle in the solid particle system.
  26639. */
  26640. export class DepthSortedParticle {
  26641. /**
  26642. * Index of the particle in the "indices" array
  26643. */
  26644. ind: number;
  26645. /**
  26646. * Length of the particle shape in the "indices" array
  26647. */
  26648. indicesLength: number;
  26649. /**
  26650. * Squared distance from the particle to the camera
  26651. */
  26652. sqDistance: number;
  26653. }
  26654. }
  26655. declare module "babylonjs/Collisions/meshCollisionData" {
  26656. import { Collider } from "babylonjs/Collisions/collider";
  26657. import { Vector3 } from "babylonjs/Maths/math.vector";
  26658. import { Nullable } from "babylonjs/types";
  26659. import { Observer } from "babylonjs/Misc/observable";
  26660. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26661. /**
  26662. * @hidden
  26663. */
  26664. export class _MeshCollisionData {
  26665. _checkCollisions: boolean;
  26666. _collisionMask: number;
  26667. _collisionGroup: number;
  26668. _collider: Nullable<Collider>;
  26669. _oldPositionForCollisions: Vector3;
  26670. _diffPositionForCollisions: Vector3;
  26671. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  26672. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  26673. }
  26674. }
  26675. declare module "babylonjs/Meshes/abstractMesh" {
  26676. import { Observable } from "babylonjs/Misc/observable";
  26677. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  26678. import { Camera } from "babylonjs/Cameras/camera";
  26679. import { Scene, IDisposable } from "babylonjs/scene";
  26680. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26681. import { Node } from "babylonjs/node";
  26682. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  26683. import { TransformNode } from "babylonjs/Meshes/transformNode";
  26684. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26685. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  26686. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26687. import { Material } from "babylonjs/Materials/material";
  26688. import { Light } from "babylonjs/Lights/light";
  26689. import { Skeleton } from "babylonjs/Bones/skeleton";
  26690. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  26691. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  26692. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  26693. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  26694. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  26695. import { Plane } from "babylonjs/Maths/math.plane";
  26696. import { Ray } from "babylonjs/Culling/ray";
  26697. import { Collider } from "babylonjs/Collisions/collider";
  26698. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26699. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  26700. /** @hidden */
  26701. class _FacetDataStorage {
  26702. facetPositions: Vector3[];
  26703. facetNormals: Vector3[];
  26704. facetPartitioning: number[][];
  26705. facetNb: number;
  26706. partitioningSubdivisions: number;
  26707. partitioningBBoxRatio: number;
  26708. facetDataEnabled: boolean;
  26709. facetParameters: any;
  26710. bbSize: Vector3;
  26711. subDiv: {
  26712. max: number;
  26713. X: number;
  26714. Y: number;
  26715. Z: number;
  26716. };
  26717. facetDepthSort: boolean;
  26718. facetDepthSortEnabled: boolean;
  26719. depthSortedIndices: IndicesArray;
  26720. depthSortedFacets: {
  26721. ind: number;
  26722. sqDistance: number;
  26723. }[];
  26724. facetDepthSortFunction: (f1: {
  26725. ind: number;
  26726. sqDistance: number;
  26727. }, f2: {
  26728. ind: number;
  26729. sqDistance: number;
  26730. }) => number;
  26731. facetDepthSortFrom: Vector3;
  26732. facetDepthSortOrigin: Vector3;
  26733. invertedMatrix: Matrix;
  26734. }
  26735. /**
  26736. * @hidden
  26737. **/
  26738. class _InternalAbstractMeshDataInfo {
  26739. _hasVertexAlpha: boolean;
  26740. _useVertexColors: boolean;
  26741. _numBoneInfluencers: number;
  26742. _applyFog: boolean;
  26743. _receiveShadows: boolean;
  26744. _facetData: _FacetDataStorage;
  26745. _visibility: number;
  26746. _skeleton: Nullable<Skeleton>;
  26747. _layerMask: number;
  26748. _computeBonesUsingShaders: boolean;
  26749. _isActive: boolean;
  26750. _onlyForInstances: boolean;
  26751. _isActiveIntermediate: boolean;
  26752. _onlyForInstancesIntermediate: boolean;
  26753. _actAsRegularMesh: boolean;
  26754. }
  26755. /**
  26756. * Class used to store all common mesh properties
  26757. */
  26758. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  26759. /** No occlusion */
  26760. static OCCLUSION_TYPE_NONE: number;
  26761. /** Occlusion set to optimisitic */
  26762. static OCCLUSION_TYPE_OPTIMISTIC: number;
  26763. /** Occlusion set to strict */
  26764. static OCCLUSION_TYPE_STRICT: number;
  26765. /** Use an accurante occlusion algorithm */
  26766. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  26767. /** Use a conservative occlusion algorithm */
  26768. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  26769. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  26770. * Test order :
  26771. * Is the bounding sphere outside the frustum ?
  26772. * If not, are the bounding box vertices outside the frustum ?
  26773. * It not, then the cullable object is in the frustum.
  26774. */
  26775. static readonly CULLINGSTRATEGY_STANDARD: number;
  26776. /** Culling strategy : Bounding Sphere Only.
  26777. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  26778. * It's also less accurate than the standard because some not visible objects can still be selected.
  26779. * Test : is the bounding sphere outside the frustum ?
  26780. * If not, then the cullable object is in the frustum.
  26781. */
  26782. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  26783. /** Culling strategy : Optimistic Inclusion.
  26784. * This in an inclusion test first, then the standard exclusion test.
  26785. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  26786. * 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.
  26787. * Anyway, it's as accurate as the standard strategy.
  26788. * Test :
  26789. * Is the cullable object bounding sphere center in the frustum ?
  26790. * If not, apply the default culling strategy.
  26791. */
  26792. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  26793. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  26794. * This in an inclusion test first, then the bounding sphere only exclusion test.
  26795. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  26796. * 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.
  26797. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  26798. * Test :
  26799. * Is the cullable object bounding sphere center in the frustum ?
  26800. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  26801. */
  26802. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  26803. /**
  26804. * No billboard
  26805. */
  26806. static readonly BILLBOARDMODE_NONE: number;
  26807. /** Billboard on X axis */
  26808. static readonly BILLBOARDMODE_X: number;
  26809. /** Billboard on Y axis */
  26810. static readonly BILLBOARDMODE_Y: number;
  26811. /** Billboard on Z axis */
  26812. static readonly BILLBOARDMODE_Z: number;
  26813. /** Billboard on all axes */
  26814. static readonly BILLBOARDMODE_ALL: number;
  26815. /** Billboard on using position instead of orientation */
  26816. static readonly BILLBOARDMODE_USE_POSITION: number;
  26817. /** @hidden */
  26818. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  26819. /**
  26820. * The culling strategy to use to check whether the mesh must be rendered or not.
  26821. * This value can be changed at any time and will be used on the next render mesh selection.
  26822. * The possible values are :
  26823. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26824. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26825. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26826. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26827. * Please read each static variable documentation to get details about the culling process.
  26828. * */
  26829. cullingStrategy: number;
  26830. /**
  26831. * Gets the number of facets in the mesh
  26832. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  26833. */
  26834. readonly facetNb: number;
  26835. /**
  26836. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  26837. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  26838. */
  26839. partitioningSubdivisions: number;
  26840. /**
  26841. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  26842. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  26843. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  26844. */
  26845. partitioningBBoxRatio: number;
  26846. /**
  26847. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  26848. * Works only for updatable meshes.
  26849. * Doesn't work with multi-materials
  26850. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  26851. */
  26852. mustDepthSortFacets: boolean;
  26853. /**
  26854. * The location (Vector3) where the facet depth sort must be computed from.
  26855. * By default, the active camera position.
  26856. * Used only when facet depth sort is enabled
  26857. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  26858. */
  26859. facetDepthSortFrom: Vector3;
  26860. /**
  26861. * gets a boolean indicating if facetData is enabled
  26862. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  26863. */
  26864. readonly isFacetDataEnabled: boolean;
  26865. /** @hidden */
  26866. _updateNonUniformScalingState(value: boolean): boolean;
  26867. /**
  26868. * An event triggered when this mesh collides with another one
  26869. */
  26870. onCollideObservable: Observable<AbstractMesh>;
  26871. /** Set a function to call when this mesh collides with another one */
  26872. onCollide: () => void;
  26873. /**
  26874. * An event triggered when the collision's position changes
  26875. */
  26876. onCollisionPositionChangeObservable: Observable<Vector3>;
  26877. /** Set a function to call when the collision's position changes */
  26878. onCollisionPositionChange: () => void;
  26879. /**
  26880. * An event triggered when material is changed
  26881. */
  26882. onMaterialChangedObservable: Observable<AbstractMesh>;
  26883. /**
  26884. * Gets or sets the orientation for POV movement & rotation
  26885. */
  26886. definedFacingForward: boolean;
  26887. /** @hidden */
  26888. _occlusionQuery: Nullable<WebGLQuery>;
  26889. /** @hidden */
  26890. _renderingGroup: Nullable<RenderingGroup>;
  26891. /**
  26892. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  26893. */
  26894. /**
  26895. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  26896. */
  26897. visibility: number;
  26898. /** Gets or sets the alpha index used to sort transparent meshes
  26899. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  26900. */
  26901. alphaIndex: number;
  26902. /**
  26903. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  26904. */
  26905. isVisible: boolean;
  26906. /**
  26907. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  26908. */
  26909. isPickable: boolean;
  26910. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  26911. showSubMeshesBoundingBox: boolean;
  26912. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  26913. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  26914. */
  26915. isBlocker: boolean;
  26916. /**
  26917. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  26918. */
  26919. enablePointerMoveEvents: boolean;
  26920. /**
  26921. * Specifies the rendering group id for this mesh (0 by default)
  26922. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  26923. */
  26924. renderingGroupId: number;
  26925. private _material;
  26926. /** Gets or sets current material */
  26927. material: Nullable<Material>;
  26928. /**
  26929. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  26930. * @see http://doc.babylonjs.com/babylon101/shadows
  26931. */
  26932. receiveShadows: boolean;
  26933. /** Defines color to use when rendering outline */
  26934. outlineColor: Color3;
  26935. /** Define width to use when rendering outline */
  26936. outlineWidth: number;
  26937. /** Defines color to use when rendering overlay */
  26938. overlayColor: Color3;
  26939. /** Defines alpha to use when rendering overlay */
  26940. overlayAlpha: number;
  26941. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  26942. hasVertexAlpha: boolean;
  26943. /** 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) */
  26944. useVertexColors: boolean;
  26945. /**
  26946. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  26947. */
  26948. computeBonesUsingShaders: boolean;
  26949. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  26950. numBoneInfluencers: number;
  26951. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  26952. applyFog: boolean;
  26953. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  26954. useOctreeForRenderingSelection: boolean;
  26955. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  26956. useOctreeForPicking: boolean;
  26957. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  26958. useOctreeForCollisions: boolean;
  26959. /**
  26960. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  26961. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  26962. */
  26963. layerMask: number;
  26964. /**
  26965. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  26966. */
  26967. alwaysSelectAsActiveMesh: boolean;
  26968. /**
  26969. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  26970. */
  26971. doNotSyncBoundingInfo: boolean;
  26972. /**
  26973. * Gets or sets the current action manager
  26974. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  26975. */
  26976. actionManager: Nullable<AbstractActionManager>;
  26977. private _meshCollisionData;
  26978. /**
  26979. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  26980. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26981. */
  26982. ellipsoid: Vector3;
  26983. /**
  26984. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  26985. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26986. */
  26987. ellipsoidOffset: Vector3;
  26988. /**
  26989. * Gets or sets a collision mask used to mask collisions (default is -1).
  26990. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  26991. */
  26992. collisionMask: number;
  26993. /**
  26994. * Gets or sets the current collision group mask (-1 by default).
  26995. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  26996. */
  26997. collisionGroup: number;
  26998. /**
  26999. * Defines edge width used when edgesRenderer is enabled
  27000. * @see https://www.babylonjs-playground.com/#10OJSG#13
  27001. */
  27002. edgesWidth: number;
  27003. /**
  27004. * Defines edge color used when edgesRenderer is enabled
  27005. * @see https://www.babylonjs-playground.com/#10OJSG#13
  27006. */
  27007. edgesColor: Color4;
  27008. /** @hidden */
  27009. _edgesRenderer: Nullable<IEdgesRenderer>;
  27010. /** @hidden */
  27011. _masterMesh: Nullable<AbstractMesh>;
  27012. /** @hidden */
  27013. _boundingInfo: Nullable<BoundingInfo>;
  27014. /** @hidden */
  27015. _renderId: number;
  27016. /**
  27017. * Gets or sets the list of subMeshes
  27018. * @see http://doc.babylonjs.com/how_to/multi_materials
  27019. */
  27020. subMeshes: SubMesh[];
  27021. /** @hidden */
  27022. _intersectionsInProgress: AbstractMesh[];
  27023. /** @hidden */
  27024. _unIndexed: boolean;
  27025. /** @hidden */
  27026. _lightSources: Light[];
  27027. /** Gets the list of lights affecting that mesh */
  27028. readonly lightSources: Light[];
  27029. /** @hidden */
  27030. readonly _positions: Nullable<Vector3[]>;
  27031. /** @hidden */
  27032. _waitingData: {
  27033. lods: Nullable<any>;
  27034. actions: Nullable<any>;
  27035. freezeWorldMatrix: Nullable<boolean>;
  27036. };
  27037. /** @hidden */
  27038. _bonesTransformMatrices: Nullable<Float32Array>;
  27039. /** @hidden */
  27040. _transformMatrixTexture: Nullable<RawTexture>;
  27041. /**
  27042. * Gets or sets a skeleton to apply skining transformations
  27043. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  27044. */
  27045. skeleton: Nullable<Skeleton>;
  27046. /**
  27047. * An event triggered when the mesh is rebuilt.
  27048. */
  27049. onRebuildObservable: Observable<AbstractMesh>;
  27050. /**
  27051. * Creates a new AbstractMesh
  27052. * @param name defines the name of the mesh
  27053. * @param scene defines the hosting scene
  27054. */
  27055. constructor(name: string, scene?: Nullable<Scene>);
  27056. /**
  27057. * Returns the string "AbstractMesh"
  27058. * @returns "AbstractMesh"
  27059. */
  27060. getClassName(): string;
  27061. /**
  27062. * Gets a string representation of the current mesh
  27063. * @param fullDetails defines a boolean indicating if full details must be included
  27064. * @returns a string representation of the current mesh
  27065. */
  27066. toString(fullDetails?: boolean): string;
  27067. /**
  27068. * @hidden
  27069. */
  27070. protected _getEffectiveParent(): Nullable<Node>;
  27071. /** @hidden */
  27072. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  27073. /** @hidden */
  27074. _rebuild(): void;
  27075. /** @hidden */
  27076. _resyncLightSources(): void;
  27077. /** @hidden */
  27078. _resyncLighSource(light: Light): void;
  27079. /** @hidden */
  27080. _unBindEffect(): void;
  27081. /** @hidden */
  27082. _removeLightSource(light: Light, dispose: boolean): void;
  27083. private _markSubMeshesAsDirty;
  27084. /** @hidden */
  27085. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  27086. /** @hidden */
  27087. _markSubMeshesAsAttributesDirty(): void;
  27088. /** @hidden */
  27089. _markSubMeshesAsMiscDirty(): void;
  27090. /**
  27091. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  27092. */
  27093. scaling: Vector3;
  27094. /**
  27095. * Returns true if the mesh is blocked. Implemented by child classes
  27096. */
  27097. readonly isBlocked: boolean;
  27098. /**
  27099. * Returns the mesh itself by default. Implemented by child classes
  27100. * @param camera defines the camera to use to pick the right LOD level
  27101. * @returns the currentAbstractMesh
  27102. */
  27103. getLOD(camera: Camera): Nullable<AbstractMesh>;
  27104. /**
  27105. * Returns 0 by default. Implemented by child classes
  27106. * @returns an integer
  27107. */
  27108. getTotalVertices(): number;
  27109. /**
  27110. * Returns a positive integer : the total number of indices in this mesh geometry.
  27111. * @returns the numner of indices or zero if the mesh has no geometry.
  27112. */
  27113. getTotalIndices(): number;
  27114. /**
  27115. * Returns null by default. Implemented by child classes
  27116. * @returns null
  27117. */
  27118. getIndices(): Nullable<IndicesArray>;
  27119. /**
  27120. * Returns the array of the requested vertex data kind. Implemented by child classes
  27121. * @param kind defines the vertex data kind to use
  27122. * @returns null
  27123. */
  27124. getVerticesData(kind: string): Nullable<FloatArray>;
  27125. /**
  27126. * Sets the vertex data of the mesh geometry for the requested `kind`.
  27127. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  27128. * Note that a new underlying VertexBuffer object is created each call.
  27129. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  27130. * @param kind defines vertex data kind:
  27131. * * VertexBuffer.PositionKind
  27132. * * VertexBuffer.UVKind
  27133. * * VertexBuffer.UV2Kind
  27134. * * VertexBuffer.UV3Kind
  27135. * * VertexBuffer.UV4Kind
  27136. * * VertexBuffer.UV5Kind
  27137. * * VertexBuffer.UV6Kind
  27138. * * VertexBuffer.ColorKind
  27139. * * VertexBuffer.MatricesIndicesKind
  27140. * * VertexBuffer.MatricesIndicesExtraKind
  27141. * * VertexBuffer.MatricesWeightsKind
  27142. * * VertexBuffer.MatricesWeightsExtraKind
  27143. * @param data defines the data source
  27144. * @param updatable defines if the data must be flagged as updatable (or static)
  27145. * @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
  27146. * @returns the current mesh
  27147. */
  27148. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  27149. /**
  27150. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  27151. * If the mesh has no geometry, it is simply returned as it is.
  27152. * @param kind defines vertex data kind:
  27153. * * VertexBuffer.PositionKind
  27154. * * VertexBuffer.UVKind
  27155. * * VertexBuffer.UV2Kind
  27156. * * VertexBuffer.UV3Kind
  27157. * * VertexBuffer.UV4Kind
  27158. * * VertexBuffer.UV5Kind
  27159. * * VertexBuffer.UV6Kind
  27160. * * VertexBuffer.ColorKind
  27161. * * VertexBuffer.MatricesIndicesKind
  27162. * * VertexBuffer.MatricesIndicesExtraKind
  27163. * * VertexBuffer.MatricesWeightsKind
  27164. * * VertexBuffer.MatricesWeightsExtraKind
  27165. * @param data defines the data source
  27166. * @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
  27167. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  27168. * @returns the current mesh
  27169. */
  27170. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  27171. /**
  27172. * Sets the mesh indices,
  27173. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  27174. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  27175. * @param totalVertices Defines the total number of vertices
  27176. * @returns the current mesh
  27177. */
  27178. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  27179. /**
  27180. * Gets a boolean indicating if specific vertex data is present
  27181. * @param kind defines the vertex data kind to use
  27182. * @returns true is data kind is present
  27183. */
  27184. isVerticesDataPresent(kind: string): boolean;
  27185. /**
  27186. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  27187. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  27188. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  27189. * @returns a BoundingInfo
  27190. */
  27191. getBoundingInfo(): BoundingInfo;
  27192. /**
  27193. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  27194. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  27195. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  27196. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  27197. * @returns the current mesh
  27198. */
  27199. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  27200. /**
  27201. * Overwrite the current bounding info
  27202. * @param boundingInfo defines the new bounding info
  27203. * @returns the current mesh
  27204. */
  27205. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  27206. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  27207. readonly useBones: boolean;
  27208. /** @hidden */
  27209. _preActivate(): void;
  27210. /** @hidden */
  27211. _preActivateForIntermediateRendering(renderId: number): void;
  27212. /** @hidden */
  27213. _activate(renderId: number, intermediateRendering: boolean): boolean;
  27214. /** @hidden */
  27215. _postActivate(): void;
  27216. /** @hidden */
  27217. _freeze(): void;
  27218. /** @hidden */
  27219. _unFreeze(): void;
  27220. /**
  27221. * Gets the current world matrix
  27222. * @returns a Matrix
  27223. */
  27224. getWorldMatrix(): Matrix;
  27225. /** @hidden */
  27226. _getWorldMatrixDeterminant(): number;
  27227. /**
  27228. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  27229. */
  27230. readonly isAnInstance: boolean;
  27231. /**
  27232. * Gets a boolean indicating if this mesh has instances
  27233. */
  27234. readonly hasInstances: boolean;
  27235. /**
  27236. * Perform relative position change from the point of view of behind the front of the mesh.
  27237. * This is performed taking into account the meshes current rotation, so you do not have to care.
  27238. * Supports definition of mesh facing forward or backward
  27239. * @param amountRight defines the distance on the right axis
  27240. * @param amountUp defines the distance on the up axis
  27241. * @param amountForward defines the distance on the forward axis
  27242. * @returns the current mesh
  27243. */
  27244. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  27245. /**
  27246. * Calculate relative position change from the point of view of behind the front of the mesh.
  27247. * This is performed taking into account the meshes current rotation, so you do not have to care.
  27248. * Supports definition of mesh facing forward or backward
  27249. * @param amountRight defines the distance on the right axis
  27250. * @param amountUp defines the distance on the up axis
  27251. * @param amountForward defines the distance on the forward axis
  27252. * @returns the new displacement vector
  27253. */
  27254. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  27255. /**
  27256. * Perform relative rotation change from the point of view of behind the front of the mesh.
  27257. * Supports definition of mesh facing forward or backward
  27258. * @param flipBack defines the flip
  27259. * @param twirlClockwise defines the twirl
  27260. * @param tiltRight defines the tilt
  27261. * @returns the current mesh
  27262. */
  27263. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  27264. /**
  27265. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  27266. * Supports definition of mesh facing forward or backward.
  27267. * @param flipBack defines the flip
  27268. * @param twirlClockwise defines the twirl
  27269. * @param tiltRight defines the tilt
  27270. * @returns the new rotation vector
  27271. */
  27272. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  27273. /**
  27274. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  27275. * This means the mesh underlying bounding box and sphere are recomputed.
  27276. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  27277. * @returns the current mesh
  27278. */
  27279. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  27280. /** @hidden */
  27281. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  27282. /** @hidden */
  27283. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  27284. /** @hidden */
  27285. _updateBoundingInfo(): AbstractMesh;
  27286. /** @hidden */
  27287. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  27288. /** @hidden */
  27289. protected _afterComputeWorldMatrix(): void;
  27290. /** @hidden */
  27291. readonly _effectiveMesh: AbstractMesh;
  27292. /**
  27293. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  27294. * A mesh is in the frustum if its bounding box intersects the frustum
  27295. * @param frustumPlanes defines the frustum to test
  27296. * @returns true if the mesh is in the frustum planes
  27297. */
  27298. isInFrustum(frustumPlanes: Plane[]): boolean;
  27299. /**
  27300. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  27301. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  27302. * @param frustumPlanes defines the frustum to test
  27303. * @returns true if the mesh is completely in the frustum planes
  27304. */
  27305. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  27306. /**
  27307. * True if the mesh intersects another mesh or a SolidParticle object
  27308. * @param mesh defines a target mesh or SolidParticle to test
  27309. * @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)
  27310. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  27311. * @returns true if there is an intersection
  27312. */
  27313. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  27314. /**
  27315. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  27316. * @param point defines the point to test
  27317. * @returns true if there is an intersection
  27318. */
  27319. intersectsPoint(point: Vector3): boolean;
  27320. /**
  27321. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  27322. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27323. */
  27324. checkCollisions: boolean;
  27325. /**
  27326. * Gets Collider object used to compute collisions (not physics)
  27327. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27328. */
  27329. readonly collider: Nullable<Collider>;
  27330. /**
  27331. * Move the mesh using collision engine
  27332. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27333. * @param displacement defines the requested displacement vector
  27334. * @returns the current mesh
  27335. */
  27336. moveWithCollisions(displacement: Vector3): AbstractMesh;
  27337. private _onCollisionPositionChange;
  27338. /** @hidden */
  27339. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  27340. /** @hidden */
  27341. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  27342. /** @hidden */
  27343. _checkCollision(collider: Collider): AbstractMesh;
  27344. /** @hidden */
  27345. _generatePointsArray(): boolean;
  27346. /**
  27347. * Checks if the passed Ray intersects with the mesh
  27348. * @param ray defines the ray to use
  27349. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  27350. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  27351. * @returns the picking info
  27352. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  27353. */
  27354. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  27355. /**
  27356. * Clones the current mesh
  27357. * @param name defines the mesh name
  27358. * @param newParent defines the new mesh parent
  27359. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  27360. * @returns the new mesh
  27361. */
  27362. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  27363. /**
  27364. * Disposes all the submeshes of the current meshnp
  27365. * @returns the current mesh
  27366. */
  27367. releaseSubMeshes(): AbstractMesh;
  27368. /**
  27369. * Releases resources associated with this abstract mesh.
  27370. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  27371. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  27372. */
  27373. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  27374. /**
  27375. * Adds the passed mesh as a child to the current mesh
  27376. * @param mesh defines the child mesh
  27377. * @returns the current mesh
  27378. */
  27379. addChild(mesh: AbstractMesh): AbstractMesh;
  27380. /**
  27381. * Removes the passed mesh from the current mesh children list
  27382. * @param mesh defines the child mesh
  27383. * @returns the current mesh
  27384. */
  27385. removeChild(mesh: AbstractMesh): AbstractMesh;
  27386. /** @hidden */
  27387. private _initFacetData;
  27388. /**
  27389. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  27390. * This method can be called within the render loop.
  27391. * 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
  27392. * @returns the current mesh
  27393. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27394. */
  27395. updateFacetData(): AbstractMesh;
  27396. /**
  27397. * Returns the facetLocalNormals array.
  27398. * The normals are expressed in the mesh local spac
  27399. * @returns an array of Vector3
  27400. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27401. */
  27402. getFacetLocalNormals(): Vector3[];
  27403. /**
  27404. * Returns the facetLocalPositions array.
  27405. * The facet positions are expressed in the mesh local space
  27406. * @returns an array of Vector3
  27407. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27408. */
  27409. getFacetLocalPositions(): Vector3[];
  27410. /**
  27411. * Returns the facetLocalPartioning array
  27412. * @returns an array of array of numbers
  27413. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27414. */
  27415. getFacetLocalPartitioning(): number[][];
  27416. /**
  27417. * Returns the i-th facet position in the world system.
  27418. * This method allocates a new Vector3 per call
  27419. * @param i defines the facet index
  27420. * @returns a new Vector3
  27421. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27422. */
  27423. getFacetPosition(i: number): Vector3;
  27424. /**
  27425. * Sets the reference Vector3 with the i-th facet position in the world system
  27426. * @param i defines the facet index
  27427. * @param ref defines the target vector
  27428. * @returns the current mesh
  27429. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27430. */
  27431. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  27432. /**
  27433. * Returns the i-th facet normal in the world system.
  27434. * This method allocates a new Vector3 per call
  27435. * @param i defines the facet index
  27436. * @returns a new Vector3
  27437. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27438. */
  27439. getFacetNormal(i: number): Vector3;
  27440. /**
  27441. * Sets the reference Vector3 with the i-th facet normal in the world system
  27442. * @param i defines the facet index
  27443. * @param ref defines the target vector
  27444. * @returns the current mesh
  27445. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27446. */
  27447. getFacetNormalToRef(i: number, ref: Vector3): this;
  27448. /**
  27449. * 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)
  27450. * @param x defines x coordinate
  27451. * @param y defines y coordinate
  27452. * @param z defines z coordinate
  27453. * @returns the array of facet indexes
  27454. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27455. */
  27456. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  27457. /**
  27458. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  27459. * @param projected sets as the (x,y,z) world projection on the facet
  27460. * @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
  27461. * @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
  27462. * @param x defines x coordinate
  27463. * @param y defines y coordinate
  27464. * @param z defines z coordinate
  27465. * @returns the face index if found (or null instead)
  27466. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27467. */
  27468. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27469. /**
  27470. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  27471. * @param projected sets as the (x,y,z) local projection on the facet
  27472. * @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
  27473. * @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
  27474. * @param x defines x coordinate
  27475. * @param y defines y coordinate
  27476. * @param z defines z coordinate
  27477. * @returns the face index if found (or null instead)
  27478. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27479. */
  27480. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27481. /**
  27482. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  27483. * @returns the parameters
  27484. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27485. */
  27486. getFacetDataParameters(): any;
  27487. /**
  27488. * Disables the feature FacetData and frees the related memory
  27489. * @returns the current mesh
  27490. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27491. */
  27492. disableFacetData(): AbstractMesh;
  27493. /**
  27494. * Updates the AbstractMesh indices array
  27495. * @param indices defines the data source
  27496. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  27497. * @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)
  27498. * @returns the current mesh
  27499. */
  27500. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  27501. /**
  27502. * Creates new normals data for the mesh
  27503. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  27504. * @returns the current mesh
  27505. */
  27506. createNormals(updatable: boolean): AbstractMesh;
  27507. /**
  27508. * Align the mesh with a normal
  27509. * @param normal defines the normal to use
  27510. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  27511. * @returns the current mesh
  27512. */
  27513. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  27514. /** @hidden */
  27515. _checkOcclusionQuery(): boolean;
  27516. /**
  27517. * Disables the mesh edge rendering mode
  27518. * @returns the currentAbstractMesh
  27519. */
  27520. disableEdgesRendering(): AbstractMesh;
  27521. /**
  27522. * Enables the edge rendering mode on the mesh.
  27523. * This mode makes the mesh edges visible
  27524. * @param epsilon defines the maximal distance between two angles to detect a face
  27525. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  27526. * @returns the currentAbstractMesh
  27527. * @see https://www.babylonjs-playground.com/#19O9TU#0
  27528. */
  27529. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  27530. }
  27531. }
  27532. declare module "babylonjs/Actions/actionEvent" {
  27533. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27534. import { Nullable } from "babylonjs/types";
  27535. import { Sprite } from "babylonjs/Sprites/sprite";
  27536. import { Scene } from "babylonjs/scene";
  27537. import { Vector2 } from "babylonjs/Maths/math.vector";
  27538. /**
  27539. * Interface used to define ActionEvent
  27540. */
  27541. export interface IActionEvent {
  27542. /** The mesh or sprite that triggered the action */
  27543. source: any;
  27544. /** The X mouse cursor position at the time of the event */
  27545. pointerX: number;
  27546. /** The Y mouse cursor position at the time of the event */
  27547. pointerY: number;
  27548. /** The mesh that is currently pointed at (can be null) */
  27549. meshUnderPointer: Nullable<AbstractMesh>;
  27550. /** the original (browser) event that triggered the ActionEvent */
  27551. sourceEvent?: any;
  27552. /** additional data for the event */
  27553. additionalData?: any;
  27554. }
  27555. /**
  27556. * ActionEvent is the event being sent when an action is triggered.
  27557. */
  27558. export class ActionEvent implements IActionEvent {
  27559. /** The mesh or sprite that triggered the action */
  27560. source: any;
  27561. /** The X mouse cursor position at the time of the event */
  27562. pointerX: number;
  27563. /** The Y mouse cursor position at the time of the event */
  27564. pointerY: number;
  27565. /** The mesh that is currently pointed at (can be null) */
  27566. meshUnderPointer: Nullable<AbstractMesh>;
  27567. /** the original (browser) event that triggered the ActionEvent */
  27568. sourceEvent?: any;
  27569. /** additional data for the event */
  27570. additionalData?: any;
  27571. /**
  27572. * Creates a new ActionEvent
  27573. * @param source The mesh or sprite that triggered the action
  27574. * @param pointerX The X mouse cursor position at the time of the event
  27575. * @param pointerY The Y mouse cursor position at the time of the event
  27576. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  27577. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  27578. * @param additionalData additional data for the event
  27579. */
  27580. constructor(
  27581. /** The mesh or sprite that triggered the action */
  27582. source: any,
  27583. /** The X mouse cursor position at the time of the event */
  27584. pointerX: number,
  27585. /** The Y mouse cursor position at the time of the event */
  27586. pointerY: number,
  27587. /** The mesh that is currently pointed at (can be null) */
  27588. meshUnderPointer: Nullable<AbstractMesh>,
  27589. /** the original (browser) event that triggered the ActionEvent */
  27590. sourceEvent?: any,
  27591. /** additional data for the event */
  27592. additionalData?: any);
  27593. /**
  27594. * Helper function to auto-create an ActionEvent from a source mesh.
  27595. * @param source The source mesh that triggered the event
  27596. * @param evt The original (browser) event
  27597. * @param additionalData additional data for the event
  27598. * @returns the new ActionEvent
  27599. */
  27600. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  27601. /**
  27602. * Helper function to auto-create an ActionEvent from a source sprite
  27603. * @param source The source sprite that triggered the event
  27604. * @param scene Scene associated with the sprite
  27605. * @param evt The original (browser) event
  27606. * @param additionalData additional data for the event
  27607. * @returns the new ActionEvent
  27608. */
  27609. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  27610. /**
  27611. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  27612. * @param scene the scene where the event occurred
  27613. * @param evt The original (browser) event
  27614. * @returns the new ActionEvent
  27615. */
  27616. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  27617. /**
  27618. * Helper function to auto-create an ActionEvent from a primitive
  27619. * @param prim defines the target primitive
  27620. * @param pointerPos defines the pointer position
  27621. * @param evt The original (browser) event
  27622. * @param additionalData additional data for the event
  27623. * @returns the new ActionEvent
  27624. */
  27625. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  27626. }
  27627. }
  27628. declare module "babylonjs/Actions/abstractActionManager" {
  27629. import { IDisposable } from "babylonjs/scene";
  27630. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  27631. import { IAction } from "babylonjs/Actions/action";
  27632. import { Nullable } from "babylonjs/types";
  27633. /**
  27634. * Abstract class used to decouple action Manager from scene and meshes.
  27635. * Do not instantiate.
  27636. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  27637. */
  27638. export abstract class AbstractActionManager implements IDisposable {
  27639. /** Gets the list of active triggers */
  27640. static Triggers: {
  27641. [key: string]: number;
  27642. };
  27643. /** Gets the cursor to use when hovering items */
  27644. hoverCursor: string;
  27645. /** Gets the list of actions */
  27646. actions: IAction[];
  27647. /**
  27648. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  27649. */
  27650. isRecursive: boolean;
  27651. /**
  27652. * Releases all associated resources
  27653. */
  27654. abstract dispose(): void;
  27655. /**
  27656. * Does this action manager has pointer triggers
  27657. */
  27658. abstract readonly hasPointerTriggers: boolean;
  27659. /**
  27660. * Does this action manager has pick triggers
  27661. */
  27662. abstract readonly hasPickTriggers: boolean;
  27663. /**
  27664. * Process a specific trigger
  27665. * @param trigger defines the trigger to process
  27666. * @param evt defines the event details to be processed
  27667. */
  27668. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  27669. /**
  27670. * Does this action manager handles actions of any of the given triggers
  27671. * @param triggers defines the triggers to be tested
  27672. * @return a boolean indicating whether one (or more) of the triggers is handled
  27673. */
  27674. abstract hasSpecificTriggers(triggers: number[]): boolean;
  27675. /**
  27676. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  27677. * speed.
  27678. * @param triggerA defines the trigger to be tested
  27679. * @param triggerB defines the trigger to be tested
  27680. * @return a boolean indicating whether one (or more) of the triggers is handled
  27681. */
  27682. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  27683. /**
  27684. * Does this action manager handles actions of a given trigger
  27685. * @param trigger defines the trigger to be tested
  27686. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  27687. * @return whether the trigger is handled
  27688. */
  27689. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  27690. /**
  27691. * Serialize this manager to a JSON object
  27692. * @param name defines the property name to store this manager
  27693. * @returns a JSON representation of this manager
  27694. */
  27695. abstract serialize(name: string): any;
  27696. /**
  27697. * Registers an action to this action manager
  27698. * @param action defines the action to be registered
  27699. * @return the action amended (prepared) after registration
  27700. */
  27701. abstract registerAction(action: IAction): Nullable<IAction>;
  27702. /**
  27703. * Unregisters an action to this action manager
  27704. * @param action defines the action to be unregistered
  27705. * @return a boolean indicating whether the action has been unregistered
  27706. */
  27707. abstract unregisterAction(action: IAction): Boolean;
  27708. /**
  27709. * Does exist one action manager with at least one trigger
  27710. **/
  27711. static readonly HasTriggers: boolean;
  27712. /**
  27713. * Does exist one action manager with at least one pick trigger
  27714. **/
  27715. static readonly HasPickTriggers: boolean;
  27716. /**
  27717. * Does exist one action manager that handles actions of a given trigger
  27718. * @param trigger defines the trigger to be tested
  27719. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  27720. **/
  27721. static HasSpecificTrigger(trigger: number): boolean;
  27722. }
  27723. }
  27724. declare module "babylonjs/node" {
  27725. import { Scene } from "babylonjs/scene";
  27726. import { Nullable } from "babylonjs/types";
  27727. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  27728. import { Engine } from "babylonjs/Engines/engine";
  27729. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  27730. import { Observable } from "babylonjs/Misc/observable";
  27731. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  27732. import { IInspectable } from "babylonjs/Misc/iInspectable";
  27733. import { Animatable } from "babylonjs/Animations/animatable";
  27734. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27735. import { Animation } from "babylonjs/Animations/animation";
  27736. import { AnimationRange } from "babylonjs/Animations/animationRange";
  27737. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27738. /**
  27739. * Defines how a node can be built from a string name.
  27740. */
  27741. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  27742. /**
  27743. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  27744. */
  27745. export class Node implements IBehaviorAware<Node> {
  27746. /** @hidden */
  27747. static _AnimationRangeFactory: (name: string, from: number, to: number) => import("babylonjs/Animations/animationRange").AnimationRange;
  27748. private static _NodeConstructors;
  27749. /**
  27750. * Add a new node constructor
  27751. * @param type defines the type name of the node to construct
  27752. * @param constructorFunc defines the constructor function
  27753. */
  27754. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  27755. /**
  27756. * Returns a node constructor based on type name
  27757. * @param type defines the type name
  27758. * @param name defines the new node name
  27759. * @param scene defines the hosting scene
  27760. * @param options defines optional options to transmit to constructors
  27761. * @returns the new constructor or null
  27762. */
  27763. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  27764. /**
  27765. * Gets or sets the name of the node
  27766. */
  27767. name: string;
  27768. /**
  27769. * Gets or sets the id of the node
  27770. */
  27771. id: string;
  27772. /**
  27773. * Gets or sets the unique id of the node
  27774. */
  27775. uniqueId: number;
  27776. /**
  27777. * Gets or sets a string used to store user defined state for the node
  27778. */
  27779. state: string;
  27780. /**
  27781. * Gets or sets an object used to store user defined information for the node
  27782. */
  27783. metadata: any;
  27784. /**
  27785. * For internal use only. Please do not use.
  27786. */
  27787. reservedDataStore: any;
  27788. /**
  27789. * List of inspectable custom properties (used by the Inspector)
  27790. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  27791. */
  27792. inspectableCustomProperties: IInspectable[];
  27793. private _doNotSerialize;
  27794. /**
  27795. * Gets or sets a boolean used to define if the node must be serialized
  27796. */
  27797. doNotSerialize: boolean;
  27798. /** @hidden */
  27799. _isDisposed: boolean;
  27800. /**
  27801. * Gets a list of Animations associated with the node
  27802. */
  27803. animations: import("babylonjs/Animations/animation").Animation[];
  27804. protected _ranges: {
  27805. [name: string]: Nullable<AnimationRange>;
  27806. };
  27807. /**
  27808. * Callback raised when the node is ready to be used
  27809. */
  27810. onReady: Nullable<(node: Node) => void>;
  27811. private _isEnabled;
  27812. private _isParentEnabled;
  27813. private _isReady;
  27814. /** @hidden */
  27815. _currentRenderId: number;
  27816. private _parentUpdateId;
  27817. /** @hidden */
  27818. _childUpdateId: number;
  27819. /** @hidden */
  27820. _waitingParentId: Nullable<string>;
  27821. /** @hidden */
  27822. _scene: Scene;
  27823. /** @hidden */
  27824. _cache: any;
  27825. private _parentNode;
  27826. private _children;
  27827. /** @hidden */
  27828. _worldMatrix: Matrix;
  27829. /** @hidden */
  27830. _worldMatrixDeterminant: number;
  27831. /** @hidden */
  27832. _worldMatrixDeterminantIsDirty: boolean;
  27833. /** @hidden */
  27834. private _sceneRootNodesIndex;
  27835. /**
  27836. * Gets a boolean indicating if the node has been disposed
  27837. * @returns true if the node was disposed
  27838. */
  27839. isDisposed(): boolean;
  27840. /**
  27841. * Gets or sets the parent of the node (without keeping the current position in the scene)
  27842. * @see https://doc.babylonjs.com/how_to/parenting
  27843. */
  27844. parent: Nullable<Node>;
  27845. /** @hidden */
  27846. _addToSceneRootNodes(): void;
  27847. /** @hidden */
  27848. _removeFromSceneRootNodes(): void;
  27849. private _animationPropertiesOverride;
  27850. /**
  27851. * Gets or sets the animation properties override
  27852. */
  27853. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  27854. /**
  27855. * Gets a string idenfifying the name of the class
  27856. * @returns "Node" string
  27857. */
  27858. getClassName(): string;
  27859. /** @hidden */
  27860. readonly _isNode: boolean;
  27861. /**
  27862. * An event triggered when the mesh is disposed
  27863. */
  27864. onDisposeObservable: Observable<Node>;
  27865. private _onDisposeObserver;
  27866. /**
  27867. * Sets a callback that will be raised when the node will be disposed
  27868. */
  27869. onDispose: () => void;
  27870. /**
  27871. * Creates a new Node
  27872. * @param name the name and id to be given to this node
  27873. * @param scene the scene this node will be added to
  27874. */
  27875. constructor(name: string, scene?: Nullable<Scene>);
  27876. /**
  27877. * Gets the scene of the node
  27878. * @returns a scene
  27879. */
  27880. getScene(): Scene;
  27881. /**
  27882. * Gets the engine of the node
  27883. * @returns a Engine
  27884. */
  27885. getEngine(): Engine;
  27886. private _behaviors;
  27887. /**
  27888. * Attach a behavior to the node
  27889. * @see http://doc.babylonjs.com/features/behaviour
  27890. * @param behavior defines the behavior to attach
  27891. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  27892. * @returns the current Node
  27893. */
  27894. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  27895. /**
  27896. * Remove an attached behavior
  27897. * @see http://doc.babylonjs.com/features/behaviour
  27898. * @param behavior defines the behavior to attach
  27899. * @returns the current Node
  27900. */
  27901. removeBehavior(behavior: Behavior<Node>): Node;
  27902. /**
  27903. * Gets the list of attached behaviors
  27904. * @see http://doc.babylonjs.com/features/behaviour
  27905. */
  27906. readonly behaviors: Behavior<Node>[];
  27907. /**
  27908. * Gets an attached behavior by name
  27909. * @param name defines the name of the behavior to look for
  27910. * @see http://doc.babylonjs.com/features/behaviour
  27911. * @returns null if behavior was not found else the requested behavior
  27912. */
  27913. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  27914. /**
  27915. * Returns the latest update of the World matrix
  27916. * @returns a Matrix
  27917. */
  27918. getWorldMatrix(): Matrix;
  27919. /** @hidden */
  27920. _getWorldMatrixDeterminant(): number;
  27921. /**
  27922. * Returns directly the latest state of the mesh World matrix.
  27923. * A Matrix is returned.
  27924. */
  27925. readonly worldMatrixFromCache: Matrix;
  27926. /** @hidden */
  27927. _initCache(): void;
  27928. /** @hidden */
  27929. updateCache(force?: boolean): void;
  27930. /** @hidden */
  27931. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  27932. /** @hidden */
  27933. _updateCache(ignoreParentClass?: boolean): void;
  27934. /** @hidden */
  27935. _isSynchronized(): boolean;
  27936. /** @hidden */
  27937. _markSyncedWithParent(): void;
  27938. /** @hidden */
  27939. isSynchronizedWithParent(): boolean;
  27940. /** @hidden */
  27941. isSynchronized(): boolean;
  27942. /**
  27943. * Is this node ready to be used/rendered
  27944. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  27945. * @return true if the node is ready
  27946. */
  27947. isReady(completeCheck?: boolean): boolean;
  27948. /**
  27949. * Is this node enabled?
  27950. * 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
  27951. * @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
  27952. * @return whether this node (and its parent) is enabled
  27953. */
  27954. isEnabled(checkAncestors?: boolean): boolean;
  27955. /** @hidden */
  27956. protected _syncParentEnabledState(): void;
  27957. /**
  27958. * Set the enabled state of this node
  27959. * @param value defines the new enabled state
  27960. */
  27961. setEnabled(value: boolean): void;
  27962. /**
  27963. * Is this node a descendant of the given node?
  27964. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  27965. * @param ancestor defines the parent node to inspect
  27966. * @returns a boolean indicating if this node is a descendant of the given node
  27967. */
  27968. isDescendantOf(ancestor: Node): boolean;
  27969. /** @hidden */
  27970. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  27971. /**
  27972. * Will return all nodes that have this node as ascendant
  27973. * @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
  27974. * @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
  27975. * @return all children nodes of all types
  27976. */
  27977. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  27978. /**
  27979. * Get all child-meshes of this node
  27980. * @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)
  27981. * @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
  27982. * @returns an array of AbstractMesh
  27983. */
  27984. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  27985. /**
  27986. * Get all direct children of this node
  27987. * @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
  27988. * @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)
  27989. * @returns an array of Node
  27990. */
  27991. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  27992. /** @hidden */
  27993. _setReady(state: boolean): void;
  27994. /**
  27995. * Get an animation by name
  27996. * @param name defines the name of the animation to look for
  27997. * @returns null if not found else the requested animation
  27998. */
  27999. getAnimationByName(name: string): Nullable<Animation>;
  28000. /**
  28001. * Creates an animation range for this node
  28002. * @param name defines the name of the range
  28003. * @param from defines the starting key
  28004. * @param to defines the end key
  28005. */
  28006. createAnimationRange(name: string, from: number, to: number): void;
  28007. /**
  28008. * Delete a specific animation range
  28009. * @param name defines the name of the range to delete
  28010. * @param deleteFrames defines if animation frames from the range must be deleted as well
  28011. */
  28012. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  28013. /**
  28014. * Get an animation range by name
  28015. * @param name defines the name of the animation range to look for
  28016. * @returns null if not found else the requested animation range
  28017. */
  28018. getAnimationRange(name: string): Nullable<AnimationRange>;
  28019. /**
  28020. * Gets the list of all animation ranges defined on this node
  28021. * @returns an array
  28022. */
  28023. getAnimationRanges(): Nullable<AnimationRange>[];
  28024. /**
  28025. * Will start the animation sequence
  28026. * @param name defines the range frames for animation sequence
  28027. * @param loop defines if the animation should loop (false by default)
  28028. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  28029. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  28030. * @returns the object created for this animation. If range does not exist, it will return null
  28031. */
  28032. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  28033. /**
  28034. * Serialize animation ranges into a JSON compatible object
  28035. * @returns serialization object
  28036. */
  28037. serializeAnimationRanges(): any;
  28038. /**
  28039. * Computes the world matrix of the node
  28040. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  28041. * @returns the world matrix
  28042. */
  28043. computeWorldMatrix(force?: boolean): Matrix;
  28044. /**
  28045. * Releases resources associated with this node.
  28046. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  28047. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  28048. */
  28049. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  28050. /**
  28051. * Parse animation range data from a serialization object and store them into a given node
  28052. * @param node defines where to store the animation ranges
  28053. * @param parsedNode defines the serialization object to read data from
  28054. * @param scene defines the hosting scene
  28055. */
  28056. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  28057. /**
  28058. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  28059. * @param includeDescendants Include bounding info from descendants as well (true by default)
  28060. * @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
  28061. * @returns the new bounding vectors
  28062. */
  28063. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  28064. min: Vector3;
  28065. max: Vector3;
  28066. };
  28067. }
  28068. }
  28069. declare module "babylonjs/Animations/animation" {
  28070. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  28071. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  28072. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  28073. import { Nullable } from "babylonjs/types";
  28074. import { Scene } from "babylonjs/scene";
  28075. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  28076. import { AnimationRange } from "babylonjs/Animations/animationRange";
  28077. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  28078. import { Node } from "babylonjs/node";
  28079. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28080. import { Size } from "babylonjs/Maths/math.size";
  28081. import { Animatable } from "babylonjs/Animations/animatable";
  28082. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  28083. /**
  28084. * @hidden
  28085. */
  28086. export class _IAnimationState {
  28087. key: number;
  28088. repeatCount: number;
  28089. workValue?: any;
  28090. loopMode?: number;
  28091. offsetValue?: any;
  28092. highLimitValue?: any;
  28093. }
  28094. /**
  28095. * Class used to store any kind of animation
  28096. */
  28097. export class Animation {
  28098. /**Name of the animation */
  28099. name: string;
  28100. /**Property to animate */
  28101. targetProperty: string;
  28102. /**The frames per second of the animation */
  28103. framePerSecond: number;
  28104. /**The data type of the animation */
  28105. dataType: number;
  28106. /**The loop mode of the animation */
  28107. loopMode?: number | undefined;
  28108. /**Specifies if blending should be enabled */
  28109. enableBlending?: boolean | undefined;
  28110. /**
  28111. * Use matrix interpolation instead of using direct key value when animating matrices
  28112. */
  28113. static AllowMatricesInterpolation: boolean;
  28114. /**
  28115. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  28116. */
  28117. static AllowMatrixDecomposeForInterpolation: boolean;
  28118. /**
  28119. * Stores the key frames of the animation
  28120. */
  28121. private _keys;
  28122. /**
  28123. * Stores the easing function of the animation
  28124. */
  28125. private _easingFunction;
  28126. /**
  28127. * @hidden Internal use only
  28128. */
  28129. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  28130. /**
  28131. * The set of event that will be linked to this animation
  28132. */
  28133. private _events;
  28134. /**
  28135. * Stores an array of target property paths
  28136. */
  28137. targetPropertyPath: string[];
  28138. /**
  28139. * Stores the blending speed of the animation
  28140. */
  28141. blendingSpeed: number;
  28142. /**
  28143. * Stores the animation ranges for the animation
  28144. */
  28145. private _ranges;
  28146. /**
  28147. * @hidden Internal use
  28148. */
  28149. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  28150. /**
  28151. * Sets up an animation
  28152. * @param property The property to animate
  28153. * @param animationType The animation type to apply
  28154. * @param framePerSecond The frames per second of the animation
  28155. * @param easingFunction The easing function used in the animation
  28156. * @returns The created animation
  28157. */
  28158. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  28159. /**
  28160. * Create and start an animation on a node
  28161. * @param name defines the name of the global animation that will be run on all nodes
  28162. * @param node defines the root node where the animation will take place
  28163. * @param targetProperty defines property to animate
  28164. * @param framePerSecond defines the number of frame per second yo use
  28165. * @param totalFrame defines the number of frames in total
  28166. * @param from defines the initial value
  28167. * @param to defines the final value
  28168. * @param loopMode defines which loop mode you want to use (off by default)
  28169. * @param easingFunction defines the easing function to use (linear by default)
  28170. * @param onAnimationEnd defines the callback to call when animation end
  28171. * @returns the animatable created for this animation
  28172. */
  28173. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  28174. /**
  28175. * Create and start an animation on a node and its descendants
  28176. * @param name defines the name of the global animation that will be run on all nodes
  28177. * @param node defines the root node where the animation will take place
  28178. * @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
  28179. * @param targetProperty defines property to animate
  28180. * @param framePerSecond defines the number of frame per second to use
  28181. * @param totalFrame defines the number of frames in total
  28182. * @param from defines the initial value
  28183. * @param to defines the final value
  28184. * @param loopMode defines which loop mode you want to use (off by default)
  28185. * @param easingFunction defines the easing function to use (linear by default)
  28186. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  28187. * @returns the list of animatables created for all nodes
  28188. * @example https://www.babylonjs-playground.com/#MH0VLI
  28189. */
  28190. 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[]>;
  28191. /**
  28192. * Creates a new animation, merges it with the existing animations and starts it
  28193. * @param name Name of the animation
  28194. * @param node Node which contains the scene that begins the animations
  28195. * @param targetProperty Specifies which property to animate
  28196. * @param framePerSecond The frames per second of the animation
  28197. * @param totalFrame The total number of frames
  28198. * @param from The frame at the beginning of the animation
  28199. * @param to The frame at the end of the animation
  28200. * @param loopMode Specifies the loop mode of the animation
  28201. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  28202. * @param onAnimationEnd Callback to run once the animation is complete
  28203. * @returns Nullable animation
  28204. */
  28205. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  28206. /**
  28207. * Transition property of an host to the target Value
  28208. * @param property The property to transition
  28209. * @param targetValue The target Value of the property
  28210. * @param host The object where the property to animate belongs
  28211. * @param scene Scene used to run the animation
  28212. * @param frameRate Framerate (in frame/s) to use
  28213. * @param transition The transition type we want to use
  28214. * @param duration The duration of the animation, in milliseconds
  28215. * @param onAnimationEnd Callback trigger at the end of the animation
  28216. * @returns Nullable animation
  28217. */
  28218. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  28219. /**
  28220. * Return the array of runtime animations currently using this animation
  28221. */
  28222. readonly runtimeAnimations: RuntimeAnimation[];
  28223. /**
  28224. * Specifies if any of the runtime animations are currently running
  28225. */
  28226. readonly hasRunningRuntimeAnimations: boolean;
  28227. /**
  28228. * Initializes the animation
  28229. * @param name Name of the animation
  28230. * @param targetProperty Property to animate
  28231. * @param framePerSecond The frames per second of the animation
  28232. * @param dataType The data type of the animation
  28233. * @param loopMode The loop mode of the animation
  28234. * @param enableBlending Specifies if blending should be enabled
  28235. */
  28236. constructor(
  28237. /**Name of the animation */
  28238. name: string,
  28239. /**Property to animate */
  28240. targetProperty: string,
  28241. /**The frames per second of the animation */
  28242. framePerSecond: number,
  28243. /**The data type of the animation */
  28244. dataType: number,
  28245. /**The loop mode of the animation */
  28246. loopMode?: number | undefined,
  28247. /**Specifies if blending should be enabled */
  28248. enableBlending?: boolean | undefined);
  28249. /**
  28250. * Converts the animation to a string
  28251. * @param fullDetails support for multiple levels of logging within scene loading
  28252. * @returns String form of the animation
  28253. */
  28254. toString(fullDetails?: boolean): string;
  28255. /**
  28256. * Add an event to this animation
  28257. * @param event Event to add
  28258. */
  28259. addEvent(event: AnimationEvent): void;
  28260. /**
  28261. * Remove all events found at the given frame
  28262. * @param frame The frame to remove events from
  28263. */
  28264. removeEvents(frame: number): void;
  28265. /**
  28266. * Retrieves all the events from the animation
  28267. * @returns Events from the animation
  28268. */
  28269. getEvents(): AnimationEvent[];
  28270. /**
  28271. * Creates an animation range
  28272. * @param name Name of the animation range
  28273. * @param from Starting frame of the animation range
  28274. * @param to Ending frame of the animation
  28275. */
  28276. createRange(name: string, from: number, to: number): void;
  28277. /**
  28278. * Deletes an animation range by name
  28279. * @param name Name of the animation range to delete
  28280. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  28281. */
  28282. deleteRange(name: string, deleteFrames?: boolean): void;
  28283. /**
  28284. * Gets the animation range by name, or null if not defined
  28285. * @param name Name of the animation range
  28286. * @returns Nullable animation range
  28287. */
  28288. getRange(name: string): Nullable<AnimationRange>;
  28289. /**
  28290. * Gets the key frames from the animation
  28291. * @returns The key frames of the animation
  28292. */
  28293. getKeys(): Array<IAnimationKey>;
  28294. /**
  28295. * Gets the highest frame rate of the animation
  28296. * @returns Highest frame rate of the animation
  28297. */
  28298. getHighestFrame(): number;
  28299. /**
  28300. * Gets the easing function of the animation
  28301. * @returns Easing function of the animation
  28302. */
  28303. getEasingFunction(): IEasingFunction;
  28304. /**
  28305. * Sets the easing function of the animation
  28306. * @param easingFunction A custom mathematical formula for animation
  28307. */
  28308. setEasingFunction(easingFunction: EasingFunction): void;
  28309. /**
  28310. * Interpolates a scalar linearly
  28311. * @param startValue Start value of the animation curve
  28312. * @param endValue End value of the animation curve
  28313. * @param gradient Scalar amount to interpolate
  28314. * @returns Interpolated scalar value
  28315. */
  28316. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  28317. /**
  28318. * Interpolates a scalar cubically
  28319. * @param startValue Start value of the animation curve
  28320. * @param outTangent End tangent of the animation
  28321. * @param endValue End value of the animation curve
  28322. * @param inTangent Start tangent of the animation curve
  28323. * @param gradient Scalar amount to interpolate
  28324. * @returns Interpolated scalar value
  28325. */
  28326. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  28327. /**
  28328. * Interpolates a quaternion using a spherical linear interpolation
  28329. * @param startValue Start value of the animation curve
  28330. * @param endValue End value of the animation curve
  28331. * @param gradient Scalar amount to interpolate
  28332. * @returns Interpolated quaternion value
  28333. */
  28334. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  28335. /**
  28336. * Interpolates a quaternion cubically
  28337. * @param startValue Start value of the animation curve
  28338. * @param outTangent End tangent of the animation curve
  28339. * @param endValue End value of the animation curve
  28340. * @param inTangent Start tangent of the animation curve
  28341. * @param gradient Scalar amount to interpolate
  28342. * @returns Interpolated quaternion value
  28343. */
  28344. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  28345. /**
  28346. * Interpolates a Vector3 linearl
  28347. * @param startValue Start value of the animation curve
  28348. * @param endValue End value of the animation curve
  28349. * @param gradient Scalar amount to interpolate
  28350. * @returns Interpolated scalar value
  28351. */
  28352. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  28353. /**
  28354. * Interpolates a Vector3 cubically
  28355. * @param startValue Start value of the animation curve
  28356. * @param outTangent End tangent of the animation
  28357. * @param endValue End value of the animation curve
  28358. * @param inTangent Start tangent of the animation curve
  28359. * @param gradient Scalar amount to interpolate
  28360. * @returns InterpolatedVector3 value
  28361. */
  28362. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  28363. /**
  28364. * Interpolates a Vector2 linearly
  28365. * @param startValue Start value of the animation curve
  28366. * @param endValue End value of the animation curve
  28367. * @param gradient Scalar amount to interpolate
  28368. * @returns Interpolated Vector2 value
  28369. */
  28370. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  28371. /**
  28372. * Interpolates a Vector2 cubically
  28373. * @param startValue Start value of the animation curve
  28374. * @param outTangent End tangent of the animation
  28375. * @param endValue End value of the animation curve
  28376. * @param inTangent Start tangent of the animation curve
  28377. * @param gradient Scalar amount to interpolate
  28378. * @returns Interpolated Vector2 value
  28379. */
  28380. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  28381. /**
  28382. * Interpolates a size linearly
  28383. * @param startValue Start value of the animation curve
  28384. * @param endValue End value of the animation curve
  28385. * @param gradient Scalar amount to interpolate
  28386. * @returns Interpolated Size value
  28387. */
  28388. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  28389. /**
  28390. * Interpolates a Color3 linearly
  28391. * @param startValue Start value of the animation curve
  28392. * @param endValue End value of the animation curve
  28393. * @param gradient Scalar amount to interpolate
  28394. * @returns Interpolated Color3 value
  28395. */
  28396. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  28397. /**
  28398. * Interpolates a Color4 linearly
  28399. * @param startValue Start value of the animation curve
  28400. * @param endValue End value of the animation curve
  28401. * @param gradient Scalar amount to interpolate
  28402. * @returns Interpolated Color3 value
  28403. */
  28404. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  28405. /**
  28406. * @hidden Internal use only
  28407. */
  28408. _getKeyValue(value: any): any;
  28409. /**
  28410. * @hidden Internal use only
  28411. */
  28412. _interpolate(currentFrame: number, state: _IAnimationState): any;
  28413. /**
  28414. * Defines the function to use to interpolate matrices
  28415. * @param startValue defines the start matrix
  28416. * @param endValue defines the end matrix
  28417. * @param gradient defines the gradient between both matrices
  28418. * @param result defines an optional target matrix where to store the interpolation
  28419. * @returns the interpolated matrix
  28420. */
  28421. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  28422. /**
  28423. * Makes a copy of the animation
  28424. * @returns Cloned animation
  28425. */
  28426. clone(): Animation;
  28427. /**
  28428. * Sets the key frames of the animation
  28429. * @param values The animation key frames to set
  28430. */
  28431. setKeys(values: Array<IAnimationKey>): void;
  28432. /**
  28433. * Serializes the animation to an object
  28434. * @returns Serialized object
  28435. */
  28436. serialize(): any;
  28437. /**
  28438. * Float animation type
  28439. */
  28440. static readonly ANIMATIONTYPE_FLOAT: number;
  28441. /**
  28442. * Vector3 animation type
  28443. */
  28444. static readonly ANIMATIONTYPE_VECTOR3: number;
  28445. /**
  28446. * Quaternion animation type
  28447. */
  28448. static readonly ANIMATIONTYPE_QUATERNION: number;
  28449. /**
  28450. * Matrix animation type
  28451. */
  28452. static readonly ANIMATIONTYPE_MATRIX: number;
  28453. /**
  28454. * Color3 animation type
  28455. */
  28456. static readonly ANIMATIONTYPE_COLOR3: number;
  28457. /**
  28458. * Color3 animation type
  28459. */
  28460. static readonly ANIMATIONTYPE_COLOR4: number;
  28461. /**
  28462. * Vector2 animation type
  28463. */
  28464. static readonly ANIMATIONTYPE_VECTOR2: number;
  28465. /**
  28466. * Size animation type
  28467. */
  28468. static readonly ANIMATIONTYPE_SIZE: number;
  28469. /**
  28470. * Relative Loop Mode
  28471. */
  28472. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  28473. /**
  28474. * Cycle Loop Mode
  28475. */
  28476. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  28477. /**
  28478. * Constant Loop Mode
  28479. */
  28480. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  28481. /** @hidden */
  28482. static _UniversalLerp(left: any, right: any, amount: number): any;
  28483. /**
  28484. * Parses an animation object and creates an animation
  28485. * @param parsedAnimation Parsed animation object
  28486. * @returns Animation object
  28487. */
  28488. static Parse(parsedAnimation: any): Animation;
  28489. /**
  28490. * Appends the serialized animations from the source animations
  28491. * @param source Source containing the animations
  28492. * @param destination Target to store the animations
  28493. */
  28494. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28495. }
  28496. }
  28497. declare module "babylonjs/Animations/animatable.interface" {
  28498. import { Nullable } from "babylonjs/types";
  28499. import { Animation } from "babylonjs/Animations/animation";
  28500. /**
  28501. * Interface containing an array of animations
  28502. */
  28503. export interface IAnimatable {
  28504. /**
  28505. * Array of animations
  28506. */
  28507. animations: Nullable<Array<Animation>>;
  28508. }
  28509. }
  28510. declare module "babylonjs/Materials/fresnelParameters" {
  28511. import { Color3 } from "babylonjs/Maths/math.color";
  28512. /**
  28513. * This represents all the required information to add a fresnel effect on a material:
  28514. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  28515. */
  28516. export class FresnelParameters {
  28517. private _isEnabled;
  28518. /**
  28519. * Define if the fresnel effect is enable or not.
  28520. */
  28521. isEnabled: boolean;
  28522. /**
  28523. * Define the color used on edges (grazing angle)
  28524. */
  28525. leftColor: Color3;
  28526. /**
  28527. * Define the color used on center
  28528. */
  28529. rightColor: Color3;
  28530. /**
  28531. * Define bias applied to computed fresnel term
  28532. */
  28533. bias: number;
  28534. /**
  28535. * Defined the power exponent applied to fresnel term
  28536. */
  28537. power: number;
  28538. /**
  28539. * Clones the current fresnel and its valuues
  28540. * @returns a clone fresnel configuration
  28541. */
  28542. clone(): FresnelParameters;
  28543. /**
  28544. * Serializes the current fresnel parameters to a JSON representation.
  28545. * @return the JSON serialization
  28546. */
  28547. serialize(): any;
  28548. /**
  28549. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  28550. * @param parsedFresnelParameters Define the JSON representation
  28551. * @returns the parsed parameters
  28552. */
  28553. static Parse(parsedFresnelParameters: any): FresnelParameters;
  28554. }
  28555. }
  28556. declare module "babylonjs/Misc/decorators" {
  28557. import { Nullable } from "babylonjs/types";
  28558. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28559. import { Scene } from "babylonjs/scene";
  28560. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  28561. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28562. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28563. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28564. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28565. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28566. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28567. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28568. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28569. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28570. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28571. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28572. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28573. /**
  28574. * Decorator used to define property that can be serialized as reference to a camera
  28575. * @param sourceName defines the name of the property to decorate
  28576. */
  28577. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28578. /**
  28579. * Class used to help serialization objects
  28580. */
  28581. export class SerializationHelper {
  28582. /** @hidden */
  28583. static _ImageProcessingConfigurationParser: (sourceProperty: any) => import("babylonjs/Materials/imageProcessingConfiguration").ImageProcessingConfiguration;
  28584. /** @hidden */
  28585. static _FresnelParametersParser: (sourceProperty: any) => import("babylonjs/Materials/fresnelParameters").FresnelParameters;
  28586. /** @hidden */
  28587. static _ColorCurvesParser: (sourceProperty: any) => import("babylonjs/Materials/colorCurves").ColorCurves;
  28588. /** @hidden */
  28589. static _TextureParser: (sourceProperty: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => Nullable<import("babylonjs/Materials/Textures/baseTexture").BaseTexture>;
  28590. /**
  28591. * Appends the serialized animations from the source animations
  28592. * @param source Source containing the animations
  28593. * @param destination Target to store the animations
  28594. */
  28595. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28596. /**
  28597. * Static function used to serialized a specific entity
  28598. * @param entity defines the entity to serialize
  28599. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  28600. * @returns a JSON compatible object representing the serialization of the entity
  28601. */
  28602. static Serialize<T>(entity: T, serializationObject?: any): any;
  28603. /**
  28604. * Creates a new entity from a serialization data object
  28605. * @param creationFunction defines a function used to instanciated the new entity
  28606. * @param source defines the source serialization data
  28607. * @param scene defines the hosting scene
  28608. * @param rootUrl defines the root url for resources
  28609. * @returns a new entity
  28610. */
  28611. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  28612. /**
  28613. * Clones an object
  28614. * @param creationFunction defines the function used to instanciate the new object
  28615. * @param source defines the source object
  28616. * @returns the cloned object
  28617. */
  28618. static Clone<T>(creationFunction: () => T, source: T): T;
  28619. /**
  28620. * Instanciates a new object based on a source one (some data will be shared between both object)
  28621. * @param creationFunction defines the function used to instanciate the new object
  28622. * @param source defines the source object
  28623. * @returns the new object
  28624. */
  28625. static Instanciate<T>(creationFunction: () => T, source: T): T;
  28626. }
  28627. }
  28628. declare module "babylonjs/Misc/guid" {
  28629. /**
  28630. * Class used to manipulate GUIDs
  28631. */
  28632. export class GUID {
  28633. /**
  28634. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  28635. * Be aware Math.random() could cause collisions, but:
  28636. * "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"
  28637. * @returns a pseudo random id
  28638. */
  28639. static RandomId(): string;
  28640. }
  28641. }
  28642. declare module "babylonjs/Materials/Textures/baseTexture" {
  28643. import { Observable } from "babylonjs/Misc/observable";
  28644. import { Nullable } from "babylonjs/types";
  28645. import { Scene } from "babylonjs/scene";
  28646. import { Matrix } from "babylonjs/Maths/math.vector";
  28647. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28648. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28649. import { ISize } from "babylonjs/Maths/math.size";
  28650. /**
  28651. * Base class of all the textures in babylon.
  28652. * It groups all the common properties the materials, post process, lights... might need
  28653. * in order to make a correct use of the texture.
  28654. */
  28655. export class BaseTexture implements IAnimatable {
  28656. /**
  28657. * Default anisotropic filtering level for the application.
  28658. * It is set to 4 as a good tradeoff between perf and quality.
  28659. */
  28660. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  28661. /**
  28662. * Gets or sets the unique id of the texture
  28663. */
  28664. uniqueId: number;
  28665. /**
  28666. * Define the name of the texture.
  28667. */
  28668. name: string;
  28669. /**
  28670. * Gets or sets an object used to store user defined information.
  28671. */
  28672. metadata: any;
  28673. /**
  28674. * For internal use only. Please do not use.
  28675. */
  28676. reservedDataStore: any;
  28677. private _hasAlpha;
  28678. /**
  28679. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  28680. */
  28681. hasAlpha: boolean;
  28682. /**
  28683. * Defines if the alpha value should be determined via the rgb values.
  28684. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  28685. */
  28686. getAlphaFromRGB: boolean;
  28687. /**
  28688. * Intensity or strength of the texture.
  28689. * It is commonly used by materials to fine tune the intensity of the texture
  28690. */
  28691. level: number;
  28692. /**
  28693. * Define the UV chanel to use starting from 0 and defaulting to 0.
  28694. * This is part of the texture as textures usually maps to one uv set.
  28695. */
  28696. coordinatesIndex: number;
  28697. private _coordinatesMode;
  28698. /**
  28699. * How a texture is mapped.
  28700. *
  28701. * | Value | Type | Description |
  28702. * | ----- | ----------------------------------- | ----------- |
  28703. * | 0 | EXPLICIT_MODE | |
  28704. * | 1 | SPHERICAL_MODE | |
  28705. * | 2 | PLANAR_MODE | |
  28706. * | 3 | CUBIC_MODE | |
  28707. * | 4 | PROJECTION_MODE | |
  28708. * | 5 | SKYBOX_MODE | |
  28709. * | 6 | INVCUBIC_MODE | |
  28710. * | 7 | EQUIRECTANGULAR_MODE | |
  28711. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  28712. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  28713. */
  28714. coordinatesMode: number;
  28715. /**
  28716. * | Value | Type | Description |
  28717. * | ----- | ------------------ | ----------- |
  28718. * | 0 | CLAMP_ADDRESSMODE | |
  28719. * | 1 | WRAP_ADDRESSMODE | |
  28720. * | 2 | MIRROR_ADDRESSMODE | |
  28721. */
  28722. wrapU: number;
  28723. /**
  28724. * | Value | Type | Description |
  28725. * | ----- | ------------------ | ----------- |
  28726. * | 0 | CLAMP_ADDRESSMODE | |
  28727. * | 1 | WRAP_ADDRESSMODE | |
  28728. * | 2 | MIRROR_ADDRESSMODE | |
  28729. */
  28730. wrapV: number;
  28731. /**
  28732. * | Value | Type | Description |
  28733. * | ----- | ------------------ | ----------- |
  28734. * | 0 | CLAMP_ADDRESSMODE | |
  28735. * | 1 | WRAP_ADDRESSMODE | |
  28736. * | 2 | MIRROR_ADDRESSMODE | |
  28737. */
  28738. wrapR: number;
  28739. /**
  28740. * With compliant hardware and browser (supporting anisotropic filtering)
  28741. * this defines the level of anisotropic filtering in the texture.
  28742. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  28743. */
  28744. anisotropicFilteringLevel: number;
  28745. /**
  28746. * Define if the texture is a cube texture or if false a 2d texture.
  28747. */
  28748. isCube: boolean;
  28749. /**
  28750. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  28751. */
  28752. is3D: boolean;
  28753. /**
  28754. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  28755. * HDR texture are usually stored in linear space.
  28756. * This only impacts the PBR and Background materials
  28757. */
  28758. gammaSpace: boolean;
  28759. /**
  28760. * Gets or sets whether or not the texture contains RGBD data.
  28761. */
  28762. isRGBD: boolean;
  28763. /**
  28764. * Is Z inverted in the texture (useful in a cube texture).
  28765. */
  28766. invertZ: boolean;
  28767. /**
  28768. * Are mip maps generated for this texture or not.
  28769. */
  28770. readonly noMipmap: boolean;
  28771. /**
  28772. * @hidden
  28773. */
  28774. lodLevelInAlpha: boolean;
  28775. /**
  28776. * With prefiltered texture, defined the offset used during the prefiltering steps.
  28777. */
  28778. lodGenerationOffset: number;
  28779. /**
  28780. * With prefiltered texture, defined the scale used during the prefiltering steps.
  28781. */
  28782. lodGenerationScale: number;
  28783. /**
  28784. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  28785. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  28786. * average roughness values.
  28787. */
  28788. linearSpecularLOD: boolean;
  28789. /**
  28790. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  28791. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  28792. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  28793. */
  28794. irradianceTexture: Nullable<BaseTexture>;
  28795. /**
  28796. * Define if the texture is a render target.
  28797. */
  28798. isRenderTarget: boolean;
  28799. /**
  28800. * Define the unique id of the texture in the scene.
  28801. */
  28802. readonly uid: string;
  28803. /**
  28804. * Return a string representation of the texture.
  28805. * @returns the texture as a string
  28806. */
  28807. toString(): string;
  28808. /**
  28809. * Get the class name of the texture.
  28810. * @returns "BaseTexture"
  28811. */
  28812. getClassName(): string;
  28813. /**
  28814. * Define the list of animation attached to the texture.
  28815. */
  28816. animations: import("babylonjs/Animations/animation").Animation[];
  28817. /**
  28818. * An event triggered when the texture is disposed.
  28819. */
  28820. onDisposeObservable: Observable<BaseTexture>;
  28821. private _onDisposeObserver;
  28822. /**
  28823. * Callback triggered when the texture has been disposed.
  28824. * Kept for back compatibility, you can use the onDisposeObservable instead.
  28825. */
  28826. onDispose: () => void;
  28827. /**
  28828. * Define the current state of the loading sequence when in delayed load mode.
  28829. */
  28830. delayLoadState: number;
  28831. private _scene;
  28832. /** @hidden */
  28833. _texture: Nullable<InternalTexture>;
  28834. private _uid;
  28835. /**
  28836. * Define if the texture is preventinga material to render or not.
  28837. * If not and the texture is not ready, the engine will use a default black texture instead.
  28838. */
  28839. readonly isBlocking: boolean;
  28840. /**
  28841. * Instantiates a new BaseTexture.
  28842. * Base class of all the textures in babylon.
  28843. * It groups all the common properties the materials, post process, lights... might need
  28844. * in order to make a correct use of the texture.
  28845. * @param scene Define the scene the texture blongs to
  28846. */
  28847. constructor(scene: Nullable<Scene>);
  28848. /**
  28849. * Get the scene the texture belongs to.
  28850. * @returns the scene or null if undefined
  28851. */
  28852. getScene(): Nullable<Scene>;
  28853. /**
  28854. * Get the texture transform matrix used to offset tile the texture for istance.
  28855. * @returns the transformation matrix
  28856. */
  28857. getTextureMatrix(): Matrix;
  28858. /**
  28859. * Get the texture reflection matrix used to rotate/transform the reflection.
  28860. * @returns the reflection matrix
  28861. */
  28862. getReflectionTextureMatrix(): Matrix;
  28863. /**
  28864. * Get the underlying lower level texture from Babylon.
  28865. * @returns the insternal texture
  28866. */
  28867. getInternalTexture(): Nullable<InternalTexture>;
  28868. /**
  28869. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  28870. * @returns true if ready or not blocking
  28871. */
  28872. isReadyOrNotBlocking(): boolean;
  28873. /**
  28874. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  28875. * @returns true if fully ready
  28876. */
  28877. isReady(): boolean;
  28878. private _cachedSize;
  28879. /**
  28880. * Get the size of the texture.
  28881. * @returns the texture size.
  28882. */
  28883. getSize(): ISize;
  28884. /**
  28885. * Get the base size of the texture.
  28886. * It can be different from the size if the texture has been resized for POT for instance
  28887. * @returns the base size
  28888. */
  28889. getBaseSize(): ISize;
  28890. /**
  28891. * Update the sampling mode of the texture.
  28892. * Default is Trilinear mode.
  28893. *
  28894. * | Value | Type | Description |
  28895. * | ----- | ------------------ | ----------- |
  28896. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  28897. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  28898. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  28899. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  28900. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  28901. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  28902. * | 7 | NEAREST_LINEAR | |
  28903. * | 8 | NEAREST_NEAREST | |
  28904. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  28905. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  28906. * | 11 | LINEAR_LINEAR | |
  28907. * | 12 | LINEAR_NEAREST | |
  28908. *
  28909. * > _mag_: magnification filter (close to the viewer)
  28910. * > _min_: minification filter (far from the viewer)
  28911. * > _mip_: filter used between mip map levels
  28912. *@param samplingMode Define the new sampling mode of the texture
  28913. */
  28914. updateSamplingMode(samplingMode: number): void;
  28915. /**
  28916. * Scales the texture if is `canRescale()`
  28917. * @param ratio the resize factor we want to use to rescale
  28918. */
  28919. scale(ratio: number): void;
  28920. /**
  28921. * Get if the texture can rescale.
  28922. */
  28923. readonly canRescale: boolean;
  28924. /** @hidden */
  28925. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  28926. /** @hidden */
  28927. _rebuild(): void;
  28928. /**
  28929. * Triggers the load sequence in delayed load mode.
  28930. */
  28931. delayLoad(): void;
  28932. /**
  28933. * Clones the texture.
  28934. * @returns the cloned texture
  28935. */
  28936. clone(): Nullable<BaseTexture>;
  28937. /**
  28938. * Get the texture underlying type (INT, FLOAT...)
  28939. */
  28940. readonly textureType: number;
  28941. /**
  28942. * Get the texture underlying format (RGB, RGBA...)
  28943. */
  28944. readonly textureFormat: number;
  28945. /**
  28946. * Indicates that textures need to be re-calculated for all materials
  28947. */
  28948. protected _markAllSubMeshesAsTexturesDirty(): void;
  28949. /**
  28950. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  28951. * This will returns an RGBA array buffer containing either in values (0-255) or
  28952. * float values (0-1) depending of the underlying buffer type.
  28953. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  28954. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  28955. * @param buffer defines a user defined buffer to fill with data (can be null)
  28956. * @returns The Array buffer containing the pixels data.
  28957. */
  28958. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  28959. /**
  28960. * Release and destroy the underlying lower level texture aka internalTexture.
  28961. */
  28962. releaseInternalTexture(): void;
  28963. /** @hidden */
  28964. readonly _lodTextureHigh: Nullable<BaseTexture>;
  28965. /** @hidden */
  28966. readonly _lodTextureMid: Nullable<BaseTexture>;
  28967. /** @hidden */
  28968. readonly _lodTextureLow: Nullable<BaseTexture>;
  28969. /**
  28970. * Dispose the texture and release its associated resources.
  28971. */
  28972. dispose(): void;
  28973. /**
  28974. * Serialize the texture into a JSON representation that can be parsed later on.
  28975. * @returns the JSON representation of the texture
  28976. */
  28977. serialize(): any;
  28978. /**
  28979. * Helper function to be called back once a list of texture contains only ready textures.
  28980. * @param textures Define the list of textures to wait for
  28981. * @param callback Define the callback triggered once the entire list will be ready
  28982. */
  28983. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  28984. }
  28985. }
  28986. declare module "babylonjs/Materials/effect" {
  28987. import { Observable } from "babylonjs/Misc/observable";
  28988. import { Nullable } from "babylonjs/types";
  28989. import { IDisposable } from "babylonjs/scene";
  28990. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  28991. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  28992. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  28993. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  28994. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  28995. import { Engine } from "babylonjs/Engines/engine";
  28996. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28997. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  28998. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  28999. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  29000. /**
  29001. * Options to be used when creating an effect.
  29002. */
  29003. export interface IEffectCreationOptions {
  29004. /**
  29005. * Atrributes that will be used in the shader.
  29006. */
  29007. attributes: string[];
  29008. /**
  29009. * Uniform varible names that will be set in the shader.
  29010. */
  29011. uniformsNames: string[];
  29012. /**
  29013. * Uniform buffer varible names that will be set in the shader.
  29014. */
  29015. uniformBuffersNames: string[];
  29016. /**
  29017. * Sampler texture variable names that will be set in the shader.
  29018. */
  29019. samplers: string[];
  29020. /**
  29021. * Define statements that will be set in the shader.
  29022. */
  29023. defines: any;
  29024. /**
  29025. * Possible fallbacks for this effect to improve performance when needed.
  29026. */
  29027. fallbacks: Nullable<IEffectFallbacks>;
  29028. /**
  29029. * Callback that will be called when the shader is compiled.
  29030. */
  29031. onCompiled: Nullable<(effect: Effect) => void>;
  29032. /**
  29033. * Callback that will be called if an error occurs during shader compilation.
  29034. */
  29035. onError: Nullable<(effect: Effect, errors: string) => void>;
  29036. /**
  29037. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29038. */
  29039. indexParameters?: any;
  29040. /**
  29041. * Max number of lights that can be used in the shader.
  29042. */
  29043. maxSimultaneousLights?: number;
  29044. /**
  29045. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  29046. */
  29047. transformFeedbackVaryings?: Nullable<string[]>;
  29048. }
  29049. /**
  29050. * Effect containing vertex and fragment shader that can be executed on an object.
  29051. */
  29052. export class Effect implements IDisposable {
  29053. /**
  29054. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  29055. */
  29056. static ShadersRepository: string;
  29057. /**
  29058. * Name of the effect.
  29059. */
  29060. name: any;
  29061. /**
  29062. * String container all the define statements that should be set on the shader.
  29063. */
  29064. defines: string;
  29065. /**
  29066. * Callback that will be called when the shader is compiled.
  29067. */
  29068. onCompiled: Nullable<(effect: Effect) => void>;
  29069. /**
  29070. * Callback that will be called if an error occurs during shader compilation.
  29071. */
  29072. onError: Nullable<(effect: Effect, errors: string) => void>;
  29073. /**
  29074. * Callback that will be called when effect is bound.
  29075. */
  29076. onBind: Nullable<(effect: Effect) => void>;
  29077. /**
  29078. * Unique ID of the effect.
  29079. */
  29080. uniqueId: number;
  29081. /**
  29082. * Observable that will be called when the shader is compiled.
  29083. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  29084. */
  29085. onCompileObservable: Observable<Effect>;
  29086. /**
  29087. * Observable that will be called if an error occurs during shader compilation.
  29088. */
  29089. onErrorObservable: Observable<Effect>;
  29090. /** @hidden */
  29091. _onBindObservable: Nullable<Observable<Effect>>;
  29092. /**
  29093. * Observable that will be called when effect is bound.
  29094. */
  29095. readonly onBindObservable: Observable<Effect>;
  29096. /** @hidden */
  29097. _bonesComputationForcedToCPU: boolean;
  29098. private static _uniqueIdSeed;
  29099. private _engine;
  29100. private _uniformBuffersNames;
  29101. private _uniformsNames;
  29102. private _samplerList;
  29103. private _samplers;
  29104. private _isReady;
  29105. private _compilationError;
  29106. private _allFallbacksProcessed;
  29107. private _attributesNames;
  29108. private _attributes;
  29109. private _uniforms;
  29110. /**
  29111. * Key for the effect.
  29112. * @hidden
  29113. */
  29114. _key: string;
  29115. private _indexParameters;
  29116. private _fallbacks;
  29117. private _vertexSourceCode;
  29118. private _fragmentSourceCode;
  29119. private _vertexSourceCodeOverride;
  29120. private _fragmentSourceCodeOverride;
  29121. private _transformFeedbackVaryings;
  29122. /**
  29123. * Compiled shader to webGL program.
  29124. * @hidden
  29125. */
  29126. _pipelineContext: Nullable<IPipelineContext>;
  29127. private _valueCache;
  29128. private static _baseCache;
  29129. /**
  29130. * Instantiates an effect.
  29131. * An effect can be used to create/manage/execute vertex and fragment shaders.
  29132. * @param baseName Name of the effect.
  29133. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  29134. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  29135. * @param samplers List of sampler variables that will be passed to the shader.
  29136. * @param engine Engine to be used to render the effect
  29137. * @param defines Define statements to be added to the shader.
  29138. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  29139. * @param onCompiled Callback that will be called when the shader is compiled.
  29140. * @param onError Callback that will be called if an error occurs during shader compilation.
  29141. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29142. */
  29143. 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);
  29144. private _useFinalCode;
  29145. /**
  29146. * Unique key for this effect
  29147. */
  29148. readonly key: string;
  29149. /**
  29150. * If the effect has been compiled and prepared.
  29151. * @returns if the effect is compiled and prepared.
  29152. */
  29153. isReady(): boolean;
  29154. private _isReadyInternal;
  29155. /**
  29156. * The engine the effect was initialized with.
  29157. * @returns the engine.
  29158. */
  29159. getEngine(): Engine;
  29160. /**
  29161. * The pipeline context for this effect
  29162. * @returns the associated pipeline context
  29163. */
  29164. getPipelineContext(): Nullable<IPipelineContext>;
  29165. /**
  29166. * The set of names of attribute variables for the shader.
  29167. * @returns An array of attribute names.
  29168. */
  29169. getAttributesNames(): string[];
  29170. /**
  29171. * Returns the attribute at the given index.
  29172. * @param index The index of the attribute.
  29173. * @returns The location of the attribute.
  29174. */
  29175. getAttributeLocation(index: number): number;
  29176. /**
  29177. * Returns the attribute based on the name of the variable.
  29178. * @param name of the attribute to look up.
  29179. * @returns the attribute location.
  29180. */
  29181. getAttributeLocationByName(name: string): number;
  29182. /**
  29183. * The number of attributes.
  29184. * @returns the numnber of attributes.
  29185. */
  29186. getAttributesCount(): number;
  29187. /**
  29188. * Gets the index of a uniform variable.
  29189. * @param uniformName of the uniform to look up.
  29190. * @returns the index.
  29191. */
  29192. getUniformIndex(uniformName: string): number;
  29193. /**
  29194. * Returns the attribute based on the name of the variable.
  29195. * @param uniformName of the uniform to look up.
  29196. * @returns the location of the uniform.
  29197. */
  29198. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  29199. /**
  29200. * Returns an array of sampler variable names
  29201. * @returns The array of sampler variable neames.
  29202. */
  29203. getSamplers(): string[];
  29204. /**
  29205. * The error from the last compilation.
  29206. * @returns the error string.
  29207. */
  29208. getCompilationError(): string;
  29209. /**
  29210. * Gets a boolean indicating that all fallbacks were used during compilation
  29211. * @returns true if all fallbacks were used
  29212. */
  29213. allFallbacksProcessed(): boolean;
  29214. /**
  29215. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  29216. * @param func The callback to be used.
  29217. */
  29218. executeWhenCompiled(func: (effect: Effect) => void): void;
  29219. private _checkIsReady;
  29220. private _loadShader;
  29221. /**
  29222. * Recompiles the webGL program
  29223. * @param vertexSourceCode The source code for the vertex shader.
  29224. * @param fragmentSourceCode The source code for the fragment shader.
  29225. * @param onCompiled Callback called when completed.
  29226. * @param onError Callback called on error.
  29227. * @hidden
  29228. */
  29229. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  29230. /**
  29231. * Prepares the effect
  29232. * @hidden
  29233. */
  29234. _prepareEffect(): void;
  29235. private _processCompilationErrors;
  29236. /**
  29237. * Checks if the effect is supported. (Must be called after compilation)
  29238. */
  29239. readonly isSupported: boolean;
  29240. /**
  29241. * Binds a texture to the engine to be used as output of the shader.
  29242. * @param channel Name of the output variable.
  29243. * @param texture Texture to bind.
  29244. * @hidden
  29245. */
  29246. _bindTexture(channel: string, texture: InternalTexture): void;
  29247. /**
  29248. * Sets a texture on the engine to be used in the shader.
  29249. * @param channel Name of the sampler variable.
  29250. * @param texture Texture to set.
  29251. */
  29252. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  29253. /**
  29254. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  29255. * @param channel Name of the sampler variable.
  29256. * @param texture Texture to set.
  29257. */
  29258. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  29259. /**
  29260. * Sets an array of textures on the engine to be used in the shader.
  29261. * @param channel Name of the variable.
  29262. * @param textures Textures to set.
  29263. */
  29264. setTextureArray(channel: string, textures: BaseTexture[]): void;
  29265. /**
  29266. * 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)
  29267. * @param channel Name of the sampler variable.
  29268. * @param postProcess Post process to get the input texture from.
  29269. */
  29270. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  29271. /**
  29272. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  29273. * 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)
  29274. * @param channel Name of the sampler variable.
  29275. * @param postProcess Post process to get the output texture from.
  29276. */
  29277. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  29278. /** @hidden */
  29279. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  29280. /** @hidden */
  29281. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  29282. /** @hidden */
  29283. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  29284. /** @hidden */
  29285. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  29286. /**
  29287. * Binds a buffer to a uniform.
  29288. * @param buffer Buffer to bind.
  29289. * @param name Name of the uniform variable to bind to.
  29290. */
  29291. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  29292. /**
  29293. * Binds block to a uniform.
  29294. * @param blockName Name of the block to bind.
  29295. * @param index Index to bind.
  29296. */
  29297. bindUniformBlock(blockName: string, index: number): void;
  29298. /**
  29299. * Sets an interger value on a uniform variable.
  29300. * @param uniformName Name of the variable.
  29301. * @param value Value to be set.
  29302. * @returns this effect.
  29303. */
  29304. setInt(uniformName: string, value: number): Effect;
  29305. /**
  29306. * Sets an int array on a uniform variable.
  29307. * @param uniformName Name of the variable.
  29308. * @param array array to be set.
  29309. * @returns this effect.
  29310. */
  29311. setIntArray(uniformName: string, array: Int32Array): Effect;
  29312. /**
  29313. * 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)
  29314. * @param uniformName Name of the variable.
  29315. * @param array array to be set.
  29316. * @returns this effect.
  29317. */
  29318. setIntArray2(uniformName: string, array: Int32Array): Effect;
  29319. /**
  29320. * 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)
  29321. * @param uniformName Name of the variable.
  29322. * @param array array to be set.
  29323. * @returns this effect.
  29324. */
  29325. setIntArray3(uniformName: string, array: Int32Array): Effect;
  29326. /**
  29327. * 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)
  29328. * @param uniformName Name of the variable.
  29329. * @param array array to be set.
  29330. * @returns this effect.
  29331. */
  29332. setIntArray4(uniformName: string, array: Int32Array): Effect;
  29333. /**
  29334. * Sets an float array on a uniform variable.
  29335. * @param uniformName Name of the variable.
  29336. * @param array array to be set.
  29337. * @returns this effect.
  29338. */
  29339. setFloatArray(uniformName: string, array: Float32Array): Effect;
  29340. /**
  29341. * 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)
  29342. * @param uniformName Name of the variable.
  29343. * @param array array to be set.
  29344. * @returns this effect.
  29345. */
  29346. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  29347. /**
  29348. * 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)
  29349. * @param uniformName Name of the variable.
  29350. * @param array array to be set.
  29351. * @returns this effect.
  29352. */
  29353. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  29354. /**
  29355. * 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)
  29356. * @param uniformName Name of the variable.
  29357. * @param array array to be set.
  29358. * @returns this effect.
  29359. */
  29360. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  29361. /**
  29362. * Sets an array on a uniform variable.
  29363. * @param uniformName Name of the variable.
  29364. * @param array array to be set.
  29365. * @returns this effect.
  29366. */
  29367. setArray(uniformName: string, array: number[]): Effect;
  29368. /**
  29369. * 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)
  29370. * @param uniformName Name of the variable.
  29371. * @param array array to be set.
  29372. * @returns this effect.
  29373. */
  29374. setArray2(uniformName: string, array: number[]): Effect;
  29375. /**
  29376. * 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)
  29377. * @param uniformName Name of the variable.
  29378. * @param array array to be set.
  29379. * @returns this effect.
  29380. */
  29381. setArray3(uniformName: string, array: number[]): Effect;
  29382. /**
  29383. * 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)
  29384. * @param uniformName Name of the variable.
  29385. * @param array array to be set.
  29386. * @returns this effect.
  29387. */
  29388. setArray4(uniformName: string, array: number[]): Effect;
  29389. /**
  29390. * Sets matrices on a uniform variable.
  29391. * @param uniformName Name of the variable.
  29392. * @param matrices matrices to be set.
  29393. * @returns this effect.
  29394. */
  29395. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  29396. /**
  29397. * Sets matrix on a uniform variable.
  29398. * @param uniformName Name of the variable.
  29399. * @param matrix matrix to be set.
  29400. * @returns this effect.
  29401. */
  29402. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  29403. /**
  29404. * 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)
  29405. * @param uniformName Name of the variable.
  29406. * @param matrix matrix to be set.
  29407. * @returns this effect.
  29408. */
  29409. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  29410. /**
  29411. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  29412. * @param uniformName Name of the variable.
  29413. * @param matrix matrix to be set.
  29414. * @returns this effect.
  29415. */
  29416. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  29417. /**
  29418. * Sets a float on a uniform variable.
  29419. * @param uniformName Name of the variable.
  29420. * @param value value to be set.
  29421. * @returns this effect.
  29422. */
  29423. setFloat(uniformName: string, value: number): Effect;
  29424. /**
  29425. * Sets a boolean on a uniform variable.
  29426. * @param uniformName Name of the variable.
  29427. * @param bool value to be set.
  29428. * @returns this effect.
  29429. */
  29430. setBool(uniformName: string, bool: boolean): Effect;
  29431. /**
  29432. * Sets a Vector2 on a uniform variable.
  29433. * @param uniformName Name of the variable.
  29434. * @param vector2 vector2 to be set.
  29435. * @returns this effect.
  29436. */
  29437. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  29438. /**
  29439. * Sets a float2 on a uniform variable.
  29440. * @param uniformName Name of the variable.
  29441. * @param x First float in float2.
  29442. * @param y Second float in float2.
  29443. * @returns this effect.
  29444. */
  29445. setFloat2(uniformName: string, x: number, y: number): Effect;
  29446. /**
  29447. * Sets a Vector3 on a uniform variable.
  29448. * @param uniformName Name of the variable.
  29449. * @param vector3 Value to be set.
  29450. * @returns this effect.
  29451. */
  29452. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  29453. /**
  29454. * Sets a float3 on a uniform variable.
  29455. * @param uniformName Name of the variable.
  29456. * @param x First float in float3.
  29457. * @param y Second float in float3.
  29458. * @param z Third float in float3.
  29459. * @returns this effect.
  29460. */
  29461. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  29462. /**
  29463. * Sets a Vector4 on a uniform variable.
  29464. * @param uniformName Name of the variable.
  29465. * @param vector4 Value to be set.
  29466. * @returns this effect.
  29467. */
  29468. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  29469. /**
  29470. * Sets a float4 on a uniform variable.
  29471. * @param uniformName Name of the variable.
  29472. * @param x First float in float4.
  29473. * @param y Second float in float4.
  29474. * @param z Third float in float4.
  29475. * @param w Fourth float in float4.
  29476. * @returns this effect.
  29477. */
  29478. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  29479. /**
  29480. * Sets a Color3 on a uniform variable.
  29481. * @param uniformName Name of the variable.
  29482. * @param color3 Value to be set.
  29483. * @returns this effect.
  29484. */
  29485. setColor3(uniformName: string, color3: IColor3Like): Effect;
  29486. /**
  29487. * Sets a Color4 on a uniform variable.
  29488. * @param uniformName Name of the variable.
  29489. * @param color3 Value to be set.
  29490. * @param alpha Alpha value to be set.
  29491. * @returns this effect.
  29492. */
  29493. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  29494. /**
  29495. * Sets a Color4 on a uniform variable
  29496. * @param uniformName defines the name of the variable
  29497. * @param color4 defines the value to be set
  29498. * @returns this effect.
  29499. */
  29500. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  29501. /** Release all associated resources */
  29502. dispose(): void;
  29503. /**
  29504. * This function will add a new shader to the shader store
  29505. * @param name the name of the shader
  29506. * @param pixelShader optional pixel shader content
  29507. * @param vertexShader optional vertex shader content
  29508. */
  29509. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  29510. /**
  29511. * Store of each shader (The can be looked up using effect.key)
  29512. */
  29513. static ShadersStore: {
  29514. [key: string]: string;
  29515. };
  29516. /**
  29517. * Store of each included file for a shader (The can be looked up using effect.key)
  29518. */
  29519. static IncludesShadersStore: {
  29520. [key: string]: string;
  29521. };
  29522. /**
  29523. * Resets the cache of effects.
  29524. */
  29525. static ResetCache(): void;
  29526. }
  29527. }
  29528. declare module "babylonjs/Engines/engineCapabilities" {
  29529. /**
  29530. * Interface used to describe the capabilities of the engine relatively to the current browser
  29531. */
  29532. export interface EngineCapabilities {
  29533. /** Maximum textures units per fragment shader */
  29534. maxTexturesImageUnits: number;
  29535. /** Maximum texture units per vertex shader */
  29536. maxVertexTextureImageUnits: number;
  29537. /** Maximum textures units in the entire pipeline */
  29538. maxCombinedTexturesImageUnits: number;
  29539. /** Maximum texture size */
  29540. maxTextureSize: number;
  29541. /** Maximum cube texture size */
  29542. maxCubemapTextureSize: number;
  29543. /** Maximum render texture size */
  29544. maxRenderTextureSize: number;
  29545. /** Maximum number of vertex attributes */
  29546. maxVertexAttribs: number;
  29547. /** Maximum number of varyings */
  29548. maxVaryingVectors: number;
  29549. /** Maximum number of uniforms per vertex shader */
  29550. maxVertexUniformVectors: number;
  29551. /** Maximum number of uniforms per fragment shader */
  29552. maxFragmentUniformVectors: number;
  29553. /** Defines if standard derivates (dx/dy) are supported */
  29554. standardDerivatives: boolean;
  29555. /** Defines if s3tc texture compression is supported */
  29556. s3tc?: WEBGL_compressed_texture_s3tc;
  29557. /** Defines if pvrtc texture compression is supported */
  29558. pvrtc: any;
  29559. /** Defines if etc1 texture compression is supported */
  29560. etc1: any;
  29561. /** Defines if etc2 texture compression is supported */
  29562. etc2: any;
  29563. /** Defines if astc texture compression is supported */
  29564. astc: any;
  29565. /** Defines if float textures are supported */
  29566. textureFloat: boolean;
  29567. /** Defines if vertex array objects are supported */
  29568. vertexArrayObject: boolean;
  29569. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  29570. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  29571. /** Gets the maximum level of anisotropy supported */
  29572. maxAnisotropy: number;
  29573. /** Defines if instancing is supported */
  29574. instancedArrays: boolean;
  29575. /** Defines if 32 bits indices are supported */
  29576. uintIndices: boolean;
  29577. /** Defines if high precision shaders are supported */
  29578. highPrecisionShaderSupported: boolean;
  29579. /** Defines if depth reading in the fragment shader is supported */
  29580. fragmentDepthSupported: boolean;
  29581. /** Defines if float texture linear filtering is supported*/
  29582. textureFloatLinearFiltering: boolean;
  29583. /** Defines if rendering to float textures is supported */
  29584. textureFloatRender: boolean;
  29585. /** Defines if half float textures are supported*/
  29586. textureHalfFloat: boolean;
  29587. /** Defines if half float texture linear filtering is supported*/
  29588. textureHalfFloatLinearFiltering: boolean;
  29589. /** Defines if rendering to half float textures is supported */
  29590. textureHalfFloatRender: boolean;
  29591. /** Defines if textureLOD shader command is supported */
  29592. textureLOD: boolean;
  29593. /** Defines if draw buffers extension is supported */
  29594. drawBuffersExtension: boolean;
  29595. /** Defines if depth textures are supported */
  29596. depthTextureExtension: boolean;
  29597. /** Defines if float color buffer are supported */
  29598. colorBufferFloat: boolean;
  29599. /** Gets disjoint timer query extension (null if not supported) */
  29600. timerQuery?: EXT_disjoint_timer_query;
  29601. /** Defines if timestamp can be used with timer query */
  29602. canUseTimestampForTimerQuery: boolean;
  29603. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  29604. multiview?: any;
  29605. /** Function used to let the system compiles shaders in background */
  29606. parallelShaderCompile?: {
  29607. COMPLETION_STATUS_KHR: number;
  29608. };
  29609. /** Max number of texture samples for MSAA */
  29610. maxMSAASamples: number;
  29611. /** Defines if the blend min max extension is supported */
  29612. blendMinMax: boolean;
  29613. }
  29614. }
  29615. declare module "babylonjs/States/depthCullingState" {
  29616. import { Nullable } from "babylonjs/types";
  29617. /**
  29618. * @hidden
  29619. **/
  29620. export class DepthCullingState {
  29621. private _isDepthTestDirty;
  29622. private _isDepthMaskDirty;
  29623. private _isDepthFuncDirty;
  29624. private _isCullFaceDirty;
  29625. private _isCullDirty;
  29626. private _isZOffsetDirty;
  29627. private _isFrontFaceDirty;
  29628. private _depthTest;
  29629. private _depthMask;
  29630. private _depthFunc;
  29631. private _cull;
  29632. private _cullFace;
  29633. private _zOffset;
  29634. private _frontFace;
  29635. /**
  29636. * Initializes the state.
  29637. */
  29638. constructor();
  29639. readonly isDirty: boolean;
  29640. zOffset: number;
  29641. cullFace: Nullable<number>;
  29642. cull: Nullable<boolean>;
  29643. depthFunc: Nullable<number>;
  29644. depthMask: boolean;
  29645. depthTest: boolean;
  29646. frontFace: Nullable<number>;
  29647. reset(): void;
  29648. apply(gl: WebGLRenderingContext): void;
  29649. }
  29650. }
  29651. declare module "babylonjs/States/stencilState" {
  29652. /**
  29653. * @hidden
  29654. **/
  29655. export class StencilState {
  29656. /** 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 */
  29657. static readonly ALWAYS: number;
  29658. /** Passed to stencilOperation to specify that stencil value must be kept */
  29659. static readonly KEEP: number;
  29660. /** Passed to stencilOperation to specify that stencil value must be replaced */
  29661. static readonly REPLACE: number;
  29662. private _isStencilTestDirty;
  29663. private _isStencilMaskDirty;
  29664. private _isStencilFuncDirty;
  29665. private _isStencilOpDirty;
  29666. private _stencilTest;
  29667. private _stencilMask;
  29668. private _stencilFunc;
  29669. private _stencilFuncRef;
  29670. private _stencilFuncMask;
  29671. private _stencilOpStencilFail;
  29672. private _stencilOpDepthFail;
  29673. private _stencilOpStencilDepthPass;
  29674. readonly isDirty: boolean;
  29675. stencilFunc: number;
  29676. stencilFuncRef: number;
  29677. stencilFuncMask: number;
  29678. stencilOpStencilFail: number;
  29679. stencilOpDepthFail: number;
  29680. stencilOpStencilDepthPass: number;
  29681. stencilMask: number;
  29682. stencilTest: boolean;
  29683. constructor();
  29684. reset(): void;
  29685. apply(gl: WebGLRenderingContext): void;
  29686. }
  29687. }
  29688. declare module "babylonjs/States/alphaCullingState" {
  29689. /**
  29690. * @hidden
  29691. **/
  29692. export class AlphaState {
  29693. private _isAlphaBlendDirty;
  29694. private _isBlendFunctionParametersDirty;
  29695. private _isBlendEquationParametersDirty;
  29696. private _isBlendConstantsDirty;
  29697. private _alphaBlend;
  29698. private _blendFunctionParameters;
  29699. private _blendEquationParameters;
  29700. private _blendConstants;
  29701. /**
  29702. * Initializes the state.
  29703. */
  29704. constructor();
  29705. readonly isDirty: boolean;
  29706. alphaBlend: boolean;
  29707. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  29708. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  29709. setAlphaEquationParameters(rgb: number, alpha: number): void;
  29710. reset(): void;
  29711. apply(gl: WebGLRenderingContext): void;
  29712. }
  29713. }
  29714. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  29715. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  29716. /** @hidden */
  29717. export class WebGL2ShaderProcessor implements IShaderProcessor {
  29718. attributeProcessor(attribute: string): string;
  29719. varyingProcessor(varying: string, isFragment: boolean): string;
  29720. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  29721. }
  29722. }
  29723. declare module "babylonjs/Engines/instancingAttributeInfo" {
  29724. /**
  29725. * Interface for attribute information associated with buffer instanciation
  29726. */
  29727. export interface InstancingAttributeInfo {
  29728. /**
  29729. * Index/offset of the attribute in the vertex shader
  29730. */
  29731. index: number;
  29732. /**
  29733. * size of the attribute, 1, 2, 3 or 4
  29734. */
  29735. attributeSize: number;
  29736. /**
  29737. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  29738. * default is FLOAT
  29739. */
  29740. attributeType: number;
  29741. /**
  29742. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  29743. */
  29744. normalized: boolean;
  29745. /**
  29746. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  29747. */
  29748. offset: number;
  29749. /**
  29750. * Name of the GLSL attribute, for debugging purpose only
  29751. */
  29752. attributeName: string;
  29753. }
  29754. }
  29755. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  29756. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  29757. import { Nullable } from "babylonjs/types";
  29758. module "babylonjs/Engines/thinEngine" {
  29759. interface ThinEngine {
  29760. /**
  29761. * Update a video texture
  29762. * @param texture defines the texture to update
  29763. * @param video defines the video element to use
  29764. * @param invertY defines if data must be stored with Y axis inverted
  29765. */
  29766. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  29767. }
  29768. }
  29769. }
  29770. declare module "babylonjs/Materials/Textures/videoTexture" {
  29771. import { Observable } from "babylonjs/Misc/observable";
  29772. import { Nullable } from "babylonjs/types";
  29773. import { Scene } from "babylonjs/scene";
  29774. import { Texture } from "babylonjs/Materials/Textures/texture";
  29775. import "babylonjs/Engines/Extensions/engine.videoTexture";
  29776. /**
  29777. * Settings for finer control over video usage
  29778. */
  29779. export interface VideoTextureSettings {
  29780. /**
  29781. * Applies `autoplay` to video, if specified
  29782. */
  29783. autoPlay?: boolean;
  29784. /**
  29785. * Applies `loop` to video, if specified
  29786. */
  29787. loop?: boolean;
  29788. /**
  29789. * Automatically updates internal texture from video at every frame in the render loop
  29790. */
  29791. autoUpdateTexture: boolean;
  29792. /**
  29793. * Image src displayed during the video loading or until the user interacts with the video.
  29794. */
  29795. poster?: string;
  29796. }
  29797. /**
  29798. * If you want to display a video in your scene, this is the special texture for that.
  29799. * This special texture works similar to other textures, with the exception of a few parameters.
  29800. * @see https://doc.babylonjs.com/how_to/video_texture
  29801. */
  29802. export class VideoTexture extends Texture {
  29803. /**
  29804. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  29805. */
  29806. readonly autoUpdateTexture: boolean;
  29807. /**
  29808. * The video instance used by the texture internally
  29809. */
  29810. readonly video: HTMLVideoElement;
  29811. private _onUserActionRequestedObservable;
  29812. /**
  29813. * Event triggerd when a dom action is required by the user to play the video.
  29814. * This happens due to recent changes in browser policies preventing video to auto start.
  29815. */
  29816. readonly onUserActionRequestedObservable: Observable<Texture>;
  29817. private _generateMipMaps;
  29818. private _engine;
  29819. private _stillImageCaptured;
  29820. private _displayingPosterTexture;
  29821. private _settings;
  29822. private _createInternalTextureOnEvent;
  29823. private _frameId;
  29824. /**
  29825. * Creates a video texture.
  29826. * If you want to display a video in your scene, this is the special texture for that.
  29827. * This special texture works similar to other textures, with the exception of a few parameters.
  29828. * @see https://doc.babylonjs.com/how_to/video_texture
  29829. * @param name optional name, will detect from video source, if not defined
  29830. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  29831. * @param scene is obviously the current scene.
  29832. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  29833. * @param invertY is false by default but can be used to invert video on Y axis
  29834. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  29835. * @param settings allows finer control over video usage
  29836. */
  29837. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  29838. private _getName;
  29839. private _getVideo;
  29840. private _createInternalTexture;
  29841. private reset;
  29842. /**
  29843. * @hidden Internal method to initiate `update`.
  29844. */
  29845. _rebuild(): void;
  29846. /**
  29847. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  29848. */
  29849. update(): void;
  29850. /**
  29851. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  29852. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  29853. */
  29854. updateTexture(isVisible: boolean): void;
  29855. protected _updateInternalTexture: () => void;
  29856. /**
  29857. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  29858. * @param url New url.
  29859. */
  29860. updateURL(url: string): void;
  29861. /**
  29862. * Dispose the texture and release its associated resources.
  29863. */
  29864. dispose(): void;
  29865. /**
  29866. * Creates a video texture straight from a stream.
  29867. * @param scene Define the scene the texture should be created in
  29868. * @param stream Define the stream the texture should be created from
  29869. * @returns The created video texture as a promise
  29870. */
  29871. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  29872. /**
  29873. * Creates a video texture straight from your WebCam video feed.
  29874. * @param scene Define the scene the texture should be created in
  29875. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  29876. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  29877. * @returns The created video texture as a promise
  29878. */
  29879. static CreateFromWebCamAsync(scene: Scene, constraints: {
  29880. minWidth: number;
  29881. maxWidth: number;
  29882. minHeight: number;
  29883. maxHeight: number;
  29884. deviceId: string;
  29885. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  29886. /**
  29887. * Creates a video texture straight from your WebCam video feed.
  29888. * @param scene Define the scene the texture should be created in
  29889. * @param onReady Define a callback to triggered once the texture will be ready
  29890. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  29891. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  29892. */
  29893. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  29894. minWidth: number;
  29895. maxWidth: number;
  29896. minHeight: number;
  29897. maxHeight: number;
  29898. deviceId: string;
  29899. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  29900. }
  29901. }
  29902. declare module "babylonjs/Engines/thinEngine" {
  29903. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  29904. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  29905. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  29906. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  29907. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  29908. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  29909. import { Observable } from "babylonjs/Misc/observable";
  29910. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  29911. import { StencilState } from "babylonjs/States/stencilState";
  29912. import { AlphaState } from "babylonjs/States/alphaCullingState";
  29913. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  29914. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  29915. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  29916. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  29917. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  29918. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  29919. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29920. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  29921. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  29922. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  29923. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  29924. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  29925. /**
  29926. * Defines the interface used by objects working like Scene
  29927. * @hidden
  29928. */
  29929. interface ISceneLike {
  29930. _addPendingData(data: any): void;
  29931. _removePendingData(data: any): void;
  29932. offlineProvider: IOfflineProvider;
  29933. }
  29934. /** Interface defining initialization parameters for Engine class */
  29935. export interface EngineOptions extends WebGLContextAttributes {
  29936. /**
  29937. * Defines if the engine should no exceed a specified device ratio
  29938. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  29939. */
  29940. limitDeviceRatio?: number;
  29941. /**
  29942. * Defines if webvr should be enabled automatically
  29943. * @see http://doc.babylonjs.com/how_to/webvr_camera
  29944. */
  29945. autoEnableWebVR?: boolean;
  29946. /**
  29947. * Defines if webgl2 should be turned off even if supported
  29948. * @see http://doc.babylonjs.com/features/webgl2
  29949. */
  29950. disableWebGL2Support?: boolean;
  29951. /**
  29952. * Defines if webaudio should be initialized as well
  29953. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  29954. */
  29955. audioEngine?: boolean;
  29956. /**
  29957. * Defines if animations should run using a deterministic lock step
  29958. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  29959. */
  29960. deterministicLockstep?: boolean;
  29961. /** Defines the maximum steps to use with deterministic lock step mode */
  29962. lockstepMaxSteps?: number;
  29963. /**
  29964. * Defines that engine should ignore context lost events
  29965. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  29966. */
  29967. doNotHandleContextLost?: boolean;
  29968. /**
  29969. * Defines that engine should ignore modifying touch action attribute and style
  29970. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  29971. */
  29972. doNotHandleTouchAction?: boolean;
  29973. /**
  29974. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  29975. */
  29976. useHighPrecisionFloats?: boolean;
  29977. }
  29978. /**
  29979. * The base engine class (root of all engines)
  29980. */
  29981. export class ThinEngine {
  29982. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  29983. static ExceptionList: ({
  29984. key: string;
  29985. capture: string;
  29986. captureConstraint: number;
  29987. targets: string[];
  29988. } | {
  29989. key: string;
  29990. capture: null;
  29991. captureConstraint: null;
  29992. targets: string[];
  29993. })[];
  29994. /** @hidden */
  29995. static _TextureLoaders: IInternalTextureLoader[];
  29996. /**
  29997. * Returns the current npm package of the sdk
  29998. */
  29999. static readonly NpmPackage: string;
  30000. /**
  30001. * Returns the current version of the framework
  30002. */
  30003. static readonly Version: string;
  30004. /**
  30005. * Returns a string describing the current engine
  30006. */
  30007. readonly description: string;
  30008. /**
  30009. * Gets or sets the epsilon value used by collision engine
  30010. */
  30011. static CollisionsEpsilon: number;
  30012. /**
  30013. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  30014. */
  30015. static ShadersRepository: string;
  30016. /** @hidden */
  30017. _shaderProcessor: IShaderProcessor;
  30018. /**
  30019. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  30020. */
  30021. forcePOTTextures: boolean;
  30022. /**
  30023. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  30024. */
  30025. isFullscreen: boolean;
  30026. /**
  30027. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  30028. */
  30029. cullBackFaces: boolean;
  30030. /**
  30031. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  30032. */
  30033. renderEvenInBackground: boolean;
  30034. /**
  30035. * Gets or sets a boolean indicating that cache can be kept between frames
  30036. */
  30037. preventCacheWipeBetweenFrames: boolean;
  30038. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  30039. validateShaderPrograms: boolean;
  30040. /**
  30041. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  30042. */
  30043. disableUniformBuffers: boolean;
  30044. /** @hidden */
  30045. _uniformBuffers: UniformBuffer[];
  30046. /**
  30047. * Gets a boolean indicating that the engine supports uniform buffers
  30048. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  30049. */
  30050. readonly supportsUniformBuffers: boolean;
  30051. /** @hidden */
  30052. _gl: WebGLRenderingContext;
  30053. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  30054. protected _windowIsBackground: boolean;
  30055. protected _webGLVersion: number;
  30056. protected _creationOptions: EngineOptions;
  30057. protected _highPrecisionShadersAllowed: boolean;
  30058. /** @hidden */
  30059. readonly _shouldUseHighPrecisionShader: boolean;
  30060. /**
  30061. * Gets a boolean indicating that only power of 2 textures are supported
  30062. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  30063. */
  30064. readonly needPOTTextures: boolean;
  30065. /** @hidden */
  30066. _badOS: boolean;
  30067. /** @hidden */
  30068. _badDesktopOS: boolean;
  30069. private _hardwareScalingLevel;
  30070. /** @hidden */
  30071. _caps: EngineCapabilities;
  30072. private _isStencilEnable;
  30073. protected _colorWrite: boolean;
  30074. private _glVersion;
  30075. private _glRenderer;
  30076. private _glVendor;
  30077. /** @hidden */
  30078. _videoTextureSupported: boolean;
  30079. protected _renderingQueueLaunched: boolean;
  30080. protected _activeRenderLoops: (() => void)[];
  30081. /**
  30082. * Observable signaled when a context lost event is raised
  30083. */
  30084. onContextLostObservable: Observable<ThinEngine>;
  30085. /**
  30086. * Observable signaled when a context restored event is raised
  30087. */
  30088. onContextRestoredObservable: Observable<ThinEngine>;
  30089. private _onContextLost;
  30090. private _onContextRestored;
  30091. protected _contextWasLost: boolean;
  30092. /** @hidden */
  30093. _doNotHandleContextLost: boolean;
  30094. /**
  30095. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  30096. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  30097. */
  30098. doNotHandleContextLost: boolean;
  30099. /**
  30100. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  30101. */
  30102. disableVertexArrayObjects: boolean;
  30103. /** @hidden */
  30104. protected _depthCullingState: DepthCullingState;
  30105. /** @hidden */
  30106. protected _stencilState: StencilState;
  30107. /** @hidden */
  30108. protected _alphaState: AlphaState;
  30109. /** @hidden */
  30110. _internalTexturesCache: InternalTexture[];
  30111. /** @hidden */
  30112. protected _activeChannel: number;
  30113. private _currentTextureChannel;
  30114. /** @hidden */
  30115. protected _boundTexturesCache: {
  30116. [key: string]: Nullable<InternalTexture>;
  30117. };
  30118. /** @hidden */
  30119. protected _currentEffect: Nullable<Effect>;
  30120. /** @hidden */
  30121. protected _currentProgram: Nullable<WebGLProgram>;
  30122. private _compiledEffects;
  30123. private _vertexAttribArraysEnabled;
  30124. /** @hidden */
  30125. protected _cachedViewport: Nullable<IViewportLike>;
  30126. private _cachedVertexArrayObject;
  30127. /** @hidden */
  30128. protected _cachedVertexBuffers: any;
  30129. /** @hidden */
  30130. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  30131. /** @hidden */
  30132. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  30133. /** @hidden */
  30134. _currentRenderTarget: Nullable<InternalTexture>;
  30135. private _uintIndicesCurrentlySet;
  30136. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  30137. /** @hidden */
  30138. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  30139. private _currentBufferPointers;
  30140. private _currentInstanceLocations;
  30141. private _currentInstanceBuffers;
  30142. private _textureUnits;
  30143. /** @hidden */
  30144. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  30145. /** @hidden */
  30146. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  30147. /** @hidden */
  30148. _boundRenderFunction: any;
  30149. private _vaoRecordInProgress;
  30150. private _mustWipeVertexAttributes;
  30151. private _emptyTexture;
  30152. private _emptyCubeTexture;
  30153. private _emptyTexture3D;
  30154. /** @hidden */
  30155. _frameHandler: number;
  30156. private _nextFreeTextureSlots;
  30157. private _maxSimultaneousTextures;
  30158. private _activeRequests;
  30159. protected _texturesSupported: string[];
  30160. /** @hidden */
  30161. _textureFormatInUse: Nullable<string>;
  30162. protected readonly _supportsHardwareTextureRescaling: boolean;
  30163. /**
  30164. * Gets the list of texture formats supported
  30165. */
  30166. readonly texturesSupported: Array<string>;
  30167. /**
  30168. * Gets the list of texture formats in use
  30169. */
  30170. readonly textureFormatInUse: Nullable<string>;
  30171. /**
  30172. * Gets the current viewport
  30173. */
  30174. readonly currentViewport: Nullable<IViewportLike>;
  30175. /**
  30176. * Gets the default empty texture
  30177. */
  30178. readonly emptyTexture: InternalTexture;
  30179. /**
  30180. * Gets the default empty 3D texture
  30181. */
  30182. readonly emptyTexture3D: InternalTexture;
  30183. /**
  30184. * Gets the default empty cube texture
  30185. */
  30186. readonly emptyCubeTexture: InternalTexture;
  30187. /**
  30188. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  30189. */
  30190. readonly premultipliedAlpha: boolean;
  30191. /**
  30192. * Observable event triggered before each texture is initialized
  30193. */
  30194. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  30195. /**
  30196. * Creates a new engine
  30197. * @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
  30198. * @param antialias defines enable antialiasing (default: false)
  30199. * @param options defines further options to be sent to the getContext() function
  30200. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  30201. */
  30202. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  30203. private _rebuildInternalTextures;
  30204. private _rebuildEffects;
  30205. /**
  30206. * Gets a boolean indicating if all created effects are ready
  30207. * @returns true if all effects are ready
  30208. */
  30209. areAllEffectsReady(): boolean;
  30210. protected _rebuildBuffers(): void;
  30211. private _initGLContext;
  30212. /**
  30213. * Gets version of the current webGL context
  30214. */
  30215. readonly webGLVersion: number;
  30216. /**
  30217. * Gets a string idenfifying the name of the class
  30218. * @returns "Engine" string
  30219. */
  30220. getClassName(): string;
  30221. /**
  30222. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  30223. */
  30224. readonly isStencilEnable: boolean;
  30225. /** @hidden */
  30226. _prepareWorkingCanvas(): void;
  30227. /**
  30228. * Reset the texture cache to empty state
  30229. */
  30230. resetTextureCache(): void;
  30231. /**
  30232. * Gets an object containing information about the current webGL context
  30233. * @returns an object containing the vender, the renderer and the version of the current webGL context
  30234. */
  30235. getGlInfo(): {
  30236. vendor: string;
  30237. renderer: string;
  30238. version: string;
  30239. };
  30240. /**
  30241. * Defines the hardware scaling level.
  30242. * By default the hardware scaling level is computed from the window device ratio.
  30243. * 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.
  30244. * @param level defines the level to use
  30245. */
  30246. setHardwareScalingLevel(level: number): void;
  30247. /**
  30248. * Gets the current hardware scaling level.
  30249. * By default the hardware scaling level is computed from the window device ratio.
  30250. * 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.
  30251. * @returns a number indicating the current hardware scaling level
  30252. */
  30253. getHardwareScalingLevel(): number;
  30254. /**
  30255. * Gets the list of loaded textures
  30256. * @returns an array containing all loaded textures
  30257. */
  30258. getLoadedTexturesCache(): InternalTexture[];
  30259. /**
  30260. * Gets the object containing all engine capabilities
  30261. * @returns the EngineCapabilities object
  30262. */
  30263. getCaps(): EngineCapabilities;
  30264. /**
  30265. * stop executing a render loop function and remove it from the execution array
  30266. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  30267. */
  30268. stopRenderLoop(renderFunction?: () => void): void;
  30269. /** @hidden */
  30270. _renderLoop(): void;
  30271. /**
  30272. * Gets the HTML canvas attached with the current webGL context
  30273. * @returns a HTML canvas
  30274. */
  30275. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  30276. /**
  30277. * Gets host window
  30278. * @returns the host window object
  30279. */
  30280. getHostWindow(): Nullable<Window>;
  30281. /**
  30282. * Gets the current render width
  30283. * @param useScreen defines if screen size must be used (or the current render target if any)
  30284. * @returns a number defining the current render width
  30285. */
  30286. getRenderWidth(useScreen?: boolean): number;
  30287. /**
  30288. * Gets the current render height
  30289. * @param useScreen defines if screen size must be used (or the current render target if any)
  30290. * @returns a number defining the current render height
  30291. */
  30292. getRenderHeight(useScreen?: boolean): number;
  30293. /**
  30294. * Can be used to override the current requestAnimationFrame requester.
  30295. * @hidden
  30296. */
  30297. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  30298. /**
  30299. * Register and execute a render loop. The engine can have more than one render function
  30300. * @param renderFunction defines the function to continuously execute
  30301. */
  30302. runRenderLoop(renderFunction: () => void): void;
  30303. /**
  30304. * Clear the current render buffer or the current render target (if any is set up)
  30305. * @param color defines the color to use
  30306. * @param backBuffer defines if the back buffer must be cleared
  30307. * @param depth defines if the depth buffer must be cleared
  30308. * @param stencil defines if the stencil buffer must be cleared
  30309. */
  30310. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  30311. private _viewportCached;
  30312. /** @hidden */
  30313. _viewport(x: number, y: number, width: number, height: number): void;
  30314. /**
  30315. * Set the WebGL's viewport
  30316. * @param viewport defines the viewport element to be used
  30317. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  30318. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  30319. */
  30320. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  30321. /**
  30322. * Begin a new frame
  30323. */
  30324. beginFrame(): void;
  30325. /**
  30326. * Enf the current frame
  30327. */
  30328. endFrame(): void;
  30329. /**
  30330. * Resize the view according to the canvas' size
  30331. */
  30332. resize(): void;
  30333. /**
  30334. * Force a specific size of the canvas
  30335. * @param width defines the new canvas' width
  30336. * @param height defines the new canvas' height
  30337. */
  30338. setSize(width: number, height: number): void;
  30339. /**
  30340. * Binds the frame buffer to the specified texture.
  30341. * @param texture The texture to render to or null for the default canvas
  30342. * @param faceIndex The face of the texture to render to in case of cube texture
  30343. * @param requiredWidth The width of the target to render to
  30344. * @param requiredHeight The height of the target to render to
  30345. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  30346. * @param depthStencilTexture The depth stencil texture to use to render
  30347. * @param lodLevel defines le lod level to bind to the frame buffer
  30348. */
  30349. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  30350. /** @hidden */
  30351. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  30352. /**
  30353. * Unbind the current render target texture from the webGL context
  30354. * @param texture defines the render target texture to unbind
  30355. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  30356. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  30357. */
  30358. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  30359. /**
  30360. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  30361. */
  30362. flushFramebuffer(): void;
  30363. /**
  30364. * Unbind the current render target and bind the default framebuffer
  30365. */
  30366. restoreDefaultFramebuffer(): void;
  30367. /** @hidden */
  30368. protected _resetVertexBufferBinding(): void;
  30369. /**
  30370. * Creates a vertex buffer
  30371. * @param data the data for the vertex buffer
  30372. * @returns the new WebGL static buffer
  30373. */
  30374. createVertexBuffer(data: DataArray): DataBuffer;
  30375. private _createVertexBuffer;
  30376. /**
  30377. * Creates a dynamic vertex buffer
  30378. * @param data the data for the dynamic vertex buffer
  30379. * @returns the new WebGL dynamic buffer
  30380. */
  30381. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  30382. protected _resetIndexBufferBinding(): void;
  30383. /**
  30384. * Creates a new index buffer
  30385. * @param indices defines the content of the index buffer
  30386. * @param updatable defines if the index buffer must be updatable
  30387. * @returns a new webGL buffer
  30388. */
  30389. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  30390. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  30391. /**
  30392. * Bind a webGL buffer to the webGL context
  30393. * @param buffer defines the buffer to bind
  30394. */
  30395. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  30396. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  30397. private bindBuffer;
  30398. /**
  30399. * update the bound buffer with the given data
  30400. * @param data defines the data to update
  30401. */
  30402. updateArrayBuffer(data: Float32Array): void;
  30403. private _vertexAttribPointer;
  30404. private _bindIndexBufferWithCache;
  30405. private _bindVertexBuffersAttributes;
  30406. /**
  30407. * Records a vertex array object
  30408. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  30409. * @param vertexBuffers defines the list of vertex buffers to store
  30410. * @param indexBuffer defines the index buffer to store
  30411. * @param effect defines the effect to store
  30412. * @returns the new vertex array object
  30413. */
  30414. recordVertexArrayObject(vertexBuffers: {
  30415. [key: string]: VertexBuffer;
  30416. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  30417. /**
  30418. * Bind a specific vertex array object
  30419. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  30420. * @param vertexArrayObject defines the vertex array object to bind
  30421. * @param indexBuffer defines the index buffer to bind
  30422. */
  30423. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  30424. /**
  30425. * Bind webGl buffers directly to the webGL context
  30426. * @param vertexBuffer defines the vertex buffer to bind
  30427. * @param indexBuffer defines the index buffer to bind
  30428. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  30429. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  30430. * @param effect defines the effect associated with the vertex buffer
  30431. */
  30432. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  30433. private _unbindVertexArrayObject;
  30434. /**
  30435. * Bind a list of vertex buffers to the webGL context
  30436. * @param vertexBuffers defines the list of vertex buffers to bind
  30437. * @param indexBuffer defines the index buffer to bind
  30438. * @param effect defines the effect associated with the vertex buffers
  30439. */
  30440. bindBuffers(vertexBuffers: {
  30441. [key: string]: Nullable<VertexBuffer>;
  30442. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  30443. /**
  30444. * Unbind all instance attributes
  30445. */
  30446. unbindInstanceAttributes(): void;
  30447. /**
  30448. * Release and free the memory of a vertex array object
  30449. * @param vao defines the vertex array object to delete
  30450. */
  30451. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  30452. /** @hidden */
  30453. _releaseBuffer(buffer: DataBuffer): boolean;
  30454. protected _deleteBuffer(buffer: DataBuffer): void;
  30455. /**
  30456. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  30457. * @param instancesBuffer defines the webGL buffer to update and bind
  30458. * @param data defines the data to store in the buffer
  30459. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  30460. */
  30461. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  30462. /**
  30463. * Apply all cached states (depth, culling, stencil and alpha)
  30464. */
  30465. applyStates(): void;
  30466. /**
  30467. * Send a draw order
  30468. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  30469. * @param indexStart defines the starting index
  30470. * @param indexCount defines the number of index to draw
  30471. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30472. */
  30473. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  30474. /**
  30475. * Draw a list of points
  30476. * @param verticesStart defines the index of first vertex to draw
  30477. * @param verticesCount defines the count of vertices to draw
  30478. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30479. */
  30480. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30481. /**
  30482. * Draw a list of unindexed primitives
  30483. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  30484. * @param verticesStart defines the index of first vertex to draw
  30485. * @param verticesCount defines the count of vertices to draw
  30486. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30487. */
  30488. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30489. /**
  30490. * Draw a list of indexed primitives
  30491. * @param fillMode defines the primitive to use
  30492. * @param indexStart defines the starting index
  30493. * @param indexCount defines the number of index to draw
  30494. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30495. */
  30496. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  30497. /**
  30498. * Draw a list of unindexed primitives
  30499. * @param fillMode defines the primitive to use
  30500. * @param verticesStart defines the index of first vertex to draw
  30501. * @param verticesCount defines the count of vertices to draw
  30502. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30503. */
  30504. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30505. private _drawMode;
  30506. /** @hidden */
  30507. protected _reportDrawCall(): void;
  30508. /** @hidden */
  30509. _releaseEffect(effect: Effect): void;
  30510. /** @hidden */
  30511. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  30512. /**
  30513. * Create a new effect (used to store vertex/fragment shaders)
  30514. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  30515. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  30516. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  30517. * @param samplers defines an array of string used to represent textures
  30518. * @param defines defines the string containing the defines to use to compile the shaders
  30519. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  30520. * @param onCompiled defines a function to call when the effect creation is successful
  30521. * @param onError defines a function to call when the effect creation has failed
  30522. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  30523. * @returns the new Effect
  30524. */
  30525. 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;
  30526. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  30527. private _compileShader;
  30528. private _compileRawShader;
  30529. /**
  30530. * Directly creates a webGL program
  30531. * @param pipelineContext defines the pipeline context to attach to
  30532. * @param vertexCode defines the vertex shader code to use
  30533. * @param fragmentCode defines the fragment shader code to use
  30534. * @param context defines the webGL context to use (if not set, the current one will be used)
  30535. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  30536. * @returns the new webGL program
  30537. */
  30538. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30539. /**
  30540. * Creates a webGL program
  30541. * @param pipelineContext defines the pipeline context to attach to
  30542. * @param vertexCode defines the vertex shader code to use
  30543. * @param fragmentCode defines the fragment shader code to use
  30544. * @param defines defines the string containing the defines to use to compile the shaders
  30545. * @param context defines the webGL context to use (if not set, the current one will be used)
  30546. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  30547. * @returns the new webGL program
  30548. */
  30549. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30550. /**
  30551. * Creates a new pipeline context
  30552. * @returns the new pipeline
  30553. */
  30554. createPipelineContext(): IPipelineContext;
  30555. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30556. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  30557. /** @hidden */
  30558. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  30559. /** @hidden */
  30560. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  30561. /** @hidden */
  30562. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  30563. /**
  30564. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  30565. * @param pipelineContext defines the pipeline context to use
  30566. * @param uniformsNames defines the list of uniform names
  30567. * @returns an array of webGL uniform locations
  30568. */
  30569. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  30570. /**
  30571. * Gets the lsit of active attributes for a given webGL program
  30572. * @param pipelineContext defines the pipeline context to use
  30573. * @param attributesNames defines the list of attribute names to get
  30574. * @returns an array of indices indicating the offset of each attribute
  30575. */
  30576. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  30577. /**
  30578. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  30579. * @param effect defines the effect to activate
  30580. */
  30581. enableEffect(effect: Nullable<Effect>): void;
  30582. /**
  30583. * Set the value of an uniform to a number (int)
  30584. * @param uniform defines the webGL uniform location where to store the value
  30585. * @param value defines the int number to store
  30586. */
  30587. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  30588. /**
  30589. * Set the value of an uniform to an array of int32
  30590. * @param uniform defines the webGL uniform location where to store the value
  30591. * @param array defines the array of int32 to store
  30592. */
  30593. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30594. /**
  30595. * Set the value of an uniform to an array of int32 (stored as vec2)
  30596. * @param uniform defines the webGL uniform location where to store the value
  30597. * @param array defines the array of int32 to store
  30598. */
  30599. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30600. /**
  30601. * Set the value of an uniform to an array of int32 (stored as vec3)
  30602. * @param uniform defines the webGL uniform location where to store the value
  30603. * @param array defines the array of int32 to store
  30604. */
  30605. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30606. /**
  30607. * Set the value of an uniform to an array of int32 (stored as vec4)
  30608. * @param uniform defines the webGL uniform location where to store the value
  30609. * @param array defines the array of int32 to store
  30610. */
  30611. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30612. /**
  30613. * Set the value of an uniform to an array of number
  30614. * @param uniform defines the webGL uniform location where to store the value
  30615. * @param array defines the array of number to store
  30616. */
  30617. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30618. /**
  30619. * Set the value of an uniform to an array of number (stored as vec2)
  30620. * @param uniform defines the webGL uniform location where to store the value
  30621. * @param array defines the array of number to store
  30622. */
  30623. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30624. /**
  30625. * Set the value of an uniform to an array of number (stored as vec3)
  30626. * @param uniform defines the webGL uniform location where to store the value
  30627. * @param array defines the array of number to store
  30628. */
  30629. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30630. /**
  30631. * Set the value of an uniform to an array of number (stored as vec4)
  30632. * @param uniform defines the webGL uniform location where to store the value
  30633. * @param array defines the array of number to store
  30634. */
  30635. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30636. /**
  30637. * Set the value of an uniform to an array of float32 (stored as matrices)
  30638. * @param uniform defines the webGL uniform location where to store the value
  30639. * @param matrices defines the array of float32 to store
  30640. */
  30641. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  30642. /**
  30643. * Set the value of an uniform to a matrix (3x3)
  30644. * @param uniform defines the webGL uniform location where to store the value
  30645. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  30646. */
  30647. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  30648. /**
  30649. * Set the value of an uniform to a matrix (2x2)
  30650. * @param uniform defines the webGL uniform location where to store the value
  30651. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  30652. */
  30653. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  30654. /**
  30655. * Set the value of an uniform to a number (float)
  30656. * @param uniform defines the webGL uniform location where to store the value
  30657. * @param value defines the float number to store
  30658. */
  30659. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  30660. /**
  30661. * Set the value of an uniform to a vec2
  30662. * @param uniform defines the webGL uniform location where to store the value
  30663. * @param x defines the 1st component of the value
  30664. * @param y defines the 2nd component of the value
  30665. */
  30666. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  30667. /**
  30668. * Set the value of an uniform to a vec3
  30669. * @param uniform defines the webGL uniform location where to store the value
  30670. * @param x defines the 1st component of the value
  30671. * @param y defines the 2nd component of the value
  30672. * @param z defines the 3rd component of the value
  30673. */
  30674. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  30675. /**
  30676. * Set the value of an uniform to a vec4
  30677. * @param uniform defines the webGL uniform location where to store the value
  30678. * @param x defines the 1st component of the value
  30679. * @param y defines the 2nd component of the value
  30680. * @param z defines the 3rd component of the value
  30681. * @param w defines the 4th component of the value
  30682. */
  30683. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  30684. /**
  30685. * Gets the depth culling state manager
  30686. */
  30687. readonly depthCullingState: DepthCullingState;
  30688. /**
  30689. * Gets the alpha state manager
  30690. */
  30691. readonly alphaState: AlphaState;
  30692. /**
  30693. * Gets the stencil state manager
  30694. */
  30695. readonly stencilState: StencilState;
  30696. /**
  30697. * Clears the list of texture accessible through engine.
  30698. * This can help preventing texture load conflict due to name collision.
  30699. */
  30700. clearInternalTexturesCache(): void;
  30701. /**
  30702. * Force the entire cache to be cleared
  30703. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  30704. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  30705. */
  30706. wipeCaches(bruteForce?: boolean): void;
  30707. /** @hidden */
  30708. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  30709. min: number;
  30710. mag: number;
  30711. };
  30712. /** @hidden */
  30713. _createTexture(): WebGLTexture;
  30714. /**
  30715. * Usually called from Texture.ts.
  30716. * Passed information to create a WebGLTexture
  30717. * @param urlArg defines a value which contains one of the following:
  30718. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  30719. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  30720. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  30721. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  30722. * @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)
  30723. * @param scene needed for loading to the correct scene
  30724. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  30725. * @param onLoad optional callback to be called upon successful completion
  30726. * @param onError optional callback to be called upon failure
  30727. * @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
  30728. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  30729. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  30730. * @param forcedExtension defines the extension to use to pick the right loader
  30731. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  30732. * @param mimeType defines an optional mime type
  30733. * @returns a InternalTexture for assignment back into BABYLON.Texture
  30734. */
  30735. 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>, excludeLoaders?: Array<IInternalTextureLoader>, mimeType?: string): InternalTexture;
  30736. /**
  30737. * @hidden
  30738. */
  30739. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  30740. /**
  30741. * Creates a raw texture
  30742. * @param data defines the data to store in the texture
  30743. * @param width defines the width of the texture
  30744. * @param height defines the height of the texture
  30745. * @param format defines the format of the data
  30746. * @param generateMipMaps defines if the engine should generate the mip levels
  30747. * @param invertY defines if data must be stored with Y axis inverted
  30748. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  30749. * @param compression defines the compression used (null by default)
  30750. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  30751. * @returns the raw texture inside an InternalTexture
  30752. */
  30753. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, type?: number): InternalTexture;
  30754. /**
  30755. * Creates a new raw cube texture
  30756. * @param data defines the array of data to use to create each face
  30757. * @param size defines the size of the textures
  30758. * @param format defines the format of the data
  30759. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  30760. * @param generateMipMaps defines if the engine should generate the mip levels
  30761. * @param invertY defines if data must be stored with Y axis inverted
  30762. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  30763. * @param compression defines the compression used (null by default)
  30764. * @returns the cube texture as an InternalTexture
  30765. */
  30766. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>): InternalTexture;
  30767. /**
  30768. * Creates a new raw 3D texture
  30769. * @param data defines the data used to create the texture
  30770. * @param width defines the width of the texture
  30771. * @param height defines the height of the texture
  30772. * @param depth defines the depth of the texture
  30773. * @param format defines the format of the texture
  30774. * @param generateMipMaps defines if the engine must generate mip levels
  30775. * @param invertY defines if data must be stored with Y axis inverted
  30776. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  30777. * @param compression defines the compressed used (can be null)
  30778. * @param textureType defines the compressed used (can be null)
  30779. * @returns a new raw 3D texture (stored in an InternalTexture)
  30780. */
  30781. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  30782. private _unpackFlipYCached;
  30783. /**
  30784. * In case you are sharing the context with other applications, it might
  30785. * be interested to not cache the unpack flip y state to ensure a consistent
  30786. * value would be set.
  30787. */
  30788. enableUnpackFlipYCached: boolean;
  30789. /** @hidden */
  30790. _unpackFlipY(value: boolean): void;
  30791. /** @hidden */
  30792. _getUnpackAlignement(): number;
  30793. /**
  30794. * Update the sampling mode of a given texture
  30795. * @param samplingMode defines the required sampling mode
  30796. * @param texture defines the texture to update
  30797. */
  30798. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  30799. /** @hidden */
  30800. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  30801. width: number;
  30802. height: number;
  30803. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  30804. /** @hidden */
  30805. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  30806. /** @hidden */
  30807. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  30808. /** @hidden */
  30809. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  30810. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  30811. private _prepareWebGLTexture;
  30812. /** @hidden */
  30813. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  30814. /** @hidden */
  30815. _releaseFramebufferObjects(texture: InternalTexture): void;
  30816. /** @hidden */
  30817. _releaseTexture(texture: InternalTexture): void;
  30818. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  30819. protected _setProgram(program: WebGLProgram): void;
  30820. protected _boundUniforms: {
  30821. [key: number]: WebGLUniformLocation;
  30822. };
  30823. /**
  30824. * Binds an effect to the webGL context
  30825. * @param effect defines the effect to bind
  30826. */
  30827. bindSamplers(effect: Effect): void;
  30828. private _activateCurrentTexture;
  30829. /** @hidden */
  30830. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  30831. /** @hidden */
  30832. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  30833. /**
  30834. * Unbind all textures from the webGL context
  30835. */
  30836. unbindAllTextures(): void;
  30837. /**
  30838. * Sets a texture to the according uniform.
  30839. * @param channel The texture channel
  30840. * @param uniform The uniform to set
  30841. * @param texture The texture to apply
  30842. */
  30843. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  30844. private _bindSamplerUniformToChannel;
  30845. private _getTextureWrapMode;
  30846. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  30847. /**
  30848. * Sets an array of texture to the webGL context
  30849. * @param channel defines the channel where the texture array must be set
  30850. * @param uniform defines the associated uniform location
  30851. * @param textures defines the array of textures to bind
  30852. */
  30853. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  30854. /** @hidden */
  30855. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  30856. private _setTextureParameterFloat;
  30857. private _setTextureParameterInteger;
  30858. /**
  30859. * Unbind all vertex attributes from the webGL context
  30860. */
  30861. unbindAllAttributes(): void;
  30862. /**
  30863. * 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
  30864. */
  30865. releaseEffects(): void;
  30866. /**
  30867. * Dispose and release all associated resources
  30868. */
  30869. dispose(): void;
  30870. /**
  30871. * Attach a new callback raised when context lost event is fired
  30872. * @param callback defines the callback to call
  30873. */
  30874. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  30875. /**
  30876. * Attach a new callback raised when context restored event is fired
  30877. * @param callback defines the callback to call
  30878. */
  30879. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  30880. /**
  30881. * Get the current error code of the webGL context
  30882. * @returns the error code
  30883. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  30884. */
  30885. getError(): number;
  30886. private _canRenderToFloatFramebuffer;
  30887. private _canRenderToHalfFloatFramebuffer;
  30888. private _canRenderToFramebuffer;
  30889. /** @hidden */
  30890. _getWebGLTextureType(type: number): number;
  30891. /** @hidden */
  30892. _getInternalFormat(format: number): number;
  30893. /** @hidden */
  30894. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  30895. /** @hidden */
  30896. _getRGBAMultiSampleBufferFormat(type: number): number;
  30897. /** @hidden */
  30898. _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;
  30899. /**
  30900. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  30901. * @returns true if the engine can be created
  30902. * @ignorenaming
  30903. */
  30904. static isSupported(): boolean;
  30905. /**
  30906. * Find the next highest power of two.
  30907. * @param x Number to start search from.
  30908. * @return Next highest power of two.
  30909. */
  30910. static CeilingPOT(x: number): number;
  30911. /**
  30912. * Find the next lowest power of two.
  30913. * @param x Number to start search from.
  30914. * @return Next lowest power of two.
  30915. */
  30916. static FloorPOT(x: number): number;
  30917. /**
  30918. * Find the nearest power of two.
  30919. * @param x Number to start search from.
  30920. * @return Next nearest power of two.
  30921. */
  30922. static NearestPOT(x: number): number;
  30923. /**
  30924. * Get the closest exponent of two
  30925. * @param value defines the value to approximate
  30926. * @param max defines the maximum value to return
  30927. * @param mode defines how to define the closest value
  30928. * @returns closest exponent of two of the given value
  30929. */
  30930. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  30931. /**
  30932. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  30933. * @param func - the function to be called
  30934. * @param requester - the object that will request the next frame. Falls back to window.
  30935. * @returns frame number
  30936. */
  30937. static QueueNewFrame(func: () => void, requester?: any): number;
  30938. }
  30939. }
  30940. declare module "babylonjs/Maths/sphericalPolynomial" {
  30941. import { Vector3 } from "babylonjs/Maths/math.vector";
  30942. import { Color3 } from "babylonjs/Maths/math.color";
  30943. /**
  30944. * Class representing spherical harmonics coefficients to the 3rd degree
  30945. */
  30946. export class SphericalHarmonics {
  30947. /**
  30948. * Defines whether or not the harmonics have been prescaled for rendering.
  30949. */
  30950. preScaled: boolean;
  30951. /**
  30952. * The l0,0 coefficients of the spherical harmonics
  30953. */
  30954. l00: Vector3;
  30955. /**
  30956. * The l1,-1 coefficients of the spherical harmonics
  30957. */
  30958. l1_1: Vector3;
  30959. /**
  30960. * The l1,0 coefficients of the spherical harmonics
  30961. */
  30962. l10: Vector3;
  30963. /**
  30964. * The l1,1 coefficients of the spherical harmonics
  30965. */
  30966. l11: Vector3;
  30967. /**
  30968. * The l2,-2 coefficients of the spherical harmonics
  30969. */
  30970. l2_2: Vector3;
  30971. /**
  30972. * The l2,-1 coefficients of the spherical harmonics
  30973. */
  30974. l2_1: Vector3;
  30975. /**
  30976. * The l2,0 coefficients of the spherical harmonics
  30977. */
  30978. l20: Vector3;
  30979. /**
  30980. * The l2,1 coefficients of the spherical harmonics
  30981. */
  30982. l21: Vector3;
  30983. /**
  30984. * The l2,2 coefficients of the spherical harmonics
  30985. */
  30986. l22: Vector3;
  30987. /**
  30988. * Adds a light to the spherical harmonics
  30989. * @param direction the direction of the light
  30990. * @param color the color of the light
  30991. * @param deltaSolidAngle the delta solid angle of the light
  30992. */
  30993. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  30994. /**
  30995. * Scales the spherical harmonics by the given amount
  30996. * @param scale the amount to scale
  30997. */
  30998. scaleInPlace(scale: number): void;
  30999. /**
  31000. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  31001. *
  31002. * ```
  31003. * E_lm = A_l * L_lm
  31004. * ```
  31005. *
  31006. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  31007. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  31008. * the scaling factors are given in equation 9.
  31009. */
  31010. convertIncidentRadianceToIrradiance(): void;
  31011. /**
  31012. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  31013. *
  31014. * ```
  31015. * L = (1/pi) * E * rho
  31016. * ```
  31017. *
  31018. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  31019. */
  31020. convertIrradianceToLambertianRadiance(): void;
  31021. /**
  31022. * Integrates the reconstruction coefficients directly in to the SH preventing further
  31023. * required operations at run time.
  31024. *
  31025. * This is simply done by scaling back the SH with Ylm constants parameter.
  31026. * The trigonometric part being applied by the shader at run time.
  31027. */
  31028. preScaleForRendering(): void;
  31029. /**
  31030. * Constructs a spherical harmonics from an array.
  31031. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  31032. * @returns the spherical harmonics
  31033. */
  31034. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  31035. /**
  31036. * Gets the spherical harmonics from polynomial
  31037. * @param polynomial the spherical polynomial
  31038. * @returns the spherical harmonics
  31039. */
  31040. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  31041. }
  31042. /**
  31043. * Class representing spherical polynomial coefficients to the 3rd degree
  31044. */
  31045. export class SphericalPolynomial {
  31046. private _harmonics;
  31047. /**
  31048. * The spherical harmonics used to create the polynomials.
  31049. */
  31050. readonly preScaledHarmonics: SphericalHarmonics;
  31051. /**
  31052. * The x coefficients of the spherical polynomial
  31053. */
  31054. x: Vector3;
  31055. /**
  31056. * The y coefficients of the spherical polynomial
  31057. */
  31058. y: Vector3;
  31059. /**
  31060. * The z coefficients of the spherical polynomial
  31061. */
  31062. z: Vector3;
  31063. /**
  31064. * The xx coefficients of the spherical polynomial
  31065. */
  31066. xx: Vector3;
  31067. /**
  31068. * The yy coefficients of the spherical polynomial
  31069. */
  31070. yy: Vector3;
  31071. /**
  31072. * The zz coefficients of the spherical polynomial
  31073. */
  31074. zz: Vector3;
  31075. /**
  31076. * The xy coefficients of the spherical polynomial
  31077. */
  31078. xy: Vector3;
  31079. /**
  31080. * The yz coefficients of the spherical polynomial
  31081. */
  31082. yz: Vector3;
  31083. /**
  31084. * The zx coefficients of the spherical polynomial
  31085. */
  31086. zx: Vector3;
  31087. /**
  31088. * Adds an ambient color to the spherical polynomial
  31089. * @param color the color to add
  31090. */
  31091. addAmbient(color: Color3): void;
  31092. /**
  31093. * Scales the spherical polynomial by the given amount
  31094. * @param scale the amount to scale
  31095. */
  31096. scaleInPlace(scale: number): void;
  31097. /**
  31098. * Gets the spherical polynomial from harmonics
  31099. * @param harmonics the spherical harmonics
  31100. * @returns the spherical polynomial
  31101. */
  31102. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  31103. /**
  31104. * Constructs a spherical polynomial from an array.
  31105. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  31106. * @returns the spherical polynomial
  31107. */
  31108. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  31109. }
  31110. }
  31111. declare module "babylonjs/Materials/Textures/internalTexture" {
  31112. import { Observable } from "babylonjs/Misc/observable";
  31113. import { Nullable, int } from "babylonjs/types";
  31114. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  31115. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31116. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  31117. /**
  31118. * Defines the source of the internal texture
  31119. */
  31120. export enum InternalTextureSource {
  31121. /**
  31122. * The source of the texture data is unknown
  31123. */
  31124. Unknown = 0,
  31125. /**
  31126. * Texture data comes from an URL
  31127. */
  31128. Url = 1,
  31129. /**
  31130. * Texture data is only used for temporary storage
  31131. */
  31132. Temp = 2,
  31133. /**
  31134. * Texture data comes from raw data (ArrayBuffer)
  31135. */
  31136. Raw = 3,
  31137. /**
  31138. * Texture content is dynamic (video or dynamic texture)
  31139. */
  31140. Dynamic = 4,
  31141. /**
  31142. * Texture content is generated by rendering to it
  31143. */
  31144. RenderTarget = 5,
  31145. /**
  31146. * Texture content is part of a multi render target process
  31147. */
  31148. MultiRenderTarget = 6,
  31149. /**
  31150. * Texture data comes from a cube data file
  31151. */
  31152. Cube = 7,
  31153. /**
  31154. * Texture data comes from a raw cube data
  31155. */
  31156. CubeRaw = 8,
  31157. /**
  31158. * Texture data come from a prefiltered cube data file
  31159. */
  31160. CubePrefiltered = 9,
  31161. /**
  31162. * Texture content is raw 3D data
  31163. */
  31164. Raw3D = 10,
  31165. /**
  31166. * Texture content is a depth texture
  31167. */
  31168. Depth = 11,
  31169. /**
  31170. * Texture data comes from a raw cube data encoded with RGBD
  31171. */
  31172. CubeRawRGBD = 12
  31173. }
  31174. /**
  31175. * Class used to store data associated with WebGL texture data for the engine
  31176. * This class should not be used directly
  31177. */
  31178. export class InternalTexture {
  31179. /** @hidden */
  31180. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<import("babylonjs/Maths/sphericalPolynomial").SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  31181. /**
  31182. * Defines if the texture is ready
  31183. */
  31184. isReady: boolean;
  31185. /**
  31186. * Defines if the texture is a cube texture
  31187. */
  31188. isCube: boolean;
  31189. /**
  31190. * Defines if the texture contains 3D data
  31191. */
  31192. is3D: boolean;
  31193. /**
  31194. * Defines if the texture contains multiview data
  31195. */
  31196. isMultiview: boolean;
  31197. /**
  31198. * Gets the URL used to load this texture
  31199. */
  31200. url: string;
  31201. /**
  31202. * Gets the sampling mode of the texture
  31203. */
  31204. samplingMode: number;
  31205. /**
  31206. * Gets a boolean indicating if the texture needs mipmaps generation
  31207. */
  31208. generateMipMaps: boolean;
  31209. /**
  31210. * Gets the number of samples used by the texture (WebGL2+ only)
  31211. */
  31212. samples: number;
  31213. /**
  31214. * Gets the type of the texture (int, float...)
  31215. */
  31216. type: number;
  31217. /**
  31218. * Gets the format of the texture (RGB, RGBA...)
  31219. */
  31220. format: number;
  31221. /**
  31222. * Observable called when the texture is loaded
  31223. */
  31224. onLoadedObservable: Observable<InternalTexture>;
  31225. /**
  31226. * Gets the width of the texture
  31227. */
  31228. width: number;
  31229. /**
  31230. * Gets the height of the texture
  31231. */
  31232. height: number;
  31233. /**
  31234. * Gets the depth of the texture
  31235. */
  31236. depth: number;
  31237. /**
  31238. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  31239. */
  31240. baseWidth: number;
  31241. /**
  31242. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  31243. */
  31244. baseHeight: number;
  31245. /**
  31246. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  31247. */
  31248. baseDepth: number;
  31249. /**
  31250. * Gets a boolean indicating if the texture is inverted on Y axis
  31251. */
  31252. invertY: boolean;
  31253. /** @hidden */
  31254. _invertVScale: boolean;
  31255. /** @hidden */
  31256. _associatedChannel: number;
  31257. /** @hidden */
  31258. _source: InternalTextureSource;
  31259. /** @hidden */
  31260. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  31261. /** @hidden */
  31262. _bufferView: Nullable<ArrayBufferView>;
  31263. /** @hidden */
  31264. _bufferViewArray: Nullable<ArrayBufferView[]>;
  31265. /** @hidden */
  31266. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  31267. /** @hidden */
  31268. _size: number;
  31269. /** @hidden */
  31270. _extension: string;
  31271. /** @hidden */
  31272. _files: Nullable<string[]>;
  31273. /** @hidden */
  31274. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  31275. /** @hidden */
  31276. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  31277. /** @hidden */
  31278. _framebuffer: Nullable<WebGLFramebuffer>;
  31279. /** @hidden */
  31280. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  31281. /** @hidden */
  31282. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  31283. /** @hidden */
  31284. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  31285. /** @hidden */
  31286. _attachments: Nullable<number[]>;
  31287. /** @hidden */
  31288. _cachedCoordinatesMode: Nullable<number>;
  31289. /** @hidden */
  31290. _cachedWrapU: Nullable<number>;
  31291. /** @hidden */
  31292. _cachedWrapV: Nullable<number>;
  31293. /** @hidden */
  31294. _cachedWrapR: Nullable<number>;
  31295. /** @hidden */
  31296. _cachedAnisotropicFilteringLevel: Nullable<number>;
  31297. /** @hidden */
  31298. _isDisabled: boolean;
  31299. /** @hidden */
  31300. _compression: Nullable<string>;
  31301. /** @hidden */
  31302. _generateStencilBuffer: boolean;
  31303. /** @hidden */
  31304. _generateDepthBuffer: boolean;
  31305. /** @hidden */
  31306. _comparisonFunction: number;
  31307. /** @hidden */
  31308. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  31309. /** @hidden */
  31310. _lodGenerationScale: number;
  31311. /** @hidden */
  31312. _lodGenerationOffset: number;
  31313. /** @hidden */
  31314. _colorTextureArray: Nullable<WebGLTexture>;
  31315. /** @hidden */
  31316. _depthStencilTextureArray: Nullable<WebGLTexture>;
  31317. /** @hidden */
  31318. _lodTextureHigh: Nullable<BaseTexture>;
  31319. /** @hidden */
  31320. _lodTextureMid: Nullable<BaseTexture>;
  31321. /** @hidden */
  31322. _lodTextureLow: Nullable<BaseTexture>;
  31323. /** @hidden */
  31324. _isRGBD: boolean;
  31325. /** @hidden */
  31326. _linearSpecularLOD: boolean;
  31327. /** @hidden */
  31328. _irradianceTexture: Nullable<BaseTexture>;
  31329. /** @hidden */
  31330. _webGLTexture: Nullable<WebGLTexture>;
  31331. /** @hidden */
  31332. _references: number;
  31333. private _engine;
  31334. /**
  31335. * Gets the Engine the texture belongs to.
  31336. * @returns The babylon engine
  31337. */
  31338. getEngine(): ThinEngine;
  31339. /**
  31340. * Gets the data source type of the texture
  31341. */
  31342. readonly source: InternalTextureSource;
  31343. /**
  31344. * Creates a new InternalTexture
  31345. * @param engine defines the engine to use
  31346. * @param source defines the type of data that will be used
  31347. * @param delayAllocation if the texture allocation should be delayed (default: false)
  31348. */
  31349. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  31350. /**
  31351. * Increments the number of references (ie. the number of Texture that point to it)
  31352. */
  31353. incrementReferences(): void;
  31354. /**
  31355. * Change the size of the texture (not the size of the content)
  31356. * @param width defines the new width
  31357. * @param height defines the new height
  31358. * @param depth defines the new depth (1 by default)
  31359. */
  31360. updateSize(width: int, height: int, depth?: int): void;
  31361. /** @hidden */
  31362. _rebuild(): void;
  31363. /** @hidden */
  31364. _swapAndDie(target: InternalTexture): void;
  31365. /**
  31366. * Dispose the current allocated resources
  31367. */
  31368. dispose(): void;
  31369. }
  31370. }
  31371. declare module "babylonjs/Audio/analyser" {
  31372. import { Scene } from "babylonjs/scene";
  31373. /**
  31374. * Class used to work with sound analyzer using fast fourier transform (FFT)
  31375. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31376. */
  31377. export class Analyser {
  31378. /**
  31379. * Gets or sets the smoothing
  31380. * @ignorenaming
  31381. */
  31382. SMOOTHING: number;
  31383. /**
  31384. * Gets or sets the FFT table size
  31385. * @ignorenaming
  31386. */
  31387. FFT_SIZE: number;
  31388. /**
  31389. * Gets or sets the bar graph amplitude
  31390. * @ignorenaming
  31391. */
  31392. BARGRAPHAMPLITUDE: number;
  31393. /**
  31394. * Gets or sets the position of the debug canvas
  31395. * @ignorenaming
  31396. */
  31397. DEBUGCANVASPOS: {
  31398. x: number;
  31399. y: number;
  31400. };
  31401. /**
  31402. * Gets or sets the debug canvas size
  31403. * @ignorenaming
  31404. */
  31405. DEBUGCANVASSIZE: {
  31406. width: number;
  31407. height: number;
  31408. };
  31409. private _byteFreqs;
  31410. private _byteTime;
  31411. private _floatFreqs;
  31412. private _webAudioAnalyser;
  31413. private _debugCanvas;
  31414. private _debugCanvasContext;
  31415. private _scene;
  31416. private _registerFunc;
  31417. private _audioEngine;
  31418. /**
  31419. * Creates a new analyser
  31420. * @param scene defines hosting scene
  31421. */
  31422. constructor(scene: Scene);
  31423. /**
  31424. * Get the number of data values you will have to play with for the visualization
  31425. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  31426. * @returns a number
  31427. */
  31428. getFrequencyBinCount(): number;
  31429. /**
  31430. * Gets the current frequency data as a byte array
  31431. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  31432. * @returns a Uint8Array
  31433. */
  31434. getByteFrequencyData(): Uint8Array;
  31435. /**
  31436. * Gets the current waveform as a byte array
  31437. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  31438. * @returns a Uint8Array
  31439. */
  31440. getByteTimeDomainData(): Uint8Array;
  31441. /**
  31442. * Gets the current frequency data as a float array
  31443. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  31444. * @returns a Float32Array
  31445. */
  31446. getFloatFrequencyData(): Float32Array;
  31447. /**
  31448. * Renders the debug canvas
  31449. */
  31450. drawDebugCanvas(): void;
  31451. /**
  31452. * Stops rendering the debug canvas and removes it
  31453. */
  31454. stopDebugCanvas(): void;
  31455. /**
  31456. * Connects two audio nodes
  31457. * @param inputAudioNode defines first node to connect
  31458. * @param outputAudioNode defines second node to connect
  31459. */
  31460. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  31461. /**
  31462. * Releases all associated resources
  31463. */
  31464. dispose(): void;
  31465. }
  31466. }
  31467. declare module "babylonjs/Audio/audioEngine" {
  31468. import { IDisposable } from "babylonjs/scene";
  31469. import { Analyser } from "babylonjs/Audio/analyser";
  31470. import { Nullable } from "babylonjs/types";
  31471. import { Observable } from "babylonjs/Misc/observable";
  31472. /**
  31473. * This represents an audio engine and it is responsible
  31474. * to play, synchronize and analyse sounds throughout the application.
  31475. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31476. */
  31477. export interface IAudioEngine extends IDisposable {
  31478. /**
  31479. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  31480. */
  31481. readonly canUseWebAudio: boolean;
  31482. /**
  31483. * Gets the current AudioContext if available.
  31484. */
  31485. readonly audioContext: Nullable<AudioContext>;
  31486. /**
  31487. * The master gain node defines the global audio volume of your audio engine.
  31488. */
  31489. readonly masterGain: GainNode;
  31490. /**
  31491. * Gets whether or not mp3 are supported by your browser.
  31492. */
  31493. readonly isMP3supported: boolean;
  31494. /**
  31495. * Gets whether or not ogg are supported by your browser.
  31496. */
  31497. readonly isOGGsupported: boolean;
  31498. /**
  31499. * Defines if Babylon should emit a warning if WebAudio is not supported.
  31500. * @ignoreNaming
  31501. */
  31502. WarnedWebAudioUnsupported: boolean;
  31503. /**
  31504. * Defines if the audio engine relies on a custom unlocked button.
  31505. * In this case, the embedded button will not be displayed.
  31506. */
  31507. useCustomUnlockedButton: boolean;
  31508. /**
  31509. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  31510. */
  31511. readonly unlocked: boolean;
  31512. /**
  31513. * Event raised when audio has been unlocked on the browser.
  31514. */
  31515. onAudioUnlockedObservable: Observable<AudioEngine>;
  31516. /**
  31517. * Event raised when audio has been locked on the browser.
  31518. */
  31519. onAudioLockedObservable: Observable<AudioEngine>;
  31520. /**
  31521. * Flags the audio engine in Locked state.
  31522. * This happens due to new browser policies preventing audio to autoplay.
  31523. */
  31524. lock(): void;
  31525. /**
  31526. * Unlocks the audio engine once a user action has been done on the dom.
  31527. * This is helpful to resume play once browser policies have been satisfied.
  31528. */
  31529. unlock(): void;
  31530. }
  31531. /**
  31532. * This represents the default audio engine used in babylon.
  31533. * It is responsible to play, synchronize and analyse sounds throughout the application.
  31534. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31535. */
  31536. export class AudioEngine implements IAudioEngine {
  31537. private _audioContext;
  31538. private _audioContextInitialized;
  31539. private _muteButton;
  31540. private _hostElement;
  31541. /**
  31542. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  31543. */
  31544. canUseWebAudio: boolean;
  31545. /**
  31546. * The master gain node defines the global audio volume of your audio engine.
  31547. */
  31548. masterGain: GainNode;
  31549. /**
  31550. * Defines if Babylon should emit a warning if WebAudio is not supported.
  31551. * @ignoreNaming
  31552. */
  31553. WarnedWebAudioUnsupported: boolean;
  31554. /**
  31555. * Gets whether or not mp3 are supported by your browser.
  31556. */
  31557. isMP3supported: boolean;
  31558. /**
  31559. * Gets whether or not ogg are supported by your browser.
  31560. */
  31561. isOGGsupported: boolean;
  31562. /**
  31563. * Gets whether audio has been unlocked on the device.
  31564. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  31565. * a user interaction has happened.
  31566. */
  31567. unlocked: boolean;
  31568. /**
  31569. * Defines if the audio engine relies on a custom unlocked button.
  31570. * In this case, the embedded button will not be displayed.
  31571. */
  31572. useCustomUnlockedButton: boolean;
  31573. /**
  31574. * Event raised when audio has been unlocked on the browser.
  31575. */
  31576. onAudioUnlockedObservable: Observable<AudioEngine>;
  31577. /**
  31578. * Event raised when audio has been locked on the browser.
  31579. */
  31580. onAudioLockedObservable: Observable<AudioEngine>;
  31581. /**
  31582. * Gets the current AudioContext if available.
  31583. */
  31584. readonly audioContext: Nullable<AudioContext>;
  31585. private _connectedAnalyser;
  31586. /**
  31587. * Instantiates a new audio engine.
  31588. *
  31589. * There should be only one per page as some browsers restrict the number
  31590. * of audio contexts you can create.
  31591. * @param hostElement defines the host element where to display the mute icon if necessary
  31592. */
  31593. constructor(hostElement?: Nullable<HTMLElement>);
  31594. /**
  31595. * Flags the audio engine in Locked state.
  31596. * This happens due to new browser policies preventing audio to autoplay.
  31597. */
  31598. lock(): void;
  31599. /**
  31600. * Unlocks the audio engine once a user action has been done on the dom.
  31601. * This is helpful to resume play once browser policies have been satisfied.
  31602. */
  31603. unlock(): void;
  31604. private _resumeAudioContext;
  31605. private _initializeAudioContext;
  31606. private _tryToRun;
  31607. private _triggerRunningState;
  31608. private _triggerSuspendedState;
  31609. private _displayMuteButton;
  31610. private _moveButtonToTopLeft;
  31611. private _onResize;
  31612. private _hideMuteButton;
  31613. /**
  31614. * Destroy and release the resources associated with the audio ccontext.
  31615. */
  31616. dispose(): void;
  31617. /**
  31618. * Gets the global volume sets on the master gain.
  31619. * @returns the global volume if set or -1 otherwise
  31620. */
  31621. getGlobalVolume(): number;
  31622. /**
  31623. * Sets the global volume of your experience (sets on the master gain).
  31624. * @param newVolume Defines the new global volume of the application
  31625. */
  31626. setGlobalVolume(newVolume: number): void;
  31627. /**
  31628. * Connect the audio engine to an audio analyser allowing some amazing
  31629. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  31630. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  31631. * @param analyser The analyser to connect to the engine
  31632. */
  31633. connectToAnalyser(analyser: Analyser): void;
  31634. }
  31635. }
  31636. declare module "babylonjs/Loading/loadingScreen" {
  31637. /**
  31638. * Interface used to present a loading screen while loading a scene
  31639. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  31640. */
  31641. export interface ILoadingScreen {
  31642. /**
  31643. * Function called to display the loading screen
  31644. */
  31645. displayLoadingUI: () => void;
  31646. /**
  31647. * Function called to hide the loading screen
  31648. */
  31649. hideLoadingUI: () => void;
  31650. /**
  31651. * Gets or sets the color to use for the background
  31652. */
  31653. loadingUIBackgroundColor: string;
  31654. /**
  31655. * Gets or sets the text to display while loading
  31656. */
  31657. loadingUIText: string;
  31658. }
  31659. /**
  31660. * Class used for the default loading screen
  31661. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  31662. */
  31663. export class DefaultLoadingScreen implements ILoadingScreen {
  31664. private _renderingCanvas;
  31665. private _loadingText;
  31666. private _loadingDivBackgroundColor;
  31667. private _loadingDiv;
  31668. private _loadingTextDiv;
  31669. /** Gets or sets the logo url to use for the default loading screen */
  31670. static DefaultLogoUrl: string;
  31671. /** Gets or sets the spinner url to use for the default loading screen */
  31672. static DefaultSpinnerUrl: string;
  31673. /**
  31674. * Creates a new default loading screen
  31675. * @param _renderingCanvas defines the canvas used to render the scene
  31676. * @param _loadingText defines the default text to display
  31677. * @param _loadingDivBackgroundColor defines the default background color
  31678. */
  31679. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  31680. /**
  31681. * Function called to display the loading screen
  31682. */
  31683. displayLoadingUI(): void;
  31684. /**
  31685. * Function called to hide the loading screen
  31686. */
  31687. hideLoadingUI(): void;
  31688. /**
  31689. * Gets or sets the text to display while loading
  31690. */
  31691. loadingUIText: string;
  31692. /**
  31693. * Gets or sets the color to use for the background
  31694. */
  31695. loadingUIBackgroundColor: string;
  31696. private _resizeLoadingUI;
  31697. }
  31698. }
  31699. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  31700. /**
  31701. * Interface for any object that can request an animation frame
  31702. */
  31703. export interface ICustomAnimationFrameRequester {
  31704. /**
  31705. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  31706. */
  31707. renderFunction?: Function;
  31708. /**
  31709. * Called to request the next frame to render to
  31710. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  31711. */
  31712. requestAnimationFrame: Function;
  31713. /**
  31714. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  31715. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  31716. */
  31717. requestID?: number;
  31718. }
  31719. }
  31720. declare module "babylonjs/Misc/performanceMonitor" {
  31721. /**
  31722. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  31723. */
  31724. export class PerformanceMonitor {
  31725. private _enabled;
  31726. private _rollingFrameTime;
  31727. private _lastFrameTimeMs;
  31728. /**
  31729. * constructor
  31730. * @param frameSampleSize The number of samples required to saturate the sliding window
  31731. */
  31732. constructor(frameSampleSize?: number);
  31733. /**
  31734. * Samples current frame
  31735. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  31736. */
  31737. sampleFrame(timeMs?: number): void;
  31738. /**
  31739. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  31740. */
  31741. readonly averageFrameTime: number;
  31742. /**
  31743. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  31744. */
  31745. readonly averageFrameTimeVariance: number;
  31746. /**
  31747. * Returns the frame time of the most recent frame
  31748. */
  31749. readonly instantaneousFrameTime: number;
  31750. /**
  31751. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  31752. */
  31753. readonly averageFPS: number;
  31754. /**
  31755. * Returns the average framerate in frames per second using the most recent frame time
  31756. */
  31757. readonly instantaneousFPS: number;
  31758. /**
  31759. * Returns true if enough samples have been taken to completely fill the sliding window
  31760. */
  31761. readonly isSaturated: boolean;
  31762. /**
  31763. * Enables contributions to the sliding window sample set
  31764. */
  31765. enable(): void;
  31766. /**
  31767. * Disables contributions to the sliding window sample set
  31768. * Samples will not be interpolated over the disabled period
  31769. */
  31770. disable(): void;
  31771. /**
  31772. * Returns true if sampling is enabled
  31773. */
  31774. readonly isEnabled: boolean;
  31775. /**
  31776. * Resets performance monitor
  31777. */
  31778. reset(): void;
  31779. }
  31780. /**
  31781. * RollingAverage
  31782. *
  31783. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  31784. */
  31785. export class RollingAverage {
  31786. /**
  31787. * Current average
  31788. */
  31789. average: number;
  31790. /**
  31791. * Current variance
  31792. */
  31793. variance: number;
  31794. protected _samples: Array<number>;
  31795. protected _sampleCount: number;
  31796. protected _pos: number;
  31797. protected _m2: number;
  31798. /**
  31799. * constructor
  31800. * @param length The number of samples required to saturate the sliding window
  31801. */
  31802. constructor(length: number);
  31803. /**
  31804. * Adds a sample to the sample set
  31805. * @param v The sample value
  31806. */
  31807. add(v: number): void;
  31808. /**
  31809. * Returns previously added values or null if outside of history or outside the sliding window domain
  31810. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  31811. * @return Value previously recorded with add() or null if outside of range
  31812. */
  31813. history(i: number): number;
  31814. /**
  31815. * Returns true if enough samples have been taken to completely fill the sliding window
  31816. * @return true if sample-set saturated
  31817. */
  31818. isSaturated(): boolean;
  31819. /**
  31820. * Resets the rolling average (equivalent to 0 samples taken so far)
  31821. */
  31822. reset(): void;
  31823. /**
  31824. * Wraps a value around the sample range boundaries
  31825. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  31826. * @return Wrapped position in sample range
  31827. */
  31828. protected _wrapPosition(i: number): number;
  31829. }
  31830. }
  31831. declare module "babylonjs/Misc/perfCounter" {
  31832. /**
  31833. * This class is used to track a performance counter which is number based.
  31834. * The user has access to many properties which give statistics of different nature.
  31835. *
  31836. * The implementer can track two kinds of Performance Counter: time and count.
  31837. * 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.
  31838. * 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.
  31839. */
  31840. export class PerfCounter {
  31841. /**
  31842. * Gets or sets a global boolean to turn on and off all the counters
  31843. */
  31844. static Enabled: boolean;
  31845. /**
  31846. * Returns the smallest value ever
  31847. */
  31848. readonly min: number;
  31849. /**
  31850. * Returns the biggest value ever
  31851. */
  31852. readonly max: number;
  31853. /**
  31854. * Returns the average value since the performance counter is running
  31855. */
  31856. readonly average: number;
  31857. /**
  31858. * Returns the average value of the last second the counter was monitored
  31859. */
  31860. readonly lastSecAverage: number;
  31861. /**
  31862. * Returns the current value
  31863. */
  31864. readonly current: number;
  31865. /**
  31866. * Gets the accumulated total
  31867. */
  31868. readonly total: number;
  31869. /**
  31870. * Gets the total value count
  31871. */
  31872. readonly count: number;
  31873. /**
  31874. * Creates a new counter
  31875. */
  31876. constructor();
  31877. /**
  31878. * Call this method to start monitoring a new frame.
  31879. * 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.
  31880. */
  31881. fetchNewFrame(): void;
  31882. /**
  31883. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  31884. * @param newCount the count value to add to the monitored count
  31885. * @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.
  31886. */
  31887. addCount(newCount: number, fetchResult: boolean): void;
  31888. /**
  31889. * Start monitoring this performance counter
  31890. */
  31891. beginMonitoring(): void;
  31892. /**
  31893. * Compute the time lapsed since the previous beginMonitoring() call.
  31894. * @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
  31895. */
  31896. endMonitoring(newFrame?: boolean): void;
  31897. private _fetchResult;
  31898. private _startMonitoringTime;
  31899. private _min;
  31900. private _max;
  31901. private _average;
  31902. private _current;
  31903. private _totalValueCount;
  31904. private _totalAccumulated;
  31905. private _lastSecAverage;
  31906. private _lastSecAccumulated;
  31907. private _lastSecTime;
  31908. private _lastSecValueCount;
  31909. }
  31910. }
  31911. declare module "babylonjs/Engines/engine" {
  31912. import { Observable } from "babylonjs/Misc/observable";
  31913. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  31914. import { Scene } from "babylonjs/scene";
  31915. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  31916. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  31917. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  31918. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  31919. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  31920. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  31921. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  31922. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  31923. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  31924. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31925. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  31926. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  31927. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  31928. import { Material } from "babylonjs/Materials/material";
  31929. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  31930. /**
  31931. * Defines the interface used by display changed events
  31932. */
  31933. export interface IDisplayChangedEventArgs {
  31934. /** Gets the vrDisplay object (if any) */
  31935. vrDisplay: Nullable<any>;
  31936. /** Gets a boolean indicating if webVR is supported */
  31937. vrSupported: boolean;
  31938. }
  31939. /**
  31940. * Defines the interface used by objects containing a viewport (like a camera)
  31941. */
  31942. interface IViewportOwnerLike {
  31943. /**
  31944. * Gets or sets the viewport
  31945. */
  31946. viewport: IViewportLike;
  31947. }
  31948. /**
  31949. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  31950. */
  31951. export class Engine extends ThinEngine {
  31952. /** Defines that alpha blending is disabled */
  31953. static readonly ALPHA_DISABLE: number;
  31954. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  31955. static readonly ALPHA_ADD: number;
  31956. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  31957. static readonly ALPHA_COMBINE: number;
  31958. /** Defines that alpha blending to DEST - SRC * DEST */
  31959. static readonly ALPHA_SUBTRACT: number;
  31960. /** Defines that alpha blending to SRC * DEST */
  31961. static readonly ALPHA_MULTIPLY: number;
  31962. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  31963. static readonly ALPHA_MAXIMIZED: number;
  31964. /** Defines that alpha blending to SRC + DEST */
  31965. static readonly ALPHA_ONEONE: number;
  31966. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  31967. static readonly ALPHA_PREMULTIPLIED: number;
  31968. /**
  31969. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  31970. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  31971. */
  31972. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  31973. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  31974. static readonly ALPHA_INTERPOLATE: number;
  31975. /**
  31976. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  31977. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  31978. */
  31979. static readonly ALPHA_SCREENMODE: number;
  31980. /** Defines that the ressource is not delayed*/
  31981. static readonly DELAYLOADSTATE_NONE: number;
  31982. /** Defines that the ressource was successfully delay loaded */
  31983. static readonly DELAYLOADSTATE_LOADED: number;
  31984. /** Defines that the ressource is currently delay loading */
  31985. static readonly DELAYLOADSTATE_LOADING: number;
  31986. /** Defines that the ressource is delayed and has not started loading */
  31987. static readonly DELAYLOADSTATE_NOTLOADED: number;
  31988. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  31989. static readonly NEVER: number;
  31990. /** 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 */
  31991. static readonly ALWAYS: number;
  31992. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  31993. static readonly LESS: number;
  31994. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  31995. static readonly EQUAL: number;
  31996. /** 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 */
  31997. static readonly LEQUAL: number;
  31998. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  31999. static readonly GREATER: number;
  32000. /** 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 */
  32001. static readonly GEQUAL: number;
  32002. /** 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 */
  32003. static readonly NOTEQUAL: number;
  32004. /** Passed to stencilOperation to specify that stencil value must be kept */
  32005. static readonly KEEP: number;
  32006. /** Passed to stencilOperation to specify that stencil value must be replaced */
  32007. static readonly REPLACE: number;
  32008. /** Passed to stencilOperation to specify that stencil value must be incremented */
  32009. static readonly INCR: number;
  32010. /** Passed to stencilOperation to specify that stencil value must be decremented */
  32011. static readonly DECR: number;
  32012. /** Passed to stencilOperation to specify that stencil value must be inverted */
  32013. static readonly INVERT: number;
  32014. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  32015. static readonly INCR_WRAP: number;
  32016. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  32017. static readonly DECR_WRAP: number;
  32018. /** Texture is not repeating outside of 0..1 UVs */
  32019. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  32020. /** Texture is repeating outside of 0..1 UVs */
  32021. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  32022. /** Texture is repeating and mirrored */
  32023. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  32024. /** ALPHA */
  32025. static readonly TEXTUREFORMAT_ALPHA: number;
  32026. /** LUMINANCE */
  32027. static readonly TEXTUREFORMAT_LUMINANCE: number;
  32028. /** LUMINANCE_ALPHA */
  32029. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  32030. /** RGB */
  32031. static readonly TEXTUREFORMAT_RGB: number;
  32032. /** RGBA */
  32033. static readonly TEXTUREFORMAT_RGBA: number;
  32034. /** RED */
  32035. static readonly TEXTUREFORMAT_RED: number;
  32036. /** RED (2nd reference) */
  32037. static readonly TEXTUREFORMAT_R: number;
  32038. /** RG */
  32039. static readonly TEXTUREFORMAT_RG: number;
  32040. /** RED_INTEGER */
  32041. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  32042. /** RED_INTEGER (2nd reference) */
  32043. static readonly TEXTUREFORMAT_R_INTEGER: number;
  32044. /** RG_INTEGER */
  32045. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  32046. /** RGB_INTEGER */
  32047. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  32048. /** RGBA_INTEGER */
  32049. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  32050. /** UNSIGNED_BYTE */
  32051. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  32052. /** UNSIGNED_BYTE (2nd reference) */
  32053. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  32054. /** FLOAT */
  32055. static readonly TEXTURETYPE_FLOAT: number;
  32056. /** HALF_FLOAT */
  32057. static readonly TEXTURETYPE_HALF_FLOAT: number;
  32058. /** BYTE */
  32059. static readonly TEXTURETYPE_BYTE: number;
  32060. /** SHORT */
  32061. static readonly TEXTURETYPE_SHORT: number;
  32062. /** UNSIGNED_SHORT */
  32063. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  32064. /** INT */
  32065. static readonly TEXTURETYPE_INT: number;
  32066. /** UNSIGNED_INT */
  32067. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  32068. /** UNSIGNED_SHORT_4_4_4_4 */
  32069. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  32070. /** UNSIGNED_SHORT_5_5_5_1 */
  32071. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  32072. /** UNSIGNED_SHORT_5_6_5 */
  32073. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  32074. /** UNSIGNED_INT_2_10_10_10_REV */
  32075. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  32076. /** UNSIGNED_INT_24_8 */
  32077. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  32078. /** UNSIGNED_INT_10F_11F_11F_REV */
  32079. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  32080. /** UNSIGNED_INT_5_9_9_9_REV */
  32081. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  32082. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  32083. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  32084. /** nearest is mag = nearest and min = nearest and mip = linear */
  32085. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  32086. /** Bilinear is mag = linear and min = linear and mip = nearest */
  32087. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  32088. /** Trilinear is mag = linear and min = linear and mip = linear */
  32089. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  32090. /** nearest is mag = nearest and min = nearest and mip = linear */
  32091. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  32092. /** Bilinear is mag = linear and min = linear and mip = nearest */
  32093. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  32094. /** Trilinear is mag = linear and min = linear and mip = linear */
  32095. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  32096. /** mag = nearest and min = nearest and mip = nearest */
  32097. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  32098. /** mag = nearest and min = linear and mip = nearest */
  32099. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  32100. /** mag = nearest and min = linear and mip = linear */
  32101. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  32102. /** mag = nearest and min = linear and mip = none */
  32103. static readonly TEXTURE_NEAREST_LINEAR: number;
  32104. /** mag = nearest and min = nearest and mip = none */
  32105. static readonly TEXTURE_NEAREST_NEAREST: number;
  32106. /** mag = linear and min = nearest and mip = nearest */
  32107. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  32108. /** mag = linear and min = nearest and mip = linear */
  32109. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  32110. /** mag = linear and min = linear and mip = none */
  32111. static readonly TEXTURE_LINEAR_LINEAR: number;
  32112. /** mag = linear and min = nearest and mip = none */
  32113. static readonly TEXTURE_LINEAR_NEAREST: number;
  32114. /** Explicit coordinates mode */
  32115. static readonly TEXTURE_EXPLICIT_MODE: number;
  32116. /** Spherical coordinates mode */
  32117. static readonly TEXTURE_SPHERICAL_MODE: number;
  32118. /** Planar coordinates mode */
  32119. static readonly TEXTURE_PLANAR_MODE: number;
  32120. /** Cubic coordinates mode */
  32121. static readonly TEXTURE_CUBIC_MODE: number;
  32122. /** Projection coordinates mode */
  32123. static readonly TEXTURE_PROJECTION_MODE: number;
  32124. /** Skybox coordinates mode */
  32125. static readonly TEXTURE_SKYBOX_MODE: number;
  32126. /** Inverse Cubic coordinates mode */
  32127. static readonly TEXTURE_INVCUBIC_MODE: number;
  32128. /** Equirectangular coordinates mode */
  32129. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  32130. /** Equirectangular Fixed coordinates mode */
  32131. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  32132. /** Equirectangular Fixed Mirrored coordinates mode */
  32133. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  32134. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  32135. static readonly SCALEMODE_FLOOR: number;
  32136. /** Defines that texture rescaling will look for the nearest power of 2 size */
  32137. static readonly SCALEMODE_NEAREST: number;
  32138. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  32139. static readonly SCALEMODE_CEILING: number;
  32140. /**
  32141. * Returns the current npm package of the sdk
  32142. */
  32143. static readonly NpmPackage: string;
  32144. /**
  32145. * Returns the current version of the framework
  32146. */
  32147. static readonly Version: string;
  32148. /** Gets the list of created engines */
  32149. static readonly Instances: Engine[];
  32150. /**
  32151. * Gets the latest created engine
  32152. */
  32153. static readonly LastCreatedEngine: Nullable<Engine>;
  32154. /**
  32155. * Gets the latest created scene
  32156. */
  32157. static readonly LastCreatedScene: Nullable<Scene>;
  32158. /**
  32159. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  32160. * @param flag defines which part of the materials must be marked as dirty
  32161. * @param predicate defines a predicate used to filter which materials should be affected
  32162. */
  32163. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  32164. /**
  32165. * Method called to create the default loading screen.
  32166. * This can be overriden in your own app.
  32167. * @param canvas The rendering canvas element
  32168. * @returns The loading screen
  32169. */
  32170. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  32171. /**
  32172. * Method called to create the default rescale post process on each engine.
  32173. */
  32174. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  32175. /**
  32176. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  32177. **/
  32178. enableOfflineSupport: boolean;
  32179. /**
  32180. * 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)
  32181. **/
  32182. disableManifestCheck: boolean;
  32183. /**
  32184. * Gets the list of created scenes
  32185. */
  32186. scenes: Scene[];
  32187. /**
  32188. * Event raised when a new scene is created
  32189. */
  32190. onNewSceneAddedObservable: Observable<Scene>;
  32191. /**
  32192. * Gets the list of created postprocesses
  32193. */
  32194. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  32195. /**
  32196. * Gets a boolean indicating if the pointer is currently locked
  32197. */
  32198. isPointerLock: boolean;
  32199. /**
  32200. * Observable event triggered each time the rendering canvas is resized
  32201. */
  32202. onResizeObservable: Observable<Engine>;
  32203. /**
  32204. * Observable event triggered each time the canvas loses focus
  32205. */
  32206. onCanvasBlurObservable: Observable<Engine>;
  32207. /**
  32208. * Observable event triggered each time the canvas gains focus
  32209. */
  32210. onCanvasFocusObservable: Observable<Engine>;
  32211. /**
  32212. * Observable event triggered each time the canvas receives pointerout event
  32213. */
  32214. onCanvasPointerOutObservable: Observable<PointerEvent>;
  32215. /**
  32216. * Observable raised when the engine begins a new frame
  32217. */
  32218. onBeginFrameObservable: Observable<Engine>;
  32219. /**
  32220. * If set, will be used to request the next animation frame for the render loop
  32221. */
  32222. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  32223. /**
  32224. * Observable raised when the engine ends the current frame
  32225. */
  32226. onEndFrameObservable: Observable<Engine>;
  32227. /**
  32228. * Observable raised when the engine is about to compile a shader
  32229. */
  32230. onBeforeShaderCompilationObservable: Observable<Engine>;
  32231. /**
  32232. * Observable raised when the engine has jsut compiled a shader
  32233. */
  32234. onAfterShaderCompilationObservable: Observable<Engine>;
  32235. /**
  32236. * Gets the audio engine
  32237. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  32238. * @ignorenaming
  32239. */
  32240. static audioEngine: IAudioEngine;
  32241. /**
  32242. * Default AudioEngine factory responsible of creating the Audio Engine.
  32243. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  32244. */
  32245. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  32246. /**
  32247. * Default offline support factory responsible of creating a tool used to store data locally.
  32248. * By default, this will create a Database object if the workload has been embedded.
  32249. */
  32250. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  32251. private _loadingScreen;
  32252. private _pointerLockRequested;
  32253. private _dummyFramebuffer;
  32254. private _rescalePostProcess;
  32255. /** @hidden */
  32256. protected _alphaMode: number;
  32257. /** @hidden */
  32258. protected _alphaEquation: number;
  32259. private _deterministicLockstep;
  32260. private _lockstepMaxSteps;
  32261. protected readonly _supportsHardwareTextureRescaling: boolean;
  32262. private _fps;
  32263. private _deltaTime;
  32264. /** @hidden */
  32265. _drawCalls: PerfCounter;
  32266. /**
  32267. * Turn this value on if you want to pause FPS computation when in background
  32268. */
  32269. disablePerformanceMonitorInBackground: boolean;
  32270. private _performanceMonitor;
  32271. /**
  32272. * Gets the performance monitor attached to this engine
  32273. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  32274. */
  32275. readonly performanceMonitor: PerformanceMonitor;
  32276. private _onFocus;
  32277. private _onBlur;
  32278. private _onCanvasPointerOut;
  32279. private _onCanvasBlur;
  32280. private _onCanvasFocus;
  32281. private _onFullscreenChange;
  32282. private _onPointerLockChange;
  32283. /**
  32284. * Creates a new engine
  32285. * @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
  32286. * @param antialias defines enable antialiasing (default: false)
  32287. * @param options defines further options to be sent to the getContext() function
  32288. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  32289. */
  32290. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  32291. /**
  32292. * Gets current aspect ratio
  32293. * @param viewportOwner defines the camera to use to get the aspect ratio
  32294. * @param useScreen defines if screen size must be used (or the current render target if any)
  32295. * @returns a number defining the aspect ratio
  32296. */
  32297. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  32298. /**
  32299. * Gets current screen aspect ratio
  32300. * @returns a number defining the aspect ratio
  32301. */
  32302. getScreenAspectRatio(): number;
  32303. /**
  32304. * Gets host document
  32305. * @returns the host document object
  32306. */
  32307. getHostDocument(): Document;
  32308. /**
  32309. * Gets the client rect of the HTML canvas attached with the current webGL context
  32310. * @returns a client rectanglee
  32311. */
  32312. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  32313. /**
  32314. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  32315. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  32316. * @returns true if engine is in deterministic lock step mode
  32317. */
  32318. isDeterministicLockStep(): boolean;
  32319. /**
  32320. * Gets the max steps when engine is running in deterministic lock step
  32321. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  32322. * @returns the max steps
  32323. */
  32324. getLockstepMaxSteps(): number;
  32325. /**
  32326. * Force the mipmap generation for the given render target texture
  32327. * @param texture defines the render target texture to use
  32328. */
  32329. generateMipMapsForCubemap(texture: InternalTexture): void;
  32330. /** States */
  32331. /**
  32332. * Set various states to the webGL context
  32333. * @param culling defines backface culling state
  32334. * @param zOffset defines the value to apply to zOffset (0 by default)
  32335. * @param force defines if states must be applied even if cache is up to date
  32336. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  32337. */
  32338. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  32339. /**
  32340. * Set the z offset to apply to current rendering
  32341. * @param value defines the offset to apply
  32342. */
  32343. setZOffset(value: number): void;
  32344. /**
  32345. * Gets the current value of the zOffset
  32346. * @returns the current zOffset state
  32347. */
  32348. getZOffset(): number;
  32349. /**
  32350. * Enable or disable depth buffering
  32351. * @param enable defines the state to set
  32352. */
  32353. setDepthBuffer(enable: boolean): void;
  32354. /**
  32355. * Gets a boolean indicating if depth writing is enabled
  32356. * @returns the current depth writing state
  32357. */
  32358. getDepthWrite(): boolean;
  32359. /**
  32360. * Enable or disable depth writing
  32361. * @param enable defines the state to set
  32362. */
  32363. setDepthWrite(enable: boolean): void;
  32364. /**
  32365. * Enable or disable color writing
  32366. * @param enable defines the state to set
  32367. */
  32368. setColorWrite(enable: boolean): void;
  32369. /**
  32370. * Gets a boolean indicating if color writing is enabled
  32371. * @returns the current color writing state
  32372. */
  32373. getColorWrite(): boolean;
  32374. /**
  32375. * Sets alpha constants used by some alpha blending modes
  32376. * @param r defines the red component
  32377. * @param g defines the green component
  32378. * @param b defines the blue component
  32379. * @param a defines the alpha component
  32380. */
  32381. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  32382. /**
  32383. * Sets the current alpha mode
  32384. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  32385. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  32386. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32387. */
  32388. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  32389. /**
  32390. * Gets the current alpha mode
  32391. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32392. * @returns the current alpha mode
  32393. */
  32394. getAlphaMode(): number;
  32395. /**
  32396. * Sets the current alpha equation
  32397. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  32398. */
  32399. setAlphaEquation(equation: number): void;
  32400. /**
  32401. * Gets the current alpha equation.
  32402. * @returns the current alpha equation
  32403. */
  32404. getAlphaEquation(): number;
  32405. /**
  32406. * Gets a boolean indicating if stencil buffer is enabled
  32407. * @returns the current stencil buffer state
  32408. */
  32409. getStencilBuffer(): boolean;
  32410. /**
  32411. * Enable or disable the stencil buffer
  32412. * @param enable defines if the stencil buffer must be enabled or disabled
  32413. */
  32414. setStencilBuffer(enable: boolean): void;
  32415. /**
  32416. * Gets the current stencil mask
  32417. * @returns a number defining the new stencil mask to use
  32418. */
  32419. getStencilMask(): number;
  32420. /**
  32421. * Sets the current stencil mask
  32422. * @param mask defines the new stencil mask to use
  32423. */
  32424. setStencilMask(mask: number): void;
  32425. /**
  32426. * Gets the current stencil function
  32427. * @returns a number defining the stencil function to use
  32428. */
  32429. getStencilFunction(): number;
  32430. /**
  32431. * Gets the current stencil reference value
  32432. * @returns a number defining the stencil reference value to use
  32433. */
  32434. getStencilFunctionReference(): number;
  32435. /**
  32436. * Gets the current stencil mask
  32437. * @returns a number defining the stencil mask to use
  32438. */
  32439. getStencilFunctionMask(): number;
  32440. /**
  32441. * Sets the current stencil function
  32442. * @param stencilFunc defines the new stencil function to use
  32443. */
  32444. setStencilFunction(stencilFunc: number): void;
  32445. /**
  32446. * Sets the current stencil reference
  32447. * @param reference defines the new stencil reference to use
  32448. */
  32449. setStencilFunctionReference(reference: number): void;
  32450. /**
  32451. * Sets the current stencil mask
  32452. * @param mask defines the new stencil mask to use
  32453. */
  32454. setStencilFunctionMask(mask: number): void;
  32455. /**
  32456. * Gets the current stencil operation when stencil fails
  32457. * @returns a number defining stencil operation to use when stencil fails
  32458. */
  32459. getStencilOperationFail(): number;
  32460. /**
  32461. * Gets the current stencil operation when depth fails
  32462. * @returns a number defining stencil operation to use when depth fails
  32463. */
  32464. getStencilOperationDepthFail(): number;
  32465. /**
  32466. * Gets the current stencil operation when stencil passes
  32467. * @returns a number defining stencil operation to use when stencil passes
  32468. */
  32469. getStencilOperationPass(): number;
  32470. /**
  32471. * Sets the stencil operation to use when stencil fails
  32472. * @param operation defines the stencil operation to use when stencil fails
  32473. */
  32474. setStencilOperationFail(operation: number): void;
  32475. /**
  32476. * Sets the stencil operation to use when depth fails
  32477. * @param operation defines the stencil operation to use when depth fails
  32478. */
  32479. setStencilOperationDepthFail(operation: number): void;
  32480. /**
  32481. * Sets the stencil operation to use when stencil passes
  32482. * @param operation defines the stencil operation to use when stencil passes
  32483. */
  32484. setStencilOperationPass(operation: number): void;
  32485. /**
  32486. * Sets a boolean indicating if the dithering state is enabled or disabled
  32487. * @param value defines the dithering state
  32488. */
  32489. setDitheringState(value: boolean): void;
  32490. /**
  32491. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  32492. * @param value defines the rasterizer state
  32493. */
  32494. setRasterizerState(value: boolean): void;
  32495. /**
  32496. * Gets the current depth function
  32497. * @returns a number defining the depth function
  32498. */
  32499. getDepthFunction(): Nullable<number>;
  32500. /**
  32501. * Sets the current depth function
  32502. * @param depthFunc defines the function to use
  32503. */
  32504. setDepthFunction(depthFunc: number): void;
  32505. /**
  32506. * Sets the current depth function to GREATER
  32507. */
  32508. setDepthFunctionToGreater(): void;
  32509. /**
  32510. * Sets the current depth function to GEQUAL
  32511. */
  32512. setDepthFunctionToGreaterOrEqual(): void;
  32513. /**
  32514. * Sets the current depth function to LESS
  32515. */
  32516. setDepthFunctionToLess(): void;
  32517. /**
  32518. * Sets the current depth function to LEQUAL
  32519. */
  32520. setDepthFunctionToLessOrEqual(): void;
  32521. private _cachedStencilBuffer;
  32522. private _cachedStencilFunction;
  32523. private _cachedStencilMask;
  32524. private _cachedStencilOperationPass;
  32525. private _cachedStencilOperationFail;
  32526. private _cachedStencilOperationDepthFail;
  32527. private _cachedStencilReference;
  32528. /**
  32529. * Caches the the state of the stencil buffer
  32530. */
  32531. cacheStencilState(): void;
  32532. /**
  32533. * Restores the state of the stencil buffer
  32534. */
  32535. restoreStencilState(): void;
  32536. /**
  32537. * Directly set the WebGL Viewport
  32538. * @param x defines the x coordinate of the viewport (in screen space)
  32539. * @param y defines the y coordinate of the viewport (in screen space)
  32540. * @param width defines the width of the viewport (in screen space)
  32541. * @param height defines the height of the viewport (in screen space)
  32542. * @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
  32543. */
  32544. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  32545. /**
  32546. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  32547. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  32548. * @param y defines the y-coordinate of the corner of the clear rectangle
  32549. * @param width defines the width of the clear rectangle
  32550. * @param height defines the height of the clear rectangle
  32551. * @param clearColor defines the clear color
  32552. */
  32553. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  32554. /**
  32555. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  32556. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  32557. * @param y defines the y-coordinate of the corner of the clear rectangle
  32558. * @param width defines the width of the clear rectangle
  32559. * @param height defines the height of the clear rectangle
  32560. */
  32561. enableScissor(x: number, y: number, width: number, height: number): void;
  32562. /**
  32563. * Disable previously set scissor test rectangle
  32564. */
  32565. disableScissor(): void;
  32566. protected _reportDrawCall(): void;
  32567. /**
  32568. * Initializes a webVR display and starts listening to display change events
  32569. * The onVRDisplayChangedObservable will be notified upon these changes
  32570. * @returns The onVRDisplayChangedObservable
  32571. */
  32572. initWebVR(): Observable<IDisplayChangedEventArgs>;
  32573. /** @hidden */
  32574. _prepareVRComponent(): void;
  32575. /** @hidden */
  32576. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  32577. /** @hidden */
  32578. _submitVRFrame(): void;
  32579. /**
  32580. * Call this function to leave webVR mode
  32581. * Will do nothing if webVR is not supported or if there is no webVR device
  32582. * @see http://doc.babylonjs.com/how_to/webvr_camera
  32583. */
  32584. disableVR(): void;
  32585. /**
  32586. * Gets a boolean indicating that the system is in VR mode and is presenting
  32587. * @returns true if VR mode is engaged
  32588. */
  32589. isVRPresenting(): boolean;
  32590. /** @hidden */
  32591. _requestVRFrame(): void;
  32592. /** @hidden */
  32593. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  32594. /**
  32595. * Gets the source code of the vertex shader associated with a specific webGL program
  32596. * @param program defines the program to use
  32597. * @returns a string containing the source code of the vertex shader associated with the program
  32598. */
  32599. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  32600. /**
  32601. * Gets the source code of the fragment shader associated with a specific webGL program
  32602. * @param program defines the program to use
  32603. * @returns a string containing the source code of the fragment shader associated with the program
  32604. */
  32605. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  32606. /**
  32607. * Reads pixels from the current frame buffer. Please note that this function can be slow
  32608. * @param x defines the x coordinate of the rectangle where pixels must be read
  32609. * @param y defines the y coordinate of the rectangle where pixels must be read
  32610. * @param width defines the width of the rectangle where pixels must be read
  32611. * @param height defines the height of the rectangle where pixels must be read
  32612. * @returns a Uint8Array containing RGBA colors
  32613. */
  32614. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  32615. /**
  32616. * Sets a depth stencil texture from a render target to the according uniform.
  32617. * @param channel The texture channel
  32618. * @param uniform The uniform to set
  32619. * @param texture The render target texture containing the depth stencil texture to apply
  32620. */
  32621. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  32622. /**
  32623. * Sets a texture to the webGL context from a postprocess
  32624. * @param channel defines the channel to use
  32625. * @param postProcess defines the source postprocess
  32626. */
  32627. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  32628. /**
  32629. * Binds the output of the passed in post process to the texture channel specified
  32630. * @param channel The channel the texture should be bound to
  32631. * @param postProcess The post process which's output should be bound
  32632. */
  32633. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  32634. /** @hidden */
  32635. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  32636. protected _rebuildBuffers(): void;
  32637. /** @hidden */
  32638. _renderFrame(): void;
  32639. _renderLoop(): void;
  32640. /** @hidden */
  32641. _renderViews(): void;
  32642. /**
  32643. * Toggle full screen mode
  32644. * @param requestPointerLock defines if a pointer lock should be requested from the user
  32645. */
  32646. switchFullscreen(requestPointerLock: boolean): void;
  32647. /**
  32648. * Enters full screen mode
  32649. * @param requestPointerLock defines if a pointer lock should be requested from the user
  32650. */
  32651. enterFullscreen(requestPointerLock: boolean): void;
  32652. /**
  32653. * Exits full screen mode
  32654. */
  32655. exitFullscreen(): void;
  32656. /**
  32657. * Enters Pointerlock mode
  32658. */
  32659. enterPointerlock(): void;
  32660. /**
  32661. * Exits Pointerlock mode
  32662. */
  32663. exitPointerlock(): void;
  32664. /**
  32665. * Begin a new frame
  32666. */
  32667. beginFrame(): void;
  32668. /**
  32669. * Enf the current frame
  32670. */
  32671. endFrame(): void;
  32672. resize(): void;
  32673. /**
  32674. * Set the compressed texture format to use, based on the formats you have, and the formats
  32675. * supported by the hardware / browser.
  32676. *
  32677. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  32678. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  32679. * to API arguments needed to compressed textures. This puts the burden on the container
  32680. * generator to house the arcane code for determining these for current & future formats.
  32681. *
  32682. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  32683. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  32684. *
  32685. * Note: The result of this call is not taken into account when a texture is base64.
  32686. *
  32687. * @param formatsAvailable defines the list of those format families you have created
  32688. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  32689. *
  32690. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  32691. * @returns The extension selected.
  32692. */
  32693. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  32694. /**
  32695. * Force a specific size of the canvas
  32696. * @param width defines the new canvas' width
  32697. * @param height defines the new canvas' height
  32698. */
  32699. setSize(width: number, height: number): void;
  32700. /**
  32701. * Updates a dynamic vertex buffer.
  32702. * @param vertexBuffer the vertex buffer to update
  32703. * @param data the data used to update the vertex buffer
  32704. * @param byteOffset the byte offset of the data
  32705. * @param byteLength the byte length of the data
  32706. */
  32707. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  32708. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  32709. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  32710. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  32711. _releaseTexture(texture: InternalTexture): void;
  32712. /**
  32713. * @hidden
  32714. * Rescales a texture
  32715. * @param source input texutre
  32716. * @param destination destination texture
  32717. * @param scene scene to use to render the resize
  32718. * @param internalFormat format to use when resizing
  32719. * @param onComplete callback to be called when resize has completed
  32720. */
  32721. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  32722. /**
  32723. * Gets the current framerate
  32724. * @returns a number representing the framerate
  32725. */
  32726. getFps(): number;
  32727. /**
  32728. * Gets the time spent between current and previous frame
  32729. * @returns a number representing the delta time in ms
  32730. */
  32731. getDeltaTime(): number;
  32732. private _measureFps;
  32733. /** @hidden */
  32734. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  32735. /**
  32736. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  32737. * @param renderTarget The render target to set the frame buffer for
  32738. */
  32739. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  32740. /**
  32741. * Update a dynamic index buffer
  32742. * @param indexBuffer defines the target index buffer
  32743. * @param indices defines the data to update
  32744. * @param offset defines the offset in the target index buffer where update should start
  32745. */
  32746. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  32747. /**
  32748. * Updates the sample count of a render target texture
  32749. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  32750. * @param texture defines the texture to update
  32751. * @param samples defines the sample count to set
  32752. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  32753. */
  32754. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  32755. /**
  32756. * Updates a depth texture Comparison Mode and Function.
  32757. * If the comparison Function is equal to 0, the mode will be set to none.
  32758. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  32759. * @param texture The texture to set the comparison function for
  32760. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  32761. */
  32762. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  32763. /**
  32764. * Creates a webGL buffer to use with instanciation
  32765. * @param capacity defines the size of the buffer
  32766. * @returns the webGL buffer
  32767. */
  32768. createInstancesBuffer(capacity: number): DataBuffer;
  32769. /**
  32770. * Delete a webGL buffer used with instanciation
  32771. * @param buffer defines the webGL buffer to delete
  32772. */
  32773. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  32774. /** @hidden */
  32775. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  32776. dispose(): void;
  32777. private _disableTouchAction;
  32778. /**
  32779. * Display the loading screen
  32780. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32781. */
  32782. displayLoadingUI(): void;
  32783. /**
  32784. * Hide the loading screen
  32785. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32786. */
  32787. hideLoadingUI(): void;
  32788. /**
  32789. * Gets the current loading screen object
  32790. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32791. */
  32792. /**
  32793. * Sets the current loading screen object
  32794. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32795. */
  32796. loadingScreen: ILoadingScreen;
  32797. /**
  32798. * Sets the current loading screen text
  32799. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32800. */
  32801. loadingUIText: string;
  32802. /**
  32803. * Sets the current loading screen background color
  32804. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32805. */
  32806. loadingUIBackgroundColor: string;
  32807. /** Pointerlock and fullscreen */
  32808. /**
  32809. * Ask the browser to promote the current element to pointerlock mode
  32810. * @param element defines the DOM element to promote
  32811. */
  32812. static _RequestPointerlock(element: HTMLElement): void;
  32813. /**
  32814. * Asks the browser to exit pointerlock mode
  32815. */
  32816. static _ExitPointerlock(): void;
  32817. /**
  32818. * Ask the browser to promote the current element to fullscreen rendering mode
  32819. * @param element defines the DOM element to promote
  32820. */
  32821. static _RequestFullscreen(element: HTMLElement): void;
  32822. /**
  32823. * Asks the browser to exit fullscreen mode
  32824. */
  32825. static _ExitFullscreen(): void;
  32826. }
  32827. }
  32828. declare module "babylonjs/Engines/engineStore" {
  32829. import { Nullable } from "babylonjs/types";
  32830. import { Engine } from "babylonjs/Engines/engine";
  32831. import { Scene } from "babylonjs/scene";
  32832. /**
  32833. * The engine store class is responsible to hold all the instances of Engine and Scene created
  32834. * during the life time of the application.
  32835. */
  32836. export class EngineStore {
  32837. /** Gets the list of created engines */
  32838. static Instances: import("babylonjs/Engines/engine").Engine[];
  32839. /** @hidden */
  32840. static _LastCreatedScene: Nullable<Scene>;
  32841. /**
  32842. * Gets the latest created engine
  32843. */
  32844. static readonly LastCreatedEngine: Nullable<Engine>;
  32845. /**
  32846. * Gets the latest created scene
  32847. */
  32848. static readonly LastCreatedScene: Nullable<Scene>;
  32849. /**
  32850. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  32851. * @ignorenaming
  32852. */
  32853. static UseFallbackTexture: boolean;
  32854. /**
  32855. * Texture content used if a texture cannot loaded
  32856. * @ignorenaming
  32857. */
  32858. static FallbackTexture: string;
  32859. }
  32860. }
  32861. declare module "babylonjs/Misc/promise" {
  32862. /**
  32863. * Helper class that provides a small promise polyfill
  32864. */
  32865. export class PromisePolyfill {
  32866. /**
  32867. * Static function used to check if the polyfill is required
  32868. * If this is the case then the function will inject the polyfill to window.Promise
  32869. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  32870. */
  32871. static Apply(force?: boolean): void;
  32872. }
  32873. }
  32874. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  32875. /**
  32876. * Interface for screenshot methods with describe argument called `size` as object with options
  32877. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  32878. */
  32879. export interface IScreenshotSize {
  32880. /**
  32881. * number in pixels for canvas height
  32882. */
  32883. height?: number;
  32884. /**
  32885. * multiplier allowing render at a higher or lower resolution
  32886. * If value is defined then height and width will be ignored and taken from camera
  32887. */
  32888. precision?: number;
  32889. /**
  32890. * number in pixels for canvas width
  32891. */
  32892. width?: number;
  32893. }
  32894. }
  32895. declare module "babylonjs/Misc/tools" {
  32896. import { Nullable, float } from "babylonjs/types";
  32897. import { DomManagement } from "babylonjs/Misc/domManagement";
  32898. import { WebRequest } from "babylonjs/Misc/webRequest";
  32899. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  32900. import { ReadFileError } from "babylonjs/Misc/fileTools";
  32901. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  32902. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  32903. import { Camera } from "babylonjs/Cameras/camera";
  32904. import { Engine } from "babylonjs/Engines/engine";
  32905. interface IColor4Like {
  32906. r: float;
  32907. g: float;
  32908. b: float;
  32909. a: float;
  32910. }
  32911. /**
  32912. * Class containing a set of static utilities functions
  32913. */
  32914. export class Tools {
  32915. /**
  32916. * Gets or sets the base URL to use to load assets
  32917. */
  32918. static BaseUrl: string;
  32919. /**
  32920. * Enable/Disable Custom HTTP Request Headers globally.
  32921. * default = false
  32922. * @see CustomRequestHeaders
  32923. */
  32924. static UseCustomRequestHeaders: boolean;
  32925. /**
  32926. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  32927. * i.e. when loading files, where the server/service expects an Authorization header
  32928. */
  32929. static CustomRequestHeaders: {
  32930. [key: string]: string;
  32931. };
  32932. /**
  32933. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  32934. */
  32935. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  32936. /**
  32937. * Default behaviour for cors in the application.
  32938. * It can be a string if the expected behavior is identical in the entire app.
  32939. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  32940. */
  32941. static CorsBehavior: string | ((url: string | string[]) => string);
  32942. /**
  32943. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  32944. * @ignorenaming
  32945. */
  32946. static UseFallbackTexture: boolean;
  32947. /**
  32948. * Use this object to register external classes like custom textures or material
  32949. * to allow the laoders to instantiate them
  32950. */
  32951. static RegisteredExternalClasses: {
  32952. [key: string]: Object;
  32953. };
  32954. /**
  32955. * Texture content used if a texture cannot loaded
  32956. * @ignorenaming
  32957. */
  32958. static fallbackTexture: string;
  32959. /**
  32960. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  32961. * @param u defines the coordinate on X axis
  32962. * @param v defines the coordinate on Y axis
  32963. * @param width defines the width of the source data
  32964. * @param height defines the height of the source data
  32965. * @param pixels defines the source byte array
  32966. * @param color defines the output color
  32967. */
  32968. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  32969. /**
  32970. * Interpolates between a and b via alpha
  32971. * @param a The lower value (returned when alpha = 0)
  32972. * @param b The upper value (returned when alpha = 1)
  32973. * @param alpha The interpolation-factor
  32974. * @return The mixed value
  32975. */
  32976. static Mix(a: number, b: number, alpha: number): number;
  32977. /**
  32978. * Tries to instantiate a new object from a given class name
  32979. * @param className defines the class name to instantiate
  32980. * @returns the new object or null if the system was not able to do the instantiation
  32981. */
  32982. static Instantiate(className: string): any;
  32983. /**
  32984. * Provides a slice function that will work even on IE
  32985. * @param data defines the array to slice
  32986. * @param start defines the start of the data (optional)
  32987. * @param end defines the end of the data (optional)
  32988. * @returns the new sliced array
  32989. */
  32990. static Slice<T>(data: T, start?: number, end?: number): T;
  32991. /**
  32992. * Polyfill for setImmediate
  32993. * @param action defines the action to execute after the current execution block
  32994. */
  32995. static SetImmediate(action: () => void): void;
  32996. /**
  32997. * Function indicating if a number is an exponent of 2
  32998. * @param value defines the value to test
  32999. * @returns true if the value is an exponent of 2
  33000. */
  33001. static IsExponentOfTwo(value: number): boolean;
  33002. private static _tmpFloatArray;
  33003. /**
  33004. * Returns the nearest 32-bit single precision float representation of a Number
  33005. * @param value A Number. If the parameter is of a different type, it will get converted
  33006. * to a number or to NaN if it cannot be converted
  33007. * @returns number
  33008. */
  33009. static FloatRound(value: number): number;
  33010. /**
  33011. * Extracts the filename from a path
  33012. * @param path defines the path to use
  33013. * @returns the filename
  33014. */
  33015. static GetFilename(path: string): string;
  33016. /**
  33017. * Extracts the "folder" part of a path (everything before the filename).
  33018. * @param uri The URI to extract the info from
  33019. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  33020. * @returns The "folder" part of the path
  33021. */
  33022. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  33023. /**
  33024. * Extracts text content from a DOM element hierarchy
  33025. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  33026. */
  33027. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  33028. /**
  33029. * Convert an angle in radians to degrees
  33030. * @param angle defines the angle to convert
  33031. * @returns the angle in degrees
  33032. */
  33033. static ToDegrees(angle: number): number;
  33034. /**
  33035. * Convert an angle in degrees to radians
  33036. * @param angle defines the angle to convert
  33037. * @returns the angle in radians
  33038. */
  33039. static ToRadians(angle: number): number;
  33040. /**
  33041. * Returns an array if obj is not an array
  33042. * @param obj defines the object to evaluate as an array
  33043. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  33044. * @returns either obj directly if obj is an array or a new array containing obj
  33045. */
  33046. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  33047. /**
  33048. * Gets the pointer prefix to use
  33049. * @returns "pointer" if touch is enabled. Else returns "mouse"
  33050. */
  33051. static GetPointerPrefix(): string;
  33052. /**
  33053. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  33054. * @param url define the url we are trying
  33055. * @param element define the dom element where to configure the cors policy
  33056. */
  33057. static SetCorsBehavior(url: string | string[], element: {
  33058. crossOrigin: string | null;
  33059. }): void;
  33060. /**
  33061. * Removes unwanted characters from an url
  33062. * @param url defines the url to clean
  33063. * @returns the cleaned url
  33064. */
  33065. static CleanUrl(url: string): string;
  33066. /**
  33067. * Gets or sets a function used to pre-process url before using them to load assets
  33068. */
  33069. static PreprocessUrl: (url: string) => string;
  33070. /**
  33071. * Loads an image as an HTMLImageElement.
  33072. * @param input url string, ArrayBuffer, or Blob to load
  33073. * @param onLoad callback called when the image successfully loads
  33074. * @param onError callback called when the image fails to load
  33075. * @param offlineProvider offline provider for caching
  33076. * @param mimeType optional mime type
  33077. * @returns the HTMLImageElement of the loaded image
  33078. */
  33079. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  33080. /**
  33081. * Loads a file from a url
  33082. * @param url url string, ArrayBuffer, or Blob to load
  33083. * @param onSuccess callback called when the file successfully loads
  33084. * @param onProgress callback called while file is loading (if the server supports this mode)
  33085. * @param offlineProvider defines the offline provider for caching
  33086. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  33087. * @param onError callback called when the file fails to load
  33088. * @returns a file request object
  33089. */
  33090. 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;
  33091. /**
  33092. * Loads a file from a url
  33093. * @param url the file url to load
  33094. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  33095. */
  33096. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  33097. /**
  33098. * Load a script (identified by an url). When the url returns, the
  33099. * content of this file is added into a new script element, attached to the DOM (body element)
  33100. * @param scriptUrl defines the url of the script to laod
  33101. * @param onSuccess defines the callback called when the script is loaded
  33102. * @param onError defines the callback to call if an error occurs
  33103. * @param scriptId defines the id of the script element
  33104. */
  33105. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  33106. /**
  33107. * Load an asynchronous script (identified by an url). When the url returns, the
  33108. * content of this file is added into a new script element, attached to the DOM (body element)
  33109. * @param scriptUrl defines the url of the script to laod
  33110. * @param scriptId defines the id of the script element
  33111. * @returns a promise request object
  33112. */
  33113. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  33114. /**
  33115. * Loads a file from a blob
  33116. * @param fileToLoad defines the blob to use
  33117. * @param callback defines the callback to call when data is loaded
  33118. * @param progressCallback defines the callback to call during loading process
  33119. * @returns a file request object
  33120. */
  33121. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  33122. /**
  33123. * Reads a file from a File object
  33124. * @param file defines the file to load
  33125. * @param onSuccess defines the callback to call when data is loaded
  33126. * @param onProgress defines the callback to call during loading process
  33127. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  33128. * @param onError defines the callback to call when an error occurs
  33129. * @returns a file request object
  33130. */
  33131. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  33132. /**
  33133. * Creates a data url from a given string content
  33134. * @param content defines the content to convert
  33135. * @returns the new data url link
  33136. */
  33137. static FileAsURL(content: string): string;
  33138. /**
  33139. * Format the given number to a specific decimal format
  33140. * @param value defines the number to format
  33141. * @param decimals defines the number of decimals to use
  33142. * @returns the formatted string
  33143. */
  33144. static Format(value: number, decimals?: number): string;
  33145. /**
  33146. * Tries to copy an object by duplicating every property
  33147. * @param source defines the source object
  33148. * @param destination defines the target object
  33149. * @param doNotCopyList defines a list of properties to avoid
  33150. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  33151. */
  33152. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  33153. /**
  33154. * Gets a boolean indicating if the given object has no own property
  33155. * @param obj defines the object to test
  33156. * @returns true if object has no own property
  33157. */
  33158. static IsEmpty(obj: any): boolean;
  33159. /**
  33160. * Function used to register events at window level
  33161. * @param windowElement defines the Window object to use
  33162. * @param events defines the events to register
  33163. */
  33164. static RegisterTopRootEvents(windowElement: Window, events: {
  33165. name: string;
  33166. handler: Nullable<(e: FocusEvent) => any>;
  33167. }[]): void;
  33168. /**
  33169. * Function used to unregister events from window level
  33170. * @param windowElement defines the Window object to use
  33171. * @param events defines the events to unregister
  33172. */
  33173. static UnregisterTopRootEvents(windowElement: Window, events: {
  33174. name: string;
  33175. handler: Nullable<(e: FocusEvent) => any>;
  33176. }[]): void;
  33177. /**
  33178. * @ignore
  33179. */
  33180. static _ScreenshotCanvas: HTMLCanvasElement;
  33181. /**
  33182. * Dumps the current bound framebuffer
  33183. * @param width defines the rendering width
  33184. * @param height defines the rendering height
  33185. * @param engine defines the hosting engine
  33186. * @param successCallback defines the callback triggered once the data are available
  33187. * @param mimeType defines the mime type of the result
  33188. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  33189. */
  33190. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  33191. /**
  33192. * Converts the canvas data to blob.
  33193. * This acts as a polyfill for browsers not supporting the to blob function.
  33194. * @param canvas Defines the canvas to extract the data from
  33195. * @param successCallback Defines the callback triggered once the data are available
  33196. * @param mimeType Defines the mime type of the result
  33197. */
  33198. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  33199. /**
  33200. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  33201. * @param successCallback defines the callback triggered once the data are available
  33202. * @param mimeType defines the mime type of the result
  33203. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  33204. */
  33205. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  33206. /**
  33207. * Downloads a blob in the browser
  33208. * @param blob defines the blob to download
  33209. * @param fileName defines the name of the downloaded file
  33210. */
  33211. static Download(blob: Blob, fileName: string): void;
  33212. /**
  33213. * Captures a screenshot of the current rendering
  33214. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33215. * @param engine defines the rendering engine
  33216. * @param camera defines the source camera
  33217. * @param size This parameter can be set to a single number or to an object with the
  33218. * following (optional) properties: precision, width, height. If a single number is passed,
  33219. * it will be used for both width and height. If an object is passed, the screenshot size
  33220. * will be derived from the parameters. The precision property is a multiplier allowing
  33221. * rendering at a higher or lower resolution
  33222. * @param successCallback defines the callback receives a single parameter which contains the
  33223. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  33224. * src parameter of an <img> to display it
  33225. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  33226. * Check your browser for supported MIME types
  33227. */
  33228. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  33229. /**
  33230. * Captures a screenshot of the current rendering
  33231. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33232. * @param engine defines the rendering engine
  33233. * @param camera defines the source camera
  33234. * @param size This parameter can be set to a single number or to an object with the
  33235. * following (optional) properties: precision, width, height. If a single number is passed,
  33236. * it will be used for both width and height. If an object is passed, the screenshot size
  33237. * will be derived from the parameters. The precision property is a multiplier allowing
  33238. * rendering at a higher or lower resolution
  33239. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  33240. * Check your browser for supported MIME types
  33241. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  33242. * to the src parameter of an <img> to display it
  33243. */
  33244. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  33245. /**
  33246. * Generates an image screenshot from the specified camera.
  33247. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33248. * @param engine The engine to use for rendering
  33249. * @param camera The camera to use for rendering
  33250. * @param size This parameter can be set to a single number or to an object with the
  33251. * following (optional) properties: precision, width, height. If a single number is passed,
  33252. * it will be used for both width and height. If an object is passed, the screenshot size
  33253. * will be derived from the parameters. The precision property is a multiplier allowing
  33254. * rendering at a higher or lower resolution
  33255. * @param successCallback The callback receives a single parameter which contains the
  33256. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  33257. * src parameter of an <img> to display it
  33258. * @param mimeType The MIME type of the screenshot image (default: image/png).
  33259. * Check your browser for supported MIME types
  33260. * @param samples Texture samples (default: 1)
  33261. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  33262. * @param fileName A name for for the downloaded file.
  33263. */
  33264. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  33265. /**
  33266. * Generates an image screenshot from the specified camera.
  33267. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33268. * @param engine The engine to use for rendering
  33269. * @param camera The camera to use for rendering
  33270. * @param size This parameter can be set to a single number or to an object with the
  33271. * following (optional) properties: precision, width, height. If a single number is passed,
  33272. * it will be used for both width and height. If an object is passed, the screenshot size
  33273. * will be derived from the parameters. The precision property is a multiplier allowing
  33274. * rendering at a higher or lower resolution
  33275. * @param mimeType The MIME type of the screenshot image (default: image/png).
  33276. * Check your browser for supported MIME types
  33277. * @param samples Texture samples (default: 1)
  33278. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  33279. * @param fileName A name for for the downloaded file.
  33280. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  33281. * to the src parameter of an <img> to display it
  33282. */
  33283. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  33284. /**
  33285. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  33286. * Be aware Math.random() could cause collisions, but:
  33287. * "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"
  33288. * @returns a pseudo random id
  33289. */
  33290. static RandomId(): string;
  33291. /**
  33292. * Test if the given uri is a base64 string
  33293. * @param uri The uri to test
  33294. * @return True if the uri is a base64 string or false otherwise
  33295. */
  33296. static IsBase64(uri: string): boolean;
  33297. /**
  33298. * Decode the given base64 uri.
  33299. * @param uri The uri to decode
  33300. * @return The decoded base64 data.
  33301. */
  33302. static DecodeBase64(uri: string): ArrayBuffer;
  33303. /**
  33304. * Gets the absolute url.
  33305. * @param url the input url
  33306. * @return the absolute url
  33307. */
  33308. static GetAbsoluteUrl(url: string): string;
  33309. /**
  33310. * No log
  33311. */
  33312. static readonly NoneLogLevel: number;
  33313. /**
  33314. * Only message logs
  33315. */
  33316. static readonly MessageLogLevel: number;
  33317. /**
  33318. * Only warning logs
  33319. */
  33320. static readonly WarningLogLevel: number;
  33321. /**
  33322. * Only error logs
  33323. */
  33324. static readonly ErrorLogLevel: number;
  33325. /**
  33326. * All logs
  33327. */
  33328. static readonly AllLogLevel: number;
  33329. /**
  33330. * Gets a value indicating the number of loading errors
  33331. * @ignorenaming
  33332. */
  33333. static readonly errorsCount: number;
  33334. /**
  33335. * Callback called when a new log is added
  33336. */
  33337. static OnNewCacheEntry: (entry: string) => void;
  33338. /**
  33339. * Log a message to the console
  33340. * @param message defines the message to log
  33341. */
  33342. static Log(message: string): void;
  33343. /**
  33344. * Write a warning message to the console
  33345. * @param message defines the message to log
  33346. */
  33347. static Warn(message: string): void;
  33348. /**
  33349. * Write an error message to the console
  33350. * @param message defines the message to log
  33351. */
  33352. static Error(message: string): void;
  33353. /**
  33354. * Gets current log cache (list of logs)
  33355. */
  33356. static readonly LogCache: string;
  33357. /**
  33358. * Clears the log cache
  33359. */
  33360. static ClearLogCache(): void;
  33361. /**
  33362. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  33363. */
  33364. static LogLevels: number;
  33365. /**
  33366. * Checks if the window object exists
  33367. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  33368. */
  33369. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  33370. /**
  33371. * No performance log
  33372. */
  33373. static readonly PerformanceNoneLogLevel: number;
  33374. /**
  33375. * Use user marks to log performance
  33376. */
  33377. static readonly PerformanceUserMarkLogLevel: number;
  33378. /**
  33379. * Log performance to the console
  33380. */
  33381. static readonly PerformanceConsoleLogLevel: number;
  33382. private static _performance;
  33383. /**
  33384. * Sets the current performance log level
  33385. */
  33386. static PerformanceLogLevel: number;
  33387. private static _StartPerformanceCounterDisabled;
  33388. private static _EndPerformanceCounterDisabled;
  33389. private static _StartUserMark;
  33390. private static _EndUserMark;
  33391. private static _StartPerformanceConsole;
  33392. private static _EndPerformanceConsole;
  33393. /**
  33394. * Starts a performance counter
  33395. */
  33396. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33397. /**
  33398. * Ends a specific performance coutner
  33399. */
  33400. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33401. /**
  33402. * Gets either window.performance.now() if supported or Date.now() else
  33403. */
  33404. static readonly Now: number;
  33405. /**
  33406. * This method will return the name of the class used to create the instance of the given object.
  33407. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  33408. * @param object the object to get the class name from
  33409. * @param isType defines if the object is actually a type
  33410. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  33411. */
  33412. static GetClassName(object: any, isType?: boolean): string;
  33413. /**
  33414. * Gets the first element of an array satisfying a given predicate
  33415. * @param array defines the array to browse
  33416. * @param predicate defines the predicate to use
  33417. * @returns null if not found or the element
  33418. */
  33419. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  33420. /**
  33421. * This method will return the name of the full name of the class, including its owning module (if any).
  33422. * 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).
  33423. * @param object the object to get the class name from
  33424. * @param isType defines if the object is actually a type
  33425. * @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.
  33426. * @ignorenaming
  33427. */
  33428. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  33429. /**
  33430. * Returns a promise that resolves after the given amount of time.
  33431. * @param delay Number of milliseconds to delay
  33432. * @returns Promise that resolves after the given amount of time
  33433. */
  33434. static DelayAsync(delay: number): Promise<void>;
  33435. }
  33436. /**
  33437. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  33438. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  33439. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  33440. * @param name The name of the class, case should be preserved
  33441. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  33442. */
  33443. export function className(name: string, module?: string): (target: Object) => void;
  33444. /**
  33445. * An implementation of a loop for asynchronous functions.
  33446. */
  33447. export class AsyncLoop {
  33448. /**
  33449. * Defines the number of iterations for the loop
  33450. */
  33451. iterations: number;
  33452. /**
  33453. * Defines the current index of the loop.
  33454. */
  33455. index: number;
  33456. private _done;
  33457. private _fn;
  33458. private _successCallback;
  33459. /**
  33460. * Constructor.
  33461. * @param iterations the number of iterations.
  33462. * @param func the function to run each iteration
  33463. * @param successCallback the callback that will be called upon succesful execution
  33464. * @param offset starting offset.
  33465. */
  33466. constructor(
  33467. /**
  33468. * Defines the number of iterations for the loop
  33469. */
  33470. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  33471. /**
  33472. * Execute the next iteration. Must be called after the last iteration was finished.
  33473. */
  33474. executeNext(): void;
  33475. /**
  33476. * Break the loop and run the success callback.
  33477. */
  33478. breakLoop(): void;
  33479. /**
  33480. * Create and run an async loop.
  33481. * @param iterations the number of iterations.
  33482. * @param fn the function to run each iteration
  33483. * @param successCallback the callback that will be called upon succesful execution
  33484. * @param offset starting offset.
  33485. * @returns the created async loop object
  33486. */
  33487. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  33488. /**
  33489. * A for-loop that will run a given number of iterations synchronous and the rest async.
  33490. * @param iterations total number of iterations
  33491. * @param syncedIterations number of synchronous iterations in each async iteration.
  33492. * @param fn the function to call each iteration.
  33493. * @param callback a success call back that will be called when iterating stops.
  33494. * @param breakFunction a break condition (optional)
  33495. * @param timeout timeout settings for the setTimeout function. default - 0.
  33496. * @returns the created async loop object
  33497. */
  33498. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  33499. }
  33500. }
  33501. declare module "babylonjs/Misc/stringDictionary" {
  33502. import { Nullable } from "babylonjs/types";
  33503. /**
  33504. * This class implement a typical dictionary using a string as key and the generic type T as value.
  33505. * The underlying implementation relies on an associative array to ensure the best performances.
  33506. * The value can be anything including 'null' but except 'undefined'
  33507. */
  33508. export class StringDictionary<T> {
  33509. /**
  33510. * This will clear this dictionary and copy the content from the 'source' one.
  33511. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  33512. * @param source the dictionary to take the content from and copy to this dictionary
  33513. */
  33514. copyFrom(source: StringDictionary<T>): void;
  33515. /**
  33516. * Get a value based from its key
  33517. * @param key the given key to get the matching value from
  33518. * @return the value if found, otherwise undefined is returned
  33519. */
  33520. get(key: string): T | undefined;
  33521. /**
  33522. * Get a value from its key or add it if it doesn't exist.
  33523. * This method will ensure you that a given key/data will be present in the dictionary.
  33524. * @param key the given key to get the matching value from
  33525. * @param factory the factory that will create the value if the key is not present in the dictionary.
  33526. * The factory will only be invoked if there's no data for the given key.
  33527. * @return the value corresponding to the key.
  33528. */
  33529. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  33530. /**
  33531. * Get a value from its key if present in the dictionary otherwise add it
  33532. * @param key the key to get the value from
  33533. * @param val if there's no such key/value pair in the dictionary add it with this value
  33534. * @return the value corresponding to the key
  33535. */
  33536. getOrAdd(key: string, val: T): T;
  33537. /**
  33538. * Check if there's a given key in the dictionary
  33539. * @param key the key to check for
  33540. * @return true if the key is present, false otherwise
  33541. */
  33542. contains(key: string): boolean;
  33543. /**
  33544. * Add a new key and its corresponding value
  33545. * @param key the key to add
  33546. * @param value the value corresponding to the key
  33547. * @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
  33548. */
  33549. add(key: string, value: T): boolean;
  33550. /**
  33551. * Update a specific value associated to a key
  33552. * @param key defines the key to use
  33553. * @param value defines the value to store
  33554. * @returns true if the value was updated (or false if the key was not found)
  33555. */
  33556. set(key: string, value: T): boolean;
  33557. /**
  33558. * Get the element of the given key and remove it from the dictionary
  33559. * @param key defines the key to search
  33560. * @returns the value associated with the key or null if not found
  33561. */
  33562. getAndRemove(key: string): Nullable<T>;
  33563. /**
  33564. * Remove a key/value from the dictionary.
  33565. * @param key the key to remove
  33566. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  33567. */
  33568. remove(key: string): boolean;
  33569. /**
  33570. * Clear the whole content of the dictionary
  33571. */
  33572. clear(): void;
  33573. /**
  33574. * Gets the current count
  33575. */
  33576. readonly count: number;
  33577. /**
  33578. * Execute a callback on each key/val of the dictionary.
  33579. * Note that you can remove any element in this dictionary in the callback implementation
  33580. * @param callback the callback to execute on a given key/value pair
  33581. */
  33582. forEach(callback: (key: string, val: T) => void): void;
  33583. /**
  33584. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  33585. * If the callback returns null or undefined the method will iterate to the next key/value pair
  33586. * Note that you can remove any element in this dictionary in the callback implementation
  33587. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  33588. * @returns the first item
  33589. */
  33590. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  33591. private _count;
  33592. private _data;
  33593. }
  33594. }
  33595. declare module "babylonjs/Collisions/collisionCoordinator" {
  33596. import { Nullable } from "babylonjs/types";
  33597. import { Scene } from "babylonjs/scene";
  33598. import { Vector3 } from "babylonjs/Maths/math.vector";
  33599. import { Collider } from "babylonjs/Collisions/collider";
  33600. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33601. /** @hidden */
  33602. export interface ICollisionCoordinator {
  33603. createCollider(): Collider;
  33604. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33605. init(scene: Scene): void;
  33606. }
  33607. /** @hidden */
  33608. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  33609. private _scene;
  33610. private _scaledPosition;
  33611. private _scaledVelocity;
  33612. private _finalPosition;
  33613. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33614. createCollider(): Collider;
  33615. init(scene: Scene): void;
  33616. private _collideWithWorld;
  33617. }
  33618. }
  33619. declare module "babylonjs/Inputs/scene.inputManager" {
  33620. import { Nullable } from "babylonjs/types";
  33621. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33622. import { Vector2 } from "babylonjs/Maths/math.vector";
  33623. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33624. import { Scene } from "babylonjs/scene";
  33625. /**
  33626. * Class used to manage all inputs for the scene.
  33627. */
  33628. export class InputManager {
  33629. /** The distance in pixel that you have to move to prevent some events */
  33630. static DragMovementThreshold: number;
  33631. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  33632. static LongPressDelay: number;
  33633. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  33634. static DoubleClickDelay: number;
  33635. /** If you need to check double click without raising a single click at first click, enable this flag */
  33636. static ExclusiveDoubleClickMode: boolean;
  33637. private _wheelEventName;
  33638. private _onPointerMove;
  33639. private _onPointerDown;
  33640. private _onPointerUp;
  33641. private _initClickEvent;
  33642. private _initActionManager;
  33643. private _delayedSimpleClick;
  33644. private _delayedSimpleClickTimeout;
  33645. private _previousDelayedSimpleClickTimeout;
  33646. private _meshPickProceed;
  33647. private _previousButtonPressed;
  33648. private _currentPickResult;
  33649. private _previousPickResult;
  33650. private _totalPointersPressed;
  33651. private _doubleClickOccured;
  33652. private _pointerOverMesh;
  33653. private _pickedDownMesh;
  33654. private _pickedUpMesh;
  33655. private _pointerX;
  33656. private _pointerY;
  33657. private _unTranslatedPointerX;
  33658. private _unTranslatedPointerY;
  33659. private _startingPointerPosition;
  33660. private _previousStartingPointerPosition;
  33661. private _startingPointerTime;
  33662. private _previousStartingPointerTime;
  33663. private _pointerCaptures;
  33664. private _onKeyDown;
  33665. private _onKeyUp;
  33666. private _onCanvasFocusObserver;
  33667. private _onCanvasBlurObserver;
  33668. private _scene;
  33669. /**
  33670. * Creates a new InputManager
  33671. * @param scene defines the hosting scene
  33672. */
  33673. constructor(scene: Scene);
  33674. /**
  33675. * Gets the mesh that is currently under the pointer
  33676. */
  33677. readonly meshUnderPointer: Nullable<AbstractMesh>;
  33678. /**
  33679. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  33680. */
  33681. readonly unTranslatedPointer: Vector2;
  33682. /**
  33683. * Gets or sets the current on-screen X position of the pointer
  33684. */
  33685. pointerX: number;
  33686. /**
  33687. * Gets or sets the current on-screen Y position of the pointer
  33688. */
  33689. pointerY: number;
  33690. private _updatePointerPosition;
  33691. private _processPointerMove;
  33692. private _setRayOnPointerInfo;
  33693. private _checkPrePointerObservable;
  33694. /**
  33695. * Use this method to simulate a pointer move on a mesh
  33696. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33697. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33698. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33699. */
  33700. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  33701. /**
  33702. * Use this method to simulate a pointer down on a mesh
  33703. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33704. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33705. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33706. */
  33707. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  33708. private _processPointerDown;
  33709. /** @hidden */
  33710. _isPointerSwiping(): boolean;
  33711. /**
  33712. * Use this method to simulate a pointer up on a mesh
  33713. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33714. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33715. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33716. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  33717. */
  33718. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  33719. private _processPointerUp;
  33720. /**
  33721. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  33722. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  33723. * @returns true if the pointer was captured
  33724. */
  33725. isPointerCaptured(pointerId?: number): boolean;
  33726. /**
  33727. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  33728. * @param attachUp defines if you want to attach events to pointerup
  33729. * @param attachDown defines if you want to attach events to pointerdown
  33730. * @param attachMove defines if you want to attach events to pointermove
  33731. */
  33732. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  33733. /**
  33734. * Detaches all event handlers
  33735. */
  33736. detachControl(): void;
  33737. /**
  33738. * Force the value of meshUnderPointer
  33739. * @param mesh defines the mesh to use
  33740. */
  33741. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  33742. /**
  33743. * Gets the mesh under the pointer
  33744. * @returns a Mesh or null if no mesh is under the pointer
  33745. */
  33746. getPointerOverMesh(): Nullable<AbstractMesh>;
  33747. }
  33748. }
  33749. declare module "babylonjs/Misc/uniqueIdGenerator" {
  33750. /**
  33751. * Helper class used to generate session unique ID
  33752. */
  33753. export class UniqueIdGenerator {
  33754. private static _UniqueIdCounter;
  33755. /**
  33756. * Gets an unique (relatively to the current scene) Id
  33757. */
  33758. static readonly UniqueId: number;
  33759. }
  33760. }
  33761. declare module "babylonjs/Animations/animationGroup" {
  33762. import { Animatable } from "babylonjs/Animations/animatable";
  33763. import { Animation } from "babylonjs/Animations/animation";
  33764. import { Scene, IDisposable } from "babylonjs/scene";
  33765. import { Observable } from "babylonjs/Misc/observable";
  33766. import { Nullable } from "babylonjs/types";
  33767. import "babylonjs/Animations/animatable";
  33768. /**
  33769. * This class defines the direct association between an animation and a target
  33770. */
  33771. export class TargetedAnimation {
  33772. /**
  33773. * Animation to perform
  33774. */
  33775. animation: Animation;
  33776. /**
  33777. * Target to animate
  33778. */
  33779. target: any;
  33780. /**
  33781. * Serialize the object
  33782. * @returns the JSON object representing the current entity
  33783. */
  33784. serialize(): any;
  33785. }
  33786. /**
  33787. * Use this class to create coordinated animations on multiple targets
  33788. */
  33789. export class AnimationGroup implements IDisposable {
  33790. /** The name of the animation group */
  33791. name: string;
  33792. private _scene;
  33793. private _targetedAnimations;
  33794. private _animatables;
  33795. private _from;
  33796. private _to;
  33797. private _isStarted;
  33798. private _isPaused;
  33799. private _speedRatio;
  33800. private _loopAnimation;
  33801. /**
  33802. * Gets or sets the unique id of the node
  33803. */
  33804. uniqueId: number;
  33805. /**
  33806. * This observable will notify when one animation have ended
  33807. */
  33808. onAnimationEndObservable: Observable<TargetedAnimation>;
  33809. /**
  33810. * Observer raised when one animation loops
  33811. */
  33812. onAnimationLoopObservable: Observable<TargetedAnimation>;
  33813. /**
  33814. * Observer raised when all animations have looped
  33815. */
  33816. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  33817. /**
  33818. * This observable will notify when all animations have ended.
  33819. */
  33820. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  33821. /**
  33822. * This observable will notify when all animations have paused.
  33823. */
  33824. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  33825. /**
  33826. * This observable will notify when all animations are playing.
  33827. */
  33828. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  33829. /**
  33830. * Gets the first frame
  33831. */
  33832. readonly from: number;
  33833. /**
  33834. * Gets the last frame
  33835. */
  33836. readonly to: number;
  33837. /**
  33838. * Define if the animations are started
  33839. */
  33840. readonly isStarted: boolean;
  33841. /**
  33842. * Gets a value indicating that the current group is playing
  33843. */
  33844. readonly isPlaying: boolean;
  33845. /**
  33846. * Gets or sets the speed ratio to use for all animations
  33847. */
  33848. /**
  33849. * Gets or sets the speed ratio to use for all animations
  33850. */
  33851. speedRatio: number;
  33852. /**
  33853. * Gets or sets if all animations should loop or not
  33854. */
  33855. loopAnimation: boolean;
  33856. /**
  33857. * Gets the targeted animations for this animation group
  33858. */
  33859. readonly targetedAnimations: Array<TargetedAnimation>;
  33860. /**
  33861. * returning the list of animatables controlled by this animation group.
  33862. */
  33863. readonly animatables: Array<Animatable>;
  33864. /**
  33865. * Instantiates a new Animation Group.
  33866. * This helps managing several animations at once.
  33867. * @see http://doc.babylonjs.com/how_to/group
  33868. * @param name Defines the name of the group
  33869. * @param scene Defines the scene the group belongs to
  33870. */
  33871. constructor(
  33872. /** The name of the animation group */
  33873. name: string, scene?: Nullable<Scene>);
  33874. /**
  33875. * Add an animation (with its target) in the group
  33876. * @param animation defines the animation we want to add
  33877. * @param target defines the target of the animation
  33878. * @returns the TargetedAnimation object
  33879. */
  33880. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  33881. /**
  33882. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  33883. * It can add constant keys at begin or end
  33884. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  33885. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  33886. * @returns the animation group
  33887. */
  33888. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  33889. private _animationLoopCount;
  33890. private _animationLoopFlags;
  33891. private _processLoop;
  33892. /**
  33893. * Start all animations on given targets
  33894. * @param loop defines if animations must loop
  33895. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  33896. * @param from defines the from key (optional)
  33897. * @param to defines the to key (optional)
  33898. * @returns the current animation group
  33899. */
  33900. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  33901. /**
  33902. * Pause all animations
  33903. * @returns the animation group
  33904. */
  33905. pause(): AnimationGroup;
  33906. /**
  33907. * Play all animations to initial state
  33908. * This function will start() the animations if they were not started or will restart() them if they were paused
  33909. * @param loop defines if animations must loop
  33910. * @returns the animation group
  33911. */
  33912. play(loop?: boolean): AnimationGroup;
  33913. /**
  33914. * Reset all animations to initial state
  33915. * @returns the animation group
  33916. */
  33917. reset(): AnimationGroup;
  33918. /**
  33919. * Restart animations from key 0
  33920. * @returns the animation group
  33921. */
  33922. restart(): AnimationGroup;
  33923. /**
  33924. * Stop all animations
  33925. * @returns the animation group
  33926. */
  33927. stop(): AnimationGroup;
  33928. /**
  33929. * Set animation weight for all animatables
  33930. * @param weight defines the weight to use
  33931. * @return the animationGroup
  33932. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  33933. */
  33934. setWeightForAllAnimatables(weight: number): AnimationGroup;
  33935. /**
  33936. * Synchronize and normalize all animatables with a source animatable
  33937. * @param root defines the root animatable to synchronize with
  33938. * @return the animationGroup
  33939. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  33940. */
  33941. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  33942. /**
  33943. * Goes to a specific frame in this animation group
  33944. * @param frame the frame number to go to
  33945. * @return the animationGroup
  33946. */
  33947. goToFrame(frame: number): AnimationGroup;
  33948. /**
  33949. * Dispose all associated resources
  33950. */
  33951. dispose(): void;
  33952. private _checkAnimationGroupEnded;
  33953. /**
  33954. * Clone the current animation group and returns a copy
  33955. * @param newName defines the name of the new group
  33956. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  33957. * @returns the new aniamtion group
  33958. */
  33959. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  33960. /**
  33961. * Serializes the animationGroup to an object
  33962. * @returns Serialized object
  33963. */
  33964. serialize(): any;
  33965. /**
  33966. * Returns a new AnimationGroup object parsed from the source provided.
  33967. * @param parsedAnimationGroup defines the source
  33968. * @param scene defines the scene that will receive the animationGroup
  33969. * @returns a new AnimationGroup
  33970. */
  33971. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  33972. /**
  33973. * Returns the string "AnimationGroup"
  33974. * @returns "AnimationGroup"
  33975. */
  33976. getClassName(): string;
  33977. /**
  33978. * Creates a detailled string about the object
  33979. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  33980. * @returns a string representing the object
  33981. */
  33982. toString(fullDetails?: boolean): string;
  33983. }
  33984. }
  33985. declare module "babylonjs/scene" {
  33986. import { Nullable } from "babylonjs/types";
  33987. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  33988. import { Observable } from "babylonjs/Misc/observable";
  33989. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  33990. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  33991. import { Geometry } from "babylonjs/Meshes/geometry";
  33992. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33993. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33994. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33995. import { Mesh } from "babylonjs/Meshes/mesh";
  33996. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33997. import { Bone } from "babylonjs/Bones/bone";
  33998. import { Skeleton } from "babylonjs/Bones/skeleton";
  33999. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  34000. import { Camera } from "babylonjs/Cameras/camera";
  34001. import { AbstractScene } from "babylonjs/abstractScene";
  34002. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34003. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  34004. import { Material } from "babylonjs/Materials/material";
  34005. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34006. import { Effect } from "babylonjs/Materials/effect";
  34007. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  34008. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  34009. import { Light } from "babylonjs/Lights/light";
  34010. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  34011. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  34012. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  34013. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  34014. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  34015. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  34016. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  34017. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  34018. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  34019. import { Engine } from "babylonjs/Engines/engine";
  34020. import { Node } from "babylonjs/node";
  34021. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  34022. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34023. import { WebRequest } from "babylonjs/Misc/webRequest";
  34024. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  34025. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  34026. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  34027. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  34028. import { Plane } from "babylonjs/Maths/math.plane";
  34029. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  34030. import { Ray } from "babylonjs/Culling/ray";
  34031. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  34032. import { Animation } from "babylonjs/Animations/animation";
  34033. import { Animatable } from "babylonjs/Animations/animatable";
  34034. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  34035. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34036. import { Collider } from "babylonjs/Collisions/collider";
  34037. /**
  34038. * Define an interface for all classes that will hold resources
  34039. */
  34040. export interface IDisposable {
  34041. /**
  34042. * Releases all held resources
  34043. */
  34044. dispose(): void;
  34045. }
  34046. /** Interface defining initialization parameters for Scene class */
  34047. export interface SceneOptions {
  34048. /**
  34049. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  34050. * It will improve performance when the number of geometries becomes important.
  34051. */
  34052. useGeometryUniqueIdsMap?: boolean;
  34053. /**
  34054. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  34055. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  34056. */
  34057. useMaterialMeshMap?: boolean;
  34058. /**
  34059. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  34060. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  34061. */
  34062. useClonedMeshhMap?: boolean;
  34063. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  34064. virtual?: boolean;
  34065. }
  34066. /**
  34067. * Represents a scene to be rendered by the engine.
  34068. * @see http://doc.babylonjs.com/features/scene
  34069. */
  34070. export class Scene extends AbstractScene implements IAnimatable {
  34071. /** The fog is deactivated */
  34072. static readonly FOGMODE_NONE: number;
  34073. /** The fog density is following an exponential function */
  34074. static readonly FOGMODE_EXP: number;
  34075. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  34076. static readonly FOGMODE_EXP2: number;
  34077. /** The fog density is following a linear function. */
  34078. static readonly FOGMODE_LINEAR: number;
  34079. /**
  34080. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  34081. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34082. */
  34083. static MinDeltaTime: number;
  34084. /**
  34085. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  34086. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34087. */
  34088. static MaxDeltaTime: number;
  34089. /**
  34090. * Factory used to create the default material.
  34091. * @param name The name of the material to create
  34092. * @param scene The scene to create the material for
  34093. * @returns The default material
  34094. */
  34095. static DefaultMaterialFactory(scene: Scene): Material;
  34096. /**
  34097. * Factory used to create the a collision coordinator.
  34098. * @returns The collision coordinator
  34099. */
  34100. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  34101. /** @hidden */
  34102. _inputManager: InputManager;
  34103. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  34104. cameraToUseForPointers: Nullable<Camera>;
  34105. /** @hidden */
  34106. readonly _isScene: boolean;
  34107. /**
  34108. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  34109. */
  34110. autoClear: boolean;
  34111. /**
  34112. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  34113. */
  34114. autoClearDepthAndStencil: boolean;
  34115. /**
  34116. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  34117. */
  34118. clearColor: Color4;
  34119. /**
  34120. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  34121. */
  34122. ambientColor: Color3;
  34123. /**
  34124. * This is use to store the default BRDF lookup for PBR materials in your scene.
  34125. * It should only be one of the following (if not the default embedded one):
  34126. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  34127. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  34128. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  34129. * The material properties need to be setup according to the type of texture in use.
  34130. */
  34131. environmentBRDFTexture: BaseTexture;
  34132. /** @hidden */
  34133. protected _environmentTexture: Nullable<BaseTexture>;
  34134. /**
  34135. * Texture used in all pbr material as the reflection texture.
  34136. * As in the majority of the scene they are the same (exception for multi room and so on),
  34137. * this is easier to reference from here than from all the materials.
  34138. */
  34139. /**
  34140. * Texture used in all pbr material as the reflection texture.
  34141. * As in the majority of the scene they are the same (exception for multi room and so on),
  34142. * this is easier to set here than in all the materials.
  34143. */
  34144. environmentTexture: Nullable<BaseTexture>;
  34145. /** @hidden */
  34146. protected _environmentIntensity: number;
  34147. /**
  34148. * Intensity of the environment in all pbr material.
  34149. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  34150. * As in the majority of the scene they are the same (exception for multi room and so on),
  34151. * this is easier to reference from here than from all the materials.
  34152. */
  34153. /**
  34154. * Intensity of the environment in all pbr material.
  34155. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  34156. * As in the majority of the scene they are the same (exception for multi room and so on),
  34157. * this is easier to set here than in all the materials.
  34158. */
  34159. environmentIntensity: number;
  34160. /** @hidden */
  34161. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  34162. /**
  34163. * Default image processing configuration used either in the rendering
  34164. * Forward main pass or through the imageProcessingPostProcess if present.
  34165. * As in the majority of the scene they are the same (exception for multi camera),
  34166. * this is easier to reference from here than from all the materials and post process.
  34167. *
  34168. * No setter as we it is a shared configuration, you can set the values instead.
  34169. */
  34170. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  34171. private _forceWireframe;
  34172. /**
  34173. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  34174. */
  34175. forceWireframe: boolean;
  34176. private _forcePointsCloud;
  34177. /**
  34178. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  34179. */
  34180. forcePointsCloud: boolean;
  34181. /**
  34182. * Gets or sets the active clipplane 1
  34183. */
  34184. clipPlane: Nullable<Plane>;
  34185. /**
  34186. * Gets or sets the active clipplane 2
  34187. */
  34188. clipPlane2: Nullable<Plane>;
  34189. /**
  34190. * Gets or sets the active clipplane 3
  34191. */
  34192. clipPlane3: Nullable<Plane>;
  34193. /**
  34194. * Gets or sets the active clipplane 4
  34195. */
  34196. clipPlane4: Nullable<Plane>;
  34197. /**
  34198. * Gets or sets a boolean indicating if animations are enabled
  34199. */
  34200. animationsEnabled: boolean;
  34201. private _animationPropertiesOverride;
  34202. /**
  34203. * Gets or sets the animation properties override
  34204. */
  34205. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  34206. /**
  34207. * Gets or sets a boolean indicating if a constant deltatime has to be used
  34208. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  34209. */
  34210. useConstantAnimationDeltaTime: boolean;
  34211. /**
  34212. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  34213. * Please note that it requires to run a ray cast through the scene on every frame
  34214. */
  34215. constantlyUpdateMeshUnderPointer: boolean;
  34216. /**
  34217. * Defines the HTML cursor to use when hovering over interactive elements
  34218. */
  34219. hoverCursor: string;
  34220. /**
  34221. * Defines the HTML default cursor to use (empty by default)
  34222. */
  34223. defaultCursor: string;
  34224. /**
  34225. * Defines wether cursors are handled by the scene.
  34226. */
  34227. doNotHandleCursors: boolean;
  34228. /**
  34229. * This is used to call preventDefault() on pointer down
  34230. * in order to block unwanted artifacts like system double clicks
  34231. */
  34232. preventDefaultOnPointerDown: boolean;
  34233. /**
  34234. * This is used to call preventDefault() on pointer up
  34235. * in order to block unwanted artifacts like system double clicks
  34236. */
  34237. preventDefaultOnPointerUp: boolean;
  34238. /**
  34239. * Gets or sets user defined metadata
  34240. */
  34241. metadata: any;
  34242. /**
  34243. * For internal use only. Please do not use.
  34244. */
  34245. reservedDataStore: any;
  34246. /**
  34247. * Gets the name of the plugin used to load this scene (null by default)
  34248. */
  34249. loadingPluginName: string;
  34250. /**
  34251. * Use this array to add regular expressions used to disable offline support for specific urls
  34252. */
  34253. disableOfflineSupportExceptionRules: RegExp[];
  34254. /**
  34255. * An event triggered when the scene is disposed.
  34256. */
  34257. onDisposeObservable: Observable<Scene>;
  34258. private _onDisposeObserver;
  34259. /** Sets a function to be executed when this scene is disposed. */
  34260. onDispose: () => void;
  34261. /**
  34262. * An event triggered before rendering the scene (right after animations and physics)
  34263. */
  34264. onBeforeRenderObservable: Observable<Scene>;
  34265. private _onBeforeRenderObserver;
  34266. /** Sets a function to be executed before rendering this scene */
  34267. beforeRender: Nullable<() => void>;
  34268. /**
  34269. * An event triggered after rendering the scene
  34270. */
  34271. onAfterRenderObservable: Observable<Scene>;
  34272. /**
  34273. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  34274. */
  34275. onAfterRenderCameraObservable: Observable<Camera>;
  34276. private _onAfterRenderObserver;
  34277. /** Sets a function to be executed after rendering this scene */
  34278. afterRender: Nullable<() => void>;
  34279. /**
  34280. * An event triggered before animating the scene
  34281. */
  34282. onBeforeAnimationsObservable: Observable<Scene>;
  34283. /**
  34284. * An event triggered after animations processing
  34285. */
  34286. onAfterAnimationsObservable: Observable<Scene>;
  34287. /**
  34288. * An event triggered before draw calls are ready to be sent
  34289. */
  34290. onBeforeDrawPhaseObservable: Observable<Scene>;
  34291. /**
  34292. * An event triggered after draw calls have been sent
  34293. */
  34294. onAfterDrawPhaseObservable: Observable<Scene>;
  34295. /**
  34296. * An event triggered when the scene is ready
  34297. */
  34298. onReadyObservable: Observable<Scene>;
  34299. /**
  34300. * An event triggered before rendering a camera
  34301. */
  34302. onBeforeCameraRenderObservable: Observable<Camera>;
  34303. private _onBeforeCameraRenderObserver;
  34304. /** Sets a function to be executed before rendering a camera*/
  34305. beforeCameraRender: () => void;
  34306. /**
  34307. * An event triggered after rendering a camera
  34308. */
  34309. onAfterCameraRenderObservable: Observable<Camera>;
  34310. private _onAfterCameraRenderObserver;
  34311. /** Sets a function to be executed after rendering a camera*/
  34312. afterCameraRender: () => void;
  34313. /**
  34314. * An event triggered when active meshes evaluation is about to start
  34315. */
  34316. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  34317. /**
  34318. * An event triggered when active meshes evaluation is done
  34319. */
  34320. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  34321. /**
  34322. * An event triggered when particles rendering is about to start
  34323. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  34324. */
  34325. onBeforeParticlesRenderingObservable: Observable<Scene>;
  34326. /**
  34327. * An event triggered when particles rendering is done
  34328. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  34329. */
  34330. onAfterParticlesRenderingObservable: Observable<Scene>;
  34331. /**
  34332. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  34333. */
  34334. onDataLoadedObservable: Observable<Scene>;
  34335. /**
  34336. * An event triggered when a camera is created
  34337. */
  34338. onNewCameraAddedObservable: Observable<Camera>;
  34339. /**
  34340. * An event triggered when a camera is removed
  34341. */
  34342. onCameraRemovedObservable: Observable<Camera>;
  34343. /**
  34344. * An event triggered when a light is created
  34345. */
  34346. onNewLightAddedObservable: Observable<Light>;
  34347. /**
  34348. * An event triggered when a light is removed
  34349. */
  34350. onLightRemovedObservable: Observable<Light>;
  34351. /**
  34352. * An event triggered when a geometry is created
  34353. */
  34354. onNewGeometryAddedObservable: Observable<Geometry>;
  34355. /**
  34356. * An event triggered when a geometry is removed
  34357. */
  34358. onGeometryRemovedObservable: Observable<Geometry>;
  34359. /**
  34360. * An event triggered when a transform node is created
  34361. */
  34362. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  34363. /**
  34364. * An event triggered when a transform node is removed
  34365. */
  34366. onTransformNodeRemovedObservable: Observable<TransformNode>;
  34367. /**
  34368. * An event triggered when a mesh is created
  34369. */
  34370. onNewMeshAddedObservable: Observable<AbstractMesh>;
  34371. /**
  34372. * An event triggered when a mesh is removed
  34373. */
  34374. onMeshRemovedObservable: Observable<AbstractMesh>;
  34375. /**
  34376. * An event triggered when a skeleton is created
  34377. */
  34378. onNewSkeletonAddedObservable: Observable<Skeleton>;
  34379. /**
  34380. * An event triggered when a skeleton is removed
  34381. */
  34382. onSkeletonRemovedObservable: Observable<Skeleton>;
  34383. /**
  34384. * An event triggered when a material is created
  34385. */
  34386. onNewMaterialAddedObservable: Observable<Material>;
  34387. /**
  34388. * An event triggered when a material is removed
  34389. */
  34390. onMaterialRemovedObservable: Observable<Material>;
  34391. /**
  34392. * An event triggered when a texture is created
  34393. */
  34394. onNewTextureAddedObservable: Observable<BaseTexture>;
  34395. /**
  34396. * An event triggered when a texture is removed
  34397. */
  34398. onTextureRemovedObservable: Observable<BaseTexture>;
  34399. /**
  34400. * An event triggered when render targets are about to be rendered
  34401. * Can happen multiple times per frame.
  34402. */
  34403. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  34404. /**
  34405. * An event triggered when render targets were rendered.
  34406. * Can happen multiple times per frame.
  34407. */
  34408. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  34409. /**
  34410. * An event triggered before calculating deterministic simulation step
  34411. */
  34412. onBeforeStepObservable: Observable<Scene>;
  34413. /**
  34414. * An event triggered after calculating deterministic simulation step
  34415. */
  34416. onAfterStepObservable: Observable<Scene>;
  34417. /**
  34418. * An event triggered when the activeCamera property is updated
  34419. */
  34420. onActiveCameraChanged: Observable<Scene>;
  34421. /**
  34422. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  34423. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34424. * 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)
  34425. */
  34426. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34427. /**
  34428. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  34429. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34430. * 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)
  34431. */
  34432. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34433. /**
  34434. * This Observable will when a mesh has been imported into the scene.
  34435. */
  34436. onMeshImportedObservable: Observable<AbstractMesh>;
  34437. /**
  34438. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  34439. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  34440. */
  34441. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  34442. /** @hidden */
  34443. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  34444. /**
  34445. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  34446. */
  34447. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  34448. /**
  34449. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  34450. */
  34451. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  34452. /**
  34453. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  34454. */
  34455. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  34456. /** Callback called when a pointer move is detected */
  34457. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34458. /** Callback called when a pointer down is detected */
  34459. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34460. /** Callback called when a pointer up is detected */
  34461. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  34462. /** Callback called when a pointer pick is detected */
  34463. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  34464. /**
  34465. * 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).
  34466. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  34467. */
  34468. onPrePointerObservable: Observable<PointerInfoPre>;
  34469. /**
  34470. * Observable event triggered each time an input event is received from the rendering canvas
  34471. */
  34472. onPointerObservable: Observable<PointerInfo>;
  34473. /**
  34474. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  34475. */
  34476. readonly unTranslatedPointer: Vector2;
  34477. /**
  34478. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  34479. */
  34480. static DragMovementThreshold: number;
  34481. /**
  34482. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  34483. */
  34484. static LongPressDelay: number;
  34485. /**
  34486. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  34487. */
  34488. static DoubleClickDelay: number;
  34489. /** If you need to check double click without raising a single click at first click, enable this flag */
  34490. static ExclusiveDoubleClickMode: boolean;
  34491. /** @hidden */
  34492. _mirroredCameraPosition: Nullable<Vector3>;
  34493. /**
  34494. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  34495. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  34496. */
  34497. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  34498. /**
  34499. * Observable event triggered each time an keyboard event is received from the hosting window
  34500. */
  34501. onKeyboardObservable: Observable<KeyboardInfo>;
  34502. private _useRightHandedSystem;
  34503. /**
  34504. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  34505. */
  34506. useRightHandedSystem: boolean;
  34507. private _timeAccumulator;
  34508. private _currentStepId;
  34509. private _currentInternalStep;
  34510. /**
  34511. * Sets the step Id used by deterministic lock step
  34512. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34513. * @param newStepId defines the step Id
  34514. */
  34515. setStepId(newStepId: number): void;
  34516. /**
  34517. * Gets the step Id used by deterministic lock step
  34518. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34519. * @returns the step Id
  34520. */
  34521. getStepId(): number;
  34522. /**
  34523. * Gets the internal step used by deterministic lock step
  34524. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34525. * @returns the internal step
  34526. */
  34527. getInternalStep(): number;
  34528. private _fogEnabled;
  34529. /**
  34530. * Gets or sets a boolean indicating if fog is enabled on this scene
  34531. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34532. * (Default is true)
  34533. */
  34534. fogEnabled: boolean;
  34535. private _fogMode;
  34536. /**
  34537. * Gets or sets the fog mode to use
  34538. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34539. * | mode | value |
  34540. * | --- | --- |
  34541. * | FOGMODE_NONE | 0 |
  34542. * | FOGMODE_EXP | 1 |
  34543. * | FOGMODE_EXP2 | 2 |
  34544. * | FOGMODE_LINEAR | 3 |
  34545. */
  34546. fogMode: number;
  34547. /**
  34548. * Gets or sets the fog color to use
  34549. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34550. * (Default is Color3(0.2, 0.2, 0.3))
  34551. */
  34552. fogColor: Color3;
  34553. /**
  34554. * Gets or sets the fog density to use
  34555. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34556. * (Default is 0.1)
  34557. */
  34558. fogDensity: number;
  34559. /**
  34560. * Gets or sets the fog start distance to use
  34561. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34562. * (Default is 0)
  34563. */
  34564. fogStart: number;
  34565. /**
  34566. * Gets or sets the fog end distance to use
  34567. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34568. * (Default is 1000)
  34569. */
  34570. fogEnd: number;
  34571. private _shadowsEnabled;
  34572. /**
  34573. * Gets or sets a boolean indicating if shadows are enabled on this scene
  34574. */
  34575. shadowsEnabled: boolean;
  34576. private _lightsEnabled;
  34577. /**
  34578. * Gets or sets a boolean indicating if lights are enabled on this scene
  34579. */
  34580. lightsEnabled: boolean;
  34581. /** All of the active cameras added to this scene. */
  34582. activeCameras: Camera[];
  34583. /** @hidden */
  34584. _activeCamera: Nullable<Camera>;
  34585. /** Gets or sets the current active camera */
  34586. activeCamera: Nullable<Camera>;
  34587. private _defaultMaterial;
  34588. /** The default material used on meshes when no material is affected */
  34589. /** The default material used on meshes when no material is affected */
  34590. defaultMaterial: Material;
  34591. private _texturesEnabled;
  34592. /**
  34593. * Gets or sets a boolean indicating if textures are enabled on this scene
  34594. */
  34595. texturesEnabled: boolean;
  34596. /**
  34597. * Gets or sets a boolean indicating if particles are enabled on this scene
  34598. */
  34599. particlesEnabled: boolean;
  34600. /**
  34601. * Gets or sets a boolean indicating if sprites are enabled on this scene
  34602. */
  34603. spritesEnabled: boolean;
  34604. private _skeletonsEnabled;
  34605. /**
  34606. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  34607. */
  34608. skeletonsEnabled: boolean;
  34609. /**
  34610. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  34611. */
  34612. lensFlaresEnabled: boolean;
  34613. /**
  34614. * Gets or sets a boolean indicating if collisions are enabled on this scene
  34615. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34616. */
  34617. collisionsEnabled: boolean;
  34618. private _collisionCoordinator;
  34619. /** @hidden */
  34620. readonly collisionCoordinator: ICollisionCoordinator;
  34621. /**
  34622. * Defines the gravity applied to this scene (used only for collisions)
  34623. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34624. */
  34625. gravity: Vector3;
  34626. /**
  34627. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  34628. */
  34629. postProcessesEnabled: boolean;
  34630. /**
  34631. * The list of postprocesses added to the scene
  34632. */
  34633. postProcesses: PostProcess[];
  34634. /**
  34635. * Gets the current postprocess manager
  34636. */
  34637. postProcessManager: PostProcessManager;
  34638. /**
  34639. * Gets or sets a boolean indicating if render targets are enabled on this scene
  34640. */
  34641. renderTargetsEnabled: boolean;
  34642. /**
  34643. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  34644. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  34645. */
  34646. dumpNextRenderTargets: boolean;
  34647. /**
  34648. * The list of user defined render targets added to the scene
  34649. */
  34650. customRenderTargets: RenderTargetTexture[];
  34651. /**
  34652. * Defines if texture loading must be delayed
  34653. * If true, textures will only be loaded when they need to be rendered
  34654. */
  34655. useDelayedTextureLoading: boolean;
  34656. /**
  34657. * Gets the list of meshes imported to the scene through SceneLoader
  34658. */
  34659. importedMeshesFiles: String[];
  34660. /**
  34661. * Gets or sets a boolean indicating if probes are enabled on this scene
  34662. */
  34663. probesEnabled: boolean;
  34664. /**
  34665. * Gets or sets the current offline provider to use to store scene data
  34666. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  34667. */
  34668. offlineProvider: IOfflineProvider;
  34669. /**
  34670. * Gets or sets the action manager associated with the scene
  34671. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  34672. */
  34673. actionManager: AbstractActionManager;
  34674. private _meshesForIntersections;
  34675. /**
  34676. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  34677. */
  34678. proceduralTexturesEnabled: boolean;
  34679. private _engine;
  34680. private _totalVertices;
  34681. /** @hidden */
  34682. _activeIndices: PerfCounter;
  34683. /** @hidden */
  34684. _activeParticles: PerfCounter;
  34685. /** @hidden */
  34686. _activeBones: PerfCounter;
  34687. private _animationRatio;
  34688. /** @hidden */
  34689. _animationTimeLast: number;
  34690. /** @hidden */
  34691. _animationTime: number;
  34692. /**
  34693. * Gets or sets a general scale for animation speed
  34694. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  34695. */
  34696. animationTimeScale: number;
  34697. /** @hidden */
  34698. _cachedMaterial: Nullable<Material>;
  34699. /** @hidden */
  34700. _cachedEffect: Nullable<Effect>;
  34701. /** @hidden */
  34702. _cachedVisibility: Nullable<number>;
  34703. private _renderId;
  34704. private _frameId;
  34705. private _executeWhenReadyTimeoutId;
  34706. private _intermediateRendering;
  34707. private _viewUpdateFlag;
  34708. private _projectionUpdateFlag;
  34709. /** @hidden */
  34710. _toBeDisposed: Nullable<IDisposable>[];
  34711. private _activeRequests;
  34712. /** @hidden */
  34713. _pendingData: any[];
  34714. private _isDisposed;
  34715. /**
  34716. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  34717. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  34718. */
  34719. dispatchAllSubMeshesOfActiveMeshes: boolean;
  34720. private _activeMeshes;
  34721. private _processedMaterials;
  34722. private _renderTargets;
  34723. /** @hidden */
  34724. _activeParticleSystems: SmartArray<IParticleSystem>;
  34725. private _activeSkeletons;
  34726. private _softwareSkinnedMeshes;
  34727. private _renderingManager;
  34728. /** @hidden */
  34729. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  34730. private _transformMatrix;
  34731. private _sceneUbo;
  34732. /** @hidden */
  34733. _viewMatrix: Matrix;
  34734. private _projectionMatrix;
  34735. /** @hidden */
  34736. _forcedViewPosition: Nullable<Vector3>;
  34737. /** @hidden */
  34738. _frustumPlanes: Plane[];
  34739. /**
  34740. * Gets the list of frustum planes (built from the active camera)
  34741. */
  34742. readonly frustumPlanes: Plane[];
  34743. /**
  34744. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  34745. * This is useful if there are more lights that the maximum simulteanous authorized
  34746. */
  34747. requireLightSorting: boolean;
  34748. /** @hidden */
  34749. readonly useMaterialMeshMap: boolean;
  34750. /** @hidden */
  34751. readonly useClonedMeshhMap: boolean;
  34752. private _externalData;
  34753. private _uid;
  34754. /**
  34755. * @hidden
  34756. * Backing store of defined scene components.
  34757. */
  34758. _components: ISceneComponent[];
  34759. /**
  34760. * @hidden
  34761. * Backing store of defined scene components.
  34762. */
  34763. _serializableComponents: ISceneSerializableComponent[];
  34764. /**
  34765. * List of components to register on the next registration step.
  34766. */
  34767. private _transientComponents;
  34768. /**
  34769. * Registers the transient components if needed.
  34770. */
  34771. private _registerTransientComponents;
  34772. /**
  34773. * @hidden
  34774. * Add a component to the scene.
  34775. * Note that the ccomponent could be registered on th next frame if this is called after
  34776. * the register component stage.
  34777. * @param component Defines the component to add to the scene
  34778. */
  34779. _addComponent(component: ISceneComponent): void;
  34780. /**
  34781. * @hidden
  34782. * Gets a component from the scene.
  34783. * @param name defines the name of the component to retrieve
  34784. * @returns the component or null if not present
  34785. */
  34786. _getComponent(name: string): Nullable<ISceneComponent>;
  34787. /**
  34788. * @hidden
  34789. * Defines the actions happening before camera updates.
  34790. */
  34791. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  34792. /**
  34793. * @hidden
  34794. * Defines the actions happening before clear the canvas.
  34795. */
  34796. _beforeClearStage: Stage<SimpleStageAction>;
  34797. /**
  34798. * @hidden
  34799. * Defines the actions when collecting render targets for the frame.
  34800. */
  34801. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  34802. /**
  34803. * @hidden
  34804. * Defines the actions happening for one camera in the frame.
  34805. */
  34806. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  34807. /**
  34808. * @hidden
  34809. * Defines the actions happening during the per mesh ready checks.
  34810. */
  34811. _isReadyForMeshStage: Stage<MeshStageAction>;
  34812. /**
  34813. * @hidden
  34814. * Defines the actions happening before evaluate active mesh checks.
  34815. */
  34816. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  34817. /**
  34818. * @hidden
  34819. * Defines the actions happening during the evaluate sub mesh checks.
  34820. */
  34821. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  34822. /**
  34823. * @hidden
  34824. * Defines the actions happening during the active mesh stage.
  34825. */
  34826. _activeMeshStage: Stage<ActiveMeshStageAction>;
  34827. /**
  34828. * @hidden
  34829. * Defines the actions happening during the per camera render target step.
  34830. */
  34831. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  34832. /**
  34833. * @hidden
  34834. * Defines the actions happening just before the active camera is drawing.
  34835. */
  34836. _beforeCameraDrawStage: Stage<CameraStageAction>;
  34837. /**
  34838. * @hidden
  34839. * Defines the actions happening just before a render target is drawing.
  34840. */
  34841. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  34842. /**
  34843. * @hidden
  34844. * Defines the actions happening just before a rendering group is drawing.
  34845. */
  34846. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  34847. /**
  34848. * @hidden
  34849. * Defines the actions happening just before a mesh is drawing.
  34850. */
  34851. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  34852. /**
  34853. * @hidden
  34854. * Defines the actions happening just after a mesh has been drawn.
  34855. */
  34856. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  34857. /**
  34858. * @hidden
  34859. * Defines the actions happening just after a rendering group has been drawn.
  34860. */
  34861. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  34862. /**
  34863. * @hidden
  34864. * Defines the actions happening just after the active camera has been drawn.
  34865. */
  34866. _afterCameraDrawStage: Stage<CameraStageAction>;
  34867. /**
  34868. * @hidden
  34869. * Defines the actions happening just after a render target has been drawn.
  34870. */
  34871. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  34872. /**
  34873. * @hidden
  34874. * Defines the actions happening just after rendering all cameras and computing intersections.
  34875. */
  34876. _afterRenderStage: Stage<SimpleStageAction>;
  34877. /**
  34878. * @hidden
  34879. * Defines the actions happening when a pointer move event happens.
  34880. */
  34881. _pointerMoveStage: Stage<PointerMoveStageAction>;
  34882. /**
  34883. * @hidden
  34884. * Defines the actions happening when a pointer down event happens.
  34885. */
  34886. _pointerDownStage: Stage<PointerUpDownStageAction>;
  34887. /**
  34888. * @hidden
  34889. * Defines the actions happening when a pointer up event happens.
  34890. */
  34891. _pointerUpStage: Stage<PointerUpDownStageAction>;
  34892. /**
  34893. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  34894. */
  34895. private geometriesByUniqueId;
  34896. /**
  34897. * Creates a new Scene
  34898. * @param engine defines the engine to use to render this scene
  34899. * @param options defines the scene options
  34900. */
  34901. constructor(engine: Engine, options?: SceneOptions);
  34902. /**
  34903. * Gets a string idenfifying the name of the class
  34904. * @returns "Scene" string
  34905. */
  34906. getClassName(): string;
  34907. private _defaultMeshCandidates;
  34908. /**
  34909. * @hidden
  34910. */
  34911. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  34912. private _defaultSubMeshCandidates;
  34913. /**
  34914. * @hidden
  34915. */
  34916. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  34917. /**
  34918. * Sets the default candidate providers for the scene.
  34919. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  34920. * and getCollidingSubMeshCandidates to their default function
  34921. */
  34922. setDefaultCandidateProviders(): void;
  34923. /**
  34924. * Gets the mesh that is currently under the pointer
  34925. */
  34926. readonly meshUnderPointer: Nullable<AbstractMesh>;
  34927. /**
  34928. * Gets or sets the current on-screen X position of the pointer
  34929. */
  34930. pointerX: number;
  34931. /**
  34932. * Gets or sets the current on-screen Y position of the pointer
  34933. */
  34934. pointerY: number;
  34935. /**
  34936. * Gets the cached material (ie. the latest rendered one)
  34937. * @returns the cached material
  34938. */
  34939. getCachedMaterial(): Nullable<Material>;
  34940. /**
  34941. * Gets the cached effect (ie. the latest rendered one)
  34942. * @returns the cached effect
  34943. */
  34944. getCachedEffect(): Nullable<Effect>;
  34945. /**
  34946. * Gets the cached visibility state (ie. the latest rendered one)
  34947. * @returns the cached visibility state
  34948. */
  34949. getCachedVisibility(): Nullable<number>;
  34950. /**
  34951. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  34952. * @param material defines the current material
  34953. * @param effect defines the current effect
  34954. * @param visibility defines the current visibility state
  34955. * @returns true if one parameter is not cached
  34956. */
  34957. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  34958. /**
  34959. * Gets the engine associated with the scene
  34960. * @returns an Engine
  34961. */
  34962. getEngine(): Engine;
  34963. /**
  34964. * Gets the total number of vertices rendered per frame
  34965. * @returns the total number of vertices rendered per frame
  34966. */
  34967. getTotalVertices(): number;
  34968. /**
  34969. * Gets the performance counter for total vertices
  34970. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34971. */
  34972. readonly totalVerticesPerfCounter: PerfCounter;
  34973. /**
  34974. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  34975. * @returns the total number of active indices rendered per frame
  34976. */
  34977. getActiveIndices(): number;
  34978. /**
  34979. * Gets the performance counter for active indices
  34980. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34981. */
  34982. readonly totalActiveIndicesPerfCounter: PerfCounter;
  34983. /**
  34984. * Gets the total number of active particles rendered per frame
  34985. * @returns the total number of active particles rendered per frame
  34986. */
  34987. getActiveParticles(): number;
  34988. /**
  34989. * Gets the performance counter for active particles
  34990. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34991. */
  34992. readonly activeParticlesPerfCounter: PerfCounter;
  34993. /**
  34994. * Gets the total number of active bones rendered per frame
  34995. * @returns the total number of active bones rendered per frame
  34996. */
  34997. getActiveBones(): number;
  34998. /**
  34999. * Gets the performance counter for active bones
  35000. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35001. */
  35002. readonly activeBonesPerfCounter: PerfCounter;
  35003. /**
  35004. * Gets the array of active meshes
  35005. * @returns an array of AbstractMesh
  35006. */
  35007. getActiveMeshes(): SmartArray<AbstractMesh>;
  35008. /**
  35009. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  35010. * @returns a number
  35011. */
  35012. getAnimationRatio(): number;
  35013. /**
  35014. * Gets an unique Id for the current render phase
  35015. * @returns a number
  35016. */
  35017. getRenderId(): number;
  35018. /**
  35019. * Gets an unique Id for the current frame
  35020. * @returns a number
  35021. */
  35022. getFrameId(): number;
  35023. /** Call this function if you want to manually increment the render Id*/
  35024. incrementRenderId(): void;
  35025. private _createUbo;
  35026. /**
  35027. * Use this method to simulate a pointer move on a mesh
  35028. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35029. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35030. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35031. * @returns the current scene
  35032. */
  35033. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  35034. /**
  35035. * Use this method to simulate a pointer down on a mesh
  35036. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35037. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35038. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35039. * @returns the current scene
  35040. */
  35041. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  35042. /**
  35043. * Use this method to simulate a pointer up on a mesh
  35044. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35045. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35046. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35047. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  35048. * @returns the current scene
  35049. */
  35050. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  35051. /**
  35052. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  35053. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  35054. * @returns true if the pointer was captured
  35055. */
  35056. isPointerCaptured(pointerId?: number): boolean;
  35057. /**
  35058. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  35059. * @param attachUp defines if you want to attach events to pointerup
  35060. * @param attachDown defines if you want to attach events to pointerdown
  35061. * @param attachMove defines if you want to attach events to pointermove
  35062. */
  35063. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  35064. /** Detaches all event handlers*/
  35065. detachControl(): void;
  35066. /**
  35067. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  35068. * Delay loaded resources are not taking in account
  35069. * @return true if all required resources are ready
  35070. */
  35071. isReady(): boolean;
  35072. /** Resets all cached information relative to material (including effect and visibility) */
  35073. resetCachedMaterial(): void;
  35074. /**
  35075. * Registers a function to be called before every frame render
  35076. * @param func defines the function to register
  35077. */
  35078. registerBeforeRender(func: () => void): void;
  35079. /**
  35080. * Unregisters a function called before every frame render
  35081. * @param func defines the function to unregister
  35082. */
  35083. unregisterBeforeRender(func: () => void): void;
  35084. /**
  35085. * Registers a function to be called after every frame render
  35086. * @param func defines the function to register
  35087. */
  35088. registerAfterRender(func: () => void): void;
  35089. /**
  35090. * Unregisters a function called after every frame render
  35091. * @param func defines the function to unregister
  35092. */
  35093. unregisterAfterRender(func: () => void): void;
  35094. private _executeOnceBeforeRender;
  35095. /**
  35096. * The provided function will run before render once and will be disposed afterwards.
  35097. * A timeout delay can be provided so that the function will be executed in N ms.
  35098. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  35099. * @param func The function to be executed.
  35100. * @param timeout optional delay in ms
  35101. */
  35102. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  35103. /** @hidden */
  35104. _addPendingData(data: any): void;
  35105. /** @hidden */
  35106. _removePendingData(data: any): void;
  35107. /**
  35108. * Returns the number of items waiting to be loaded
  35109. * @returns the number of items waiting to be loaded
  35110. */
  35111. getWaitingItemsCount(): number;
  35112. /**
  35113. * Returns a boolean indicating if the scene is still loading data
  35114. */
  35115. readonly isLoading: boolean;
  35116. /**
  35117. * Registers a function to be executed when the scene is ready
  35118. * @param {Function} func - the function to be executed
  35119. */
  35120. executeWhenReady(func: () => void): void;
  35121. /**
  35122. * Returns a promise that resolves when the scene is ready
  35123. * @returns A promise that resolves when the scene is ready
  35124. */
  35125. whenReadyAsync(): Promise<void>;
  35126. /** @hidden */
  35127. _checkIsReady(): void;
  35128. /**
  35129. * Gets all animatable attached to the scene
  35130. */
  35131. readonly animatables: Animatable[];
  35132. /**
  35133. * Resets the last animation time frame.
  35134. * Useful to override when animations start running when loading a scene for the first time.
  35135. */
  35136. resetLastAnimationTimeFrame(): void;
  35137. /**
  35138. * Gets the current view matrix
  35139. * @returns a Matrix
  35140. */
  35141. getViewMatrix(): Matrix;
  35142. /**
  35143. * Gets the current projection matrix
  35144. * @returns a Matrix
  35145. */
  35146. getProjectionMatrix(): Matrix;
  35147. /**
  35148. * Gets the current transform matrix
  35149. * @returns a Matrix made of View * Projection
  35150. */
  35151. getTransformMatrix(): Matrix;
  35152. /**
  35153. * Sets the current transform matrix
  35154. * @param viewL defines the View matrix to use
  35155. * @param projectionL defines the Projection matrix to use
  35156. * @param viewR defines the right View matrix to use (if provided)
  35157. * @param projectionR defines the right Projection matrix to use (if provided)
  35158. */
  35159. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  35160. /**
  35161. * Gets the uniform buffer used to store scene data
  35162. * @returns a UniformBuffer
  35163. */
  35164. getSceneUniformBuffer(): UniformBuffer;
  35165. /**
  35166. * Gets an unique (relatively to the current scene) Id
  35167. * @returns an unique number for the scene
  35168. */
  35169. getUniqueId(): number;
  35170. /**
  35171. * Add a mesh to the list of scene's meshes
  35172. * @param newMesh defines the mesh to add
  35173. * @param recursive if all child meshes should also be added to the scene
  35174. */
  35175. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  35176. /**
  35177. * Remove a mesh for the list of scene's meshes
  35178. * @param toRemove defines the mesh to remove
  35179. * @param recursive if all child meshes should also be removed from the scene
  35180. * @returns the index where the mesh was in the mesh list
  35181. */
  35182. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  35183. /**
  35184. * Add a transform node to the list of scene's transform nodes
  35185. * @param newTransformNode defines the transform node to add
  35186. */
  35187. addTransformNode(newTransformNode: TransformNode): void;
  35188. /**
  35189. * Remove a transform node for the list of scene's transform nodes
  35190. * @param toRemove defines the transform node to remove
  35191. * @returns the index where the transform node was in the transform node list
  35192. */
  35193. removeTransformNode(toRemove: TransformNode): number;
  35194. /**
  35195. * Remove a skeleton for the list of scene's skeletons
  35196. * @param toRemove defines the skeleton to remove
  35197. * @returns the index where the skeleton was in the skeleton list
  35198. */
  35199. removeSkeleton(toRemove: Skeleton): number;
  35200. /**
  35201. * Remove a morph target for the list of scene's morph targets
  35202. * @param toRemove defines the morph target to remove
  35203. * @returns the index where the morph target was in the morph target list
  35204. */
  35205. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  35206. /**
  35207. * Remove a light for the list of scene's lights
  35208. * @param toRemove defines the light to remove
  35209. * @returns the index where the light was in the light list
  35210. */
  35211. removeLight(toRemove: Light): number;
  35212. /**
  35213. * Remove a camera for the list of scene's cameras
  35214. * @param toRemove defines the camera to remove
  35215. * @returns the index where the camera was in the camera list
  35216. */
  35217. removeCamera(toRemove: Camera): number;
  35218. /**
  35219. * Remove a particle system for the list of scene's particle systems
  35220. * @param toRemove defines the particle system to remove
  35221. * @returns the index where the particle system was in the particle system list
  35222. */
  35223. removeParticleSystem(toRemove: IParticleSystem): number;
  35224. /**
  35225. * Remove a animation for the list of scene's animations
  35226. * @param toRemove defines the animation to remove
  35227. * @returns the index where the animation was in the animation list
  35228. */
  35229. removeAnimation(toRemove: Animation): number;
  35230. /**
  35231. * Will stop the animation of the given target
  35232. * @param target - the target
  35233. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  35234. * @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)
  35235. */
  35236. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  35237. /**
  35238. * Removes the given animation group from this scene.
  35239. * @param toRemove The animation group to remove
  35240. * @returns The index of the removed animation group
  35241. */
  35242. removeAnimationGroup(toRemove: AnimationGroup): number;
  35243. /**
  35244. * Removes the given multi-material from this scene.
  35245. * @param toRemove The multi-material to remove
  35246. * @returns The index of the removed multi-material
  35247. */
  35248. removeMultiMaterial(toRemove: MultiMaterial): number;
  35249. /**
  35250. * Removes the given material from this scene.
  35251. * @param toRemove The material to remove
  35252. * @returns The index of the removed material
  35253. */
  35254. removeMaterial(toRemove: Material): number;
  35255. /**
  35256. * Removes the given action manager from this scene.
  35257. * @param toRemove The action manager to remove
  35258. * @returns The index of the removed action manager
  35259. */
  35260. removeActionManager(toRemove: AbstractActionManager): number;
  35261. /**
  35262. * Removes the given texture from this scene.
  35263. * @param toRemove The texture to remove
  35264. * @returns The index of the removed texture
  35265. */
  35266. removeTexture(toRemove: BaseTexture): number;
  35267. /**
  35268. * Adds the given light to this scene
  35269. * @param newLight The light to add
  35270. */
  35271. addLight(newLight: Light): void;
  35272. /**
  35273. * Sorts the list list based on light priorities
  35274. */
  35275. sortLightsByPriority(): void;
  35276. /**
  35277. * Adds the given camera to this scene
  35278. * @param newCamera The camera to add
  35279. */
  35280. addCamera(newCamera: Camera): void;
  35281. /**
  35282. * Adds the given skeleton to this scene
  35283. * @param newSkeleton The skeleton to add
  35284. */
  35285. addSkeleton(newSkeleton: Skeleton): void;
  35286. /**
  35287. * Adds the given particle system to this scene
  35288. * @param newParticleSystem The particle system to add
  35289. */
  35290. addParticleSystem(newParticleSystem: IParticleSystem): void;
  35291. /**
  35292. * Adds the given animation to this scene
  35293. * @param newAnimation The animation to add
  35294. */
  35295. addAnimation(newAnimation: Animation): void;
  35296. /**
  35297. * Adds the given animation group to this scene.
  35298. * @param newAnimationGroup The animation group to add
  35299. */
  35300. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  35301. /**
  35302. * Adds the given multi-material to this scene
  35303. * @param newMultiMaterial The multi-material to add
  35304. */
  35305. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  35306. /**
  35307. * Adds the given material to this scene
  35308. * @param newMaterial The material to add
  35309. */
  35310. addMaterial(newMaterial: Material): void;
  35311. /**
  35312. * Adds the given morph target to this scene
  35313. * @param newMorphTargetManager The morph target to add
  35314. */
  35315. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  35316. /**
  35317. * Adds the given geometry to this scene
  35318. * @param newGeometry The geometry to add
  35319. */
  35320. addGeometry(newGeometry: Geometry): void;
  35321. /**
  35322. * Adds the given action manager to this scene
  35323. * @param newActionManager The action manager to add
  35324. */
  35325. addActionManager(newActionManager: AbstractActionManager): void;
  35326. /**
  35327. * Adds the given texture to this scene.
  35328. * @param newTexture The texture to add
  35329. */
  35330. addTexture(newTexture: BaseTexture): void;
  35331. /**
  35332. * Switch active camera
  35333. * @param newCamera defines the new active camera
  35334. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  35335. */
  35336. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  35337. /**
  35338. * sets the active camera of the scene using its ID
  35339. * @param id defines the camera's ID
  35340. * @return the new active camera or null if none found.
  35341. */
  35342. setActiveCameraByID(id: string): Nullable<Camera>;
  35343. /**
  35344. * sets the active camera of the scene using its name
  35345. * @param name defines the camera's name
  35346. * @returns the new active camera or null if none found.
  35347. */
  35348. setActiveCameraByName(name: string): Nullable<Camera>;
  35349. /**
  35350. * get an animation group using its name
  35351. * @param name defines the material's name
  35352. * @return the animation group or null if none found.
  35353. */
  35354. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  35355. /**
  35356. * Get a material using its unique id
  35357. * @param uniqueId defines the material's unique id
  35358. * @return the material or null if none found.
  35359. */
  35360. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  35361. /**
  35362. * get a material using its id
  35363. * @param id defines the material's ID
  35364. * @return the material or null if none found.
  35365. */
  35366. getMaterialByID(id: string): Nullable<Material>;
  35367. /**
  35368. * Gets a the last added material using a given id
  35369. * @param id defines the material's ID
  35370. * @return the last material with the given id or null if none found.
  35371. */
  35372. getLastMaterialByID(id: string): Nullable<Material>;
  35373. /**
  35374. * Gets a material using its name
  35375. * @param name defines the material's name
  35376. * @return the material or null if none found.
  35377. */
  35378. getMaterialByName(name: string): Nullable<Material>;
  35379. /**
  35380. * Get a texture using its unique id
  35381. * @param uniqueId defines the texture's unique id
  35382. * @return the texture or null if none found.
  35383. */
  35384. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  35385. /**
  35386. * Gets a camera using its id
  35387. * @param id defines the id to look for
  35388. * @returns the camera or null if not found
  35389. */
  35390. getCameraByID(id: string): Nullable<Camera>;
  35391. /**
  35392. * Gets a camera using its unique id
  35393. * @param uniqueId defines the unique id to look for
  35394. * @returns the camera or null if not found
  35395. */
  35396. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  35397. /**
  35398. * Gets a camera using its name
  35399. * @param name defines the camera's name
  35400. * @return the camera or null if none found.
  35401. */
  35402. getCameraByName(name: string): Nullable<Camera>;
  35403. /**
  35404. * Gets a bone using its id
  35405. * @param id defines the bone's id
  35406. * @return the bone or null if not found
  35407. */
  35408. getBoneByID(id: string): Nullable<Bone>;
  35409. /**
  35410. * Gets a bone using its id
  35411. * @param name defines the bone's name
  35412. * @return the bone or null if not found
  35413. */
  35414. getBoneByName(name: string): Nullable<Bone>;
  35415. /**
  35416. * Gets a light node using its name
  35417. * @param name defines the the light's name
  35418. * @return the light or null if none found.
  35419. */
  35420. getLightByName(name: string): Nullable<Light>;
  35421. /**
  35422. * Gets a light node using its id
  35423. * @param id defines the light's id
  35424. * @return the light or null if none found.
  35425. */
  35426. getLightByID(id: string): Nullable<Light>;
  35427. /**
  35428. * Gets a light node using its scene-generated unique ID
  35429. * @param uniqueId defines the light's unique id
  35430. * @return the light or null if none found.
  35431. */
  35432. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  35433. /**
  35434. * Gets a particle system by id
  35435. * @param id defines the particle system id
  35436. * @return the corresponding system or null if none found
  35437. */
  35438. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  35439. /**
  35440. * Gets a geometry using its ID
  35441. * @param id defines the geometry's id
  35442. * @return the geometry or null if none found.
  35443. */
  35444. getGeometryByID(id: string): Nullable<Geometry>;
  35445. private _getGeometryByUniqueID;
  35446. /**
  35447. * Add a new geometry to this scene
  35448. * @param geometry defines the geometry to be added to the scene.
  35449. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  35450. * @return a boolean defining if the geometry was added or not
  35451. */
  35452. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  35453. /**
  35454. * Removes an existing geometry
  35455. * @param geometry defines the geometry to be removed from the scene
  35456. * @return a boolean defining if the geometry was removed or not
  35457. */
  35458. removeGeometry(geometry: Geometry): boolean;
  35459. /**
  35460. * Gets the list of geometries attached to the scene
  35461. * @returns an array of Geometry
  35462. */
  35463. getGeometries(): Geometry[];
  35464. /**
  35465. * Gets the first added mesh found of a given ID
  35466. * @param id defines the id to search for
  35467. * @return the mesh found or null if not found at all
  35468. */
  35469. getMeshByID(id: string): Nullable<AbstractMesh>;
  35470. /**
  35471. * Gets a list of meshes using their id
  35472. * @param id defines the id to search for
  35473. * @returns a list of meshes
  35474. */
  35475. getMeshesByID(id: string): Array<AbstractMesh>;
  35476. /**
  35477. * Gets the first added transform node found of a given ID
  35478. * @param id defines the id to search for
  35479. * @return the found transform node or null if not found at all.
  35480. */
  35481. getTransformNodeByID(id: string): Nullable<TransformNode>;
  35482. /**
  35483. * Gets a transform node with its auto-generated unique id
  35484. * @param uniqueId efines the unique id to search for
  35485. * @return the found transform node or null if not found at all.
  35486. */
  35487. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  35488. /**
  35489. * Gets a list of transform nodes using their id
  35490. * @param id defines the id to search for
  35491. * @returns a list of transform nodes
  35492. */
  35493. getTransformNodesByID(id: string): Array<TransformNode>;
  35494. /**
  35495. * Gets a mesh with its auto-generated unique id
  35496. * @param uniqueId defines the unique id to search for
  35497. * @return the found mesh or null if not found at all.
  35498. */
  35499. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  35500. /**
  35501. * Gets a the last added mesh using a given id
  35502. * @param id defines the id to search for
  35503. * @return the found mesh or null if not found at all.
  35504. */
  35505. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  35506. /**
  35507. * Gets a the last added node (Mesh, Camera, Light) using a given id
  35508. * @param id defines the id to search for
  35509. * @return the found node or null if not found at all
  35510. */
  35511. getLastEntryByID(id: string): Nullable<Node>;
  35512. /**
  35513. * Gets a node (Mesh, Camera, Light) using a given id
  35514. * @param id defines the id to search for
  35515. * @return the found node or null if not found at all
  35516. */
  35517. getNodeByID(id: string): Nullable<Node>;
  35518. /**
  35519. * Gets a node (Mesh, Camera, Light) using a given name
  35520. * @param name defines the name to search for
  35521. * @return the found node or null if not found at all.
  35522. */
  35523. getNodeByName(name: string): Nullable<Node>;
  35524. /**
  35525. * Gets a mesh using a given name
  35526. * @param name defines the name to search for
  35527. * @return the found mesh or null if not found at all.
  35528. */
  35529. getMeshByName(name: string): Nullable<AbstractMesh>;
  35530. /**
  35531. * Gets a transform node using a given name
  35532. * @param name defines the name to search for
  35533. * @return the found transform node or null if not found at all.
  35534. */
  35535. getTransformNodeByName(name: string): Nullable<TransformNode>;
  35536. /**
  35537. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  35538. * @param id defines the id to search for
  35539. * @return the found skeleton or null if not found at all.
  35540. */
  35541. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  35542. /**
  35543. * Gets a skeleton using a given auto generated unique id
  35544. * @param uniqueId defines the unique id to search for
  35545. * @return the found skeleton or null if not found at all.
  35546. */
  35547. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  35548. /**
  35549. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  35550. * @param id defines the id to search for
  35551. * @return the found skeleton or null if not found at all.
  35552. */
  35553. getSkeletonById(id: string): Nullable<Skeleton>;
  35554. /**
  35555. * Gets a skeleton using a given name
  35556. * @param name defines the name to search for
  35557. * @return the found skeleton or null if not found at all.
  35558. */
  35559. getSkeletonByName(name: string): Nullable<Skeleton>;
  35560. /**
  35561. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  35562. * @param id defines the id to search for
  35563. * @return the found morph target manager or null if not found at all.
  35564. */
  35565. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  35566. /**
  35567. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  35568. * @param id defines the id to search for
  35569. * @return the found morph target or null if not found at all.
  35570. */
  35571. getMorphTargetById(id: string): Nullable<MorphTarget>;
  35572. /**
  35573. * Gets a boolean indicating if the given mesh is active
  35574. * @param mesh defines the mesh to look for
  35575. * @returns true if the mesh is in the active list
  35576. */
  35577. isActiveMesh(mesh: AbstractMesh): boolean;
  35578. /**
  35579. * Return a unique id as a string which can serve as an identifier for the scene
  35580. */
  35581. readonly uid: string;
  35582. /**
  35583. * Add an externaly attached data from its key.
  35584. * This method call will fail and return false, if such key already exists.
  35585. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  35586. * @param key the unique key that identifies the data
  35587. * @param data the data object to associate to the key for this Engine instance
  35588. * @return true if no such key were already present and the data was added successfully, false otherwise
  35589. */
  35590. addExternalData<T>(key: string, data: T): boolean;
  35591. /**
  35592. * Get an externaly attached data from its key
  35593. * @param key the unique key that identifies the data
  35594. * @return the associated data, if present (can be null), or undefined if not present
  35595. */
  35596. getExternalData<T>(key: string): Nullable<T>;
  35597. /**
  35598. * Get an externaly attached data from its key, create it using a factory if it's not already present
  35599. * @param key the unique key that identifies the data
  35600. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  35601. * @return the associated data, can be null if the factory returned null.
  35602. */
  35603. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  35604. /**
  35605. * Remove an externaly attached data from the Engine instance
  35606. * @param key the unique key that identifies the data
  35607. * @return true if the data was successfully removed, false if it doesn't exist
  35608. */
  35609. removeExternalData(key: string): boolean;
  35610. private _evaluateSubMesh;
  35611. /**
  35612. * Clear the processed materials smart array preventing retention point in material dispose.
  35613. */
  35614. freeProcessedMaterials(): void;
  35615. private _preventFreeActiveMeshesAndRenderingGroups;
  35616. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  35617. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  35618. * when disposing several meshes in a row or a hierarchy of meshes.
  35619. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  35620. */
  35621. blockfreeActiveMeshesAndRenderingGroups: boolean;
  35622. /**
  35623. * Clear the active meshes smart array preventing retention point in mesh dispose.
  35624. */
  35625. freeActiveMeshes(): void;
  35626. /**
  35627. * Clear the info related to rendering groups preventing retention points during dispose.
  35628. */
  35629. freeRenderingGroups(): void;
  35630. /** @hidden */
  35631. _isInIntermediateRendering(): boolean;
  35632. /**
  35633. * Lambda returning the list of potentially active meshes.
  35634. */
  35635. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  35636. /**
  35637. * Lambda returning the list of potentially active sub meshes.
  35638. */
  35639. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  35640. /**
  35641. * Lambda returning the list of potentially intersecting sub meshes.
  35642. */
  35643. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  35644. /**
  35645. * Lambda returning the list of potentially colliding sub meshes.
  35646. */
  35647. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  35648. private _activeMeshesFrozen;
  35649. /**
  35650. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  35651. * @returns the current scene
  35652. */
  35653. freezeActiveMeshes(): Scene;
  35654. /**
  35655. * Use this function to restart evaluating active meshes on every frame
  35656. * @returns the current scene
  35657. */
  35658. unfreezeActiveMeshes(): Scene;
  35659. private _evaluateActiveMeshes;
  35660. private _activeMesh;
  35661. /**
  35662. * Update the transform matrix to update from the current active camera
  35663. * @param force defines a boolean used to force the update even if cache is up to date
  35664. */
  35665. updateTransformMatrix(force?: boolean): void;
  35666. private _bindFrameBuffer;
  35667. /** @hidden */
  35668. _allowPostProcessClearColor: boolean;
  35669. /** @hidden */
  35670. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  35671. private _processSubCameras;
  35672. private _checkIntersections;
  35673. /** @hidden */
  35674. _advancePhysicsEngineStep(step: number): void;
  35675. /**
  35676. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  35677. */
  35678. getDeterministicFrameTime: () => number;
  35679. /** @hidden */
  35680. _animate(): void;
  35681. /** Execute all animations (for a frame) */
  35682. animate(): void;
  35683. /**
  35684. * Render the scene
  35685. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  35686. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  35687. */
  35688. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  35689. /**
  35690. * Freeze all materials
  35691. * A frozen material will not be updatable but should be faster to render
  35692. */
  35693. freezeMaterials(): void;
  35694. /**
  35695. * Unfreeze all materials
  35696. * A frozen material will not be updatable but should be faster to render
  35697. */
  35698. unfreezeMaterials(): void;
  35699. /**
  35700. * Releases all held ressources
  35701. */
  35702. dispose(): void;
  35703. /**
  35704. * Gets if the scene is already disposed
  35705. */
  35706. readonly isDisposed: boolean;
  35707. /**
  35708. * Call this function to reduce memory footprint of the scene.
  35709. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  35710. */
  35711. clearCachedVertexData(): void;
  35712. /**
  35713. * This function will remove the local cached buffer data from texture.
  35714. * It will save memory but will prevent the texture from being rebuilt
  35715. */
  35716. cleanCachedTextureBuffer(): void;
  35717. /**
  35718. * Get the world extend vectors with an optional filter
  35719. *
  35720. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  35721. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  35722. */
  35723. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  35724. min: Vector3;
  35725. max: Vector3;
  35726. };
  35727. /**
  35728. * Creates a ray that can be used to pick in the scene
  35729. * @param x defines the x coordinate of the origin (on-screen)
  35730. * @param y defines the y coordinate of the origin (on-screen)
  35731. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  35732. * @param camera defines the camera to use for the picking
  35733. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  35734. * @returns a Ray
  35735. */
  35736. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  35737. /**
  35738. * Creates a ray that can be used to pick in the scene
  35739. * @param x defines the x coordinate of the origin (on-screen)
  35740. * @param y defines the y coordinate of the origin (on-screen)
  35741. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  35742. * @param result defines the ray where to store the picking ray
  35743. * @param camera defines the camera to use for the picking
  35744. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  35745. * @returns the current scene
  35746. */
  35747. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  35748. /**
  35749. * Creates a ray that can be used to pick in the scene
  35750. * @param x defines the x coordinate of the origin (on-screen)
  35751. * @param y defines the y coordinate of the origin (on-screen)
  35752. * @param camera defines the camera to use for the picking
  35753. * @returns a Ray
  35754. */
  35755. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  35756. /**
  35757. * Creates a ray that can be used to pick in the scene
  35758. * @param x defines the x coordinate of the origin (on-screen)
  35759. * @param y defines the y coordinate of the origin (on-screen)
  35760. * @param result defines the ray where to store the picking ray
  35761. * @param camera defines the camera to use for the picking
  35762. * @returns the current scene
  35763. */
  35764. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  35765. /** Launch a ray to try to pick a mesh in the scene
  35766. * @param x position on screen
  35767. * @param y position on screen
  35768. * @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
  35769. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  35770. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  35771. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35772. * @returns a PickingInfo
  35773. */
  35774. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  35775. /** Use the given ray to pick a mesh in the scene
  35776. * @param ray The ray to use to pick meshes
  35777. * @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
  35778. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  35779. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35780. * @returns a PickingInfo
  35781. */
  35782. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  35783. /**
  35784. * Launch a ray to try to pick a mesh in the scene
  35785. * @param x X position on screen
  35786. * @param y Y position on screen
  35787. * @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
  35788. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  35789. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35790. * @returns an array of PickingInfo
  35791. */
  35792. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  35793. /**
  35794. * Launch a ray to try to pick a mesh in the scene
  35795. * @param ray Ray to use
  35796. * @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
  35797. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35798. * @returns an array of PickingInfo
  35799. */
  35800. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  35801. /**
  35802. * Force the value of meshUnderPointer
  35803. * @param mesh defines the mesh to use
  35804. */
  35805. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  35806. /**
  35807. * Gets the mesh under the pointer
  35808. * @returns a Mesh or null if no mesh is under the pointer
  35809. */
  35810. getPointerOverMesh(): Nullable<AbstractMesh>;
  35811. /** @hidden */
  35812. _rebuildGeometries(): void;
  35813. /** @hidden */
  35814. _rebuildTextures(): void;
  35815. private _getByTags;
  35816. /**
  35817. * Get a list of meshes by tags
  35818. * @param tagsQuery defines the tags query to use
  35819. * @param forEach defines a predicate used to filter results
  35820. * @returns an array of Mesh
  35821. */
  35822. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  35823. /**
  35824. * Get a list of cameras by tags
  35825. * @param tagsQuery defines the tags query to use
  35826. * @param forEach defines a predicate used to filter results
  35827. * @returns an array of Camera
  35828. */
  35829. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  35830. /**
  35831. * Get a list of lights by tags
  35832. * @param tagsQuery defines the tags query to use
  35833. * @param forEach defines a predicate used to filter results
  35834. * @returns an array of Light
  35835. */
  35836. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  35837. /**
  35838. * Get a list of materials by tags
  35839. * @param tagsQuery defines the tags query to use
  35840. * @param forEach defines a predicate used to filter results
  35841. * @returns an array of Material
  35842. */
  35843. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  35844. /**
  35845. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  35846. * This allowed control for front to back rendering or reversly depending of the special needs.
  35847. *
  35848. * @param renderingGroupId The rendering group id corresponding to its index
  35849. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  35850. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  35851. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  35852. */
  35853. 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;
  35854. /**
  35855. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  35856. *
  35857. * @param renderingGroupId The rendering group id corresponding to its index
  35858. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  35859. * @param depth Automatically clears depth between groups if true and autoClear is true.
  35860. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  35861. */
  35862. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  35863. /**
  35864. * Gets the current auto clear configuration for one rendering group of the rendering
  35865. * manager.
  35866. * @param index the rendering group index to get the information for
  35867. * @returns The auto clear setup for the requested rendering group
  35868. */
  35869. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  35870. private _blockMaterialDirtyMechanism;
  35871. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  35872. blockMaterialDirtyMechanism: boolean;
  35873. /**
  35874. * Will flag all materials as dirty to trigger new shader compilation
  35875. * @param flag defines the flag used to specify which material part must be marked as dirty
  35876. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  35877. */
  35878. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  35879. /** @hidden */
  35880. _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;
  35881. /** @hidden */
  35882. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  35883. /** @hidden */
  35884. _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;
  35885. /** @hidden */
  35886. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  35887. /** @hidden */
  35888. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  35889. /** @hidden */
  35890. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  35891. }
  35892. }
  35893. declare module "babylonjs/assetContainer" {
  35894. import { AbstractScene } from "babylonjs/abstractScene";
  35895. import { Scene } from "babylonjs/scene";
  35896. import { Mesh } from "babylonjs/Meshes/mesh";
  35897. import { TransformNode } from "babylonjs/Meshes/transformNode";
  35898. import { Skeleton } from "babylonjs/Bones/skeleton";
  35899. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  35900. /**
  35901. * Set of assets to keep when moving a scene into an asset container.
  35902. */
  35903. export class KeepAssets extends AbstractScene {
  35904. }
  35905. /**
  35906. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  35907. */
  35908. export class InstantiatedEntries {
  35909. /**
  35910. * List of new root nodes (eg. nodes with no parent)
  35911. */
  35912. rootNodes: TransformNode[];
  35913. /**
  35914. * List of new skeletons
  35915. */
  35916. skeletons: Skeleton[];
  35917. /**
  35918. * List of new animation groups
  35919. */
  35920. animationGroups: AnimationGroup[];
  35921. }
  35922. /**
  35923. * Container with a set of assets that can be added or removed from a scene.
  35924. */
  35925. export class AssetContainer extends AbstractScene {
  35926. /**
  35927. * The scene the AssetContainer belongs to.
  35928. */
  35929. scene: Scene;
  35930. /**
  35931. * Instantiates an AssetContainer.
  35932. * @param scene The scene the AssetContainer belongs to.
  35933. */
  35934. constructor(scene: Scene);
  35935. /**
  35936. * Instantiate or clone all meshes and add the new ones to the scene.
  35937. * Skeletons and animation groups will all be cloned
  35938. * @param nameFunction defines an optional function used to get new names for clones
  35939. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  35940. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  35941. */
  35942. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  35943. /**
  35944. * Adds all the assets from the container to the scene.
  35945. */
  35946. addAllToScene(): void;
  35947. /**
  35948. * Removes all the assets in the container from the scene
  35949. */
  35950. removeAllFromScene(): void;
  35951. /**
  35952. * Disposes all the assets in the container
  35953. */
  35954. dispose(): void;
  35955. private _moveAssets;
  35956. /**
  35957. * Removes all the assets contained in the scene and adds them to the container.
  35958. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  35959. */
  35960. moveAllFromScene(keepAssets?: KeepAssets): void;
  35961. /**
  35962. * 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.
  35963. * @returns the root mesh
  35964. */
  35965. createRootMesh(): Mesh;
  35966. }
  35967. }
  35968. declare module "babylonjs/abstractScene" {
  35969. import { Scene } from "babylonjs/scene";
  35970. import { Nullable } from "babylonjs/types";
  35971. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  35972. import { TransformNode } from "babylonjs/Meshes/transformNode";
  35973. import { Geometry } from "babylonjs/Meshes/geometry";
  35974. import { Skeleton } from "babylonjs/Bones/skeleton";
  35975. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  35976. import { AssetContainer } from "babylonjs/assetContainer";
  35977. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  35978. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  35979. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35980. import { Material } from "babylonjs/Materials/material";
  35981. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  35982. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  35983. import { Camera } from "babylonjs/Cameras/camera";
  35984. import { Light } from "babylonjs/Lights/light";
  35985. import { Node } from "babylonjs/node";
  35986. import { Animation } from "babylonjs/Animations/animation";
  35987. /**
  35988. * Defines how the parser contract is defined.
  35989. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  35990. */
  35991. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  35992. /**
  35993. * Defines how the individual parser contract is defined.
  35994. * These parser can parse an individual asset
  35995. */
  35996. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  35997. /**
  35998. * Base class of the scene acting as a container for the different elements composing a scene.
  35999. * This class is dynamically extended by the different components of the scene increasing
  36000. * flexibility and reducing coupling
  36001. */
  36002. export abstract class AbstractScene {
  36003. /**
  36004. * Stores the list of available parsers in the application.
  36005. */
  36006. private static _BabylonFileParsers;
  36007. /**
  36008. * Stores the list of available individual parsers in the application.
  36009. */
  36010. private static _IndividualBabylonFileParsers;
  36011. /**
  36012. * Adds a parser in the list of available ones
  36013. * @param name Defines the name of the parser
  36014. * @param parser Defines the parser to add
  36015. */
  36016. static AddParser(name: string, parser: BabylonFileParser): void;
  36017. /**
  36018. * Gets a general parser from the list of avaialble ones
  36019. * @param name Defines the name of the parser
  36020. * @returns the requested parser or null
  36021. */
  36022. static GetParser(name: string): Nullable<BabylonFileParser>;
  36023. /**
  36024. * Adds n individual parser in the list of available ones
  36025. * @param name Defines the name of the parser
  36026. * @param parser Defines the parser to add
  36027. */
  36028. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  36029. /**
  36030. * Gets an individual parser from the list of avaialble ones
  36031. * @param name Defines the name of the parser
  36032. * @returns the requested parser or null
  36033. */
  36034. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  36035. /**
  36036. * Parser json data and populate both a scene and its associated container object
  36037. * @param jsonData Defines the data to parse
  36038. * @param scene Defines the scene to parse the data for
  36039. * @param container Defines the container attached to the parsing sequence
  36040. * @param rootUrl Defines the root url of the data
  36041. */
  36042. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  36043. /**
  36044. * Gets the list of root nodes (ie. nodes with no parent)
  36045. */
  36046. rootNodes: Node[];
  36047. /** All of the cameras added to this scene
  36048. * @see http://doc.babylonjs.com/babylon101/cameras
  36049. */
  36050. cameras: Camera[];
  36051. /**
  36052. * All of the lights added to this scene
  36053. * @see http://doc.babylonjs.com/babylon101/lights
  36054. */
  36055. lights: Light[];
  36056. /**
  36057. * All of the (abstract) meshes added to this scene
  36058. */
  36059. meshes: AbstractMesh[];
  36060. /**
  36061. * The list of skeletons added to the scene
  36062. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  36063. */
  36064. skeletons: Skeleton[];
  36065. /**
  36066. * All of the particle systems added to this scene
  36067. * @see http://doc.babylonjs.com/babylon101/particles
  36068. */
  36069. particleSystems: IParticleSystem[];
  36070. /**
  36071. * Gets a list of Animations associated with the scene
  36072. */
  36073. animations: Animation[];
  36074. /**
  36075. * All of the animation groups added to this scene
  36076. * @see http://doc.babylonjs.com/how_to/group
  36077. */
  36078. animationGroups: AnimationGroup[];
  36079. /**
  36080. * All of the multi-materials added to this scene
  36081. * @see http://doc.babylonjs.com/how_to/multi_materials
  36082. */
  36083. multiMaterials: MultiMaterial[];
  36084. /**
  36085. * All of the materials added to this scene
  36086. * In the context of a Scene, it is not supposed to be modified manually.
  36087. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  36088. * Note also that the order of the Material within the array is not significant and might change.
  36089. * @see http://doc.babylonjs.com/babylon101/materials
  36090. */
  36091. materials: Material[];
  36092. /**
  36093. * The list of morph target managers added to the scene
  36094. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  36095. */
  36096. morphTargetManagers: MorphTargetManager[];
  36097. /**
  36098. * The list of geometries used in the scene.
  36099. */
  36100. geometries: Geometry[];
  36101. /**
  36102. * All of the tranform nodes added to this scene
  36103. * In the context of a Scene, it is not supposed to be modified manually.
  36104. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  36105. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  36106. * @see http://doc.babylonjs.com/how_to/transformnode
  36107. */
  36108. transformNodes: TransformNode[];
  36109. /**
  36110. * ActionManagers available on the scene.
  36111. */
  36112. actionManagers: AbstractActionManager[];
  36113. /**
  36114. * Textures to keep.
  36115. */
  36116. textures: BaseTexture[];
  36117. /**
  36118. * Environment texture for the scene
  36119. */
  36120. environmentTexture: Nullable<BaseTexture>;
  36121. }
  36122. }
  36123. declare module "babylonjs/Audio/sound" {
  36124. import { Observable } from "babylonjs/Misc/observable";
  36125. import { Vector3 } from "babylonjs/Maths/math.vector";
  36126. import { Nullable } from "babylonjs/types";
  36127. import { Scene } from "babylonjs/scene";
  36128. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36129. /**
  36130. * Interface used to define options for Sound class
  36131. */
  36132. export interface ISoundOptions {
  36133. /**
  36134. * Does the sound autoplay once loaded.
  36135. */
  36136. autoplay?: boolean;
  36137. /**
  36138. * Does the sound loop after it finishes playing once.
  36139. */
  36140. loop?: boolean;
  36141. /**
  36142. * Sound's volume
  36143. */
  36144. volume?: number;
  36145. /**
  36146. * Is it a spatial sound?
  36147. */
  36148. spatialSound?: boolean;
  36149. /**
  36150. * Maximum distance to hear that sound
  36151. */
  36152. maxDistance?: number;
  36153. /**
  36154. * Uses user defined attenuation function
  36155. */
  36156. useCustomAttenuation?: boolean;
  36157. /**
  36158. * Define the roll off factor of spatial sounds.
  36159. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36160. */
  36161. rolloffFactor?: number;
  36162. /**
  36163. * Define the reference distance the sound should be heard perfectly.
  36164. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36165. */
  36166. refDistance?: number;
  36167. /**
  36168. * Define the distance attenuation model the sound will follow.
  36169. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36170. */
  36171. distanceModel?: string;
  36172. /**
  36173. * Defines the playback speed (1 by default)
  36174. */
  36175. playbackRate?: number;
  36176. /**
  36177. * Defines if the sound is from a streaming source
  36178. */
  36179. streaming?: boolean;
  36180. /**
  36181. * Defines an optional length (in seconds) inside the sound file
  36182. */
  36183. length?: number;
  36184. /**
  36185. * Defines an optional offset (in seconds) inside the sound file
  36186. */
  36187. offset?: number;
  36188. /**
  36189. * If true, URLs will not be required to state the audio file codec to use.
  36190. */
  36191. skipCodecCheck?: boolean;
  36192. }
  36193. /**
  36194. * Defines a sound that can be played in the application.
  36195. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  36196. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36197. */
  36198. export class Sound {
  36199. /**
  36200. * The name of the sound in the scene.
  36201. */
  36202. name: string;
  36203. /**
  36204. * Does the sound autoplay once loaded.
  36205. */
  36206. autoplay: boolean;
  36207. /**
  36208. * Does the sound loop after it finishes playing once.
  36209. */
  36210. loop: boolean;
  36211. /**
  36212. * Does the sound use a custom attenuation curve to simulate the falloff
  36213. * happening when the source gets further away from the camera.
  36214. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  36215. */
  36216. useCustomAttenuation: boolean;
  36217. /**
  36218. * The sound track id this sound belongs to.
  36219. */
  36220. soundTrackId: number;
  36221. /**
  36222. * Is this sound currently played.
  36223. */
  36224. isPlaying: boolean;
  36225. /**
  36226. * Is this sound currently paused.
  36227. */
  36228. isPaused: boolean;
  36229. /**
  36230. * Does this sound enables spatial sound.
  36231. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36232. */
  36233. spatialSound: boolean;
  36234. /**
  36235. * Define the reference distance the sound should be heard perfectly.
  36236. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36237. */
  36238. refDistance: number;
  36239. /**
  36240. * Define the roll off factor of spatial sounds.
  36241. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36242. */
  36243. rolloffFactor: number;
  36244. /**
  36245. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  36246. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36247. */
  36248. maxDistance: number;
  36249. /**
  36250. * Define the distance attenuation model the sound will follow.
  36251. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36252. */
  36253. distanceModel: string;
  36254. /**
  36255. * @hidden
  36256. * Back Compat
  36257. **/
  36258. onended: () => any;
  36259. /**
  36260. * Observable event when the current playing sound finishes.
  36261. */
  36262. onEndedObservable: Observable<Sound>;
  36263. private _panningModel;
  36264. private _playbackRate;
  36265. private _streaming;
  36266. private _startTime;
  36267. private _startOffset;
  36268. private _position;
  36269. /** @hidden */
  36270. _positionInEmitterSpace: boolean;
  36271. private _localDirection;
  36272. private _volume;
  36273. private _isReadyToPlay;
  36274. private _isDirectional;
  36275. private _readyToPlayCallback;
  36276. private _audioBuffer;
  36277. private _soundSource;
  36278. private _streamingSource;
  36279. private _soundPanner;
  36280. private _soundGain;
  36281. private _inputAudioNode;
  36282. private _outputAudioNode;
  36283. private _coneInnerAngle;
  36284. private _coneOuterAngle;
  36285. private _coneOuterGain;
  36286. private _scene;
  36287. private _connectedTransformNode;
  36288. private _customAttenuationFunction;
  36289. private _registerFunc;
  36290. private _isOutputConnected;
  36291. private _htmlAudioElement;
  36292. private _urlType;
  36293. private _length?;
  36294. private _offset?;
  36295. /** @hidden */
  36296. static _SceneComponentInitialization: (scene: Scene) => void;
  36297. /**
  36298. * Create a sound and attach it to a scene
  36299. * @param name Name of your sound
  36300. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  36301. * @param scene defines the scene the sound belongs to
  36302. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  36303. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  36304. */
  36305. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  36306. /**
  36307. * Release the sound and its associated resources
  36308. */
  36309. dispose(): void;
  36310. /**
  36311. * Gets if the sounds is ready to be played or not.
  36312. * @returns true if ready, otherwise false
  36313. */
  36314. isReady(): boolean;
  36315. private _soundLoaded;
  36316. /**
  36317. * Sets the data of the sound from an audiobuffer
  36318. * @param audioBuffer The audioBuffer containing the data
  36319. */
  36320. setAudioBuffer(audioBuffer: AudioBuffer): void;
  36321. /**
  36322. * Updates the current sounds options such as maxdistance, loop...
  36323. * @param options A JSON object containing values named as the object properties
  36324. */
  36325. updateOptions(options: ISoundOptions): void;
  36326. private _createSpatialParameters;
  36327. private _updateSpatialParameters;
  36328. /**
  36329. * Switch the panning model to HRTF:
  36330. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  36331. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36332. */
  36333. switchPanningModelToHRTF(): void;
  36334. /**
  36335. * Switch the panning model to Equal Power:
  36336. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  36337. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36338. */
  36339. switchPanningModelToEqualPower(): void;
  36340. private _switchPanningModel;
  36341. /**
  36342. * Connect this sound to a sound track audio node like gain...
  36343. * @param soundTrackAudioNode the sound track audio node to connect to
  36344. */
  36345. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  36346. /**
  36347. * Transform this sound into a directional source
  36348. * @param coneInnerAngle Size of the inner cone in degree
  36349. * @param coneOuterAngle Size of the outer cone in degree
  36350. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  36351. */
  36352. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  36353. /**
  36354. * Gets or sets the inner angle for the directional cone.
  36355. */
  36356. /**
  36357. * Gets or sets the inner angle for the directional cone.
  36358. */
  36359. directionalConeInnerAngle: number;
  36360. /**
  36361. * Gets or sets the outer angle for the directional cone.
  36362. */
  36363. /**
  36364. * Gets or sets the outer angle for the directional cone.
  36365. */
  36366. directionalConeOuterAngle: number;
  36367. /**
  36368. * Sets the position of the emitter if spatial sound is enabled
  36369. * @param newPosition Defines the new posisiton
  36370. */
  36371. setPosition(newPosition: Vector3): void;
  36372. /**
  36373. * Sets the local direction of the emitter if spatial sound is enabled
  36374. * @param newLocalDirection Defines the new local direction
  36375. */
  36376. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  36377. private _updateDirection;
  36378. /** @hidden */
  36379. updateDistanceFromListener(): void;
  36380. /**
  36381. * Sets a new custom attenuation function for the sound.
  36382. * @param callback Defines the function used for the attenuation
  36383. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  36384. */
  36385. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  36386. /**
  36387. * Play the sound
  36388. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  36389. * @param offset (optional) Start the sound at a specific time in seconds
  36390. * @param length (optional) Sound duration (in seconds)
  36391. */
  36392. play(time?: number, offset?: number, length?: number): void;
  36393. private _onended;
  36394. /**
  36395. * Stop the sound
  36396. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  36397. */
  36398. stop(time?: number): void;
  36399. /**
  36400. * Put the sound in pause
  36401. */
  36402. pause(): void;
  36403. /**
  36404. * Sets a dedicated volume for this sounds
  36405. * @param newVolume Define the new volume of the sound
  36406. * @param time Define time for gradual change to new volume
  36407. */
  36408. setVolume(newVolume: number, time?: number): void;
  36409. /**
  36410. * Set the sound play back rate
  36411. * @param newPlaybackRate Define the playback rate the sound should be played at
  36412. */
  36413. setPlaybackRate(newPlaybackRate: number): void;
  36414. /**
  36415. * Gets the volume of the sound.
  36416. * @returns the volume of the sound
  36417. */
  36418. getVolume(): number;
  36419. /**
  36420. * Attach the sound to a dedicated mesh
  36421. * @param transformNode The transform node to connect the sound with
  36422. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  36423. */
  36424. attachToMesh(transformNode: TransformNode): void;
  36425. /**
  36426. * Detach the sound from the previously attached mesh
  36427. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  36428. */
  36429. detachFromMesh(): void;
  36430. private _onRegisterAfterWorldMatrixUpdate;
  36431. /**
  36432. * Clone the current sound in the scene.
  36433. * @returns the new sound clone
  36434. */
  36435. clone(): Nullable<Sound>;
  36436. /**
  36437. * Gets the current underlying audio buffer containing the data
  36438. * @returns the audio buffer
  36439. */
  36440. getAudioBuffer(): Nullable<AudioBuffer>;
  36441. /**
  36442. * Serializes the Sound in a JSON representation
  36443. * @returns the JSON representation of the sound
  36444. */
  36445. serialize(): any;
  36446. /**
  36447. * Parse a JSON representation of a sound to innstantiate in a given scene
  36448. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  36449. * @param scene Define the scene the new parsed sound should be created in
  36450. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  36451. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  36452. * @returns the newly parsed sound
  36453. */
  36454. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  36455. }
  36456. }
  36457. declare module "babylonjs/Actions/directAudioActions" {
  36458. import { Action } from "babylonjs/Actions/action";
  36459. import { Condition } from "babylonjs/Actions/condition";
  36460. import { Sound } from "babylonjs/Audio/sound";
  36461. /**
  36462. * This defines an action helpful to play a defined sound on a triggered action.
  36463. */
  36464. export class PlaySoundAction extends Action {
  36465. private _sound;
  36466. /**
  36467. * Instantiate the action
  36468. * @param triggerOptions defines the trigger options
  36469. * @param sound defines the sound to play
  36470. * @param condition defines the trigger related conditions
  36471. */
  36472. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36473. /** @hidden */
  36474. _prepare(): void;
  36475. /**
  36476. * Execute the action and play the sound.
  36477. */
  36478. execute(): void;
  36479. /**
  36480. * Serializes the actions and its related information.
  36481. * @param parent defines the object to serialize in
  36482. * @returns the serialized object
  36483. */
  36484. serialize(parent: any): any;
  36485. }
  36486. /**
  36487. * This defines an action helpful to stop a defined sound on a triggered action.
  36488. */
  36489. export class StopSoundAction extends Action {
  36490. private _sound;
  36491. /**
  36492. * Instantiate the action
  36493. * @param triggerOptions defines the trigger options
  36494. * @param sound defines the sound to stop
  36495. * @param condition defines the trigger related conditions
  36496. */
  36497. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36498. /** @hidden */
  36499. _prepare(): void;
  36500. /**
  36501. * Execute the action and stop the sound.
  36502. */
  36503. execute(): void;
  36504. /**
  36505. * Serializes the actions and its related information.
  36506. * @param parent defines the object to serialize in
  36507. * @returns the serialized object
  36508. */
  36509. serialize(parent: any): any;
  36510. }
  36511. }
  36512. declare module "babylonjs/Actions/interpolateValueAction" {
  36513. import { Action } from "babylonjs/Actions/action";
  36514. import { Condition } from "babylonjs/Actions/condition";
  36515. import { Observable } from "babylonjs/Misc/observable";
  36516. /**
  36517. * This defines an action responsible to change the value of a property
  36518. * by interpolating between its current value and the newly set one once triggered.
  36519. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  36520. */
  36521. export class InterpolateValueAction extends Action {
  36522. /**
  36523. * Defines the path of the property where the value should be interpolated
  36524. */
  36525. propertyPath: string;
  36526. /**
  36527. * Defines the target value at the end of the interpolation.
  36528. */
  36529. value: any;
  36530. /**
  36531. * Defines the time it will take for the property to interpolate to the value.
  36532. */
  36533. duration: number;
  36534. /**
  36535. * Defines if the other scene animations should be stopped when the action has been triggered
  36536. */
  36537. stopOtherAnimations?: boolean;
  36538. /**
  36539. * Defines a callback raised once the interpolation animation has been done.
  36540. */
  36541. onInterpolationDone?: () => void;
  36542. /**
  36543. * Observable triggered once the interpolation animation has been done.
  36544. */
  36545. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  36546. private _target;
  36547. private _effectiveTarget;
  36548. private _property;
  36549. /**
  36550. * Instantiate the action
  36551. * @param triggerOptions defines the trigger options
  36552. * @param target defines the object containing the value to interpolate
  36553. * @param propertyPath defines the path to the property in the target object
  36554. * @param value defines the target value at the end of the interpolation
  36555. * @param duration deines the time it will take for the property to interpolate to the value.
  36556. * @param condition defines the trigger related conditions
  36557. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  36558. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  36559. */
  36560. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  36561. /** @hidden */
  36562. _prepare(): void;
  36563. /**
  36564. * Execute the action starts the value interpolation.
  36565. */
  36566. execute(): void;
  36567. /**
  36568. * Serializes the actions and its related information.
  36569. * @param parent defines the object to serialize in
  36570. * @returns the serialized object
  36571. */
  36572. serialize(parent: any): any;
  36573. }
  36574. }
  36575. declare module "babylonjs/Actions/index" {
  36576. export * from "babylonjs/Actions/abstractActionManager";
  36577. export * from "babylonjs/Actions/action";
  36578. export * from "babylonjs/Actions/actionEvent";
  36579. export * from "babylonjs/Actions/actionManager";
  36580. export * from "babylonjs/Actions/condition";
  36581. export * from "babylonjs/Actions/directActions";
  36582. export * from "babylonjs/Actions/directAudioActions";
  36583. export * from "babylonjs/Actions/interpolateValueAction";
  36584. }
  36585. declare module "babylonjs/Animations/index" {
  36586. export * from "babylonjs/Animations/animatable";
  36587. export * from "babylonjs/Animations/animation";
  36588. export * from "babylonjs/Animations/animationGroup";
  36589. export * from "babylonjs/Animations/animationPropertiesOverride";
  36590. export * from "babylonjs/Animations/easing";
  36591. export * from "babylonjs/Animations/runtimeAnimation";
  36592. export * from "babylonjs/Animations/animationEvent";
  36593. export * from "babylonjs/Animations/animationGroup";
  36594. export * from "babylonjs/Animations/animationKey";
  36595. export * from "babylonjs/Animations/animationRange";
  36596. export * from "babylonjs/Animations/animatable.interface";
  36597. }
  36598. declare module "babylonjs/Audio/soundTrack" {
  36599. import { Sound } from "babylonjs/Audio/sound";
  36600. import { Analyser } from "babylonjs/Audio/analyser";
  36601. import { Scene } from "babylonjs/scene";
  36602. /**
  36603. * Options allowed during the creation of a sound track.
  36604. */
  36605. export interface ISoundTrackOptions {
  36606. /**
  36607. * The volume the sound track should take during creation
  36608. */
  36609. volume?: number;
  36610. /**
  36611. * Define if the sound track is the main sound track of the scene
  36612. */
  36613. mainTrack?: boolean;
  36614. }
  36615. /**
  36616. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  36617. * It will be also used in a future release to apply effects on a specific track.
  36618. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36619. */
  36620. export class SoundTrack {
  36621. /**
  36622. * The unique identifier of the sound track in the scene.
  36623. */
  36624. id: number;
  36625. /**
  36626. * The list of sounds included in the sound track.
  36627. */
  36628. soundCollection: Array<Sound>;
  36629. private _outputAudioNode;
  36630. private _scene;
  36631. private _isMainTrack;
  36632. private _connectedAnalyser;
  36633. private _options;
  36634. private _isInitialized;
  36635. /**
  36636. * Creates a new sound track.
  36637. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36638. * @param scene Define the scene the sound track belongs to
  36639. * @param options
  36640. */
  36641. constructor(scene: Scene, options?: ISoundTrackOptions);
  36642. private _initializeSoundTrackAudioGraph;
  36643. /**
  36644. * Release the sound track and its associated resources
  36645. */
  36646. dispose(): void;
  36647. /**
  36648. * Adds a sound to this sound track
  36649. * @param sound define the cound to add
  36650. * @ignoreNaming
  36651. */
  36652. AddSound(sound: Sound): void;
  36653. /**
  36654. * Removes a sound to this sound track
  36655. * @param sound define the cound to remove
  36656. * @ignoreNaming
  36657. */
  36658. RemoveSound(sound: Sound): void;
  36659. /**
  36660. * Set a global volume for the full sound track.
  36661. * @param newVolume Define the new volume of the sound track
  36662. */
  36663. setVolume(newVolume: number): void;
  36664. /**
  36665. * Switch the panning model to HRTF:
  36666. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  36667. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36668. */
  36669. switchPanningModelToHRTF(): void;
  36670. /**
  36671. * Switch the panning model to Equal Power:
  36672. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  36673. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36674. */
  36675. switchPanningModelToEqualPower(): void;
  36676. /**
  36677. * Connect the sound track to an audio analyser allowing some amazing
  36678. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  36679. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  36680. * @param analyser The analyser to connect to the engine
  36681. */
  36682. connectToAnalyser(analyser: Analyser): void;
  36683. }
  36684. }
  36685. declare module "babylonjs/Audio/audioSceneComponent" {
  36686. import { Sound } from "babylonjs/Audio/sound";
  36687. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  36688. import { Nullable } from "babylonjs/types";
  36689. import { Vector3 } from "babylonjs/Maths/math.vector";
  36690. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  36691. import { Scene } from "babylonjs/scene";
  36692. import { AbstractScene } from "babylonjs/abstractScene";
  36693. import "babylonjs/Audio/audioEngine";
  36694. module "babylonjs/abstractScene" {
  36695. interface AbstractScene {
  36696. /**
  36697. * The list of sounds used in the scene.
  36698. */
  36699. sounds: Nullable<Array<Sound>>;
  36700. }
  36701. }
  36702. module "babylonjs/scene" {
  36703. interface Scene {
  36704. /**
  36705. * @hidden
  36706. * Backing field
  36707. */
  36708. _mainSoundTrack: SoundTrack;
  36709. /**
  36710. * The main sound track played by the scene.
  36711. * It cotains your primary collection of sounds.
  36712. */
  36713. mainSoundTrack: SoundTrack;
  36714. /**
  36715. * The list of sound tracks added to the scene
  36716. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36717. */
  36718. soundTracks: Nullable<Array<SoundTrack>>;
  36719. /**
  36720. * Gets a sound using a given name
  36721. * @param name defines the name to search for
  36722. * @return the found sound or null if not found at all.
  36723. */
  36724. getSoundByName(name: string): Nullable<Sound>;
  36725. /**
  36726. * Gets or sets if audio support is enabled
  36727. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36728. */
  36729. audioEnabled: boolean;
  36730. /**
  36731. * Gets or sets if audio will be output to headphones
  36732. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36733. */
  36734. headphone: boolean;
  36735. /**
  36736. * Gets or sets custom audio listener position provider
  36737. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36738. */
  36739. audioListenerPositionProvider: Nullable<() => Vector3>;
  36740. /**
  36741. * Gets or sets a refresh rate when using 3D audio positioning
  36742. */
  36743. audioPositioningRefreshRate: number;
  36744. }
  36745. }
  36746. /**
  36747. * Defines the sound scene component responsible to manage any sounds
  36748. * in a given scene.
  36749. */
  36750. export class AudioSceneComponent implements ISceneSerializableComponent {
  36751. /**
  36752. * The component name helpfull to identify the component in the list of scene components.
  36753. */
  36754. readonly name: string;
  36755. /**
  36756. * The scene the component belongs to.
  36757. */
  36758. scene: Scene;
  36759. private _audioEnabled;
  36760. /**
  36761. * Gets whether audio is enabled or not.
  36762. * Please use related enable/disable method to switch state.
  36763. */
  36764. readonly audioEnabled: boolean;
  36765. private _headphone;
  36766. /**
  36767. * Gets whether audio is outputing to headphone or not.
  36768. * Please use the according Switch methods to change output.
  36769. */
  36770. readonly headphone: boolean;
  36771. /**
  36772. * Gets or sets a refresh rate when using 3D audio positioning
  36773. */
  36774. audioPositioningRefreshRate: number;
  36775. private _audioListenerPositionProvider;
  36776. /**
  36777. * Gets the current audio listener position provider
  36778. */
  36779. /**
  36780. * Sets a custom listener position for all sounds in the scene
  36781. * By default, this is the position of the first active camera
  36782. */
  36783. audioListenerPositionProvider: Nullable<() => Vector3>;
  36784. /**
  36785. * Creates a new instance of the component for the given scene
  36786. * @param scene Defines the scene to register the component in
  36787. */
  36788. constructor(scene: Scene);
  36789. /**
  36790. * Registers the component in a given scene
  36791. */
  36792. register(): void;
  36793. /**
  36794. * Rebuilds the elements related to this component in case of
  36795. * context lost for instance.
  36796. */
  36797. rebuild(): void;
  36798. /**
  36799. * Serializes the component data to the specified json object
  36800. * @param serializationObject The object to serialize to
  36801. */
  36802. serialize(serializationObject: any): void;
  36803. /**
  36804. * Adds all the elements from the container to the scene
  36805. * @param container the container holding the elements
  36806. */
  36807. addFromContainer(container: AbstractScene): void;
  36808. /**
  36809. * Removes all the elements in the container from the scene
  36810. * @param container contains the elements to remove
  36811. * @param dispose if the removed element should be disposed (default: false)
  36812. */
  36813. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  36814. /**
  36815. * Disposes the component and the associated ressources.
  36816. */
  36817. dispose(): void;
  36818. /**
  36819. * Disables audio in the associated scene.
  36820. */
  36821. disableAudio(): void;
  36822. /**
  36823. * Enables audio in the associated scene.
  36824. */
  36825. enableAudio(): void;
  36826. /**
  36827. * Switch audio to headphone output.
  36828. */
  36829. switchAudioModeForHeadphones(): void;
  36830. /**
  36831. * Switch audio to normal speakers.
  36832. */
  36833. switchAudioModeForNormalSpeakers(): void;
  36834. private _cachedCameraDirection;
  36835. private _cachedCameraPosition;
  36836. private _lastCheck;
  36837. private _afterRender;
  36838. }
  36839. }
  36840. declare module "babylonjs/Audio/weightedsound" {
  36841. import { Sound } from "babylonjs/Audio/sound";
  36842. /**
  36843. * Wraps one or more Sound objects and selects one with random weight for playback.
  36844. */
  36845. export class WeightedSound {
  36846. /** When true a Sound will be selected and played when the current playing Sound completes. */
  36847. loop: boolean;
  36848. private _coneInnerAngle;
  36849. private _coneOuterAngle;
  36850. private _volume;
  36851. /** A Sound is currently playing. */
  36852. isPlaying: boolean;
  36853. /** A Sound is currently paused. */
  36854. isPaused: boolean;
  36855. private _sounds;
  36856. private _weights;
  36857. private _currentIndex?;
  36858. /**
  36859. * Creates a new WeightedSound from the list of sounds given.
  36860. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  36861. * @param sounds Array of Sounds that will be selected from.
  36862. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  36863. */
  36864. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  36865. /**
  36866. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  36867. */
  36868. /**
  36869. * The size of cone in degress for a directional sound in which there will be no attenuation.
  36870. */
  36871. directionalConeInnerAngle: number;
  36872. /**
  36873. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  36874. * Listener angles between innerAngle and outerAngle will falloff linearly.
  36875. */
  36876. /**
  36877. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  36878. * Listener angles between innerAngle and outerAngle will falloff linearly.
  36879. */
  36880. directionalConeOuterAngle: number;
  36881. /**
  36882. * Playback volume.
  36883. */
  36884. /**
  36885. * Playback volume.
  36886. */
  36887. volume: number;
  36888. private _onended;
  36889. /**
  36890. * Suspend playback
  36891. */
  36892. pause(): void;
  36893. /**
  36894. * Stop playback
  36895. */
  36896. stop(): void;
  36897. /**
  36898. * Start playback.
  36899. * @param startOffset Position the clip head at a specific time in seconds.
  36900. */
  36901. play(startOffset?: number): void;
  36902. }
  36903. }
  36904. declare module "babylonjs/Audio/index" {
  36905. export * from "babylonjs/Audio/analyser";
  36906. export * from "babylonjs/Audio/audioEngine";
  36907. export * from "babylonjs/Audio/audioSceneComponent";
  36908. export * from "babylonjs/Audio/sound";
  36909. export * from "babylonjs/Audio/soundTrack";
  36910. export * from "babylonjs/Audio/weightedsound";
  36911. }
  36912. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  36913. import { Behavior } from "babylonjs/Behaviors/behavior";
  36914. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36915. import { BackEase } from "babylonjs/Animations/easing";
  36916. /**
  36917. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  36918. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  36919. */
  36920. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  36921. /**
  36922. * Gets the name of the behavior.
  36923. */
  36924. readonly name: string;
  36925. /**
  36926. * The easing function used by animations
  36927. */
  36928. static EasingFunction: BackEase;
  36929. /**
  36930. * The easing mode used by animations
  36931. */
  36932. static EasingMode: number;
  36933. /**
  36934. * The duration of the animation, in milliseconds
  36935. */
  36936. transitionDuration: number;
  36937. /**
  36938. * Length of the distance animated by the transition when lower radius is reached
  36939. */
  36940. lowerRadiusTransitionRange: number;
  36941. /**
  36942. * Length of the distance animated by the transition when upper radius is reached
  36943. */
  36944. upperRadiusTransitionRange: number;
  36945. private _autoTransitionRange;
  36946. /**
  36947. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  36948. */
  36949. /**
  36950. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  36951. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  36952. */
  36953. autoTransitionRange: boolean;
  36954. private _attachedCamera;
  36955. private _onAfterCheckInputsObserver;
  36956. private _onMeshTargetChangedObserver;
  36957. /**
  36958. * Initializes the behavior.
  36959. */
  36960. init(): void;
  36961. /**
  36962. * Attaches the behavior to its arc rotate camera.
  36963. * @param camera Defines the camera to attach the behavior to
  36964. */
  36965. attach(camera: ArcRotateCamera): void;
  36966. /**
  36967. * Detaches the behavior from its current arc rotate camera.
  36968. */
  36969. detach(): void;
  36970. private _radiusIsAnimating;
  36971. private _radiusBounceTransition;
  36972. private _animatables;
  36973. private _cachedWheelPrecision;
  36974. /**
  36975. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  36976. * @param radiusLimit The limit to check against.
  36977. * @return Bool to indicate if at limit.
  36978. */
  36979. private _isRadiusAtLimit;
  36980. /**
  36981. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  36982. * @param radiusDelta The delta by which to animate to. Can be negative.
  36983. */
  36984. private _applyBoundRadiusAnimation;
  36985. /**
  36986. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  36987. */
  36988. protected _clearAnimationLocks(): void;
  36989. /**
  36990. * Stops and removes all animations that have been applied to the camera
  36991. */
  36992. stopAllAnimations(): void;
  36993. }
  36994. }
  36995. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  36996. import { Behavior } from "babylonjs/Behaviors/behavior";
  36997. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36998. import { ExponentialEase } from "babylonjs/Animations/easing";
  36999. import { Nullable } from "babylonjs/types";
  37000. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37001. import { Vector3 } from "babylonjs/Maths/math.vector";
  37002. /**
  37003. * 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.
  37004. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37005. */
  37006. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  37007. /**
  37008. * Gets the name of the behavior.
  37009. */
  37010. readonly name: string;
  37011. private _mode;
  37012. private _radiusScale;
  37013. private _positionScale;
  37014. private _defaultElevation;
  37015. private _elevationReturnTime;
  37016. private _elevationReturnWaitTime;
  37017. private _zoomStopsAnimation;
  37018. private _framingTime;
  37019. /**
  37020. * The easing function used by animations
  37021. */
  37022. static EasingFunction: ExponentialEase;
  37023. /**
  37024. * The easing mode used by animations
  37025. */
  37026. static EasingMode: number;
  37027. /**
  37028. * Sets the current mode used by the behavior
  37029. */
  37030. /**
  37031. * Gets current mode used by the behavior.
  37032. */
  37033. mode: number;
  37034. /**
  37035. * Sets the scale applied to the radius (1 by default)
  37036. */
  37037. /**
  37038. * Gets the scale applied to the radius
  37039. */
  37040. radiusScale: number;
  37041. /**
  37042. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  37043. */
  37044. /**
  37045. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  37046. */
  37047. positionScale: number;
  37048. /**
  37049. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  37050. * behaviour is triggered, in radians.
  37051. */
  37052. /**
  37053. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  37054. * behaviour is triggered, in radians.
  37055. */
  37056. defaultElevation: number;
  37057. /**
  37058. * Sets the time (in milliseconds) taken to return to the default beta position.
  37059. * Negative value indicates camera should not return to default.
  37060. */
  37061. /**
  37062. * Gets the time (in milliseconds) taken to return to the default beta position.
  37063. * Negative value indicates camera should not return to default.
  37064. */
  37065. elevationReturnTime: number;
  37066. /**
  37067. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  37068. */
  37069. /**
  37070. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  37071. */
  37072. elevationReturnWaitTime: number;
  37073. /**
  37074. * Sets the flag that indicates if user zooming should stop animation.
  37075. */
  37076. /**
  37077. * Gets the flag that indicates if user zooming should stop animation.
  37078. */
  37079. zoomStopsAnimation: boolean;
  37080. /**
  37081. * Sets the transition time when framing the mesh, in milliseconds
  37082. */
  37083. /**
  37084. * Gets the transition time when framing the mesh, in milliseconds
  37085. */
  37086. framingTime: number;
  37087. /**
  37088. * Define if the behavior should automatically change the configured
  37089. * camera limits and sensibilities.
  37090. */
  37091. autoCorrectCameraLimitsAndSensibility: boolean;
  37092. private _onPrePointerObservableObserver;
  37093. private _onAfterCheckInputsObserver;
  37094. private _onMeshTargetChangedObserver;
  37095. private _attachedCamera;
  37096. private _isPointerDown;
  37097. private _lastInteractionTime;
  37098. /**
  37099. * Initializes the behavior.
  37100. */
  37101. init(): void;
  37102. /**
  37103. * Attaches the behavior to its arc rotate camera.
  37104. * @param camera Defines the camera to attach the behavior to
  37105. */
  37106. attach(camera: ArcRotateCamera): void;
  37107. /**
  37108. * Detaches the behavior from its current arc rotate camera.
  37109. */
  37110. detach(): void;
  37111. private _animatables;
  37112. private _betaIsAnimating;
  37113. private _betaTransition;
  37114. private _radiusTransition;
  37115. private _vectorTransition;
  37116. /**
  37117. * Targets the given mesh and updates zoom level accordingly.
  37118. * @param mesh The mesh to target.
  37119. * @param radius Optional. If a cached radius position already exists, overrides default.
  37120. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37121. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37122. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37123. */
  37124. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37125. /**
  37126. * Targets the given mesh with its children and updates zoom level accordingly.
  37127. * @param mesh The mesh to target.
  37128. * @param radius Optional. If a cached radius position already exists, overrides default.
  37129. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37130. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37131. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37132. */
  37133. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37134. /**
  37135. * Targets the given meshes with their children and updates zoom level accordingly.
  37136. * @param meshes The mesh to target.
  37137. * @param radius Optional. If a cached radius position already exists, overrides default.
  37138. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37139. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37140. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37141. */
  37142. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37143. /**
  37144. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  37145. * @param minimumWorld Determines the smaller position of the bounding box extend
  37146. * @param maximumWorld Determines the bigger position of the bounding box extend
  37147. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37148. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37149. */
  37150. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37151. /**
  37152. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  37153. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  37154. * frustum width.
  37155. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  37156. * to fully enclose the mesh in the viewing frustum.
  37157. */
  37158. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  37159. /**
  37160. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  37161. * is automatically returned to its default position (expected to be above ground plane).
  37162. */
  37163. private _maintainCameraAboveGround;
  37164. /**
  37165. * Returns the frustum slope based on the canvas ratio and camera FOV
  37166. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  37167. */
  37168. private _getFrustumSlope;
  37169. /**
  37170. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  37171. */
  37172. private _clearAnimationLocks;
  37173. /**
  37174. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  37175. */
  37176. private _applyUserInteraction;
  37177. /**
  37178. * Stops and removes all animations that have been applied to the camera
  37179. */
  37180. stopAllAnimations(): void;
  37181. /**
  37182. * Gets a value indicating if the user is moving the camera
  37183. */
  37184. readonly isUserIsMoving: boolean;
  37185. /**
  37186. * The camera can move all the way towards the mesh.
  37187. */
  37188. static IgnoreBoundsSizeMode: number;
  37189. /**
  37190. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  37191. */
  37192. static FitFrustumSidesMode: number;
  37193. }
  37194. }
  37195. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  37196. import { Nullable } from "babylonjs/types";
  37197. import { Camera } from "babylonjs/Cameras/camera";
  37198. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37199. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  37200. /**
  37201. * Base class for Camera Pointer Inputs.
  37202. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  37203. * for example usage.
  37204. */
  37205. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  37206. /**
  37207. * Defines the camera the input is attached to.
  37208. */
  37209. abstract camera: Camera;
  37210. /**
  37211. * Whether keyboard modifier keys are pressed at time of last mouse event.
  37212. */
  37213. protected _altKey: boolean;
  37214. protected _ctrlKey: boolean;
  37215. protected _metaKey: boolean;
  37216. protected _shiftKey: boolean;
  37217. /**
  37218. * Which mouse buttons were pressed at time of last mouse event.
  37219. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  37220. */
  37221. protected _buttonsPressed: number;
  37222. /**
  37223. * Defines the buttons associated with the input to handle camera move.
  37224. */
  37225. buttons: number[];
  37226. /**
  37227. * Attach the input controls to a specific dom element to get the input from.
  37228. * @param element Defines the element the controls should be listened from
  37229. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37230. */
  37231. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37232. /**
  37233. * Detach the current controls from the specified dom element.
  37234. * @param element Defines the element to stop listening the inputs from
  37235. */
  37236. detachControl(element: Nullable<HTMLElement>): void;
  37237. /**
  37238. * Gets the class name of the current input.
  37239. * @returns the class name
  37240. */
  37241. getClassName(): string;
  37242. /**
  37243. * Get the friendly name associated with the input class.
  37244. * @returns the input friendly name
  37245. */
  37246. getSimpleName(): string;
  37247. /**
  37248. * Called on pointer POINTERDOUBLETAP event.
  37249. * Override this method to provide functionality on POINTERDOUBLETAP event.
  37250. */
  37251. protected onDoubleTap(type: string): void;
  37252. /**
  37253. * Called on pointer POINTERMOVE event if only a single touch is active.
  37254. * Override this method to provide functionality.
  37255. */
  37256. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  37257. /**
  37258. * Called on pointer POINTERMOVE event if multiple touches are active.
  37259. * Override this method to provide functionality.
  37260. */
  37261. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  37262. /**
  37263. * Called on JS contextmenu event.
  37264. * Override this method to provide functionality.
  37265. */
  37266. protected onContextMenu(evt: PointerEvent): void;
  37267. /**
  37268. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  37269. * press.
  37270. * Override this method to provide functionality.
  37271. */
  37272. protected onButtonDown(evt: PointerEvent): void;
  37273. /**
  37274. * Called each time a new POINTERUP event occurs. Ie, for each button
  37275. * release.
  37276. * Override this method to provide functionality.
  37277. */
  37278. protected onButtonUp(evt: PointerEvent): void;
  37279. /**
  37280. * Called when window becomes inactive.
  37281. * Override this method to provide functionality.
  37282. */
  37283. protected onLostFocus(): void;
  37284. private _pointerInput;
  37285. private _observer;
  37286. private _onLostFocus;
  37287. private pointA;
  37288. private pointB;
  37289. }
  37290. }
  37291. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  37292. import { Nullable } from "babylonjs/types";
  37293. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37294. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  37295. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  37296. /**
  37297. * Manage the pointers inputs to control an arc rotate camera.
  37298. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37299. */
  37300. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  37301. /**
  37302. * Defines the camera the input is attached to.
  37303. */
  37304. camera: ArcRotateCamera;
  37305. /**
  37306. * Gets the class name of the current input.
  37307. * @returns the class name
  37308. */
  37309. getClassName(): string;
  37310. /**
  37311. * Defines the buttons associated with the input to handle camera move.
  37312. */
  37313. buttons: number[];
  37314. /**
  37315. * Defines the pointer angular sensibility along the X axis or how fast is
  37316. * the camera rotating.
  37317. */
  37318. angularSensibilityX: number;
  37319. /**
  37320. * Defines the pointer angular sensibility along the Y axis or how fast is
  37321. * the camera rotating.
  37322. */
  37323. angularSensibilityY: number;
  37324. /**
  37325. * Defines the pointer pinch precision or how fast is the camera zooming.
  37326. */
  37327. pinchPrecision: number;
  37328. /**
  37329. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  37330. * from 0.
  37331. * It defines the percentage of current camera.radius to use as delta when
  37332. * pinch zoom is used.
  37333. */
  37334. pinchDeltaPercentage: number;
  37335. /**
  37336. * Defines the pointer panning sensibility or how fast is the camera moving.
  37337. */
  37338. panningSensibility: number;
  37339. /**
  37340. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  37341. */
  37342. multiTouchPanning: boolean;
  37343. /**
  37344. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  37345. * zoom (pinch) through multitouch.
  37346. */
  37347. multiTouchPanAndZoom: boolean;
  37348. /**
  37349. * Revers pinch action direction.
  37350. */
  37351. pinchInwards: boolean;
  37352. private _isPanClick;
  37353. private _twoFingerActivityCount;
  37354. private _isPinching;
  37355. /**
  37356. * Called on pointer POINTERMOVE event if only a single touch is active.
  37357. */
  37358. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  37359. /**
  37360. * Called on pointer POINTERDOUBLETAP event.
  37361. */
  37362. protected onDoubleTap(type: string): void;
  37363. /**
  37364. * Called on pointer POINTERMOVE event if multiple touches are active.
  37365. */
  37366. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  37367. /**
  37368. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  37369. * press.
  37370. */
  37371. protected onButtonDown(evt: PointerEvent): void;
  37372. /**
  37373. * Called each time a new POINTERUP event occurs. Ie, for each button
  37374. * release.
  37375. */
  37376. protected onButtonUp(evt: PointerEvent): void;
  37377. /**
  37378. * Called when window becomes inactive.
  37379. */
  37380. protected onLostFocus(): void;
  37381. }
  37382. }
  37383. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  37384. import { Nullable } from "babylonjs/types";
  37385. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37386. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37387. /**
  37388. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  37389. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37390. */
  37391. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  37392. /**
  37393. * Defines the camera the input is attached to.
  37394. */
  37395. camera: ArcRotateCamera;
  37396. /**
  37397. * Defines the list of key codes associated with the up action (increase alpha)
  37398. */
  37399. keysUp: number[];
  37400. /**
  37401. * Defines the list of key codes associated with the down action (decrease alpha)
  37402. */
  37403. keysDown: number[];
  37404. /**
  37405. * Defines the list of key codes associated with the left action (increase beta)
  37406. */
  37407. keysLeft: number[];
  37408. /**
  37409. * Defines the list of key codes associated with the right action (decrease beta)
  37410. */
  37411. keysRight: number[];
  37412. /**
  37413. * Defines the list of key codes associated with the reset action.
  37414. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  37415. */
  37416. keysReset: number[];
  37417. /**
  37418. * Defines the panning sensibility of the inputs.
  37419. * (How fast is the camera paning)
  37420. */
  37421. panningSensibility: number;
  37422. /**
  37423. * Defines the zooming sensibility of the inputs.
  37424. * (How fast is the camera zooming)
  37425. */
  37426. zoomingSensibility: number;
  37427. /**
  37428. * Defines wether maintaining the alt key down switch the movement mode from
  37429. * orientation to zoom.
  37430. */
  37431. useAltToZoom: boolean;
  37432. /**
  37433. * Rotation speed of the camera
  37434. */
  37435. angularSpeed: number;
  37436. private _keys;
  37437. private _ctrlPressed;
  37438. private _altPressed;
  37439. private _onCanvasBlurObserver;
  37440. private _onKeyboardObserver;
  37441. private _engine;
  37442. private _scene;
  37443. /**
  37444. * Attach the input controls to a specific dom element to get the input from.
  37445. * @param element Defines the element the controls should be listened from
  37446. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37447. */
  37448. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37449. /**
  37450. * Detach the current controls from the specified dom element.
  37451. * @param element Defines the element to stop listening the inputs from
  37452. */
  37453. detachControl(element: Nullable<HTMLElement>): void;
  37454. /**
  37455. * Update the current camera state depending on the inputs that have been used this frame.
  37456. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  37457. */
  37458. checkInputs(): void;
  37459. /**
  37460. * Gets the class name of the current intput.
  37461. * @returns the class name
  37462. */
  37463. getClassName(): string;
  37464. /**
  37465. * Get the friendly name associated with the input class.
  37466. * @returns the input friendly name
  37467. */
  37468. getSimpleName(): string;
  37469. }
  37470. }
  37471. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  37472. import { Nullable } from "babylonjs/types";
  37473. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37474. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37475. /**
  37476. * Manage the mouse wheel inputs to control an arc rotate camera.
  37477. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37478. */
  37479. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  37480. /**
  37481. * Defines the camera the input is attached to.
  37482. */
  37483. camera: ArcRotateCamera;
  37484. /**
  37485. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  37486. */
  37487. wheelPrecision: number;
  37488. /**
  37489. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  37490. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  37491. */
  37492. wheelDeltaPercentage: number;
  37493. private _wheel;
  37494. private _observer;
  37495. private computeDeltaFromMouseWheelLegacyEvent;
  37496. /**
  37497. * Attach the input controls to a specific dom element to get the input from.
  37498. * @param element Defines the element the controls should be listened from
  37499. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37500. */
  37501. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37502. /**
  37503. * Detach the current controls from the specified dom element.
  37504. * @param element Defines the element to stop listening the inputs from
  37505. */
  37506. detachControl(element: Nullable<HTMLElement>): void;
  37507. /**
  37508. * Gets the class name of the current intput.
  37509. * @returns the class name
  37510. */
  37511. getClassName(): string;
  37512. /**
  37513. * Get the friendly name associated with the input class.
  37514. * @returns the input friendly name
  37515. */
  37516. getSimpleName(): string;
  37517. }
  37518. }
  37519. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  37520. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37521. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  37522. /**
  37523. * Default Inputs manager for the ArcRotateCamera.
  37524. * It groups all the default supported inputs for ease of use.
  37525. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37526. */
  37527. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  37528. /**
  37529. * Instantiates a new ArcRotateCameraInputsManager.
  37530. * @param camera Defines the camera the inputs belong to
  37531. */
  37532. constructor(camera: ArcRotateCamera);
  37533. /**
  37534. * Add mouse wheel input support to the input manager.
  37535. * @returns the current input manager
  37536. */
  37537. addMouseWheel(): ArcRotateCameraInputsManager;
  37538. /**
  37539. * Add pointers input support to the input manager.
  37540. * @returns the current input manager
  37541. */
  37542. addPointers(): ArcRotateCameraInputsManager;
  37543. /**
  37544. * Add keyboard input support to the input manager.
  37545. * @returns the current input manager
  37546. */
  37547. addKeyboard(): ArcRotateCameraInputsManager;
  37548. }
  37549. }
  37550. declare module "babylonjs/Cameras/arcRotateCamera" {
  37551. import { Observable } from "babylonjs/Misc/observable";
  37552. import { Nullable } from "babylonjs/types";
  37553. import { Scene } from "babylonjs/scene";
  37554. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  37555. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37556. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  37557. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  37558. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  37559. import { Camera } from "babylonjs/Cameras/camera";
  37560. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  37561. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  37562. import { Collider } from "babylonjs/Collisions/collider";
  37563. /**
  37564. * This represents an orbital type of camera.
  37565. *
  37566. * 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.
  37567. * 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.
  37568. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  37569. */
  37570. export class ArcRotateCamera extends TargetCamera {
  37571. /**
  37572. * Defines the rotation angle of the camera along the longitudinal axis.
  37573. */
  37574. alpha: number;
  37575. /**
  37576. * Defines the rotation angle of the camera along the latitudinal axis.
  37577. */
  37578. beta: number;
  37579. /**
  37580. * Defines the radius of the camera from it s target point.
  37581. */
  37582. radius: number;
  37583. protected _target: Vector3;
  37584. protected _targetHost: Nullable<AbstractMesh>;
  37585. /**
  37586. * Defines the target point of the camera.
  37587. * The camera looks towards it form the radius distance.
  37588. */
  37589. target: Vector3;
  37590. /**
  37591. * Define the current local position of the camera in the scene
  37592. */
  37593. position: Vector3;
  37594. protected _upVector: Vector3;
  37595. protected _upToYMatrix: Matrix;
  37596. protected _YToUpMatrix: Matrix;
  37597. /**
  37598. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  37599. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  37600. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  37601. */
  37602. upVector: Vector3;
  37603. /**
  37604. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  37605. */
  37606. setMatUp(): void;
  37607. /**
  37608. * Current inertia value on the longitudinal axis.
  37609. * The bigger this number the longer it will take for the camera to stop.
  37610. */
  37611. inertialAlphaOffset: number;
  37612. /**
  37613. * Current inertia value on the latitudinal axis.
  37614. * The bigger this number the longer it will take for the camera to stop.
  37615. */
  37616. inertialBetaOffset: number;
  37617. /**
  37618. * Current inertia value on the radius axis.
  37619. * The bigger this number the longer it will take for the camera to stop.
  37620. */
  37621. inertialRadiusOffset: number;
  37622. /**
  37623. * Minimum allowed angle on the longitudinal axis.
  37624. * This can help limiting how the Camera is able to move in the scene.
  37625. */
  37626. lowerAlphaLimit: Nullable<number>;
  37627. /**
  37628. * Maximum allowed angle on the longitudinal axis.
  37629. * This can help limiting how the Camera is able to move in the scene.
  37630. */
  37631. upperAlphaLimit: Nullable<number>;
  37632. /**
  37633. * Minimum allowed angle on the latitudinal axis.
  37634. * This can help limiting how the Camera is able to move in the scene.
  37635. */
  37636. lowerBetaLimit: number;
  37637. /**
  37638. * Maximum allowed angle on the latitudinal axis.
  37639. * This can help limiting how the Camera is able to move in the scene.
  37640. */
  37641. upperBetaLimit: number;
  37642. /**
  37643. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  37644. * This can help limiting how the Camera is able to move in the scene.
  37645. */
  37646. lowerRadiusLimit: Nullable<number>;
  37647. /**
  37648. * Maximum allowed distance of the camera to the target (The camera can not get further).
  37649. * This can help limiting how the Camera is able to move in the scene.
  37650. */
  37651. upperRadiusLimit: Nullable<number>;
  37652. /**
  37653. * Defines the current inertia value used during panning of the camera along the X axis.
  37654. */
  37655. inertialPanningX: number;
  37656. /**
  37657. * Defines the current inertia value used during panning of the camera along the Y axis.
  37658. */
  37659. inertialPanningY: number;
  37660. /**
  37661. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  37662. * Basically if your fingers moves away from more than this distance you will be considered
  37663. * in pinch mode.
  37664. */
  37665. pinchToPanMaxDistance: number;
  37666. /**
  37667. * Defines the maximum distance the camera can pan.
  37668. * This could help keeping the cammera always in your scene.
  37669. */
  37670. panningDistanceLimit: Nullable<number>;
  37671. /**
  37672. * Defines the target of the camera before paning.
  37673. */
  37674. panningOriginTarget: Vector3;
  37675. /**
  37676. * Defines the value of the inertia used during panning.
  37677. * 0 would mean stop inertia and one would mean no decelleration at all.
  37678. */
  37679. panningInertia: number;
  37680. /**
  37681. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  37682. */
  37683. angularSensibilityX: number;
  37684. /**
  37685. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  37686. */
  37687. angularSensibilityY: number;
  37688. /**
  37689. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  37690. */
  37691. pinchPrecision: number;
  37692. /**
  37693. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  37694. * It will be used instead of pinchDeltaPrecision if different from 0.
  37695. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  37696. */
  37697. pinchDeltaPercentage: number;
  37698. /**
  37699. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  37700. */
  37701. panningSensibility: number;
  37702. /**
  37703. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  37704. */
  37705. keysUp: number[];
  37706. /**
  37707. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  37708. */
  37709. keysDown: number[];
  37710. /**
  37711. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  37712. */
  37713. keysLeft: number[];
  37714. /**
  37715. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  37716. */
  37717. keysRight: number[];
  37718. /**
  37719. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  37720. */
  37721. wheelPrecision: number;
  37722. /**
  37723. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  37724. * It will be used instead of pinchDeltaPrecision if different from 0.
  37725. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  37726. */
  37727. wheelDeltaPercentage: number;
  37728. /**
  37729. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  37730. */
  37731. zoomOnFactor: number;
  37732. /**
  37733. * Defines a screen offset for the camera position.
  37734. */
  37735. targetScreenOffset: Vector2;
  37736. /**
  37737. * Allows the camera to be completely reversed.
  37738. * If false the camera can not arrive upside down.
  37739. */
  37740. allowUpsideDown: boolean;
  37741. /**
  37742. * Define if double tap/click is used to restore the previously saved state of the camera.
  37743. */
  37744. useInputToRestoreState: boolean;
  37745. /** @hidden */
  37746. _viewMatrix: Matrix;
  37747. /** @hidden */
  37748. _useCtrlForPanning: boolean;
  37749. /** @hidden */
  37750. _panningMouseButton: number;
  37751. /**
  37752. * Defines the input associated to the camera.
  37753. */
  37754. inputs: ArcRotateCameraInputsManager;
  37755. /** @hidden */
  37756. _reset: () => void;
  37757. /**
  37758. * Defines the allowed panning axis.
  37759. */
  37760. panningAxis: Vector3;
  37761. protected _localDirection: Vector3;
  37762. protected _transformedDirection: Vector3;
  37763. private _bouncingBehavior;
  37764. /**
  37765. * Gets the bouncing behavior of the camera if it has been enabled.
  37766. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37767. */
  37768. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  37769. /**
  37770. * Defines if the bouncing behavior of the camera is enabled on the camera.
  37771. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37772. */
  37773. useBouncingBehavior: boolean;
  37774. private _framingBehavior;
  37775. /**
  37776. * Gets the framing behavior of the camera if it has been enabled.
  37777. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37778. */
  37779. readonly framingBehavior: Nullable<FramingBehavior>;
  37780. /**
  37781. * Defines if the framing behavior of the camera is enabled on the camera.
  37782. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37783. */
  37784. useFramingBehavior: boolean;
  37785. private _autoRotationBehavior;
  37786. /**
  37787. * Gets the auto rotation behavior of the camera if it has been enabled.
  37788. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37789. */
  37790. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  37791. /**
  37792. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  37793. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37794. */
  37795. useAutoRotationBehavior: boolean;
  37796. /**
  37797. * Observable triggered when the mesh target has been changed on the camera.
  37798. */
  37799. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  37800. /**
  37801. * Event raised when the camera is colliding with a mesh.
  37802. */
  37803. onCollide: (collidedMesh: AbstractMesh) => void;
  37804. /**
  37805. * Defines whether the camera should check collision with the objects oh the scene.
  37806. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  37807. */
  37808. checkCollisions: boolean;
  37809. /**
  37810. * Defines the collision radius of the camera.
  37811. * This simulates a sphere around the camera.
  37812. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  37813. */
  37814. collisionRadius: Vector3;
  37815. protected _collider: Collider;
  37816. protected _previousPosition: Vector3;
  37817. protected _collisionVelocity: Vector3;
  37818. protected _newPosition: Vector3;
  37819. protected _previousAlpha: number;
  37820. protected _previousBeta: number;
  37821. protected _previousRadius: number;
  37822. protected _collisionTriggered: boolean;
  37823. protected _targetBoundingCenter: Nullable<Vector3>;
  37824. private _computationVector;
  37825. /**
  37826. * Instantiates a new ArcRotateCamera in a given scene
  37827. * @param name Defines the name of the camera
  37828. * @param alpha Defines the camera rotation along the logitudinal axis
  37829. * @param beta Defines the camera rotation along the latitudinal axis
  37830. * @param radius Defines the camera distance from its target
  37831. * @param target Defines the camera target
  37832. * @param scene Defines the scene the camera belongs to
  37833. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  37834. */
  37835. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  37836. /** @hidden */
  37837. _initCache(): void;
  37838. /** @hidden */
  37839. _updateCache(ignoreParentClass?: boolean): void;
  37840. protected _getTargetPosition(): Vector3;
  37841. private _storedAlpha;
  37842. private _storedBeta;
  37843. private _storedRadius;
  37844. private _storedTarget;
  37845. private _storedTargetScreenOffset;
  37846. /**
  37847. * Stores the current state of the camera (alpha, beta, radius and target)
  37848. * @returns the camera itself
  37849. */
  37850. storeState(): Camera;
  37851. /**
  37852. * @hidden
  37853. * Restored camera state. You must call storeState() first
  37854. */
  37855. _restoreStateValues(): boolean;
  37856. /** @hidden */
  37857. _isSynchronizedViewMatrix(): boolean;
  37858. /**
  37859. * Attached controls to the current camera.
  37860. * @param element Defines the element the controls should be listened from
  37861. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37862. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  37863. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  37864. */
  37865. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  37866. /**
  37867. * Detach the current controls from the camera.
  37868. * The camera will stop reacting to inputs.
  37869. * @param element Defines the element to stop listening the inputs from
  37870. */
  37871. detachControl(element: HTMLElement): void;
  37872. /** @hidden */
  37873. _checkInputs(): void;
  37874. protected _checkLimits(): void;
  37875. /**
  37876. * Rebuilds angles (alpha, beta) and radius from the give position and target
  37877. */
  37878. rebuildAnglesAndRadius(): void;
  37879. /**
  37880. * Use a position to define the current camera related information like alpha, beta and radius
  37881. * @param position Defines the position to set the camera at
  37882. */
  37883. setPosition(position: Vector3): void;
  37884. /**
  37885. * Defines the target the camera should look at.
  37886. * This will automatically adapt alpha beta and radius to fit within the new target.
  37887. * @param target Defines the new target as a Vector or a mesh
  37888. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  37889. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  37890. */
  37891. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  37892. /** @hidden */
  37893. _getViewMatrix(): Matrix;
  37894. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  37895. /**
  37896. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  37897. * @param meshes Defines the mesh to zoom on
  37898. * @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)
  37899. */
  37900. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  37901. /**
  37902. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  37903. * The target will be changed but the radius
  37904. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  37905. * @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)
  37906. */
  37907. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  37908. min: Vector3;
  37909. max: Vector3;
  37910. distance: number;
  37911. }, doNotUpdateMaxZ?: boolean): void;
  37912. /**
  37913. * @override
  37914. * Override Camera.createRigCamera
  37915. */
  37916. createRigCamera(name: string, cameraIndex: number): Camera;
  37917. /**
  37918. * @hidden
  37919. * @override
  37920. * Override Camera._updateRigCameras
  37921. */
  37922. _updateRigCameras(): void;
  37923. /**
  37924. * Destroy the camera and release the current resources hold by it.
  37925. */
  37926. dispose(): void;
  37927. /**
  37928. * Gets the current object class name.
  37929. * @return the class name
  37930. */
  37931. getClassName(): string;
  37932. }
  37933. }
  37934. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  37935. import { Behavior } from "babylonjs/Behaviors/behavior";
  37936. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37937. /**
  37938. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  37939. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37940. */
  37941. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  37942. /**
  37943. * Gets the name of the behavior.
  37944. */
  37945. readonly name: string;
  37946. private _zoomStopsAnimation;
  37947. private _idleRotationSpeed;
  37948. private _idleRotationWaitTime;
  37949. private _idleRotationSpinupTime;
  37950. /**
  37951. * Sets the flag that indicates if user zooming should stop animation.
  37952. */
  37953. /**
  37954. * Gets the flag that indicates if user zooming should stop animation.
  37955. */
  37956. zoomStopsAnimation: boolean;
  37957. /**
  37958. * Sets the default speed at which the camera rotates around the model.
  37959. */
  37960. /**
  37961. * Gets the default speed at which the camera rotates around the model.
  37962. */
  37963. idleRotationSpeed: number;
  37964. /**
  37965. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  37966. */
  37967. /**
  37968. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  37969. */
  37970. idleRotationWaitTime: number;
  37971. /**
  37972. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  37973. */
  37974. /**
  37975. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  37976. */
  37977. idleRotationSpinupTime: number;
  37978. /**
  37979. * Gets a value indicating if the camera is currently rotating because of this behavior
  37980. */
  37981. readonly rotationInProgress: boolean;
  37982. private _onPrePointerObservableObserver;
  37983. private _onAfterCheckInputsObserver;
  37984. private _attachedCamera;
  37985. private _isPointerDown;
  37986. private _lastFrameTime;
  37987. private _lastInteractionTime;
  37988. private _cameraRotationSpeed;
  37989. /**
  37990. * Initializes the behavior.
  37991. */
  37992. init(): void;
  37993. /**
  37994. * Attaches the behavior to its arc rotate camera.
  37995. * @param camera Defines the camera to attach the behavior to
  37996. */
  37997. attach(camera: ArcRotateCamera): void;
  37998. /**
  37999. * Detaches the behavior from its current arc rotate camera.
  38000. */
  38001. detach(): void;
  38002. /**
  38003. * Returns true if user is scrolling.
  38004. * @return true if user is scrolling.
  38005. */
  38006. private _userIsZooming;
  38007. private _lastFrameRadius;
  38008. private _shouldAnimationStopForInteraction;
  38009. /**
  38010. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  38011. */
  38012. private _applyUserInteraction;
  38013. private _userIsMoving;
  38014. }
  38015. }
  38016. declare module "babylonjs/Behaviors/Cameras/index" {
  38017. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  38018. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  38019. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  38020. }
  38021. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  38022. import { Mesh } from "babylonjs/Meshes/mesh";
  38023. import { TransformNode } from "babylonjs/Meshes/transformNode";
  38024. import { Behavior } from "babylonjs/Behaviors/behavior";
  38025. /**
  38026. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  38027. */
  38028. export class AttachToBoxBehavior implements Behavior<Mesh> {
  38029. private ui;
  38030. /**
  38031. * The name of the behavior
  38032. */
  38033. name: string;
  38034. /**
  38035. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  38036. */
  38037. distanceAwayFromFace: number;
  38038. /**
  38039. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  38040. */
  38041. distanceAwayFromBottomOfFace: number;
  38042. private _faceVectors;
  38043. private _target;
  38044. private _scene;
  38045. private _onRenderObserver;
  38046. private _tmpMatrix;
  38047. private _tmpVector;
  38048. /**
  38049. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  38050. * @param ui The transform node that should be attched to the mesh
  38051. */
  38052. constructor(ui: TransformNode);
  38053. /**
  38054. * Initializes the behavior
  38055. */
  38056. init(): void;
  38057. private _closestFace;
  38058. private _zeroVector;
  38059. private _lookAtTmpMatrix;
  38060. private _lookAtToRef;
  38061. /**
  38062. * Attaches the AttachToBoxBehavior to the passed in mesh
  38063. * @param target The mesh that the specified node will be attached to
  38064. */
  38065. attach(target: Mesh): void;
  38066. /**
  38067. * Detaches the behavior from the mesh
  38068. */
  38069. detach(): void;
  38070. }
  38071. }
  38072. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  38073. import { Behavior } from "babylonjs/Behaviors/behavior";
  38074. import { Mesh } from "babylonjs/Meshes/mesh";
  38075. /**
  38076. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  38077. */
  38078. export class FadeInOutBehavior implements Behavior<Mesh> {
  38079. /**
  38080. * Time in milliseconds to delay before fading in (Default: 0)
  38081. */
  38082. delay: number;
  38083. /**
  38084. * Time in milliseconds for the mesh to fade in (Default: 300)
  38085. */
  38086. fadeInTime: number;
  38087. private _millisecondsPerFrame;
  38088. private _hovered;
  38089. private _hoverValue;
  38090. private _ownerNode;
  38091. /**
  38092. * Instatiates the FadeInOutBehavior
  38093. */
  38094. constructor();
  38095. /**
  38096. * The name of the behavior
  38097. */
  38098. readonly name: string;
  38099. /**
  38100. * Initializes the behavior
  38101. */
  38102. init(): void;
  38103. /**
  38104. * Attaches the fade behavior on the passed in mesh
  38105. * @param ownerNode The mesh that will be faded in/out once attached
  38106. */
  38107. attach(ownerNode: Mesh): void;
  38108. /**
  38109. * Detaches the behavior from the mesh
  38110. */
  38111. detach(): void;
  38112. /**
  38113. * Triggers the mesh to begin fading in or out
  38114. * @param value if the object should fade in or out (true to fade in)
  38115. */
  38116. fadeIn(value: boolean): void;
  38117. private _update;
  38118. private _setAllVisibility;
  38119. }
  38120. }
  38121. declare module "babylonjs/Misc/pivotTools" {
  38122. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38123. /**
  38124. * Class containing a set of static utilities functions for managing Pivots
  38125. * @hidden
  38126. */
  38127. export class PivotTools {
  38128. private static _PivotCached;
  38129. private static _OldPivotPoint;
  38130. private static _PivotTranslation;
  38131. private static _PivotTmpVector;
  38132. /** @hidden */
  38133. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  38134. /** @hidden */
  38135. static _RestorePivotPoint(mesh: AbstractMesh): void;
  38136. }
  38137. }
  38138. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  38139. import { Scene } from "babylonjs/scene";
  38140. import { Vector4 } from "babylonjs/Maths/math.vector";
  38141. import { Mesh } from "babylonjs/Meshes/mesh";
  38142. import { Nullable } from "babylonjs/types";
  38143. import { Plane } from "babylonjs/Maths/math.plane";
  38144. /**
  38145. * Class containing static functions to help procedurally build meshes
  38146. */
  38147. export class PlaneBuilder {
  38148. /**
  38149. * Creates a plane mesh
  38150. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  38151. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  38152. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  38153. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  38154. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  38155. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  38156. * @param name defines the name of the mesh
  38157. * @param options defines the options used to create the mesh
  38158. * @param scene defines the hosting scene
  38159. * @returns the plane mesh
  38160. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  38161. */
  38162. static CreatePlane(name: string, options: {
  38163. size?: number;
  38164. width?: number;
  38165. height?: number;
  38166. sideOrientation?: number;
  38167. frontUVs?: Vector4;
  38168. backUVs?: Vector4;
  38169. updatable?: boolean;
  38170. sourcePlane?: Plane;
  38171. }, scene?: Nullable<Scene>): Mesh;
  38172. }
  38173. }
  38174. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  38175. import { Behavior } from "babylonjs/Behaviors/behavior";
  38176. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38177. import { Observable } from "babylonjs/Misc/observable";
  38178. import { Vector3 } from "babylonjs/Maths/math.vector";
  38179. import { Ray } from "babylonjs/Culling/ray";
  38180. import "babylonjs/Meshes/Builders/planeBuilder";
  38181. /**
  38182. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  38183. */
  38184. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  38185. private static _AnyMouseID;
  38186. /**
  38187. * Abstract mesh the behavior is set on
  38188. */
  38189. attachedNode: AbstractMesh;
  38190. private _dragPlane;
  38191. private _scene;
  38192. private _pointerObserver;
  38193. private _beforeRenderObserver;
  38194. private static _planeScene;
  38195. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  38196. /**
  38197. * 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)
  38198. */
  38199. maxDragAngle: number;
  38200. /**
  38201. * @hidden
  38202. */
  38203. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  38204. /**
  38205. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  38206. */
  38207. currentDraggingPointerID: number;
  38208. /**
  38209. * The last position where the pointer hit the drag plane in world space
  38210. */
  38211. lastDragPosition: Vector3;
  38212. /**
  38213. * If the behavior is currently in a dragging state
  38214. */
  38215. dragging: boolean;
  38216. /**
  38217. * 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)
  38218. */
  38219. dragDeltaRatio: number;
  38220. /**
  38221. * If the drag plane orientation should be updated during the dragging (Default: true)
  38222. */
  38223. updateDragPlane: boolean;
  38224. private _debugMode;
  38225. private _moving;
  38226. /**
  38227. * Fires each time the attached mesh is dragged with the pointer
  38228. * * delta between last drag position and current drag position in world space
  38229. * * dragDistance along the drag axis
  38230. * * dragPlaneNormal normal of the current drag plane used during the drag
  38231. * * dragPlanePoint in world space where the drag intersects the drag plane
  38232. */
  38233. onDragObservable: Observable<{
  38234. delta: Vector3;
  38235. dragPlanePoint: Vector3;
  38236. dragPlaneNormal: Vector3;
  38237. dragDistance: number;
  38238. pointerId: number;
  38239. }>;
  38240. /**
  38241. * Fires each time a drag begins (eg. mouse down on mesh)
  38242. */
  38243. onDragStartObservable: Observable<{
  38244. dragPlanePoint: Vector3;
  38245. pointerId: number;
  38246. }>;
  38247. /**
  38248. * Fires each time a drag ends (eg. mouse release after drag)
  38249. */
  38250. onDragEndObservable: Observable<{
  38251. dragPlanePoint: Vector3;
  38252. pointerId: number;
  38253. }>;
  38254. /**
  38255. * If the attached mesh should be moved when dragged
  38256. */
  38257. moveAttached: boolean;
  38258. /**
  38259. * If the drag behavior will react to drag events (Default: true)
  38260. */
  38261. enabled: boolean;
  38262. /**
  38263. * If pointer events should start and release the drag (Default: true)
  38264. */
  38265. startAndReleaseDragOnPointerEvents: boolean;
  38266. /**
  38267. * If camera controls should be detached during the drag
  38268. */
  38269. detachCameraControls: boolean;
  38270. /**
  38271. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  38272. */
  38273. useObjectOrienationForDragging: boolean;
  38274. private _options;
  38275. /**
  38276. * Creates a pointer drag behavior that can be attached to a mesh
  38277. * @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)
  38278. */
  38279. constructor(options?: {
  38280. dragAxis?: Vector3;
  38281. dragPlaneNormal?: Vector3;
  38282. });
  38283. /**
  38284. * Predicate to determine if it is valid to move the object to a new position when it is moved
  38285. */
  38286. validateDrag: (targetPosition: Vector3) => boolean;
  38287. /**
  38288. * The name of the behavior
  38289. */
  38290. readonly name: string;
  38291. /**
  38292. * Initializes the behavior
  38293. */
  38294. init(): void;
  38295. private _tmpVector;
  38296. private _alternatePickedPoint;
  38297. private _worldDragAxis;
  38298. private _targetPosition;
  38299. private _attachedElement;
  38300. /**
  38301. * Attaches the drag behavior the passed in mesh
  38302. * @param ownerNode The mesh that will be dragged around once attached
  38303. * @param predicate Predicate to use for pick filtering
  38304. */
  38305. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  38306. /**
  38307. * Force relase the drag action by code.
  38308. */
  38309. releaseDrag(): void;
  38310. private _startDragRay;
  38311. private _lastPointerRay;
  38312. /**
  38313. * Simulates the start of a pointer drag event on the behavior
  38314. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  38315. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  38316. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  38317. */
  38318. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  38319. private _startDrag;
  38320. private _dragDelta;
  38321. private _moveDrag;
  38322. private _pickWithRayOnDragPlane;
  38323. private _pointA;
  38324. private _pointB;
  38325. private _pointC;
  38326. private _lineA;
  38327. private _lineB;
  38328. private _localAxis;
  38329. private _lookAt;
  38330. private _updateDragPlanePosition;
  38331. /**
  38332. * Detaches the behavior from the mesh
  38333. */
  38334. detach(): void;
  38335. }
  38336. }
  38337. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  38338. import { Mesh } from "babylonjs/Meshes/mesh";
  38339. import { Behavior } from "babylonjs/Behaviors/behavior";
  38340. /**
  38341. * A behavior that when attached to a mesh will allow the mesh to be scaled
  38342. */
  38343. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  38344. private _dragBehaviorA;
  38345. private _dragBehaviorB;
  38346. private _startDistance;
  38347. private _initialScale;
  38348. private _targetScale;
  38349. private _ownerNode;
  38350. private _sceneRenderObserver;
  38351. /**
  38352. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  38353. */
  38354. constructor();
  38355. /**
  38356. * The name of the behavior
  38357. */
  38358. readonly name: string;
  38359. /**
  38360. * Initializes the behavior
  38361. */
  38362. init(): void;
  38363. private _getCurrentDistance;
  38364. /**
  38365. * Attaches the scale behavior the passed in mesh
  38366. * @param ownerNode The mesh that will be scaled around once attached
  38367. */
  38368. attach(ownerNode: Mesh): void;
  38369. /**
  38370. * Detaches the behavior from the mesh
  38371. */
  38372. detach(): void;
  38373. }
  38374. }
  38375. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  38376. import { Behavior } from "babylonjs/Behaviors/behavior";
  38377. import { Mesh } from "babylonjs/Meshes/mesh";
  38378. import { Observable } from "babylonjs/Misc/observable";
  38379. /**
  38380. * 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
  38381. */
  38382. export class SixDofDragBehavior implements Behavior<Mesh> {
  38383. private static _virtualScene;
  38384. private _ownerNode;
  38385. private _sceneRenderObserver;
  38386. private _scene;
  38387. private _targetPosition;
  38388. private _virtualOriginMesh;
  38389. private _virtualDragMesh;
  38390. private _pointerObserver;
  38391. private _moving;
  38392. private _startingOrientation;
  38393. /**
  38394. * 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)
  38395. */
  38396. private zDragFactor;
  38397. /**
  38398. * If the object should rotate to face the drag origin
  38399. */
  38400. rotateDraggedObject: boolean;
  38401. /**
  38402. * If the behavior is currently in a dragging state
  38403. */
  38404. dragging: boolean;
  38405. /**
  38406. * 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)
  38407. */
  38408. dragDeltaRatio: number;
  38409. /**
  38410. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  38411. */
  38412. currentDraggingPointerID: number;
  38413. /**
  38414. * If camera controls should be detached during the drag
  38415. */
  38416. detachCameraControls: boolean;
  38417. /**
  38418. * Fires each time a drag starts
  38419. */
  38420. onDragStartObservable: Observable<{}>;
  38421. /**
  38422. * Fires each time a drag ends (eg. mouse release after drag)
  38423. */
  38424. onDragEndObservable: Observable<{}>;
  38425. /**
  38426. * 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
  38427. */
  38428. constructor();
  38429. /**
  38430. * The name of the behavior
  38431. */
  38432. readonly name: string;
  38433. /**
  38434. * Initializes the behavior
  38435. */
  38436. init(): void;
  38437. /**
  38438. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  38439. */
  38440. private readonly _pointerCamera;
  38441. /**
  38442. * Attaches the scale behavior the passed in mesh
  38443. * @param ownerNode The mesh that will be scaled around once attached
  38444. */
  38445. attach(ownerNode: Mesh): void;
  38446. /**
  38447. * Detaches the behavior from the mesh
  38448. */
  38449. detach(): void;
  38450. }
  38451. }
  38452. declare module "babylonjs/Behaviors/Meshes/index" {
  38453. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  38454. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  38455. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  38456. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  38457. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  38458. }
  38459. declare module "babylonjs/Behaviors/index" {
  38460. export * from "babylonjs/Behaviors/behavior";
  38461. export * from "babylonjs/Behaviors/Cameras/index";
  38462. export * from "babylonjs/Behaviors/Meshes/index";
  38463. }
  38464. declare module "babylonjs/Bones/boneIKController" {
  38465. import { Bone } from "babylonjs/Bones/bone";
  38466. import { Vector3 } from "babylonjs/Maths/math.vector";
  38467. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38468. import { Nullable } from "babylonjs/types";
  38469. /**
  38470. * Class used to apply inverse kinematics to bones
  38471. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  38472. */
  38473. export class BoneIKController {
  38474. private static _tmpVecs;
  38475. private static _tmpQuat;
  38476. private static _tmpMats;
  38477. /**
  38478. * Gets or sets the target mesh
  38479. */
  38480. targetMesh: AbstractMesh;
  38481. /** Gets or sets the mesh used as pole */
  38482. poleTargetMesh: AbstractMesh;
  38483. /**
  38484. * Gets or sets the bone used as pole
  38485. */
  38486. poleTargetBone: Nullable<Bone>;
  38487. /**
  38488. * Gets or sets the target position
  38489. */
  38490. targetPosition: Vector3;
  38491. /**
  38492. * Gets or sets the pole target position
  38493. */
  38494. poleTargetPosition: Vector3;
  38495. /**
  38496. * Gets or sets the pole target local offset
  38497. */
  38498. poleTargetLocalOffset: Vector3;
  38499. /**
  38500. * Gets or sets the pole angle
  38501. */
  38502. poleAngle: number;
  38503. /**
  38504. * Gets or sets the mesh associated with the controller
  38505. */
  38506. mesh: AbstractMesh;
  38507. /**
  38508. * 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)
  38509. */
  38510. slerpAmount: number;
  38511. private _bone1Quat;
  38512. private _bone1Mat;
  38513. private _bone2Ang;
  38514. private _bone1;
  38515. private _bone2;
  38516. private _bone1Length;
  38517. private _bone2Length;
  38518. private _maxAngle;
  38519. private _maxReach;
  38520. private _rightHandedSystem;
  38521. private _bendAxis;
  38522. private _slerping;
  38523. private _adjustRoll;
  38524. /**
  38525. * Gets or sets maximum allowed angle
  38526. */
  38527. maxAngle: number;
  38528. /**
  38529. * Creates a new BoneIKController
  38530. * @param mesh defines the mesh to control
  38531. * @param bone defines the bone to control
  38532. * @param options defines options to set up the controller
  38533. */
  38534. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  38535. targetMesh?: AbstractMesh;
  38536. poleTargetMesh?: AbstractMesh;
  38537. poleTargetBone?: Bone;
  38538. poleTargetLocalOffset?: Vector3;
  38539. poleAngle?: number;
  38540. bendAxis?: Vector3;
  38541. maxAngle?: number;
  38542. slerpAmount?: number;
  38543. });
  38544. private _setMaxAngle;
  38545. /**
  38546. * Force the controller to update the bones
  38547. */
  38548. update(): void;
  38549. }
  38550. }
  38551. declare module "babylonjs/Bones/boneLookController" {
  38552. import { Vector3 } from "babylonjs/Maths/math.vector";
  38553. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38554. import { Bone } from "babylonjs/Bones/bone";
  38555. import { Space } from "babylonjs/Maths/math.axis";
  38556. /**
  38557. * Class used to make a bone look toward a point in space
  38558. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  38559. */
  38560. export class BoneLookController {
  38561. private static _tmpVecs;
  38562. private static _tmpQuat;
  38563. private static _tmpMats;
  38564. /**
  38565. * The target Vector3 that the bone will look at
  38566. */
  38567. target: Vector3;
  38568. /**
  38569. * The mesh that the bone is attached to
  38570. */
  38571. mesh: AbstractMesh;
  38572. /**
  38573. * The bone that will be looking to the target
  38574. */
  38575. bone: Bone;
  38576. /**
  38577. * The up axis of the coordinate system that is used when the bone is rotated
  38578. */
  38579. upAxis: Vector3;
  38580. /**
  38581. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  38582. */
  38583. upAxisSpace: Space;
  38584. /**
  38585. * Used to make an adjustment to the yaw of the bone
  38586. */
  38587. adjustYaw: number;
  38588. /**
  38589. * Used to make an adjustment to the pitch of the bone
  38590. */
  38591. adjustPitch: number;
  38592. /**
  38593. * Used to make an adjustment to the roll of the bone
  38594. */
  38595. adjustRoll: number;
  38596. /**
  38597. * 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)
  38598. */
  38599. slerpAmount: number;
  38600. private _minYaw;
  38601. private _maxYaw;
  38602. private _minPitch;
  38603. private _maxPitch;
  38604. private _minYawSin;
  38605. private _minYawCos;
  38606. private _maxYawSin;
  38607. private _maxYawCos;
  38608. private _midYawConstraint;
  38609. private _minPitchTan;
  38610. private _maxPitchTan;
  38611. private _boneQuat;
  38612. private _slerping;
  38613. private _transformYawPitch;
  38614. private _transformYawPitchInv;
  38615. private _firstFrameSkipped;
  38616. private _yawRange;
  38617. private _fowardAxis;
  38618. /**
  38619. * Gets or sets the minimum yaw angle that the bone can look to
  38620. */
  38621. minYaw: number;
  38622. /**
  38623. * Gets or sets the maximum yaw angle that the bone can look to
  38624. */
  38625. maxYaw: number;
  38626. /**
  38627. * Gets or sets the minimum pitch angle that the bone can look to
  38628. */
  38629. minPitch: number;
  38630. /**
  38631. * Gets or sets the maximum pitch angle that the bone can look to
  38632. */
  38633. maxPitch: number;
  38634. /**
  38635. * Create a BoneLookController
  38636. * @param mesh the mesh that the bone belongs to
  38637. * @param bone the bone that will be looking to the target
  38638. * @param target the target Vector3 to look at
  38639. * @param options optional settings:
  38640. * * maxYaw: the maximum angle the bone will yaw to
  38641. * * minYaw: the minimum angle the bone will yaw to
  38642. * * maxPitch: the maximum angle the bone will pitch to
  38643. * * minPitch: the minimum angle the bone will yaw to
  38644. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  38645. * * upAxis: the up axis of the coordinate system
  38646. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  38647. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  38648. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  38649. * * adjustYaw: used to make an adjustment to the yaw of the bone
  38650. * * adjustPitch: used to make an adjustment to the pitch of the bone
  38651. * * adjustRoll: used to make an adjustment to the roll of the bone
  38652. **/
  38653. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  38654. maxYaw?: number;
  38655. minYaw?: number;
  38656. maxPitch?: number;
  38657. minPitch?: number;
  38658. slerpAmount?: number;
  38659. upAxis?: Vector3;
  38660. upAxisSpace?: Space;
  38661. yawAxis?: Vector3;
  38662. pitchAxis?: Vector3;
  38663. adjustYaw?: number;
  38664. adjustPitch?: number;
  38665. adjustRoll?: number;
  38666. });
  38667. /**
  38668. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  38669. */
  38670. update(): void;
  38671. private _getAngleDiff;
  38672. private _getAngleBetween;
  38673. private _isAngleBetween;
  38674. }
  38675. }
  38676. declare module "babylonjs/Bones/index" {
  38677. export * from "babylonjs/Bones/bone";
  38678. export * from "babylonjs/Bones/boneIKController";
  38679. export * from "babylonjs/Bones/boneLookController";
  38680. export * from "babylonjs/Bones/skeleton";
  38681. }
  38682. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  38683. import { Nullable } from "babylonjs/types";
  38684. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38685. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38686. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  38687. /**
  38688. * Manage the gamepad inputs to control an arc rotate camera.
  38689. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38690. */
  38691. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  38692. /**
  38693. * Defines the camera the input is attached to.
  38694. */
  38695. camera: ArcRotateCamera;
  38696. /**
  38697. * Defines the gamepad the input is gathering event from.
  38698. */
  38699. gamepad: Nullable<Gamepad>;
  38700. /**
  38701. * Defines the gamepad rotation sensiblity.
  38702. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  38703. */
  38704. gamepadRotationSensibility: number;
  38705. /**
  38706. * Defines the gamepad move sensiblity.
  38707. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  38708. */
  38709. gamepadMoveSensibility: number;
  38710. private _yAxisScale;
  38711. /**
  38712. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  38713. */
  38714. invertYAxis: boolean;
  38715. private _onGamepadConnectedObserver;
  38716. private _onGamepadDisconnectedObserver;
  38717. /**
  38718. * Attach the input controls to a specific dom element to get the input from.
  38719. * @param element Defines the element the controls should be listened from
  38720. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38721. */
  38722. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38723. /**
  38724. * Detach the current controls from the specified dom element.
  38725. * @param element Defines the element to stop listening the inputs from
  38726. */
  38727. detachControl(element: Nullable<HTMLElement>): void;
  38728. /**
  38729. * Update the current camera state depending on the inputs that have been used this frame.
  38730. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  38731. */
  38732. checkInputs(): void;
  38733. /**
  38734. * Gets the class name of the current intput.
  38735. * @returns the class name
  38736. */
  38737. getClassName(): string;
  38738. /**
  38739. * Get the friendly name associated with the input class.
  38740. * @returns the input friendly name
  38741. */
  38742. getSimpleName(): string;
  38743. }
  38744. }
  38745. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  38746. import { Nullable } from "babylonjs/types";
  38747. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38748. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38749. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  38750. interface ArcRotateCameraInputsManager {
  38751. /**
  38752. * Add orientation input support to the input manager.
  38753. * @returns the current input manager
  38754. */
  38755. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  38756. }
  38757. }
  38758. /**
  38759. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  38760. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38761. */
  38762. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  38763. /**
  38764. * Defines the camera the input is attached to.
  38765. */
  38766. camera: ArcRotateCamera;
  38767. /**
  38768. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  38769. */
  38770. alphaCorrection: number;
  38771. /**
  38772. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  38773. */
  38774. gammaCorrection: number;
  38775. private _alpha;
  38776. private _gamma;
  38777. private _dirty;
  38778. private _deviceOrientationHandler;
  38779. /**
  38780. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  38781. */
  38782. constructor();
  38783. /**
  38784. * Attach the input controls to a specific dom element to get the input from.
  38785. * @param element Defines the element the controls should be listened from
  38786. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38787. */
  38788. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38789. /** @hidden */
  38790. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  38791. /**
  38792. * Update the current camera state depending on the inputs that have been used this frame.
  38793. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  38794. */
  38795. checkInputs(): void;
  38796. /**
  38797. * Detach the current controls from the specified dom element.
  38798. * @param element Defines the element to stop listening the inputs from
  38799. */
  38800. detachControl(element: Nullable<HTMLElement>): void;
  38801. /**
  38802. * Gets the class name of the current intput.
  38803. * @returns the class name
  38804. */
  38805. getClassName(): string;
  38806. /**
  38807. * Get the friendly name associated with the input class.
  38808. * @returns the input friendly name
  38809. */
  38810. getSimpleName(): string;
  38811. }
  38812. }
  38813. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  38814. import { Nullable } from "babylonjs/types";
  38815. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38816. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  38817. /**
  38818. * Listen to mouse events to control the camera.
  38819. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38820. */
  38821. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  38822. /**
  38823. * Defines the camera the input is attached to.
  38824. */
  38825. camera: FlyCamera;
  38826. /**
  38827. * Defines if touch is enabled. (Default is true.)
  38828. */
  38829. touchEnabled: boolean;
  38830. /**
  38831. * Defines the buttons associated with the input to handle camera rotation.
  38832. */
  38833. buttons: number[];
  38834. /**
  38835. * Assign buttons for Yaw control.
  38836. */
  38837. buttonsYaw: number[];
  38838. /**
  38839. * Assign buttons for Pitch control.
  38840. */
  38841. buttonsPitch: number[];
  38842. /**
  38843. * Assign buttons for Roll control.
  38844. */
  38845. buttonsRoll: number[];
  38846. /**
  38847. * Detect if any button is being pressed while mouse is moved.
  38848. * -1 = Mouse locked.
  38849. * 0 = Left button.
  38850. * 1 = Middle Button.
  38851. * 2 = Right Button.
  38852. */
  38853. activeButton: number;
  38854. /**
  38855. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  38856. * Higher values reduce its sensitivity.
  38857. */
  38858. angularSensibility: number;
  38859. private _mousemoveCallback;
  38860. private _observer;
  38861. private _rollObserver;
  38862. private previousPosition;
  38863. private noPreventDefault;
  38864. private element;
  38865. /**
  38866. * Listen to mouse events to control the camera.
  38867. * @param touchEnabled Define if touch is enabled. (Default is true.)
  38868. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38869. */
  38870. constructor(touchEnabled?: boolean);
  38871. /**
  38872. * Attach the mouse control to the HTML DOM element.
  38873. * @param element Defines the element that listens to the input events.
  38874. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  38875. */
  38876. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38877. /**
  38878. * Detach the current controls from the specified dom element.
  38879. * @param element Defines the element to stop listening the inputs from
  38880. */
  38881. detachControl(element: Nullable<HTMLElement>): void;
  38882. /**
  38883. * Gets the class name of the current input.
  38884. * @returns the class name.
  38885. */
  38886. getClassName(): string;
  38887. /**
  38888. * Get the friendly name associated with the input class.
  38889. * @returns the input's friendly name.
  38890. */
  38891. getSimpleName(): string;
  38892. private _pointerInput;
  38893. private _onMouseMove;
  38894. /**
  38895. * Rotate camera by mouse offset.
  38896. */
  38897. private rotateCamera;
  38898. }
  38899. }
  38900. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  38901. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  38902. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  38903. /**
  38904. * Default Inputs manager for the FlyCamera.
  38905. * It groups all the default supported inputs for ease of use.
  38906. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38907. */
  38908. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  38909. /**
  38910. * Instantiates a new FlyCameraInputsManager.
  38911. * @param camera Defines the camera the inputs belong to.
  38912. */
  38913. constructor(camera: FlyCamera);
  38914. /**
  38915. * Add keyboard input support to the input manager.
  38916. * @returns the new FlyCameraKeyboardMoveInput().
  38917. */
  38918. addKeyboard(): FlyCameraInputsManager;
  38919. /**
  38920. * Add mouse input support to the input manager.
  38921. * @param touchEnabled Enable touch screen support.
  38922. * @returns the new FlyCameraMouseInput().
  38923. */
  38924. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  38925. }
  38926. }
  38927. declare module "babylonjs/Cameras/flyCamera" {
  38928. import { Scene } from "babylonjs/scene";
  38929. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  38930. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38931. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  38932. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  38933. /**
  38934. * This is a flying camera, designed for 3D movement and rotation in all directions,
  38935. * such as in a 3D Space Shooter or a Flight Simulator.
  38936. */
  38937. export class FlyCamera extends TargetCamera {
  38938. /**
  38939. * Define the collision ellipsoid of the camera.
  38940. * This is helpful for simulating a camera body, like a player's body.
  38941. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  38942. */
  38943. ellipsoid: Vector3;
  38944. /**
  38945. * Define an offset for the position of the ellipsoid around the camera.
  38946. * This can be helpful if the camera is attached away from the player's body center,
  38947. * such as at its head.
  38948. */
  38949. ellipsoidOffset: Vector3;
  38950. /**
  38951. * Enable or disable collisions of the camera with the rest of the scene objects.
  38952. */
  38953. checkCollisions: boolean;
  38954. /**
  38955. * Enable or disable gravity on the camera.
  38956. */
  38957. applyGravity: boolean;
  38958. /**
  38959. * Define the current direction the camera is moving to.
  38960. */
  38961. cameraDirection: Vector3;
  38962. /**
  38963. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  38964. * This overrides and empties cameraRotation.
  38965. */
  38966. rotationQuaternion: Quaternion;
  38967. /**
  38968. * Track Roll to maintain the wanted Rolling when looking around.
  38969. */
  38970. _trackRoll: number;
  38971. /**
  38972. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  38973. */
  38974. rollCorrect: number;
  38975. /**
  38976. * Mimic a banked turn, Rolling the camera when Yawing.
  38977. * It's recommended to use rollCorrect = 10 for faster banking correction.
  38978. */
  38979. bankedTurn: boolean;
  38980. /**
  38981. * Limit in radians for how much Roll banking will add. (Default: 90°)
  38982. */
  38983. bankedTurnLimit: number;
  38984. /**
  38985. * Value of 0 disables the banked Roll.
  38986. * Value of 1 is equal to the Yaw angle in radians.
  38987. */
  38988. bankedTurnMultiplier: number;
  38989. /**
  38990. * The inputs manager loads all the input sources, such as keyboard and mouse.
  38991. */
  38992. inputs: FlyCameraInputsManager;
  38993. /**
  38994. * Gets the input sensibility for mouse input.
  38995. * Higher values reduce sensitivity.
  38996. */
  38997. /**
  38998. * Sets the input sensibility for a mouse input.
  38999. * Higher values reduce sensitivity.
  39000. */
  39001. angularSensibility: number;
  39002. /**
  39003. * Get the keys for camera movement forward.
  39004. */
  39005. /**
  39006. * Set the keys for camera movement forward.
  39007. */
  39008. keysForward: number[];
  39009. /**
  39010. * Get the keys for camera movement backward.
  39011. */
  39012. keysBackward: number[];
  39013. /**
  39014. * Get the keys for camera movement up.
  39015. */
  39016. /**
  39017. * Set the keys for camera movement up.
  39018. */
  39019. keysUp: number[];
  39020. /**
  39021. * Get the keys for camera movement down.
  39022. */
  39023. /**
  39024. * Set the keys for camera movement down.
  39025. */
  39026. keysDown: number[];
  39027. /**
  39028. * Get the keys for camera movement left.
  39029. */
  39030. /**
  39031. * Set the keys for camera movement left.
  39032. */
  39033. keysLeft: number[];
  39034. /**
  39035. * Set the keys for camera movement right.
  39036. */
  39037. /**
  39038. * Set the keys for camera movement right.
  39039. */
  39040. keysRight: number[];
  39041. /**
  39042. * Event raised when the camera collides with a mesh in the scene.
  39043. */
  39044. onCollide: (collidedMesh: AbstractMesh) => void;
  39045. private _collider;
  39046. private _needMoveForGravity;
  39047. private _oldPosition;
  39048. private _diffPosition;
  39049. private _newPosition;
  39050. /** @hidden */
  39051. _localDirection: Vector3;
  39052. /** @hidden */
  39053. _transformedDirection: Vector3;
  39054. /**
  39055. * Instantiates a FlyCamera.
  39056. * This is a flying camera, designed for 3D movement and rotation in all directions,
  39057. * such as in a 3D Space Shooter or a Flight Simulator.
  39058. * @param name Define the name of the camera in the scene.
  39059. * @param position Define the starting position of the camera in the scene.
  39060. * @param scene Define the scene the camera belongs to.
  39061. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  39062. */
  39063. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  39064. /**
  39065. * Attach a control to the HTML DOM element.
  39066. * @param element Defines the element that listens to the input events.
  39067. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  39068. */
  39069. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39070. /**
  39071. * Detach a control from the HTML DOM element.
  39072. * The camera will stop reacting to that input.
  39073. * @param element Defines the element that listens to the input events.
  39074. */
  39075. detachControl(element: HTMLElement): void;
  39076. private _collisionMask;
  39077. /**
  39078. * Get the mask that the camera ignores in collision events.
  39079. */
  39080. /**
  39081. * Set the mask that the camera ignores in collision events.
  39082. */
  39083. collisionMask: number;
  39084. /** @hidden */
  39085. _collideWithWorld(displacement: Vector3): void;
  39086. /** @hidden */
  39087. private _onCollisionPositionChange;
  39088. /** @hidden */
  39089. _checkInputs(): void;
  39090. /** @hidden */
  39091. _decideIfNeedsToMove(): boolean;
  39092. /** @hidden */
  39093. _updatePosition(): void;
  39094. /**
  39095. * Restore the Roll to its target value at the rate specified.
  39096. * @param rate - Higher means slower restoring.
  39097. * @hidden
  39098. */
  39099. restoreRoll(rate: number): void;
  39100. /**
  39101. * Destroy the camera and release the current resources held by it.
  39102. */
  39103. dispose(): void;
  39104. /**
  39105. * Get the current object class name.
  39106. * @returns the class name.
  39107. */
  39108. getClassName(): string;
  39109. }
  39110. }
  39111. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  39112. import { Nullable } from "babylonjs/types";
  39113. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39114. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  39115. /**
  39116. * Listen to keyboard events to control the camera.
  39117. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39118. */
  39119. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  39120. /**
  39121. * Defines the camera the input is attached to.
  39122. */
  39123. camera: FlyCamera;
  39124. /**
  39125. * The list of keyboard keys used to control the forward move of the camera.
  39126. */
  39127. keysForward: number[];
  39128. /**
  39129. * The list of keyboard keys used to control the backward move of the camera.
  39130. */
  39131. keysBackward: number[];
  39132. /**
  39133. * The list of keyboard keys used to control the forward move of the camera.
  39134. */
  39135. keysUp: number[];
  39136. /**
  39137. * The list of keyboard keys used to control the backward move of the camera.
  39138. */
  39139. keysDown: number[];
  39140. /**
  39141. * The list of keyboard keys used to control the right strafe move of the camera.
  39142. */
  39143. keysRight: number[];
  39144. /**
  39145. * The list of keyboard keys used to control the left strafe move of the camera.
  39146. */
  39147. keysLeft: number[];
  39148. private _keys;
  39149. private _onCanvasBlurObserver;
  39150. private _onKeyboardObserver;
  39151. private _engine;
  39152. private _scene;
  39153. /**
  39154. * Attach the input controls to a specific dom element to get the input from.
  39155. * @param element Defines the element the controls should be listened from
  39156. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39157. */
  39158. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39159. /**
  39160. * Detach the current controls from the specified dom element.
  39161. * @param element Defines the element to stop listening the inputs from
  39162. */
  39163. detachControl(element: Nullable<HTMLElement>): void;
  39164. /**
  39165. * Gets the class name of the current intput.
  39166. * @returns the class name
  39167. */
  39168. getClassName(): string;
  39169. /** @hidden */
  39170. _onLostFocus(e: FocusEvent): void;
  39171. /**
  39172. * Get the friendly name associated with the input class.
  39173. * @returns the input friendly name
  39174. */
  39175. getSimpleName(): string;
  39176. /**
  39177. * Update the current camera state depending on the inputs that have been used this frame.
  39178. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39179. */
  39180. checkInputs(): void;
  39181. }
  39182. }
  39183. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  39184. import { Nullable } from "babylonjs/types";
  39185. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39186. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39187. /**
  39188. * Manage the mouse wheel inputs to control a follow camera.
  39189. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39190. */
  39191. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  39192. /**
  39193. * Defines the camera the input is attached to.
  39194. */
  39195. camera: FollowCamera;
  39196. /**
  39197. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  39198. */
  39199. axisControlRadius: boolean;
  39200. /**
  39201. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  39202. */
  39203. axisControlHeight: boolean;
  39204. /**
  39205. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  39206. */
  39207. axisControlRotation: boolean;
  39208. /**
  39209. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  39210. * relation to mouseWheel events.
  39211. */
  39212. wheelPrecision: number;
  39213. /**
  39214. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  39215. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  39216. */
  39217. wheelDeltaPercentage: number;
  39218. private _wheel;
  39219. private _observer;
  39220. /**
  39221. * Attach the input controls to a specific dom element to get the input from.
  39222. * @param element Defines the element the controls should be listened from
  39223. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39224. */
  39225. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39226. /**
  39227. * Detach the current controls from the specified dom element.
  39228. * @param element Defines the element to stop listening the inputs from
  39229. */
  39230. detachControl(element: Nullable<HTMLElement>): void;
  39231. /**
  39232. * Gets the class name of the current intput.
  39233. * @returns the class name
  39234. */
  39235. getClassName(): string;
  39236. /**
  39237. * Get the friendly name associated with the input class.
  39238. * @returns the input friendly name
  39239. */
  39240. getSimpleName(): string;
  39241. }
  39242. }
  39243. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  39244. import { Nullable } from "babylonjs/types";
  39245. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39246. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  39247. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  39248. /**
  39249. * Manage the pointers inputs to control an follow camera.
  39250. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39251. */
  39252. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  39253. /**
  39254. * Defines the camera the input is attached to.
  39255. */
  39256. camera: FollowCamera;
  39257. /**
  39258. * Gets the class name of the current input.
  39259. * @returns the class name
  39260. */
  39261. getClassName(): string;
  39262. /**
  39263. * Defines the pointer angular sensibility along the X axis or how fast is
  39264. * the camera rotating.
  39265. * A negative number will reverse the axis direction.
  39266. */
  39267. angularSensibilityX: number;
  39268. /**
  39269. * Defines the pointer angular sensibility along the Y axis or how fast is
  39270. * the camera rotating.
  39271. * A negative number will reverse the axis direction.
  39272. */
  39273. angularSensibilityY: number;
  39274. /**
  39275. * Defines the pointer pinch precision or how fast is the camera zooming.
  39276. * A negative number will reverse the axis direction.
  39277. */
  39278. pinchPrecision: number;
  39279. /**
  39280. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  39281. * from 0.
  39282. * It defines the percentage of current camera.radius to use as delta when
  39283. * pinch zoom is used.
  39284. */
  39285. pinchDeltaPercentage: number;
  39286. /**
  39287. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  39288. */
  39289. axisXControlRadius: boolean;
  39290. /**
  39291. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  39292. */
  39293. axisXControlHeight: boolean;
  39294. /**
  39295. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  39296. */
  39297. axisXControlRotation: boolean;
  39298. /**
  39299. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  39300. */
  39301. axisYControlRadius: boolean;
  39302. /**
  39303. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  39304. */
  39305. axisYControlHeight: boolean;
  39306. /**
  39307. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  39308. */
  39309. axisYControlRotation: boolean;
  39310. /**
  39311. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  39312. */
  39313. axisPinchControlRadius: boolean;
  39314. /**
  39315. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  39316. */
  39317. axisPinchControlHeight: boolean;
  39318. /**
  39319. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  39320. */
  39321. axisPinchControlRotation: boolean;
  39322. /**
  39323. * Log error messages if basic misconfiguration has occurred.
  39324. */
  39325. warningEnable: boolean;
  39326. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  39327. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  39328. private _warningCounter;
  39329. private _warning;
  39330. }
  39331. }
  39332. declare module "babylonjs/Cameras/followCameraInputsManager" {
  39333. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  39334. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39335. /**
  39336. * Default Inputs manager for the FollowCamera.
  39337. * It groups all the default supported inputs for ease of use.
  39338. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39339. */
  39340. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  39341. /**
  39342. * Instantiates a new FollowCameraInputsManager.
  39343. * @param camera Defines the camera the inputs belong to
  39344. */
  39345. constructor(camera: FollowCamera);
  39346. /**
  39347. * Add keyboard input support to the input manager.
  39348. * @returns the current input manager
  39349. */
  39350. addKeyboard(): FollowCameraInputsManager;
  39351. /**
  39352. * Add mouse wheel input support to the input manager.
  39353. * @returns the current input manager
  39354. */
  39355. addMouseWheel(): FollowCameraInputsManager;
  39356. /**
  39357. * Add pointers input support to the input manager.
  39358. * @returns the current input manager
  39359. */
  39360. addPointers(): FollowCameraInputsManager;
  39361. /**
  39362. * Add orientation input support to the input manager.
  39363. * @returns the current input manager
  39364. */
  39365. addVRDeviceOrientation(): FollowCameraInputsManager;
  39366. }
  39367. }
  39368. declare module "babylonjs/Cameras/followCamera" {
  39369. import { Nullable } from "babylonjs/types";
  39370. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  39371. import { Scene } from "babylonjs/scene";
  39372. import { Vector3 } from "babylonjs/Maths/math.vector";
  39373. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39374. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  39375. /**
  39376. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  39377. * an arc rotate version arcFollowCamera are available.
  39378. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39379. */
  39380. export class FollowCamera extends TargetCamera {
  39381. /**
  39382. * Distance the follow camera should follow an object at
  39383. */
  39384. radius: number;
  39385. /**
  39386. * Minimum allowed distance of the camera to the axis of rotation
  39387. * (The camera can not get closer).
  39388. * This can help limiting how the Camera is able to move in the scene.
  39389. */
  39390. lowerRadiusLimit: Nullable<number>;
  39391. /**
  39392. * Maximum allowed distance of the camera to the axis of rotation
  39393. * (The camera can not get further).
  39394. * This can help limiting how the Camera is able to move in the scene.
  39395. */
  39396. upperRadiusLimit: Nullable<number>;
  39397. /**
  39398. * Define a rotation offset between the camera and the object it follows
  39399. */
  39400. rotationOffset: number;
  39401. /**
  39402. * Minimum allowed angle to camera position relative to target object.
  39403. * This can help limiting how the Camera is able to move in the scene.
  39404. */
  39405. lowerRotationOffsetLimit: Nullable<number>;
  39406. /**
  39407. * Maximum allowed angle to camera position relative to target object.
  39408. * This can help limiting how the Camera is able to move in the scene.
  39409. */
  39410. upperRotationOffsetLimit: Nullable<number>;
  39411. /**
  39412. * Define a height offset between the camera and the object it follows.
  39413. * It can help following an object from the top (like a car chaing a plane)
  39414. */
  39415. heightOffset: number;
  39416. /**
  39417. * Minimum allowed height of camera position relative to target object.
  39418. * This can help limiting how the Camera is able to move in the scene.
  39419. */
  39420. lowerHeightOffsetLimit: Nullable<number>;
  39421. /**
  39422. * Maximum allowed height of camera position relative to target object.
  39423. * This can help limiting how the Camera is able to move in the scene.
  39424. */
  39425. upperHeightOffsetLimit: Nullable<number>;
  39426. /**
  39427. * Define how fast the camera can accelerate to follow it s target.
  39428. */
  39429. cameraAcceleration: number;
  39430. /**
  39431. * Define the speed limit of the camera following an object.
  39432. */
  39433. maxCameraSpeed: number;
  39434. /**
  39435. * Define the target of the camera.
  39436. */
  39437. lockedTarget: Nullable<AbstractMesh>;
  39438. /**
  39439. * Defines the input associated with the camera.
  39440. */
  39441. inputs: FollowCameraInputsManager;
  39442. /**
  39443. * Instantiates the follow camera.
  39444. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39445. * @param name Define the name of the camera in the scene
  39446. * @param position Define the position of the camera
  39447. * @param scene Define the scene the camera belong to
  39448. * @param lockedTarget Define the target of the camera
  39449. */
  39450. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  39451. private _follow;
  39452. /**
  39453. * Attached controls to the current camera.
  39454. * @param element Defines the element the controls should be listened from
  39455. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39456. */
  39457. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39458. /**
  39459. * Detach the current controls from the camera.
  39460. * The camera will stop reacting to inputs.
  39461. * @param element Defines the element to stop listening the inputs from
  39462. */
  39463. detachControl(element: HTMLElement): void;
  39464. /** @hidden */
  39465. _checkInputs(): void;
  39466. private _checkLimits;
  39467. /**
  39468. * Gets the camera class name.
  39469. * @returns the class name
  39470. */
  39471. getClassName(): string;
  39472. }
  39473. /**
  39474. * Arc Rotate version of the follow camera.
  39475. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  39476. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39477. */
  39478. export class ArcFollowCamera extends TargetCamera {
  39479. /** The longitudinal angle of the camera */
  39480. alpha: number;
  39481. /** The latitudinal angle of the camera */
  39482. beta: number;
  39483. /** The radius of the camera from its target */
  39484. radius: number;
  39485. /** Define the camera target (the messh it should follow) */
  39486. target: Nullable<AbstractMesh>;
  39487. private _cartesianCoordinates;
  39488. /**
  39489. * Instantiates a new ArcFollowCamera
  39490. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39491. * @param name Define the name of the camera
  39492. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  39493. * @param beta Define the rotation angle of the camera around the elevation axis
  39494. * @param radius Define the radius of the camera from its target point
  39495. * @param target Define the target of the camera
  39496. * @param scene Define the scene the camera belongs to
  39497. */
  39498. constructor(name: string,
  39499. /** The longitudinal angle of the camera */
  39500. alpha: number,
  39501. /** The latitudinal angle of the camera */
  39502. beta: number,
  39503. /** The radius of the camera from its target */
  39504. radius: number,
  39505. /** Define the camera target (the messh it should follow) */
  39506. target: Nullable<AbstractMesh>, scene: Scene);
  39507. private _follow;
  39508. /** @hidden */
  39509. _checkInputs(): void;
  39510. /**
  39511. * Returns the class name of the object.
  39512. * It is mostly used internally for serialization purposes.
  39513. */
  39514. getClassName(): string;
  39515. }
  39516. }
  39517. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  39518. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39519. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39520. import { Nullable } from "babylonjs/types";
  39521. /**
  39522. * Manage the keyboard inputs to control the movement of a follow camera.
  39523. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39524. */
  39525. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  39526. /**
  39527. * Defines the camera the input is attached to.
  39528. */
  39529. camera: FollowCamera;
  39530. /**
  39531. * Defines the list of key codes associated with the up action (increase heightOffset)
  39532. */
  39533. keysHeightOffsetIncr: number[];
  39534. /**
  39535. * Defines the list of key codes associated with the down action (decrease heightOffset)
  39536. */
  39537. keysHeightOffsetDecr: number[];
  39538. /**
  39539. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  39540. */
  39541. keysHeightOffsetModifierAlt: boolean;
  39542. /**
  39543. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  39544. */
  39545. keysHeightOffsetModifierCtrl: boolean;
  39546. /**
  39547. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  39548. */
  39549. keysHeightOffsetModifierShift: boolean;
  39550. /**
  39551. * Defines the list of key codes associated with the left action (increase rotationOffset)
  39552. */
  39553. keysRotationOffsetIncr: number[];
  39554. /**
  39555. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  39556. */
  39557. keysRotationOffsetDecr: number[];
  39558. /**
  39559. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  39560. */
  39561. keysRotationOffsetModifierAlt: boolean;
  39562. /**
  39563. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  39564. */
  39565. keysRotationOffsetModifierCtrl: boolean;
  39566. /**
  39567. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  39568. */
  39569. keysRotationOffsetModifierShift: boolean;
  39570. /**
  39571. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  39572. */
  39573. keysRadiusIncr: number[];
  39574. /**
  39575. * Defines the list of key codes associated with the zoom-out action (increase radius)
  39576. */
  39577. keysRadiusDecr: number[];
  39578. /**
  39579. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  39580. */
  39581. keysRadiusModifierAlt: boolean;
  39582. /**
  39583. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  39584. */
  39585. keysRadiusModifierCtrl: boolean;
  39586. /**
  39587. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  39588. */
  39589. keysRadiusModifierShift: boolean;
  39590. /**
  39591. * Defines the rate of change of heightOffset.
  39592. */
  39593. heightSensibility: number;
  39594. /**
  39595. * Defines the rate of change of rotationOffset.
  39596. */
  39597. rotationSensibility: number;
  39598. /**
  39599. * Defines the rate of change of radius.
  39600. */
  39601. radiusSensibility: number;
  39602. private _keys;
  39603. private _ctrlPressed;
  39604. private _altPressed;
  39605. private _shiftPressed;
  39606. private _onCanvasBlurObserver;
  39607. private _onKeyboardObserver;
  39608. private _engine;
  39609. private _scene;
  39610. /**
  39611. * Attach the input controls to a specific dom element to get the input from.
  39612. * @param element Defines the element the controls should be listened from
  39613. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39614. */
  39615. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39616. /**
  39617. * Detach the current controls from the specified dom element.
  39618. * @param element Defines the element to stop listening the inputs from
  39619. */
  39620. detachControl(element: Nullable<HTMLElement>): void;
  39621. /**
  39622. * Update the current camera state depending on the inputs that have been used this frame.
  39623. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39624. */
  39625. checkInputs(): void;
  39626. /**
  39627. * Gets the class name of the current input.
  39628. * @returns the class name
  39629. */
  39630. getClassName(): string;
  39631. /**
  39632. * Get the friendly name associated with the input class.
  39633. * @returns the input friendly name
  39634. */
  39635. getSimpleName(): string;
  39636. /**
  39637. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39638. * allow modification of the heightOffset value.
  39639. */
  39640. private _modifierHeightOffset;
  39641. /**
  39642. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39643. * allow modification of the rotationOffset value.
  39644. */
  39645. private _modifierRotationOffset;
  39646. /**
  39647. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39648. * allow modification of the radius value.
  39649. */
  39650. private _modifierRadius;
  39651. }
  39652. }
  39653. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  39654. import { Nullable } from "babylonjs/types";
  39655. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39656. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39657. import { Observable } from "babylonjs/Misc/observable";
  39658. module "babylonjs/Cameras/freeCameraInputsManager" {
  39659. interface FreeCameraInputsManager {
  39660. /**
  39661. * @hidden
  39662. */
  39663. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  39664. /**
  39665. * Add orientation input support to the input manager.
  39666. * @returns the current input manager
  39667. */
  39668. addDeviceOrientation(): FreeCameraInputsManager;
  39669. }
  39670. }
  39671. /**
  39672. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  39673. * Screen rotation is taken into account.
  39674. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39675. */
  39676. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  39677. private _camera;
  39678. private _screenOrientationAngle;
  39679. private _constantTranform;
  39680. private _screenQuaternion;
  39681. private _alpha;
  39682. private _beta;
  39683. private _gamma;
  39684. /**
  39685. * Can be used to detect if a device orientation sensor is availible on a device
  39686. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  39687. * @returns a promise that will resolve on orientation change
  39688. */
  39689. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  39690. /**
  39691. * @hidden
  39692. */
  39693. _onDeviceOrientationChangedObservable: Observable<void>;
  39694. /**
  39695. * Instantiates a new input
  39696. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39697. */
  39698. constructor();
  39699. /**
  39700. * Define the camera controlled by the input.
  39701. */
  39702. camera: FreeCamera;
  39703. /**
  39704. * Attach the input controls to a specific dom element to get the input from.
  39705. * @param element Defines the element the controls should be listened from
  39706. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39707. */
  39708. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39709. private _orientationChanged;
  39710. private _deviceOrientation;
  39711. /**
  39712. * Detach the current controls from the specified dom element.
  39713. * @param element Defines the element to stop listening the inputs from
  39714. */
  39715. detachControl(element: Nullable<HTMLElement>): void;
  39716. /**
  39717. * Update the current camera state depending on the inputs that have been used this frame.
  39718. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39719. */
  39720. checkInputs(): void;
  39721. /**
  39722. * Gets the class name of the current intput.
  39723. * @returns the class name
  39724. */
  39725. getClassName(): string;
  39726. /**
  39727. * Get the friendly name associated with the input class.
  39728. * @returns the input friendly name
  39729. */
  39730. getSimpleName(): string;
  39731. }
  39732. }
  39733. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  39734. import { Nullable } from "babylonjs/types";
  39735. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39736. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39737. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39738. /**
  39739. * Manage the gamepad inputs to control a free camera.
  39740. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39741. */
  39742. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  39743. /**
  39744. * Define the camera the input is attached to.
  39745. */
  39746. camera: FreeCamera;
  39747. /**
  39748. * Define the Gamepad controlling the input
  39749. */
  39750. gamepad: Nullable<Gamepad>;
  39751. /**
  39752. * Defines the gamepad rotation sensiblity.
  39753. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  39754. */
  39755. gamepadAngularSensibility: number;
  39756. /**
  39757. * Defines the gamepad move sensiblity.
  39758. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  39759. */
  39760. gamepadMoveSensibility: number;
  39761. private _yAxisScale;
  39762. /**
  39763. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  39764. */
  39765. invertYAxis: boolean;
  39766. private _onGamepadConnectedObserver;
  39767. private _onGamepadDisconnectedObserver;
  39768. private _cameraTransform;
  39769. private _deltaTransform;
  39770. private _vector3;
  39771. private _vector2;
  39772. /**
  39773. * Attach the input controls to a specific dom element to get the input from.
  39774. * @param element Defines the element the controls should be listened from
  39775. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39776. */
  39777. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39778. /**
  39779. * Detach the current controls from the specified dom element.
  39780. * @param element Defines the element to stop listening the inputs from
  39781. */
  39782. detachControl(element: Nullable<HTMLElement>): void;
  39783. /**
  39784. * Update the current camera state depending on the inputs that have been used this frame.
  39785. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39786. */
  39787. checkInputs(): void;
  39788. /**
  39789. * Gets the class name of the current intput.
  39790. * @returns the class name
  39791. */
  39792. getClassName(): string;
  39793. /**
  39794. * Get the friendly name associated with the input class.
  39795. * @returns the input friendly name
  39796. */
  39797. getSimpleName(): string;
  39798. }
  39799. }
  39800. declare module "babylonjs/Misc/virtualJoystick" {
  39801. import { Nullable } from "babylonjs/types";
  39802. import { Vector3 } from "babylonjs/Maths/math.vector";
  39803. /**
  39804. * Defines the potential axis of a Joystick
  39805. */
  39806. export enum JoystickAxis {
  39807. /** X axis */
  39808. X = 0,
  39809. /** Y axis */
  39810. Y = 1,
  39811. /** Z axis */
  39812. Z = 2
  39813. }
  39814. /**
  39815. * Class used to define virtual joystick (used in touch mode)
  39816. */
  39817. export class VirtualJoystick {
  39818. /**
  39819. * Gets or sets a boolean indicating that left and right values must be inverted
  39820. */
  39821. reverseLeftRight: boolean;
  39822. /**
  39823. * Gets or sets a boolean indicating that up and down values must be inverted
  39824. */
  39825. reverseUpDown: boolean;
  39826. /**
  39827. * Gets the offset value for the position (ie. the change of the position value)
  39828. */
  39829. deltaPosition: Vector3;
  39830. /**
  39831. * Gets a boolean indicating if the virtual joystick was pressed
  39832. */
  39833. pressed: boolean;
  39834. /**
  39835. * Canvas the virtual joystick will render onto, default z-index of this is 5
  39836. */
  39837. static Canvas: Nullable<HTMLCanvasElement>;
  39838. private static _globalJoystickIndex;
  39839. private static vjCanvasContext;
  39840. private static vjCanvasWidth;
  39841. private static vjCanvasHeight;
  39842. private static halfWidth;
  39843. private _action;
  39844. private _axisTargetedByLeftAndRight;
  39845. private _axisTargetedByUpAndDown;
  39846. private _joystickSensibility;
  39847. private _inversedSensibility;
  39848. private _joystickPointerID;
  39849. private _joystickColor;
  39850. private _joystickPointerPos;
  39851. private _joystickPreviousPointerPos;
  39852. private _joystickPointerStartPos;
  39853. private _deltaJoystickVector;
  39854. private _leftJoystick;
  39855. private _touches;
  39856. private _onPointerDownHandlerRef;
  39857. private _onPointerMoveHandlerRef;
  39858. private _onPointerUpHandlerRef;
  39859. private _onResize;
  39860. /**
  39861. * Creates a new virtual joystick
  39862. * @param leftJoystick defines that the joystick is for left hand (false by default)
  39863. */
  39864. constructor(leftJoystick?: boolean);
  39865. /**
  39866. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  39867. * @param newJoystickSensibility defines the new sensibility
  39868. */
  39869. setJoystickSensibility(newJoystickSensibility: number): void;
  39870. private _onPointerDown;
  39871. private _onPointerMove;
  39872. private _onPointerUp;
  39873. /**
  39874. * Change the color of the virtual joystick
  39875. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  39876. */
  39877. setJoystickColor(newColor: string): void;
  39878. /**
  39879. * Defines a callback to call when the joystick is touched
  39880. * @param action defines the callback
  39881. */
  39882. setActionOnTouch(action: () => any): void;
  39883. /**
  39884. * Defines which axis you'd like to control for left & right
  39885. * @param axis defines the axis to use
  39886. */
  39887. setAxisForLeftRight(axis: JoystickAxis): void;
  39888. /**
  39889. * Defines which axis you'd like to control for up & down
  39890. * @param axis defines the axis to use
  39891. */
  39892. setAxisForUpDown(axis: JoystickAxis): void;
  39893. private _drawVirtualJoystick;
  39894. /**
  39895. * Release internal HTML canvas
  39896. */
  39897. releaseCanvas(): void;
  39898. }
  39899. }
  39900. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  39901. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  39902. import { Nullable } from "babylonjs/types";
  39903. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39904. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39905. module "babylonjs/Cameras/freeCameraInputsManager" {
  39906. interface FreeCameraInputsManager {
  39907. /**
  39908. * Add virtual joystick input support to the input manager.
  39909. * @returns the current input manager
  39910. */
  39911. addVirtualJoystick(): FreeCameraInputsManager;
  39912. }
  39913. }
  39914. /**
  39915. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  39916. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39917. */
  39918. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  39919. /**
  39920. * Defines the camera the input is attached to.
  39921. */
  39922. camera: FreeCamera;
  39923. private _leftjoystick;
  39924. private _rightjoystick;
  39925. /**
  39926. * Gets the left stick of the virtual joystick.
  39927. * @returns The virtual Joystick
  39928. */
  39929. getLeftJoystick(): VirtualJoystick;
  39930. /**
  39931. * Gets the right stick of the virtual joystick.
  39932. * @returns The virtual Joystick
  39933. */
  39934. getRightJoystick(): VirtualJoystick;
  39935. /**
  39936. * Update the current camera state depending on the inputs that have been used this frame.
  39937. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39938. */
  39939. checkInputs(): void;
  39940. /**
  39941. * Attach the input controls to a specific dom element to get the input from.
  39942. * @param element Defines the element the controls should be listened from
  39943. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39944. */
  39945. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39946. /**
  39947. * Detach the current controls from the specified dom element.
  39948. * @param element Defines the element to stop listening the inputs from
  39949. */
  39950. detachControl(element: Nullable<HTMLElement>): void;
  39951. /**
  39952. * Gets the class name of the current intput.
  39953. * @returns the class name
  39954. */
  39955. getClassName(): string;
  39956. /**
  39957. * Get the friendly name associated with the input class.
  39958. * @returns the input friendly name
  39959. */
  39960. getSimpleName(): string;
  39961. }
  39962. }
  39963. declare module "babylonjs/Cameras/Inputs/index" {
  39964. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  39965. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  39966. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  39967. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  39968. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  39969. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  39970. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  39971. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  39972. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  39973. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  39974. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  39975. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  39976. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  39977. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  39978. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  39979. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  39980. }
  39981. declare module "babylonjs/Cameras/touchCamera" {
  39982. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39983. import { Scene } from "babylonjs/scene";
  39984. import { Vector3 } from "babylonjs/Maths/math.vector";
  39985. /**
  39986. * This represents a FPS type of camera controlled by touch.
  39987. * This is like a universal camera minus the Gamepad controls.
  39988. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  39989. */
  39990. export class TouchCamera extends FreeCamera {
  39991. /**
  39992. * Defines the touch sensibility for rotation.
  39993. * The higher the faster.
  39994. */
  39995. touchAngularSensibility: number;
  39996. /**
  39997. * Defines the touch sensibility for move.
  39998. * The higher the faster.
  39999. */
  40000. touchMoveSensibility: number;
  40001. /**
  40002. * Instantiates a new touch camera.
  40003. * This represents a FPS type of camera controlled by touch.
  40004. * This is like a universal camera minus the Gamepad controls.
  40005. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40006. * @param name Define the name of the camera in the scene
  40007. * @param position Define the start position of the camera in the scene
  40008. * @param scene Define the scene the camera belongs to
  40009. */
  40010. constructor(name: string, position: Vector3, scene: Scene);
  40011. /**
  40012. * Gets the current object class name.
  40013. * @return the class name
  40014. */
  40015. getClassName(): string;
  40016. /** @hidden */
  40017. _setupInputs(): void;
  40018. }
  40019. }
  40020. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  40021. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40022. import { Scene } from "babylonjs/scene";
  40023. import { Vector3 } from "babylonjs/Maths/math.vector";
  40024. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  40025. import { Axis } from "babylonjs/Maths/math.axis";
  40026. /**
  40027. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  40028. * being tilted forward or back and left or right.
  40029. */
  40030. export class DeviceOrientationCamera extends FreeCamera {
  40031. private _initialQuaternion;
  40032. private _quaternionCache;
  40033. private _tmpDragQuaternion;
  40034. private _disablePointerInputWhenUsingDeviceOrientation;
  40035. /**
  40036. * Creates a new device orientation camera
  40037. * @param name The name of the camera
  40038. * @param position The start position camera
  40039. * @param scene The scene the camera belongs to
  40040. */
  40041. constructor(name: string, position: Vector3, scene: Scene);
  40042. /**
  40043. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  40044. */
  40045. disablePointerInputWhenUsingDeviceOrientation: boolean;
  40046. private _dragFactor;
  40047. /**
  40048. * Enabled turning on the y axis when the orientation sensor is active
  40049. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  40050. */
  40051. enableHorizontalDragging(dragFactor?: number): void;
  40052. /**
  40053. * Gets the current instance class name ("DeviceOrientationCamera").
  40054. * This helps avoiding instanceof at run time.
  40055. * @returns the class name
  40056. */
  40057. getClassName(): string;
  40058. /**
  40059. * @hidden
  40060. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  40061. */
  40062. _checkInputs(): void;
  40063. /**
  40064. * Reset the camera to its default orientation on the specified axis only.
  40065. * @param axis The axis to reset
  40066. */
  40067. resetToCurrentRotation(axis?: Axis): void;
  40068. }
  40069. }
  40070. declare module "babylonjs/Gamepads/xboxGamepad" {
  40071. import { Observable } from "babylonjs/Misc/observable";
  40072. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40073. /**
  40074. * Defines supported buttons for XBox360 compatible gamepads
  40075. */
  40076. export enum Xbox360Button {
  40077. /** A */
  40078. A = 0,
  40079. /** B */
  40080. B = 1,
  40081. /** X */
  40082. X = 2,
  40083. /** Y */
  40084. Y = 3,
  40085. /** Start */
  40086. Start = 4,
  40087. /** Back */
  40088. Back = 5,
  40089. /** Left button */
  40090. LB = 6,
  40091. /** Right button */
  40092. RB = 7,
  40093. /** Left stick */
  40094. LeftStick = 8,
  40095. /** Right stick */
  40096. RightStick = 9
  40097. }
  40098. /** Defines values for XBox360 DPad */
  40099. export enum Xbox360Dpad {
  40100. /** Up */
  40101. Up = 0,
  40102. /** Down */
  40103. Down = 1,
  40104. /** Left */
  40105. Left = 2,
  40106. /** Right */
  40107. Right = 3
  40108. }
  40109. /**
  40110. * Defines a XBox360 gamepad
  40111. */
  40112. export class Xbox360Pad extends Gamepad {
  40113. private _leftTrigger;
  40114. private _rightTrigger;
  40115. private _onlefttriggerchanged;
  40116. private _onrighttriggerchanged;
  40117. private _onbuttondown;
  40118. private _onbuttonup;
  40119. private _ondpaddown;
  40120. private _ondpadup;
  40121. /** Observable raised when a button is pressed */
  40122. onButtonDownObservable: Observable<Xbox360Button>;
  40123. /** Observable raised when a button is released */
  40124. onButtonUpObservable: Observable<Xbox360Button>;
  40125. /** Observable raised when a pad is pressed */
  40126. onPadDownObservable: Observable<Xbox360Dpad>;
  40127. /** Observable raised when a pad is released */
  40128. onPadUpObservable: Observable<Xbox360Dpad>;
  40129. private _buttonA;
  40130. private _buttonB;
  40131. private _buttonX;
  40132. private _buttonY;
  40133. private _buttonBack;
  40134. private _buttonStart;
  40135. private _buttonLB;
  40136. private _buttonRB;
  40137. private _buttonLeftStick;
  40138. private _buttonRightStick;
  40139. private _dPadUp;
  40140. private _dPadDown;
  40141. private _dPadLeft;
  40142. private _dPadRight;
  40143. private _isXboxOnePad;
  40144. /**
  40145. * Creates a new XBox360 gamepad object
  40146. * @param id defines the id of this gamepad
  40147. * @param index defines its index
  40148. * @param gamepad defines the internal HTML gamepad object
  40149. * @param xboxOne defines if it is a XBox One gamepad
  40150. */
  40151. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  40152. /**
  40153. * Defines the callback to call when left trigger is pressed
  40154. * @param callback defines the callback to use
  40155. */
  40156. onlefttriggerchanged(callback: (value: number) => void): void;
  40157. /**
  40158. * Defines the callback to call when right trigger is pressed
  40159. * @param callback defines the callback to use
  40160. */
  40161. onrighttriggerchanged(callback: (value: number) => void): void;
  40162. /**
  40163. * Gets the left trigger value
  40164. */
  40165. /**
  40166. * Sets the left trigger value
  40167. */
  40168. leftTrigger: number;
  40169. /**
  40170. * Gets the right trigger value
  40171. */
  40172. /**
  40173. * Sets the right trigger value
  40174. */
  40175. rightTrigger: number;
  40176. /**
  40177. * Defines the callback to call when a button is pressed
  40178. * @param callback defines the callback to use
  40179. */
  40180. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  40181. /**
  40182. * Defines the callback to call when a button is released
  40183. * @param callback defines the callback to use
  40184. */
  40185. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  40186. /**
  40187. * Defines the callback to call when a pad is pressed
  40188. * @param callback defines the callback to use
  40189. */
  40190. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  40191. /**
  40192. * Defines the callback to call when a pad is released
  40193. * @param callback defines the callback to use
  40194. */
  40195. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  40196. private _setButtonValue;
  40197. private _setDPadValue;
  40198. /**
  40199. * Gets the value of the `A` button
  40200. */
  40201. /**
  40202. * Sets the value of the `A` button
  40203. */
  40204. buttonA: number;
  40205. /**
  40206. * Gets the value of the `B` button
  40207. */
  40208. /**
  40209. * Sets the value of the `B` button
  40210. */
  40211. buttonB: number;
  40212. /**
  40213. * Gets the value of the `X` button
  40214. */
  40215. /**
  40216. * Sets the value of the `X` button
  40217. */
  40218. buttonX: number;
  40219. /**
  40220. * Gets the value of the `Y` button
  40221. */
  40222. /**
  40223. * Sets the value of the `Y` button
  40224. */
  40225. buttonY: number;
  40226. /**
  40227. * Gets the value of the `Start` button
  40228. */
  40229. /**
  40230. * Sets the value of the `Start` button
  40231. */
  40232. buttonStart: number;
  40233. /**
  40234. * Gets the value of the `Back` button
  40235. */
  40236. /**
  40237. * Sets the value of the `Back` button
  40238. */
  40239. buttonBack: number;
  40240. /**
  40241. * Gets the value of the `Left` button
  40242. */
  40243. /**
  40244. * Sets the value of the `Left` button
  40245. */
  40246. buttonLB: number;
  40247. /**
  40248. * Gets the value of the `Right` button
  40249. */
  40250. /**
  40251. * Sets the value of the `Right` button
  40252. */
  40253. buttonRB: number;
  40254. /**
  40255. * Gets the value of the Left joystick
  40256. */
  40257. /**
  40258. * Sets the value of the Left joystick
  40259. */
  40260. buttonLeftStick: number;
  40261. /**
  40262. * Gets the value of the Right joystick
  40263. */
  40264. /**
  40265. * Sets the value of the Right joystick
  40266. */
  40267. buttonRightStick: number;
  40268. /**
  40269. * Gets the value of D-pad up
  40270. */
  40271. /**
  40272. * Sets the value of D-pad up
  40273. */
  40274. dPadUp: number;
  40275. /**
  40276. * Gets the value of D-pad down
  40277. */
  40278. /**
  40279. * Sets the value of D-pad down
  40280. */
  40281. dPadDown: number;
  40282. /**
  40283. * Gets the value of D-pad left
  40284. */
  40285. /**
  40286. * Sets the value of D-pad left
  40287. */
  40288. dPadLeft: number;
  40289. /**
  40290. * Gets the value of D-pad right
  40291. */
  40292. /**
  40293. * Sets the value of D-pad right
  40294. */
  40295. dPadRight: number;
  40296. /**
  40297. * Force the gamepad to synchronize with device values
  40298. */
  40299. update(): void;
  40300. /**
  40301. * Disposes the gamepad
  40302. */
  40303. dispose(): void;
  40304. }
  40305. }
  40306. declare module "babylonjs/Gamepads/dualShockGamepad" {
  40307. import { Observable } from "babylonjs/Misc/observable";
  40308. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40309. /**
  40310. * Defines supported buttons for DualShock compatible gamepads
  40311. */
  40312. export enum DualShockButton {
  40313. /** Cross */
  40314. Cross = 0,
  40315. /** Circle */
  40316. Circle = 1,
  40317. /** Square */
  40318. Square = 2,
  40319. /** Triangle */
  40320. Triangle = 3,
  40321. /** Options */
  40322. Options = 4,
  40323. /** Share */
  40324. Share = 5,
  40325. /** L1 */
  40326. L1 = 6,
  40327. /** R1 */
  40328. R1 = 7,
  40329. /** Left stick */
  40330. LeftStick = 8,
  40331. /** Right stick */
  40332. RightStick = 9
  40333. }
  40334. /** Defines values for DualShock DPad */
  40335. export enum DualShockDpad {
  40336. /** Up */
  40337. Up = 0,
  40338. /** Down */
  40339. Down = 1,
  40340. /** Left */
  40341. Left = 2,
  40342. /** Right */
  40343. Right = 3
  40344. }
  40345. /**
  40346. * Defines a DualShock gamepad
  40347. */
  40348. export class DualShockPad extends Gamepad {
  40349. private _leftTrigger;
  40350. private _rightTrigger;
  40351. private _onlefttriggerchanged;
  40352. private _onrighttriggerchanged;
  40353. private _onbuttondown;
  40354. private _onbuttonup;
  40355. private _ondpaddown;
  40356. private _ondpadup;
  40357. /** Observable raised when a button is pressed */
  40358. onButtonDownObservable: Observable<DualShockButton>;
  40359. /** Observable raised when a button is released */
  40360. onButtonUpObservable: Observable<DualShockButton>;
  40361. /** Observable raised when a pad is pressed */
  40362. onPadDownObservable: Observable<DualShockDpad>;
  40363. /** Observable raised when a pad is released */
  40364. onPadUpObservable: Observable<DualShockDpad>;
  40365. private _buttonCross;
  40366. private _buttonCircle;
  40367. private _buttonSquare;
  40368. private _buttonTriangle;
  40369. private _buttonShare;
  40370. private _buttonOptions;
  40371. private _buttonL1;
  40372. private _buttonR1;
  40373. private _buttonLeftStick;
  40374. private _buttonRightStick;
  40375. private _dPadUp;
  40376. private _dPadDown;
  40377. private _dPadLeft;
  40378. private _dPadRight;
  40379. /**
  40380. * Creates a new DualShock gamepad object
  40381. * @param id defines the id of this gamepad
  40382. * @param index defines its index
  40383. * @param gamepad defines the internal HTML gamepad object
  40384. */
  40385. constructor(id: string, index: number, gamepad: any);
  40386. /**
  40387. * Defines the callback to call when left trigger is pressed
  40388. * @param callback defines the callback to use
  40389. */
  40390. onlefttriggerchanged(callback: (value: number) => void): void;
  40391. /**
  40392. * Defines the callback to call when right trigger is pressed
  40393. * @param callback defines the callback to use
  40394. */
  40395. onrighttriggerchanged(callback: (value: number) => void): void;
  40396. /**
  40397. * Gets the left trigger value
  40398. */
  40399. /**
  40400. * Sets the left trigger value
  40401. */
  40402. leftTrigger: number;
  40403. /**
  40404. * Gets the right trigger value
  40405. */
  40406. /**
  40407. * Sets the right trigger value
  40408. */
  40409. rightTrigger: number;
  40410. /**
  40411. * Defines the callback to call when a button is pressed
  40412. * @param callback defines the callback to use
  40413. */
  40414. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  40415. /**
  40416. * Defines the callback to call when a button is released
  40417. * @param callback defines the callback to use
  40418. */
  40419. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  40420. /**
  40421. * Defines the callback to call when a pad is pressed
  40422. * @param callback defines the callback to use
  40423. */
  40424. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  40425. /**
  40426. * Defines the callback to call when a pad is released
  40427. * @param callback defines the callback to use
  40428. */
  40429. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  40430. private _setButtonValue;
  40431. private _setDPadValue;
  40432. /**
  40433. * Gets the value of the `Cross` button
  40434. */
  40435. /**
  40436. * Sets the value of the `Cross` button
  40437. */
  40438. buttonCross: number;
  40439. /**
  40440. * Gets the value of the `Circle` button
  40441. */
  40442. /**
  40443. * Sets the value of the `Circle` button
  40444. */
  40445. buttonCircle: number;
  40446. /**
  40447. * Gets the value of the `Square` button
  40448. */
  40449. /**
  40450. * Sets the value of the `Square` button
  40451. */
  40452. buttonSquare: number;
  40453. /**
  40454. * Gets the value of the `Triangle` button
  40455. */
  40456. /**
  40457. * Sets the value of the `Triangle` button
  40458. */
  40459. buttonTriangle: number;
  40460. /**
  40461. * Gets the value of the `Options` button
  40462. */
  40463. /**
  40464. * Sets the value of the `Options` button
  40465. */
  40466. buttonOptions: number;
  40467. /**
  40468. * Gets the value of the `Share` button
  40469. */
  40470. /**
  40471. * Sets the value of the `Share` button
  40472. */
  40473. buttonShare: number;
  40474. /**
  40475. * Gets the value of the `L1` button
  40476. */
  40477. /**
  40478. * Sets the value of the `L1` button
  40479. */
  40480. buttonL1: number;
  40481. /**
  40482. * Gets the value of the `R1` button
  40483. */
  40484. /**
  40485. * Sets the value of the `R1` button
  40486. */
  40487. buttonR1: number;
  40488. /**
  40489. * Gets the value of the Left joystick
  40490. */
  40491. /**
  40492. * Sets the value of the Left joystick
  40493. */
  40494. buttonLeftStick: number;
  40495. /**
  40496. * Gets the value of the Right joystick
  40497. */
  40498. /**
  40499. * Sets the value of the Right joystick
  40500. */
  40501. buttonRightStick: number;
  40502. /**
  40503. * Gets the value of D-pad up
  40504. */
  40505. /**
  40506. * Sets the value of D-pad up
  40507. */
  40508. dPadUp: number;
  40509. /**
  40510. * Gets the value of D-pad down
  40511. */
  40512. /**
  40513. * Sets the value of D-pad down
  40514. */
  40515. dPadDown: number;
  40516. /**
  40517. * Gets the value of D-pad left
  40518. */
  40519. /**
  40520. * Sets the value of D-pad left
  40521. */
  40522. dPadLeft: number;
  40523. /**
  40524. * Gets the value of D-pad right
  40525. */
  40526. /**
  40527. * Sets the value of D-pad right
  40528. */
  40529. dPadRight: number;
  40530. /**
  40531. * Force the gamepad to synchronize with device values
  40532. */
  40533. update(): void;
  40534. /**
  40535. * Disposes the gamepad
  40536. */
  40537. dispose(): void;
  40538. }
  40539. }
  40540. declare module "babylonjs/Gamepads/gamepadManager" {
  40541. import { Observable } from "babylonjs/Misc/observable";
  40542. import { Nullable } from "babylonjs/types";
  40543. import { Scene } from "babylonjs/scene";
  40544. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40545. /**
  40546. * Manager for handling gamepads
  40547. */
  40548. export class GamepadManager {
  40549. private _scene?;
  40550. private _babylonGamepads;
  40551. private _oneGamepadConnected;
  40552. /** @hidden */
  40553. _isMonitoring: boolean;
  40554. private _gamepadEventSupported;
  40555. private _gamepadSupport;
  40556. /**
  40557. * observable to be triggered when the gamepad controller has been connected
  40558. */
  40559. onGamepadConnectedObservable: Observable<Gamepad>;
  40560. /**
  40561. * observable to be triggered when the gamepad controller has been disconnected
  40562. */
  40563. onGamepadDisconnectedObservable: Observable<Gamepad>;
  40564. private _onGamepadConnectedEvent;
  40565. private _onGamepadDisconnectedEvent;
  40566. /**
  40567. * Initializes the gamepad manager
  40568. * @param _scene BabylonJS scene
  40569. */
  40570. constructor(_scene?: Scene | undefined);
  40571. /**
  40572. * The gamepads in the game pad manager
  40573. */
  40574. readonly gamepads: Gamepad[];
  40575. /**
  40576. * Get the gamepad controllers based on type
  40577. * @param type The type of gamepad controller
  40578. * @returns Nullable gamepad
  40579. */
  40580. getGamepadByType(type?: number): Nullable<Gamepad>;
  40581. /**
  40582. * Disposes the gamepad manager
  40583. */
  40584. dispose(): void;
  40585. private _addNewGamepad;
  40586. private _startMonitoringGamepads;
  40587. private _stopMonitoringGamepads;
  40588. /** @hidden */
  40589. _checkGamepadsStatus(): void;
  40590. private _updateGamepadObjects;
  40591. }
  40592. }
  40593. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  40594. import { Nullable } from "babylonjs/types";
  40595. import { Scene } from "babylonjs/scene";
  40596. import { ISceneComponent } from "babylonjs/sceneComponent";
  40597. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  40598. module "babylonjs/scene" {
  40599. interface Scene {
  40600. /** @hidden */
  40601. _gamepadManager: Nullable<GamepadManager>;
  40602. /**
  40603. * Gets the gamepad manager associated with the scene
  40604. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  40605. */
  40606. gamepadManager: GamepadManager;
  40607. }
  40608. }
  40609. module "babylonjs/Cameras/freeCameraInputsManager" {
  40610. /**
  40611. * Interface representing a free camera inputs manager
  40612. */
  40613. interface FreeCameraInputsManager {
  40614. /**
  40615. * Adds gamepad input support to the FreeCameraInputsManager.
  40616. * @returns the FreeCameraInputsManager
  40617. */
  40618. addGamepad(): FreeCameraInputsManager;
  40619. }
  40620. }
  40621. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  40622. /**
  40623. * Interface representing an arc rotate camera inputs manager
  40624. */
  40625. interface ArcRotateCameraInputsManager {
  40626. /**
  40627. * Adds gamepad input support to the ArcRotateCamera InputManager.
  40628. * @returns the camera inputs manager
  40629. */
  40630. addGamepad(): ArcRotateCameraInputsManager;
  40631. }
  40632. }
  40633. /**
  40634. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  40635. */
  40636. export class GamepadSystemSceneComponent implements ISceneComponent {
  40637. /**
  40638. * The component name helpfull to identify the component in the list of scene components.
  40639. */
  40640. readonly name: string;
  40641. /**
  40642. * The scene the component belongs to.
  40643. */
  40644. scene: Scene;
  40645. /**
  40646. * Creates a new instance of the component for the given scene
  40647. * @param scene Defines the scene to register the component in
  40648. */
  40649. constructor(scene: Scene);
  40650. /**
  40651. * Registers the component in a given scene
  40652. */
  40653. register(): void;
  40654. /**
  40655. * Rebuilds the elements related to this component in case of
  40656. * context lost for instance.
  40657. */
  40658. rebuild(): void;
  40659. /**
  40660. * Disposes the component and the associated ressources
  40661. */
  40662. dispose(): void;
  40663. private _beforeCameraUpdate;
  40664. }
  40665. }
  40666. declare module "babylonjs/Cameras/universalCamera" {
  40667. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  40668. import { Scene } from "babylonjs/scene";
  40669. import { Vector3 } from "babylonjs/Maths/math.vector";
  40670. import "babylonjs/Gamepads/gamepadSceneComponent";
  40671. /**
  40672. * 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,
  40673. * which still works and will still be found in many Playgrounds.
  40674. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40675. */
  40676. export class UniversalCamera extends TouchCamera {
  40677. /**
  40678. * Defines the gamepad rotation sensiblity.
  40679. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  40680. */
  40681. gamepadAngularSensibility: number;
  40682. /**
  40683. * Defines the gamepad move sensiblity.
  40684. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  40685. */
  40686. gamepadMoveSensibility: number;
  40687. /**
  40688. * 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,
  40689. * which still works and will still be found in many Playgrounds.
  40690. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40691. * @param name Define the name of the camera in the scene
  40692. * @param position Define the start position of the camera in the scene
  40693. * @param scene Define the scene the camera belongs to
  40694. */
  40695. constructor(name: string, position: Vector3, scene: Scene);
  40696. /**
  40697. * Gets the current object class name.
  40698. * @return the class name
  40699. */
  40700. getClassName(): string;
  40701. }
  40702. }
  40703. declare module "babylonjs/Cameras/gamepadCamera" {
  40704. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  40705. import { Scene } from "babylonjs/scene";
  40706. import { Vector3 } from "babylonjs/Maths/math.vector";
  40707. /**
  40708. * This represents a FPS type of camera. This is only here for back compat purpose.
  40709. * Please use the UniversalCamera instead as both are identical.
  40710. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40711. */
  40712. export class GamepadCamera extends UniversalCamera {
  40713. /**
  40714. * Instantiates a new Gamepad Camera
  40715. * This represents a FPS type of camera. This is only here for back compat purpose.
  40716. * Please use the UniversalCamera instead as both are identical.
  40717. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40718. * @param name Define the name of the camera in the scene
  40719. * @param position Define the start position of the camera in the scene
  40720. * @param scene Define the scene the camera belongs to
  40721. */
  40722. constructor(name: string, position: Vector3, scene: Scene);
  40723. /**
  40724. * Gets the current object class name.
  40725. * @return the class name
  40726. */
  40727. getClassName(): string;
  40728. }
  40729. }
  40730. declare module "babylonjs/Shaders/pass.fragment" {
  40731. /** @hidden */
  40732. export var passPixelShader: {
  40733. name: string;
  40734. shader: string;
  40735. };
  40736. }
  40737. declare module "babylonjs/Shaders/passCube.fragment" {
  40738. /** @hidden */
  40739. export var passCubePixelShader: {
  40740. name: string;
  40741. shader: string;
  40742. };
  40743. }
  40744. declare module "babylonjs/PostProcesses/passPostProcess" {
  40745. import { Nullable } from "babylonjs/types";
  40746. import { Camera } from "babylonjs/Cameras/camera";
  40747. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  40748. import { Engine } from "babylonjs/Engines/engine";
  40749. import "babylonjs/Shaders/pass.fragment";
  40750. import "babylonjs/Shaders/passCube.fragment";
  40751. /**
  40752. * PassPostProcess which produces an output the same as it's input
  40753. */
  40754. export class PassPostProcess extends PostProcess {
  40755. /**
  40756. * Creates the PassPostProcess
  40757. * @param name The name of the effect.
  40758. * @param options The required width/height ratio to downsize to before computing the render pass.
  40759. * @param camera The camera to apply the render pass to.
  40760. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40761. * @param engine The engine which the post process will be applied. (default: current engine)
  40762. * @param reusable If the post process can be reused on the same frame. (default: false)
  40763. * @param textureType The type of texture to be used when performing the post processing.
  40764. * @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)
  40765. */
  40766. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  40767. }
  40768. /**
  40769. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  40770. */
  40771. export class PassCubePostProcess extends PostProcess {
  40772. private _face;
  40773. /**
  40774. * Gets or sets the cube face to display.
  40775. * * 0 is +X
  40776. * * 1 is -X
  40777. * * 2 is +Y
  40778. * * 3 is -Y
  40779. * * 4 is +Z
  40780. * * 5 is -Z
  40781. */
  40782. face: number;
  40783. /**
  40784. * Creates the PassCubePostProcess
  40785. * @param name The name of the effect.
  40786. * @param options The required width/height ratio to downsize to before computing the render pass.
  40787. * @param camera The camera to apply the render pass to.
  40788. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40789. * @param engine The engine which the post process will be applied. (default: current engine)
  40790. * @param reusable If the post process can be reused on the same frame. (default: false)
  40791. * @param textureType The type of texture to be used when performing the post processing.
  40792. * @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)
  40793. */
  40794. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  40795. }
  40796. }
  40797. declare module "babylonjs/Shaders/anaglyph.fragment" {
  40798. /** @hidden */
  40799. export var anaglyphPixelShader: {
  40800. name: string;
  40801. shader: string;
  40802. };
  40803. }
  40804. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  40805. import { Engine } from "babylonjs/Engines/engine";
  40806. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  40807. import { Camera } from "babylonjs/Cameras/camera";
  40808. import "babylonjs/Shaders/anaglyph.fragment";
  40809. /**
  40810. * Postprocess used to generate anaglyphic rendering
  40811. */
  40812. export class AnaglyphPostProcess extends PostProcess {
  40813. private _passedProcess;
  40814. /**
  40815. * Creates a new AnaglyphPostProcess
  40816. * @param name defines postprocess name
  40817. * @param options defines creation options or target ratio scale
  40818. * @param rigCameras defines cameras using this postprocess
  40819. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  40820. * @param engine defines hosting engine
  40821. * @param reusable defines if the postprocess will be reused multiple times per frame
  40822. */
  40823. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  40824. }
  40825. }
  40826. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  40827. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  40828. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  40829. import { Scene } from "babylonjs/scene";
  40830. import { Vector3 } from "babylonjs/Maths/math.vector";
  40831. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40832. /**
  40833. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  40834. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40835. */
  40836. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  40837. /**
  40838. * Creates a new AnaglyphArcRotateCamera
  40839. * @param name defines camera name
  40840. * @param alpha defines alpha angle (in radians)
  40841. * @param beta defines beta angle (in radians)
  40842. * @param radius defines radius
  40843. * @param target defines camera target
  40844. * @param interaxialDistance defines distance between each color axis
  40845. * @param scene defines the hosting scene
  40846. */
  40847. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  40848. /**
  40849. * Gets camera class name
  40850. * @returns AnaglyphArcRotateCamera
  40851. */
  40852. getClassName(): string;
  40853. }
  40854. }
  40855. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  40856. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40857. import { Scene } from "babylonjs/scene";
  40858. import { Vector3 } from "babylonjs/Maths/math.vector";
  40859. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40860. /**
  40861. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  40862. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40863. */
  40864. export class AnaglyphFreeCamera extends FreeCamera {
  40865. /**
  40866. * Creates a new AnaglyphFreeCamera
  40867. * @param name defines camera name
  40868. * @param position defines initial position
  40869. * @param interaxialDistance defines distance between each color axis
  40870. * @param scene defines the hosting scene
  40871. */
  40872. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40873. /**
  40874. * Gets camera class name
  40875. * @returns AnaglyphFreeCamera
  40876. */
  40877. getClassName(): string;
  40878. }
  40879. }
  40880. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  40881. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  40882. import { Scene } from "babylonjs/scene";
  40883. import { Vector3 } from "babylonjs/Maths/math.vector";
  40884. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40885. /**
  40886. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  40887. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40888. */
  40889. export class AnaglyphGamepadCamera extends GamepadCamera {
  40890. /**
  40891. * Creates a new AnaglyphGamepadCamera
  40892. * @param name defines camera name
  40893. * @param position defines initial position
  40894. * @param interaxialDistance defines distance between each color axis
  40895. * @param scene defines the hosting scene
  40896. */
  40897. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40898. /**
  40899. * Gets camera class name
  40900. * @returns AnaglyphGamepadCamera
  40901. */
  40902. getClassName(): string;
  40903. }
  40904. }
  40905. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  40906. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  40907. import { Scene } from "babylonjs/scene";
  40908. import { Vector3 } from "babylonjs/Maths/math.vector";
  40909. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40910. /**
  40911. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  40912. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40913. */
  40914. export class AnaglyphUniversalCamera extends UniversalCamera {
  40915. /**
  40916. * Creates a new AnaglyphUniversalCamera
  40917. * @param name defines camera name
  40918. * @param position defines initial position
  40919. * @param interaxialDistance defines distance between each color axis
  40920. * @param scene defines the hosting scene
  40921. */
  40922. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40923. /**
  40924. * Gets camera class name
  40925. * @returns AnaglyphUniversalCamera
  40926. */
  40927. getClassName(): string;
  40928. }
  40929. }
  40930. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  40931. /** @hidden */
  40932. export var stereoscopicInterlacePixelShader: {
  40933. name: string;
  40934. shader: string;
  40935. };
  40936. }
  40937. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  40938. import { Camera } from "babylonjs/Cameras/camera";
  40939. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40940. import { Engine } from "babylonjs/Engines/engine";
  40941. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  40942. /**
  40943. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  40944. */
  40945. export class StereoscopicInterlacePostProcess extends PostProcess {
  40946. private _stepSize;
  40947. private _passedProcess;
  40948. /**
  40949. * Initializes a StereoscopicInterlacePostProcess
  40950. * @param name The name of the effect.
  40951. * @param rigCameras The rig cameras to be appled to the post process
  40952. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  40953. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40954. * @param engine The engine which the post process will be applied. (default: current engine)
  40955. * @param reusable If the post process can be reused on the same frame. (default: false)
  40956. */
  40957. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  40958. }
  40959. }
  40960. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  40961. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  40962. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  40963. import { Scene } from "babylonjs/scene";
  40964. import { Vector3 } from "babylonjs/Maths/math.vector";
  40965. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40966. /**
  40967. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  40968. * @see http://doc.babylonjs.com/features/cameras
  40969. */
  40970. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  40971. /**
  40972. * Creates a new StereoscopicArcRotateCamera
  40973. * @param name defines camera name
  40974. * @param alpha defines alpha angle (in radians)
  40975. * @param beta defines beta angle (in radians)
  40976. * @param radius defines radius
  40977. * @param target defines camera target
  40978. * @param interaxialDistance defines distance between each color axis
  40979. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  40980. * @param scene defines the hosting scene
  40981. */
  40982. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  40983. /**
  40984. * Gets camera class name
  40985. * @returns StereoscopicArcRotateCamera
  40986. */
  40987. getClassName(): string;
  40988. }
  40989. }
  40990. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  40991. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40992. import { Scene } from "babylonjs/scene";
  40993. import { Vector3 } from "babylonjs/Maths/math.vector";
  40994. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40995. /**
  40996. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  40997. * @see http://doc.babylonjs.com/features/cameras
  40998. */
  40999. export class StereoscopicFreeCamera extends FreeCamera {
  41000. /**
  41001. * Creates a new StereoscopicFreeCamera
  41002. * @param name defines camera name
  41003. * @param position defines initial position
  41004. * @param interaxialDistance defines distance between each color axis
  41005. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41006. * @param scene defines the hosting scene
  41007. */
  41008. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41009. /**
  41010. * Gets camera class name
  41011. * @returns StereoscopicFreeCamera
  41012. */
  41013. getClassName(): string;
  41014. }
  41015. }
  41016. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  41017. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  41018. import { Scene } from "babylonjs/scene";
  41019. import { Vector3 } from "babylonjs/Maths/math.vector";
  41020. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41021. /**
  41022. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  41023. * @see http://doc.babylonjs.com/features/cameras
  41024. */
  41025. export class StereoscopicGamepadCamera extends GamepadCamera {
  41026. /**
  41027. * Creates a new StereoscopicGamepadCamera
  41028. * @param name defines camera name
  41029. * @param position defines initial position
  41030. * @param interaxialDistance defines distance between each color axis
  41031. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41032. * @param scene defines the hosting scene
  41033. */
  41034. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41035. /**
  41036. * Gets camera class name
  41037. * @returns StereoscopicGamepadCamera
  41038. */
  41039. getClassName(): string;
  41040. }
  41041. }
  41042. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  41043. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  41044. import { Scene } from "babylonjs/scene";
  41045. import { Vector3 } from "babylonjs/Maths/math.vector";
  41046. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41047. /**
  41048. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  41049. * @see http://doc.babylonjs.com/features/cameras
  41050. */
  41051. export class StereoscopicUniversalCamera extends UniversalCamera {
  41052. /**
  41053. * Creates a new StereoscopicUniversalCamera
  41054. * @param name defines camera name
  41055. * @param position defines initial position
  41056. * @param interaxialDistance defines distance between each color axis
  41057. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41058. * @param scene defines the hosting scene
  41059. */
  41060. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41061. /**
  41062. * Gets camera class name
  41063. * @returns StereoscopicUniversalCamera
  41064. */
  41065. getClassName(): string;
  41066. }
  41067. }
  41068. declare module "babylonjs/Cameras/Stereoscopic/index" {
  41069. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  41070. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  41071. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  41072. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  41073. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  41074. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  41075. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  41076. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  41077. }
  41078. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  41079. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  41080. import { Scene } from "babylonjs/scene";
  41081. import { Vector3 } from "babylonjs/Maths/math.vector";
  41082. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  41083. /**
  41084. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  41085. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  41086. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  41087. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  41088. */
  41089. export class VirtualJoysticksCamera extends FreeCamera {
  41090. /**
  41091. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  41092. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  41093. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  41094. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  41095. * @param name Define the name of the camera in the scene
  41096. * @param position Define the start position of the camera in the scene
  41097. * @param scene Define the scene the camera belongs to
  41098. */
  41099. constructor(name: string, position: Vector3, scene: Scene);
  41100. /**
  41101. * Gets the current object class name.
  41102. * @return the class name
  41103. */
  41104. getClassName(): string;
  41105. }
  41106. }
  41107. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  41108. import { Matrix } from "babylonjs/Maths/math.vector";
  41109. /**
  41110. * This represents all the required metrics to create a VR camera.
  41111. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  41112. */
  41113. export class VRCameraMetrics {
  41114. /**
  41115. * Define the horizontal resolution off the screen.
  41116. */
  41117. hResolution: number;
  41118. /**
  41119. * Define the vertical resolution off the screen.
  41120. */
  41121. vResolution: number;
  41122. /**
  41123. * Define the horizontal screen size.
  41124. */
  41125. hScreenSize: number;
  41126. /**
  41127. * Define the vertical screen size.
  41128. */
  41129. vScreenSize: number;
  41130. /**
  41131. * Define the vertical screen center position.
  41132. */
  41133. vScreenCenter: number;
  41134. /**
  41135. * Define the distance of the eyes to the screen.
  41136. */
  41137. eyeToScreenDistance: number;
  41138. /**
  41139. * Define the distance between both lenses
  41140. */
  41141. lensSeparationDistance: number;
  41142. /**
  41143. * Define the distance between both viewer's eyes.
  41144. */
  41145. interpupillaryDistance: number;
  41146. /**
  41147. * Define the distortion factor of the VR postprocess.
  41148. * Please, touch with care.
  41149. */
  41150. distortionK: number[];
  41151. /**
  41152. * Define the chromatic aberration correction factors for the VR post process.
  41153. */
  41154. chromaAbCorrection: number[];
  41155. /**
  41156. * Define the scale factor of the post process.
  41157. * The smaller the better but the slower.
  41158. */
  41159. postProcessScaleFactor: number;
  41160. /**
  41161. * Define an offset for the lens center.
  41162. */
  41163. lensCenterOffset: number;
  41164. /**
  41165. * Define if the current vr camera should compensate the distortion of the lense or not.
  41166. */
  41167. compensateDistortion: boolean;
  41168. /**
  41169. * Defines if multiview should be enabled when rendering (Default: false)
  41170. */
  41171. multiviewEnabled: boolean;
  41172. /**
  41173. * Gets the rendering aspect ratio based on the provided resolutions.
  41174. */
  41175. readonly aspectRatio: number;
  41176. /**
  41177. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  41178. */
  41179. readonly aspectRatioFov: number;
  41180. /**
  41181. * @hidden
  41182. */
  41183. readonly leftHMatrix: Matrix;
  41184. /**
  41185. * @hidden
  41186. */
  41187. readonly rightHMatrix: Matrix;
  41188. /**
  41189. * @hidden
  41190. */
  41191. readonly leftPreViewMatrix: Matrix;
  41192. /**
  41193. * @hidden
  41194. */
  41195. readonly rightPreViewMatrix: Matrix;
  41196. /**
  41197. * Get the default VRMetrics based on the most generic setup.
  41198. * @returns the default vr metrics
  41199. */
  41200. static GetDefault(): VRCameraMetrics;
  41201. }
  41202. }
  41203. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  41204. /** @hidden */
  41205. export var vrDistortionCorrectionPixelShader: {
  41206. name: string;
  41207. shader: string;
  41208. };
  41209. }
  41210. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  41211. import { Camera } from "babylonjs/Cameras/camera";
  41212. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41213. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  41214. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  41215. /**
  41216. * VRDistortionCorrectionPostProcess used for mobile VR
  41217. */
  41218. export class VRDistortionCorrectionPostProcess extends PostProcess {
  41219. private _isRightEye;
  41220. private _distortionFactors;
  41221. private _postProcessScaleFactor;
  41222. private _lensCenterOffset;
  41223. private _scaleIn;
  41224. private _scaleFactor;
  41225. private _lensCenter;
  41226. /**
  41227. * Initializes the VRDistortionCorrectionPostProcess
  41228. * @param name The name of the effect.
  41229. * @param camera The camera to apply the render pass to.
  41230. * @param isRightEye If this is for the right eye distortion
  41231. * @param vrMetrics All the required metrics for the VR camera
  41232. */
  41233. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  41234. }
  41235. }
  41236. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  41237. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  41238. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  41239. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41240. import { Scene } from "babylonjs/scene";
  41241. import { Vector3 } from "babylonjs/Maths/math.vector";
  41242. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  41243. import "babylonjs/Cameras/RigModes/vrRigMode";
  41244. /**
  41245. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  41246. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41247. */
  41248. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  41249. /**
  41250. * Creates a new VRDeviceOrientationArcRotateCamera
  41251. * @param name defines camera name
  41252. * @param alpha defines the camera rotation along the logitudinal axis
  41253. * @param beta defines the camera rotation along the latitudinal axis
  41254. * @param radius defines the camera distance from its target
  41255. * @param target defines the camera target
  41256. * @param scene defines the scene the camera belongs to
  41257. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41258. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41259. */
  41260. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41261. /**
  41262. * Gets camera class name
  41263. * @returns VRDeviceOrientationArcRotateCamera
  41264. */
  41265. getClassName(): string;
  41266. }
  41267. }
  41268. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  41269. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  41270. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41271. import { Scene } from "babylonjs/scene";
  41272. import { Vector3 } from "babylonjs/Maths/math.vector";
  41273. import "babylonjs/Cameras/RigModes/vrRigMode";
  41274. /**
  41275. * Camera used to simulate VR rendering (based on FreeCamera)
  41276. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41277. */
  41278. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  41279. /**
  41280. * Creates a new VRDeviceOrientationFreeCamera
  41281. * @param name defines camera name
  41282. * @param position defines the start position of the camera
  41283. * @param scene defines the scene the camera belongs to
  41284. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41285. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41286. */
  41287. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41288. /**
  41289. * Gets camera class name
  41290. * @returns VRDeviceOrientationFreeCamera
  41291. */
  41292. getClassName(): string;
  41293. }
  41294. }
  41295. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  41296. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  41297. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41298. import { Scene } from "babylonjs/scene";
  41299. import { Vector3 } from "babylonjs/Maths/math.vector";
  41300. import "babylonjs/Gamepads/gamepadSceneComponent";
  41301. /**
  41302. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  41303. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41304. */
  41305. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  41306. /**
  41307. * Creates a new VRDeviceOrientationGamepadCamera
  41308. * @param name defines camera name
  41309. * @param position defines the start position of the camera
  41310. * @param scene defines the scene the camera belongs to
  41311. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41312. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41313. */
  41314. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41315. /**
  41316. * Gets camera class name
  41317. * @returns VRDeviceOrientationGamepadCamera
  41318. */
  41319. getClassName(): string;
  41320. }
  41321. }
  41322. declare module "babylonjs/Materials/pushMaterial" {
  41323. import { Nullable } from "babylonjs/types";
  41324. import { Scene } from "babylonjs/scene";
  41325. import { Matrix } from "babylonjs/Maths/math.vector";
  41326. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41327. import { Mesh } from "babylonjs/Meshes/mesh";
  41328. import { Material } from "babylonjs/Materials/material";
  41329. import { Effect } from "babylonjs/Materials/effect";
  41330. /**
  41331. * Base class of materials working in push mode in babylon JS
  41332. * @hidden
  41333. */
  41334. export class PushMaterial extends Material {
  41335. protected _activeEffect: Effect;
  41336. protected _normalMatrix: Matrix;
  41337. /**
  41338. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  41339. * This means that the material can keep using a previous shader while a new one is being compiled.
  41340. * This is mostly used when shader parallel compilation is supported (true by default)
  41341. */
  41342. allowShaderHotSwapping: boolean;
  41343. constructor(name: string, scene: Scene);
  41344. getEffect(): Effect;
  41345. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  41346. /**
  41347. * Binds the given world matrix to the active effect
  41348. *
  41349. * @param world the matrix to bind
  41350. */
  41351. bindOnlyWorldMatrix(world: Matrix): void;
  41352. /**
  41353. * Binds the given normal matrix to the active effect
  41354. *
  41355. * @param normalMatrix the matrix to bind
  41356. */
  41357. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  41358. bind(world: Matrix, mesh?: Mesh): void;
  41359. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  41360. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  41361. }
  41362. }
  41363. declare module "babylonjs/Materials/materialFlags" {
  41364. /**
  41365. * This groups all the flags used to control the materials channel.
  41366. */
  41367. export class MaterialFlags {
  41368. private static _DiffuseTextureEnabled;
  41369. /**
  41370. * Are diffuse textures enabled in the application.
  41371. */
  41372. static DiffuseTextureEnabled: boolean;
  41373. private static _AmbientTextureEnabled;
  41374. /**
  41375. * Are ambient textures enabled in the application.
  41376. */
  41377. static AmbientTextureEnabled: boolean;
  41378. private static _OpacityTextureEnabled;
  41379. /**
  41380. * Are opacity textures enabled in the application.
  41381. */
  41382. static OpacityTextureEnabled: boolean;
  41383. private static _ReflectionTextureEnabled;
  41384. /**
  41385. * Are reflection textures enabled in the application.
  41386. */
  41387. static ReflectionTextureEnabled: boolean;
  41388. private static _EmissiveTextureEnabled;
  41389. /**
  41390. * Are emissive textures enabled in the application.
  41391. */
  41392. static EmissiveTextureEnabled: boolean;
  41393. private static _SpecularTextureEnabled;
  41394. /**
  41395. * Are specular textures enabled in the application.
  41396. */
  41397. static SpecularTextureEnabled: boolean;
  41398. private static _BumpTextureEnabled;
  41399. /**
  41400. * Are bump textures enabled in the application.
  41401. */
  41402. static BumpTextureEnabled: boolean;
  41403. private static _LightmapTextureEnabled;
  41404. /**
  41405. * Are lightmap textures enabled in the application.
  41406. */
  41407. static LightmapTextureEnabled: boolean;
  41408. private static _RefractionTextureEnabled;
  41409. /**
  41410. * Are refraction textures enabled in the application.
  41411. */
  41412. static RefractionTextureEnabled: boolean;
  41413. private static _ColorGradingTextureEnabled;
  41414. /**
  41415. * Are color grading textures enabled in the application.
  41416. */
  41417. static ColorGradingTextureEnabled: boolean;
  41418. private static _FresnelEnabled;
  41419. /**
  41420. * Are fresnels enabled in the application.
  41421. */
  41422. static FresnelEnabled: boolean;
  41423. private static _ClearCoatTextureEnabled;
  41424. /**
  41425. * Are clear coat textures enabled in the application.
  41426. */
  41427. static ClearCoatTextureEnabled: boolean;
  41428. private static _ClearCoatBumpTextureEnabled;
  41429. /**
  41430. * Are clear coat bump textures enabled in the application.
  41431. */
  41432. static ClearCoatBumpTextureEnabled: boolean;
  41433. private static _ClearCoatTintTextureEnabled;
  41434. /**
  41435. * Are clear coat tint textures enabled in the application.
  41436. */
  41437. static ClearCoatTintTextureEnabled: boolean;
  41438. private static _SheenTextureEnabled;
  41439. /**
  41440. * Are sheen textures enabled in the application.
  41441. */
  41442. static SheenTextureEnabled: boolean;
  41443. private static _AnisotropicTextureEnabled;
  41444. /**
  41445. * Are anisotropic textures enabled in the application.
  41446. */
  41447. static AnisotropicTextureEnabled: boolean;
  41448. private static _ThicknessTextureEnabled;
  41449. /**
  41450. * Are thickness textures enabled in the application.
  41451. */
  41452. static ThicknessTextureEnabled: boolean;
  41453. }
  41454. }
  41455. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  41456. /** @hidden */
  41457. export var defaultFragmentDeclaration: {
  41458. name: string;
  41459. shader: string;
  41460. };
  41461. }
  41462. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  41463. /** @hidden */
  41464. export var defaultUboDeclaration: {
  41465. name: string;
  41466. shader: string;
  41467. };
  41468. }
  41469. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  41470. /** @hidden */
  41471. export var lightFragmentDeclaration: {
  41472. name: string;
  41473. shader: string;
  41474. };
  41475. }
  41476. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  41477. /** @hidden */
  41478. export var lightUboDeclaration: {
  41479. name: string;
  41480. shader: string;
  41481. };
  41482. }
  41483. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  41484. /** @hidden */
  41485. export var lightsFragmentFunctions: {
  41486. name: string;
  41487. shader: string;
  41488. };
  41489. }
  41490. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  41491. /** @hidden */
  41492. export var shadowsFragmentFunctions: {
  41493. name: string;
  41494. shader: string;
  41495. };
  41496. }
  41497. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  41498. /** @hidden */
  41499. export var fresnelFunction: {
  41500. name: string;
  41501. shader: string;
  41502. };
  41503. }
  41504. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  41505. /** @hidden */
  41506. export var reflectionFunction: {
  41507. name: string;
  41508. shader: string;
  41509. };
  41510. }
  41511. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  41512. /** @hidden */
  41513. export var bumpFragmentFunctions: {
  41514. name: string;
  41515. shader: string;
  41516. };
  41517. }
  41518. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  41519. /** @hidden */
  41520. export var logDepthDeclaration: {
  41521. name: string;
  41522. shader: string;
  41523. };
  41524. }
  41525. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  41526. /** @hidden */
  41527. export var bumpFragment: {
  41528. name: string;
  41529. shader: string;
  41530. };
  41531. }
  41532. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  41533. /** @hidden */
  41534. export var depthPrePass: {
  41535. name: string;
  41536. shader: string;
  41537. };
  41538. }
  41539. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  41540. /** @hidden */
  41541. export var lightFragment: {
  41542. name: string;
  41543. shader: string;
  41544. };
  41545. }
  41546. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  41547. /** @hidden */
  41548. export var logDepthFragment: {
  41549. name: string;
  41550. shader: string;
  41551. };
  41552. }
  41553. declare module "babylonjs/Shaders/default.fragment" {
  41554. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  41555. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41556. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41557. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41558. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41559. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  41560. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  41561. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  41562. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  41563. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  41564. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  41565. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  41566. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  41567. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41568. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  41569. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  41570. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  41571. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  41572. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  41573. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  41574. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  41575. /** @hidden */
  41576. export var defaultPixelShader: {
  41577. name: string;
  41578. shader: string;
  41579. };
  41580. }
  41581. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  41582. /** @hidden */
  41583. export var defaultVertexDeclaration: {
  41584. name: string;
  41585. shader: string;
  41586. };
  41587. }
  41588. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  41589. /** @hidden */
  41590. export var bumpVertexDeclaration: {
  41591. name: string;
  41592. shader: string;
  41593. };
  41594. }
  41595. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  41596. /** @hidden */
  41597. export var bumpVertex: {
  41598. name: string;
  41599. shader: string;
  41600. };
  41601. }
  41602. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  41603. /** @hidden */
  41604. export var fogVertex: {
  41605. name: string;
  41606. shader: string;
  41607. };
  41608. }
  41609. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  41610. /** @hidden */
  41611. export var shadowsVertex: {
  41612. name: string;
  41613. shader: string;
  41614. };
  41615. }
  41616. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  41617. /** @hidden */
  41618. export var pointCloudVertex: {
  41619. name: string;
  41620. shader: string;
  41621. };
  41622. }
  41623. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  41624. /** @hidden */
  41625. export var logDepthVertex: {
  41626. name: string;
  41627. shader: string;
  41628. };
  41629. }
  41630. declare module "babylonjs/Shaders/default.vertex" {
  41631. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  41632. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41633. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41634. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  41635. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  41636. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  41637. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  41638. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  41639. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41640. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41641. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  41642. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  41643. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41644. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  41645. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  41646. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  41647. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  41648. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  41649. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  41650. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  41651. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  41652. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  41653. /** @hidden */
  41654. export var defaultVertexShader: {
  41655. name: string;
  41656. shader: string;
  41657. };
  41658. }
  41659. declare module "babylonjs/Materials/standardMaterial" {
  41660. import { SmartArray } from "babylonjs/Misc/smartArray";
  41661. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  41662. import { Nullable } from "babylonjs/types";
  41663. import { Scene } from "babylonjs/scene";
  41664. import { Matrix } from "babylonjs/Maths/math.vector";
  41665. import { Color3 } from "babylonjs/Maths/math.color";
  41666. import { SubMesh } from "babylonjs/Meshes/subMesh";
  41667. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41668. import { Mesh } from "babylonjs/Meshes/mesh";
  41669. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  41670. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  41671. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  41672. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  41673. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  41674. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  41675. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  41676. import "babylonjs/Shaders/default.fragment";
  41677. import "babylonjs/Shaders/default.vertex";
  41678. /** @hidden */
  41679. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  41680. MAINUV1: boolean;
  41681. MAINUV2: boolean;
  41682. DIFFUSE: boolean;
  41683. DIFFUSEDIRECTUV: number;
  41684. AMBIENT: boolean;
  41685. AMBIENTDIRECTUV: number;
  41686. OPACITY: boolean;
  41687. OPACITYDIRECTUV: number;
  41688. OPACITYRGB: boolean;
  41689. REFLECTION: boolean;
  41690. EMISSIVE: boolean;
  41691. EMISSIVEDIRECTUV: number;
  41692. SPECULAR: boolean;
  41693. SPECULARDIRECTUV: number;
  41694. BUMP: boolean;
  41695. BUMPDIRECTUV: number;
  41696. PARALLAX: boolean;
  41697. PARALLAXOCCLUSION: boolean;
  41698. SPECULAROVERALPHA: boolean;
  41699. CLIPPLANE: boolean;
  41700. CLIPPLANE2: boolean;
  41701. CLIPPLANE3: boolean;
  41702. CLIPPLANE4: boolean;
  41703. ALPHATEST: boolean;
  41704. DEPTHPREPASS: boolean;
  41705. ALPHAFROMDIFFUSE: boolean;
  41706. POINTSIZE: boolean;
  41707. FOG: boolean;
  41708. SPECULARTERM: boolean;
  41709. DIFFUSEFRESNEL: boolean;
  41710. OPACITYFRESNEL: boolean;
  41711. REFLECTIONFRESNEL: boolean;
  41712. REFRACTIONFRESNEL: boolean;
  41713. EMISSIVEFRESNEL: boolean;
  41714. FRESNEL: boolean;
  41715. NORMAL: boolean;
  41716. UV1: boolean;
  41717. UV2: boolean;
  41718. VERTEXCOLOR: boolean;
  41719. VERTEXALPHA: boolean;
  41720. NUM_BONE_INFLUENCERS: number;
  41721. BonesPerMesh: number;
  41722. BONETEXTURE: boolean;
  41723. INSTANCES: boolean;
  41724. GLOSSINESS: boolean;
  41725. ROUGHNESS: boolean;
  41726. EMISSIVEASILLUMINATION: boolean;
  41727. LINKEMISSIVEWITHDIFFUSE: boolean;
  41728. REFLECTIONFRESNELFROMSPECULAR: boolean;
  41729. LIGHTMAP: boolean;
  41730. LIGHTMAPDIRECTUV: number;
  41731. OBJECTSPACE_NORMALMAP: boolean;
  41732. USELIGHTMAPASSHADOWMAP: boolean;
  41733. REFLECTIONMAP_3D: boolean;
  41734. REFLECTIONMAP_SPHERICAL: boolean;
  41735. REFLECTIONMAP_PLANAR: boolean;
  41736. REFLECTIONMAP_CUBIC: boolean;
  41737. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  41738. REFLECTIONMAP_PROJECTION: boolean;
  41739. REFLECTIONMAP_SKYBOX: boolean;
  41740. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  41741. REFLECTIONMAP_EXPLICIT: boolean;
  41742. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  41743. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  41744. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  41745. INVERTCUBICMAP: boolean;
  41746. LOGARITHMICDEPTH: boolean;
  41747. REFRACTION: boolean;
  41748. REFRACTIONMAP_3D: boolean;
  41749. REFLECTIONOVERALPHA: boolean;
  41750. TWOSIDEDLIGHTING: boolean;
  41751. SHADOWFLOAT: boolean;
  41752. MORPHTARGETS: boolean;
  41753. MORPHTARGETS_NORMAL: boolean;
  41754. MORPHTARGETS_TANGENT: boolean;
  41755. MORPHTARGETS_UV: boolean;
  41756. NUM_MORPH_INFLUENCERS: number;
  41757. NONUNIFORMSCALING: boolean;
  41758. PREMULTIPLYALPHA: boolean;
  41759. IMAGEPROCESSING: boolean;
  41760. VIGNETTE: boolean;
  41761. VIGNETTEBLENDMODEMULTIPLY: boolean;
  41762. VIGNETTEBLENDMODEOPAQUE: boolean;
  41763. TONEMAPPING: boolean;
  41764. TONEMAPPING_ACES: boolean;
  41765. CONTRAST: boolean;
  41766. COLORCURVES: boolean;
  41767. COLORGRADING: boolean;
  41768. COLORGRADING3D: boolean;
  41769. SAMPLER3DGREENDEPTH: boolean;
  41770. SAMPLER3DBGRMAP: boolean;
  41771. IMAGEPROCESSINGPOSTPROCESS: boolean;
  41772. MULTIVIEW: boolean;
  41773. /**
  41774. * If the reflection texture on this material is in linear color space
  41775. * @hidden
  41776. */
  41777. IS_REFLECTION_LINEAR: boolean;
  41778. /**
  41779. * If the refraction texture on this material is in linear color space
  41780. * @hidden
  41781. */
  41782. IS_REFRACTION_LINEAR: boolean;
  41783. EXPOSURE: boolean;
  41784. constructor();
  41785. setReflectionMode(modeToEnable: string): void;
  41786. }
  41787. /**
  41788. * This is the default material used in Babylon. It is the best trade off between quality
  41789. * and performances.
  41790. * @see http://doc.babylonjs.com/babylon101/materials
  41791. */
  41792. export class StandardMaterial extends PushMaterial {
  41793. private _diffuseTexture;
  41794. /**
  41795. * The basic texture of the material as viewed under a light.
  41796. */
  41797. diffuseTexture: Nullable<BaseTexture>;
  41798. private _ambientTexture;
  41799. /**
  41800. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  41801. */
  41802. ambientTexture: Nullable<BaseTexture>;
  41803. private _opacityTexture;
  41804. /**
  41805. * Define the transparency of the material from a texture.
  41806. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  41807. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  41808. */
  41809. opacityTexture: Nullable<BaseTexture>;
  41810. private _reflectionTexture;
  41811. /**
  41812. * Define the texture used to display the reflection.
  41813. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41814. */
  41815. reflectionTexture: Nullable<BaseTexture>;
  41816. private _emissiveTexture;
  41817. /**
  41818. * Define texture of the material as if self lit.
  41819. * This will be mixed in the final result even in the absence of light.
  41820. */
  41821. emissiveTexture: Nullable<BaseTexture>;
  41822. private _specularTexture;
  41823. /**
  41824. * Define how the color and intensity of the highlight given by the light in the material.
  41825. */
  41826. specularTexture: Nullable<BaseTexture>;
  41827. private _bumpTexture;
  41828. /**
  41829. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  41830. * 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.
  41831. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  41832. */
  41833. bumpTexture: Nullable<BaseTexture>;
  41834. private _lightmapTexture;
  41835. /**
  41836. * Complex lighting can be computationally expensive to compute at runtime.
  41837. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  41838. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  41839. */
  41840. lightmapTexture: Nullable<BaseTexture>;
  41841. private _refractionTexture;
  41842. /**
  41843. * Define the texture used to display the refraction.
  41844. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41845. */
  41846. refractionTexture: Nullable<BaseTexture>;
  41847. /**
  41848. * The color of the material lit by the environmental background lighting.
  41849. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  41850. */
  41851. ambientColor: Color3;
  41852. /**
  41853. * The basic color of the material as viewed under a light.
  41854. */
  41855. diffuseColor: Color3;
  41856. /**
  41857. * Define how the color and intensity of the highlight given by the light in the material.
  41858. */
  41859. specularColor: Color3;
  41860. /**
  41861. * Define the color of the material as if self lit.
  41862. * This will be mixed in the final result even in the absence of light.
  41863. */
  41864. emissiveColor: Color3;
  41865. /**
  41866. * Defines how sharp are the highlights in the material.
  41867. * The bigger the value the sharper giving a more glossy feeling to the result.
  41868. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  41869. */
  41870. specularPower: number;
  41871. private _useAlphaFromDiffuseTexture;
  41872. /**
  41873. * Does the transparency come from the diffuse texture alpha channel.
  41874. */
  41875. useAlphaFromDiffuseTexture: boolean;
  41876. private _useEmissiveAsIllumination;
  41877. /**
  41878. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  41879. */
  41880. useEmissiveAsIllumination: boolean;
  41881. private _linkEmissiveWithDiffuse;
  41882. /**
  41883. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  41884. * the emissive level when the final color is close to one.
  41885. */
  41886. linkEmissiveWithDiffuse: boolean;
  41887. private _useSpecularOverAlpha;
  41888. /**
  41889. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  41890. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  41891. */
  41892. useSpecularOverAlpha: boolean;
  41893. private _useReflectionOverAlpha;
  41894. /**
  41895. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  41896. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  41897. */
  41898. useReflectionOverAlpha: boolean;
  41899. private _disableLighting;
  41900. /**
  41901. * Does lights from the scene impacts this material.
  41902. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  41903. */
  41904. disableLighting: boolean;
  41905. private _useObjectSpaceNormalMap;
  41906. /**
  41907. * Allows using an object space normal map (instead of tangent space).
  41908. */
  41909. useObjectSpaceNormalMap: boolean;
  41910. private _useParallax;
  41911. /**
  41912. * Is parallax enabled or not.
  41913. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  41914. */
  41915. useParallax: boolean;
  41916. private _useParallaxOcclusion;
  41917. /**
  41918. * Is parallax occlusion enabled or not.
  41919. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  41920. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  41921. */
  41922. useParallaxOcclusion: boolean;
  41923. /**
  41924. * 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.
  41925. */
  41926. parallaxScaleBias: number;
  41927. private _roughness;
  41928. /**
  41929. * Helps to define how blurry the reflections should appears in the material.
  41930. */
  41931. roughness: number;
  41932. /**
  41933. * In case of refraction, define the value of the index of refraction.
  41934. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41935. */
  41936. indexOfRefraction: number;
  41937. /**
  41938. * Invert the refraction texture alongside the y axis.
  41939. * It can be useful with procedural textures or probe for instance.
  41940. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41941. */
  41942. invertRefractionY: boolean;
  41943. /**
  41944. * Defines the alpha limits in alpha test mode.
  41945. */
  41946. alphaCutOff: number;
  41947. private _useLightmapAsShadowmap;
  41948. /**
  41949. * In case of light mapping, define whether the map contains light or shadow informations.
  41950. */
  41951. useLightmapAsShadowmap: boolean;
  41952. private _diffuseFresnelParameters;
  41953. /**
  41954. * Define the diffuse fresnel parameters of the material.
  41955. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41956. */
  41957. diffuseFresnelParameters: FresnelParameters;
  41958. private _opacityFresnelParameters;
  41959. /**
  41960. * Define the opacity fresnel parameters of the material.
  41961. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41962. */
  41963. opacityFresnelParameters: FresnelParameters;
  41964. private _reflectionFresnelParameters;
  41965. /**
  41966. * Define the reflection fresnel parameters of the material.
  41967. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41968. */
  41969. reflectionFresnelParameters: FresnelParameters;
  41970. private _refractionFresnelParameters;
  41971. /**
  41972. * Define the refraction fresnel parameters of the material.
  41973. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41974. */
  41975. refractionFresnelParameters: FresnelParameters;
  41976. private _emissiveFresnelParameters;
  41977. /**
  41978. * Define the emissive fresnel parameters of the material.
  41979. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41980. */
  41981. emissiveFresnelParameters: FresnelParameters;
  41982. private _useReflectionFresnelFromSpecular;
  41983. /**
  41984. * If true automatically deducts the fresnels values from the material specularity.
  41985. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41986. */
  41987. useReflectionFresnelFromSpecular: boolean;
  41988. private _useGlossinessFromSpecularMapAlpha;
  41989. /**
  41990. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  41991. */
  41992. useGlossinessFromSpecularMapAlpha: boolean;
  41993. private _maxSimultaneousLights;
  41994. /**
  41995. * Defines the maximum number of lights that can be used in the material
  41996. */
  41997. maxSimultaneousLights: number;
  41998. private _invertNormalMapX;
  41999. /**
  42000. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  42001. */
  42002. invertNormalMapX: boolean;
  42003. private _invertNormalMapY;
  42004. /**
  42005. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  42006. */
  42007. invertNormalMapY: boolean;
  42008. private _twoSidedLighting;
  42009. /**
  42010. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  42011. */
  42012. twoSidedLighting: boolean;
  42013. /**
  42014. * Default configuration related to image processing available in the standard Material.
  42015. */
  42016. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  42017. /**
  42018. * Gets the image processing configuration used either in this material.
  42019. */
  42020. /**
  42021. * Sets the Default image processing configuration used either in the this material.
  42022. *
  42023. * If sets to null, the scene one is in use.
  42024. */
  42025. imageProcessingConfiguration: ImageProcessingConfiguration;
  42026. /**
  42027. * Keep track of the image processing observer to allow dispose and replace.
  42028. */
  42029. private _imageProcessingObserver;
  42030. /**
  42031. * Attaches a new image processing configuration to the Standard Material.
  42032. * @param configuration
  42033. */
  42034. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  42035. /**
  42036. * Gets wether the color curves effect is enabled.
  42037. */
  42038. /**
  42039. * Sets wether the color curves effect is enabled.
  42040. */
  42041. cameraColorCurvesEnabled: boolean;
  42042. /**
  42043. * Gets wether the color grading effect is enabled.
  42044. */
  42045. /**
  42046. * Gets wether the color grading effect is enabled.
  42047. */
  42048. cameraColorGradingEnabled: boolean;
  42049. /**
  42050. * Gets wether tonemapping is enabled or not.
  42051. */
  42052. /**
  42053. * Sets wether tonemapping is enabled or not
  42054. */
  42055. cameraToneMappingEnabled: boolean;
  42056. /**
  42057. * The camera exposure used on this material.
  42058. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  42059. * This corresponds to a photographic exposure.
  42060. */
  42061. /**
  42062. * The camera exposure used on this material.
  42063. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  42064. * This corresponds to a photographic exposure.
  42065. */
  42066. cameraExposure: number;
  42067. /**
  42068. * Gets The camera contrast used on this material.
  42069. */
  42070. /**
  42071. * Sets The camera contrast used on this material.
  42072. */
  42073. cameraContrast: number;
  42074. /**
  42075. * Gets the Color Grading 2D Lookup Texture.
  42076. */
  42077. /**
  42078. * Sets the Color Grading 2D Lookup Texture.
  42079. */
  42080. cameraColorGradingTexture: Nullable<BaseTexture>;
  42081. /**
  42082. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  42083. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  42084. * 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;
  42085. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  42086. */
  42087. /**
  42088. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  42089. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  42090. * 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;
  42091. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  42092. */
  42093. cameraColorCurves: Nullable<ColorCurves>;
  42094. /**
  42095. * Custom callback helping to override the default shader used in the material.
  42096. */
  42097. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  42098. protected _renderTargets: SmartArray<RenderTargetTexture>;
  42099. protected _worldViewProjectionMatrix: Matrix;
  42100. protected _globalAmbientColor: Color3;
  42101. protected _useLogarithmicDepth: boolean;
  42102. protected _rebuildInParallel: boolean;
  42103. /**
  42104. * Instantiates a new standard material.
  42105. * This is the default material used in Babylon. It is the best trade off between quality
  42106. * and performances.
  42107. * @see http://doc.babylonjs.com/babylon101/materials
  42108. * @param name Define the name of the material in the scene
  42109. * @param scene Define the scene the material belong to
  42110. */
  42111. constructor(name: string, scene: Scene);
  42112. /**
  42113. * Gets a boolean indicating that current material needs to register RTT
  42114. */
  42115. readonly hasRenderTargetTextures: boolean;
  42116. /**
  42117. * Gets the current class name of the material e.g. "StandardMaterial"
  42118. * Mainly use in serialization.
  42119. * @returns the class name
  42120. */
  42121. getClassName(): string;
  42122. /**
  42123. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  42124. * You can try switching to logarithmic depth.
  42125. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  42126. */
  42127. useLogarithmicDepth: boolean;
  42128. /**
  42129. * Specifies if the material will require alpha blending
  42130. * @returns a boolean specifying if alpha blending is needed
  42131. */
  42132. needAlphaBlending(): boolean;
  42133. /**
  42134. * Specifies if this material should be rendered in alpha test mode
  42135. * @returns a boolean specifying if an alpha test is needed.
  42136. */
  42137. needAlphaTesting(): boolean;
  42138. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  42139. /**
  42140. * Get the texture used for alpha test purpose.
  42141. * @returns the diffuse texture in case of the standard material.
  42142. */
  42143. getAlphaTestTexture(): Nullable<BaseTexture>;
  42144. /**
  42145. * Get if the submesh is ready to be used and all its information available.
  42146. * Child classes can use it to update shaders
  42147. * @param mesh defines the mesh to check
  42148. * @param subMesh defines which submesh to check
  42149. * @param useInstances specifies that instances should be used
  42150. * @returns a boolean indicating that the submesh is ready or not
  42151. */
  42152. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  42153. /**
  42154. * Builds the material UBO layouts.
  42155. * Used internally during the effect preparation.
  42156. */
  42157. buildUniformLayout(): void;
  42158. /**
  42159. * Unbinds the material from the mesh
  42160. */
  42161. unbind(): void;
  42162. /**
  42163. * Binds the submesh to this material by preparing the effect and shader to draw
  42164. * @param world defines the world transformation matrix
  42165. * @param mesh defines the mesh containing the submesh
  42166. * @param subMesh defines the submesh to bind the material to
  42167. */
  42168. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  42169. /**
  42170. * Get the list of animatables in the material.
  42171. * @returns the list of animatables object used in the material
  42172. */
  42173. getAnimatables(): IAnimatable[];
  42174. /**
  42175. * Gets the active textures from the material
  42176. * @returns an array of textures
  42177. */
  42178. getActiveTextures(): BaseTexture[];
  42179. /**
  42180. * Specifies if the material uses a texture
  42181. * @param texture defines the texture to check against the material
  42182. * @returns a boolean specifying if the material uses the texture
  42183. */
  42184. hasTexture(texture: BaseTexture): boolean;
  42185. /**
  42186. * Disposes the material
  42187. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  42188. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  42189. */
  42190. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  42191. /**
  42192. * Makes a duplicate of the material, and gives it a new name
  42193. * @param name defines the new name for the duplicated material
  42194. * @returns the cloned material
  42195. */
  42196. clone(name: string): StandardMaterial;
  42197. /**
  42198. * Serializes this material in a JSON representation
  42199. * @returns the serialized material object
  42200. */
  42201. serialize(): any;
  42202. /**
  42203. * Creates a standard material from parsed material data
  42204. * @param source defines the JSON representation of the material
  42205. * @param scene defines the hosting scene
  42206. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  42207. * @returns a new standard material
  42208. */
  42209. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  42210. /**
  42211. * Are diffuse textures enabled in the application.
  42212. */
  42213. static DiffuseTextureEnabled: boolean;
  42214. /**
  42215. * Are ambient textures enabled in the application.
  42216. */
  42217. static AmbientTextureEnabled: boolean;
  42218. /**
  42219. * Are opacity textures enabled in the application.
  42220. */
  42221. static OpacityTextureEnabled: boolean;
  42222. /**
  42223. * Are reflection textures enabled in the application.
  42224. */
  42225. static ReflectionTextureEnabled: boolean;
  42226. /**
  42227. * Are emissive textures enabled in the application.
  42228. */
  42229. static EmissiveTextureEnabled: boolean;
  42230. /**
  42231. * Are specular textures enabled in the application.
  42232. */
  42233. static SpecularTextureEnabled: boolean;
  42234. /**
  42235. * Are bump textures enabled in the application.
  42236. */
  42237. static BumpTextureEnabled: boolean;
  42238. /**
  42239. * Are lightmap textures enabled in the application.
  42240. */
  42241. static LightmapTextureEnabled: boolean;
  42242. /**
  42243. * Are refraction textures enabled in the application.
  42244. */
  42245. static RefractionTextureEnabled: boolean;
  42246. /**
  42247. * Are color grading textures enabled in the application.
  42248. */
  42249. static ColorGradingTextureEnabled: boolean;
  42250. /**
  42251. * Are fresnels enabled in the application.
  42252. */
  42253. static FresnelEnabled: boolean;
  42254. }
  42255. }
  42256. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  42257. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  42258. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  42259. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  42260. /** @hidden */
  42261. export var imageProcessingPixelShader: {
  42262. name: string;
  42263. shader: string;
  42264. };
  42265. }
  42266. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  42267. import { Nullable } from "babylonjs/types";
  42268. import { Color4 } from "babylonjs/Maths/math.color";
  42269. import { Camera } from "babylonjs/Cameras/camera";
  42270. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42271. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  42272. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  42273. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  42274. import { Engine } from "babylonjs/Engines/engine";
  42275. import "babylonjs/Shaders/imageProcessing.fragment";
  42276. import "babylonjs/Shaders/postprocess.vertex";
  42277. /**
  42278. * ImageProcessingPostProcess
  42279. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  42280. */
  42281. export class ImageProcessingPostProcess extends PostProcess {
  42282. /**
  42283. * Default configuration related to image processing available in the PBR Material.
  42284. */
  42285. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  42286. /**
  42287. * Gets the image processing configuration used either in this material.
  42288. */
  42289. /**
  42290. * Sets the Default image processing configuration used either in the this material.
  42291. *
  42292. * If sets to null, the scene one is in use.
  42293. */
  42294. imageProcessingConfiguration: ImageProcessingConfiguration;
  42295. /**
  42296. * Keep track of the image processing observer to allow dispose and replace.
  42297. */
  42298. private _imageProcessingObserver;
  42299. /**
  42300. * Attaches a new image processing configuration to the PBR Material.
  42301. * @param configuration
  42302. */
  42303. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  42304. /**
  42305. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  42306. */
  42307. /**
  42308. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  42309. */
  42310. colorCurves: Nullable<ColorCurves>;
  42311. /**
  42312. * Gets wether the color curves effect is enabled.
  42313. */
  42314. /**
  42315. * Sets wether the color curves effect is enabled.
  42316. */
  42317. colorCurvesEnabled: boolean;
  42318. /**
  42319. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  42320. */
  42321. /**
  42322. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  42323. */
  42324. colorGradingTexture: Nullable<BaseTexture>;
  42325. /**
  42326. * Gets wether the color grading effect is enabled.
  42327. */
  42328. /**
  42329. * Gets wether the color grading effect is enabled.
  42330. */
  42331. colorGradingEnabled: boolean;
  42332. /**
  42333. * Gets exposure used in the effect.
  42334. */
  42335. /**
  42336. * Sets exposure used in the effect.
  42337. */
  42338. exposure: number;
  42339. /**
  42340. * Gets wether tonemapping is enabled or not.
  42341. */
  42342. /**
  42343. * Sets wether tonemapping is enabled or not
  42344. */
  42345. toneMappingEnabled: boolean;
  42346. /**
  42347. * Gets the type of tone mapping effect.
  42348. */
  42349. /**
  42350. * Sets the type of tone mapping effect.
  42351. */
  42352. toneMappingType: number;
  42353. /**
  42354. * Gets contrast used in the effect.
  42355. */
  42356. /**
  42357. * Sets contrast used in the effect.
  42358. */
  42359. contrast: number;
  42360. /**
  42361. * Gets Vignette stretch size.
  42362. */
  42363. /**
  42364. * Sets Vignette stretch size.
  42365. */
  42366. vignetteStretch: number;
  42367. /**
  42368. * Gets Vignette centre X Offset.
  42369. */
  42370. /**
  42371. * Sets Vignette centre X Offset.
  42372. */
  42373. vignetteCentreX: number;
  42374. /**
  42375. * Gets Vignette centre Y Offset.
  42376. */
  42377. /**
  42378. * Sets Vignette centre Y Offset.
  42379. */
  42380. vignetteCentreY: number;
  42381. /**
  42382. * Gets Vignette weight or intensity of the vignette effect.
  42383. */
  42384. /**
  42385. * Sets Vignette weight or intensity of the vignette effect.
  42386. */
  42387. vignetteWeight: number;
  42388. /**
  42389. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42390. * if vignetteEnabled is set to true.
  42391. */
  42392. /**
  42393. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42394. * if vignetteEnabled is set to true.
  42395. */
  42396. vignetteColor: Color4;
  42397. /**
  42398. * Gets Camera field of view used by the Vignette effect.
  42399. */
  42400. /**
  42401. * Sets Camera field of view used by the Vignette effect.
  42402. */
  42403. vignetteCameraFov: number;
  42404. /**
  42405. * Gets the vignette blend mode allowing different kind of effect.
  42406. */
  42407. /**
  42408. * Sets the vignette blend mode allowing different kind of effect.
  42409. */
  42410. vignetteBlendMode: number;
  42411. /**
  42412. * Gets wether the vignette effect is enabled.
  42413. */
  42414. /**
  42415. * Sets wether the vignette effect is enabled.
  42416. */
  42417. vignetteEnabled: boolean;
  42418. private _fromLinearSpace;
  42419. /**
  42420. * Gets wether the input of the processing is in Gamma or Linear Space.
  42421. */
  42422. /**
  42423. * Sets wether the input of the processing is in Gamma or Linear Space.
  42424. */
  42425. fromLinearSpace: boolean;
  42426. /**
  42427. * Defines cache preventing GC.
  42428. */
  42429. private _defines;
  42430. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  42431. /**
  42432. * "ImageProcessingPostProcess"
  42433. * @returns "ImageProcessingPostProcess"
  42434. */
  42435. getClassName(): string;
  42436. protected _updateParameters(): void;
  42437. dispose(camera?: Camera): void;
  42438. }
  42439. }
  42440. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  42441. import { Scene } from "babylonjs/scene";
  42442. import { Color3 } from "babylonjs/Maths/math.color";
  42443. import { Mesh } from "babylonjs/Meshes/mesh";
  42444. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  42445. import { Nullable } from "babylonjs/types";
  42446. /**
  42447. * Class containing static functions to help procedurally build meshes
  42448. */
  42449. export class GroundBuilder {
  42450. /**
  42451. * Creates a ground mesh
  42452. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  42453. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  42454. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  42455. * @param name defines the name of the mesh
  42456. * @param options defines the options used to create the mesh
  42457. * @param scene defines the hosting scene
  42458. * @returns the ground mesh
  42459. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  42460. */
  42461. static CreateGround(name: string, options: {
  42462. width?: number;
  42463. height?: number;
  42464. subdivisions?: number;
  42465. subdivisionsX?: number;
  42466. subdivisionsY?: number;
  42467. updatable?: boolean;
  42468. }, scene: any): Mesh;
  42469. /**
  42470. * Creates a tiled ground mesh
  42471. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  42472. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  42473. * * 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
  42474. * * 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
  42475. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42476. * @param name defines the name of the mesh
  42477. * @param options defines the options used to create the mesh
  42478. * @param scene defines the hosting scene
  42479. * @returns the tiled ground mesh
  42480. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  42481. */
  42482. static CreateTiledGround(name: string, options: {
  42483. xmin: number;
  42484. zmin: number;
  42485. xmax: number;
  42486. zmax: number;
  42487. subdivisions?: {
  42488. w: number;
  42489. h: number;
  42490. };
  42491. precision?: {
  42492. w: number;
  42493. h: number;
  42494. };
  42495. updatable?: boolean;
  42496. }, scene?: Nullable<Scene>): Mesh;
  42497. /**
  42498. * Creates a ground mesh from a height map
  42499. * * The parameter `url` sets the URL of the height map image resource.
  42500. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  42501. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  42502. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  42503. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  42504. * * 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.
  42505. * * 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).
  42506. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  42507. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42508. * @param name defines the name of the mesh
  42509. * @param url defines the url to the height map
  42510. * @param options defines the options used to create the mesh
  42511. * @param scene defines the hosting scene
  42512. * @returns the ground mesh
  42513. * @see https://doc.babylonjs.com/babylon101/height_map
  42514. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  42515. */
  42516. static CreateGroundFromHeightMap(name: string, url: string, options: {
  42517. width?: number;
  42518. height?: number;
  42519. subdivisions?: number;
  42520. minHeight?: number;
  42521. maxHeight?: number;
  42522. colorFilter?: Color3;
  42523. alphaFilter?: number;
  42524. updatable?: boolean;
  42525. onReady?: (mesh: GroundMesh) => void;
  42526. }, scene?: Nullable<Scene>): GroundMesh;
  42527. }
  42528. }
  42529. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  42530. import { Vector4 } from "babylonjs/Maths/math.vector";
  42531. import { Mesh } from "babylonjs/Meshes/mesh";
  42532. /**
  42533. * Class containing static functions to help procedurally build meshes
  42534. */
  42535. export class TorusBuilder {
  42536. /**
  42537. * Creates a torus mesh
  42538. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  42539. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  42540. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  42541. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42542. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42543. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42544. * @param name defines the name of the mesh
  42545. * @param options defines the options used to create the mesh
  42546. * @param scene defines the hosting scene
  42547. * @returns the torus mesh
  42548. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  42549. */
  42550. static CreateTorus(name: string, options: {
  42551. diameter?: number;
  42552. thickness?: number;
  42553. tessellation?: number;
  42554. updatable?: boolean;
  42555. sideOrientation?: number;
  42556. frontUVs?: Vector4;
  42557. backUVs?: Vector4;
  42558. }, scene: any): Mesh;
  42559. }
  42560. }
  42561. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  42562. import { Vector4 } from "babylonjs/Maths/math.vector";
  42563. import { Color4 } from "babylonjs/Maths/math.color";
  42564. import { Mesh } from "babylonjs/Meshes/mesh";
  42565. /**
  42566. * Class containing static functions to help procedurally build meshes
  42567. */
  42568. export class CylinderBuilder {
  42569. /**
  42570. * Creates a cylinder or a cone mesh
  42571. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  42572. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  42573. * * 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.
  42574. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  42575. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  42576. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  42577. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  42578. * * 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).
  42579. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  42580. * * 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).
  42581. * * 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
  42582. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  42583. * * 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
  42584. * * 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.
  42585. * * If `enclose` is false, a ring surface is one element.
  42586. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  42587. * * 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
  42588. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42589. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42590. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42591. * @param name defines the name of the mesh
  42592. * @param options defines the options used to create the mesh
  42593. * @param scene defines the hosting scene
  42594. * @returns the cylinder mesh
  42595. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  42596. */
  42597. static CreateCylinder(name: string, options: {
  42598. height?: number;
  42599. diameterTop?: number;
  42600. diameterBottom?: number;
  42601. diameter?: number;
  42602. tessellation?: number;
  42603. subdivisions?: number;
  42604. arc?: number;
  42605. faceColors?: Color4[];
  42606. faceUV?: Vector4[];
  42607. updatable?: boolean;
  42608. hasRings?: boolean;
  42609. enclose?: boolean;
  42610. cap?: number;
  42611. sideOrientation?: number;
  42612. frontUVs?: Vector4;
  42613. backUVs?: Vector4;
  42614. }, scene: any): Mesh;
  42615. }
  42616. }
  42617. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  42618. import { Observable } from "babylonjs/Misc/observable";
  42619. import { Nullable } from "babylonjs/types";
  42620. import { Camera } from "babylonjs/Cameras/camera";
  42621. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  42622. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  42623. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  42624. import { Scene } from "babylonjs/scene";
  42625. import { Vector3 } from "babylonjs/Maths/math.vector";
  42626. import { Color3 } from "babylonjs/Maths/math.color";
  42627. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  42628. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42629. import { Mesh } from "babylonjs/Meshes/mesh";
  42630. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  42631. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  42632. import "babylonjs/Meshes/Builders/groundBuilder";
  42633. import "babylonjs/Meshes/Builders/torusBuilder";
  42634. import "babylonjs/Meshes/Builders/cylinderBuilder";
  42635. import "babylonjs/Gamepads/gamepadSceneComponent";
  42636. import "babylonjs/Animations/animatable";
  42637. /**
  42638. * Options to modify the vr teleportation behavior.
  42639. */
  42640. export interface VRTeleportationOptions {
  42641. /**
  42642. * The name of the mesh which should be used as the teleportation floor. (default: null)
  42643. */
  42644. floorMeshName?: string;
  42645. /**
  42646. * A list of meshes to be used as the teleportation floor. (default: empty)
  42647. */
  42648. floorMeshes?: Mesh[];
  42649. }
  42650. /**
  42651. * Options to modify the vr experience helper's behavior.
  42652. */
  42653. export interface VRExperienceHelperOptions extends WebVROptions {
  42654. /**
  42655. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  42656. */
  42657. createDeviceOrientationCamera?: boolean;
  42658. /**
  42659. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  42660. */
  42661. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  42662. /**
  42663. * Uses the main button on the controller to toggle the laser casted. (default: true)
  42664. */
  42665. laserToggle?: boolean;
  42666. /**
  42667. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  42668. */
  42669. floorMeshes?: Mesh[];
  42670. /**
  42671. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  42672. */
  42673. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  42674. }
  42675. /**
  42676. * Event containing information after VR has been entered
  42677. */
  42678. export class OnAfterEnteringVRObservableEvent {
  42679. /**
  42680. * If entering vr was successful
  42681. */
  42682. success: boolean;
  42683. }
  42684. /**
  42685. * Helps to quickly add VR support to an existing scene.
  42686. * See http://doc.babylonjs.com/how_to/webvr_helper
  42687. */
  42688. export class VRExperienceHelper {
  42689. /** Options to modify the vr experience helper's behavior. */
  42690. webVROptions: VRExperienceHelperOptions;
  42691. private _scene;
  42692. private _position;
  42693. private _btnVR;
  42694. private _btnVRDisplayed;
  42695. private _webVRsupported;
  42696. private _webVRready;
  42697. private _webVRrequesting;
  42698. private _webVRpresenting;
  42699. private _hasEnteredVR;
  42700. private _fullscreenVRpresenting;
  42701. private _canvas;
  42702. private _webVRCamera;
  42703. private _vrDeviceOrientationCamera;
  42704. private _deviceOrientationCamera;
  42705. private _existingCamera;
  42706. private _onKeyDown;
  42707. private _onVrDisplayPresentChange;
  42708. private _onVRDisplayChanged;
  42709. private _onVRRequestPresentStart;
  42710. private _onVRRequestPresentComplete;
  42711. /**
  42712. * 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)
  42713. */
  42714. enableGazeEvenWhenNoPointerLock: boolean;
  42715. /**
  42716. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  42717. */
  42718. exitVROnDoubleTap: boolean;
  42719. /**
  42720. * Observable raised right before entering VR.
  42721. */
  42722. onEnteringVRObservable: Observable<VRExperienceHelper>;
  42723. /**
  42724. * Observable raised when entering VR has completed.
  42725. */
  42726. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  42727. /**
  42728. * Observable raised when exiting VR.
  42729. */
  42730. onExitingVRObservable: Observable<VRExperienceHelper>;
  42731. /**
  42732. * Observable raised when controller mesh is loaded.
  42733. */
  42734. onControllerMeshLoadedObservable: Observable<WebVRController>;
  42735. /** Return this.onEnteringVRObservable
  42736. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  42737. */
  42738. readonly onEnteringVR: Observable<VRExperienceHelper>;
  42739. /** Return this.onExitingVRObservable
  42740. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  42741. */
  42742. readonly onExitingVR: Observable<VRExperienceHelper>;
  42743. /** Return this.onControllerMeshLoadedObservable
  42744. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  42745. */
  42746. readonly onControllerMeshLoaded: Observable<WebVRController>;
  42747. private _rayLength;
  42748. private _useCustomVRButton;
  42749. private _teleportationRequested;
  42750. private _teleportActive;
  42751. private _floorMeshName;
  42752. private _floorMeshesCollection;
  42753. private _rotationAllowed;
  42754. private _teleportBackwardsVector;
  42755. private _teleportationTarget;
  42756. private _isDefaultTeleportationTarget;
  42757. private _postProcessMove;
  42758. private _teleportationFillColor;
  42759. private _teleportationBorderColor;
  42760. private _rotationAngle;
  42761. private _haloCenter;
  42762. private _cameraGazer;
  42763. private _padSensibilityUp;
  42764. private _padSensibilityDown;
  42765. private _leftController;
  42766. private _rightController;
  42767. /**
  42768. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  42769. */
  42770. onNewMeshSelected: Observable<AbstractMesh>;
  42771. /**
  42772. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  42773. * This observable will provide the mesh and the controller used to select the mesh
  42774. */
  42775. onMeshSelectedWithController: Observable<{
  42776. mesh: AbstractMesh;
  42777. controller: WebVRController;
  42778. }>;
  42779. /**
  42780. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  42781. */
  42782. onNewMeshPicked: Observable<PickingInfo>;
  42783. private _circleEase;
  42784. /**
  42785. * Observable raised before camera teleportation
  42786. */
  42787. onBeforeCameraTeleport: Observable<Vector3>;
  42788. /**
  42789. * Observable raised after camera teleportation
  42790. */
  42791. onAfterCameraTeleport: Observable<Vector3>;
  42792. /**
  42793. * Observable raised when current selected mesh gets unselected
  42794. */
  42795. onSelectedMeshUnselected: Observable<AbstractMesh>;
  42796. private _raySelectionPredicate;
  42797. /**
  42798. * To be optionaly changed by user to define custom ray selection
  42799. */
  42800. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  42801. /**
  42802. * To be optionaly changed by user to define custom selection logic (after ray selection)
  42803. */
  42804. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  42805. /**
  42806. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  42807. */
  42808. teleportationEnabled: boolean;
  42809. private _defaultHeight;
  42810. private _teleportationInitialized;
  42811. private _interactionsEnabled;
  42812. private _interactionsRequested;
  42813. private _displayGaze;
  42814. private _displayLaserPointer;
  42815. /**
  42816. * The mesh used to display where the user is going to teleport.
  42817. */
  42818. /**
  42819. * Sets the mesh to be used to display where the user is going to teleport.
  42820. */
  42821. teleportationTarget: Mesh;
  42822. /**
  42823. * 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
  42824. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  42825. * See http://doc.babylonjs.com/resources/baking_transformations
  42826. */
  42827. gazeTrackerMesh: Mesh;
  42828. /**
  42829. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  42830. */
  42831. updateGazeTrackerScale: boolean;
  42832. /**
  42833. * If the gaze trackers color should be updated when selecting meshes
  42834. */
  42835. updateGazeTrackerColor: boolean;
  42836. /**
  42837. * If the controller laser color should be updated when selecting meshes
  42838. */
  42839. updateControllerLaserColor: boolean;
  42840. /**
  42841. * The gaze tracking mesh corresponding to the left controller
  42842. */
  42843. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  42844. /**
  42845. * The gaze tracking mesh corresponding to the right controller
  42846. */
  42847. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  42848. /**
  42849. * If the ray of the gaze should be displayed.
  42850. */
  42851. /**
  42852. * Sets if the ray of the gaze should be displayed.
  42853. */
  42854. displayGaze: boolean;
  42855. /**
  42856. * If the ray of the LaserPointer should be displayed.
  42857. */
  42858. /**
  42859. * Sets if the ray of the LaserPointer should be displayed.
  42860. */
  42861. displayLaserPointer: boolean;
  42862. /**
  42863. * The deviceOrientationCamera used as the camera when not in VR.
  42864. */
  42865. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  42866. /**
  42867. * Based on the current WebVR support, returns the current VR camera used.
  42868. */
  42869. readonly currentVRCamera: Nullable<Camera>;
  42870. /**
  42871. * The webVRCamera which is used when in VR.
  42872. */
  42873. readonly webVRCamera: WebVRFreeCamera;
  42874. /**
  42875. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  42876. */
  42877. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  42878. /**
  42879. * The html button that is used to trigger entering into VR.
  42880. */
  42881. readonly vrButton: Nullable<HTMLButtonElement>;
  42882. private readonly _teleportationRequestInitiated;
  42883. /**
  42884. * Defines wether or not Pointer lock should be requested when switching to
  42885. * full screen.
  42886. */
  42887. requestPointerLockOnFullScreen: boolean;
  42888. /**
  42889. * Instantiates a VRExperienceHelper.
  42890. * Helps to quickly add VR support to an existing scene.
  42891. * @param scene The scene the VRExperienceHelper belongs to.
  42892. * @param webVROptions Options to modify the vr experience helper's behavior.
  42893. */
  42894. constructor(scene: Scene,
  42895. /** Options to modify the vr experience helper's behavior. */
  42896. webVROptions?: VRExperienceHelperOptions);
  42897. private _onDefaultMeshLoaded;
  42898. private _onResize;
  42899. private _onFullscreenChange;
  42900. /**
  42901. * Gets a value indicating if we are currently in VR mode.
  42902. */
  42903. readonly isInVRMode: boolean;
  42904. private onVrDisplayPresentChange;
  42905. private onVRDisplayChanged;
  42906. private moveButtonToBottomRight;
  42907. private displayVRButton;
  42908. private updateButtonVisibility;
  42909. private _cachedAngularSensibility;
  42910. /**
  42911. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  42912. * Otherwise, will use the fullscreen API.
  42913. */
  42914. enterVR(): void;
  42915. /**
  42916. * Attempt to exit VR, or fullscreen.
  42917. */
  42918. exitVR(): void;
  42919. /**
  42920. * The position of the vr experience helper.
  42921. */
  42922. /**
  42923. * Sets the position of the vr experience helper.
  42924. */
  42925. position: Vector3;
  42926. /**
  42927. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  42928. */
  42929. enableInteractions(): void;
  42930. private readonly _noControllerIsActive;
  42931. private beforeRender;
  42932. private _isTeleportationFloor;
  42933. /**
  42934. * Adds a floor mesh to be used for teleportation.
  42935. * @param floorMesh the mesh to be used for teleportation.
  42936. */
  42937. addFloorMesh(floorMesh: Mesh): void;
  42938. /**
  42939. * Removes a floor mesh from being used for teleportation.
  42940. * @param floorMesh the mesh to be removed.
  42941. */
  42942. removeFloorMesh(floorMesh: Mesh): void;
  42943. /**
  42944. * Enables interactions and teleportation using the VR controllers and gaze.
  42945. * @param vrTeleportationOptions options to modify teleportation behavior.
  42946. */
  42947. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  42948. private _onNewGamepadConnected;
  42949. private _tryEnableInteractionOnController;
  42950. private _onNewGamepadDisconnected;
  42951. private _enableInteractionOnController;
  42952. private _checkTeleportWithRay;
  42953. private _checkRotate;
  42954. private _checkTeleportBackwards;
  42955. private _enableTeleportationOnController;
  42956. private _createTeleportationCircles;
  42957. private _displayTeleportationTarget;
  42958. private _hideTeleportationTarget;
  42959. private _rotateCamera;
  42960. private _moveTeleportationSelectorTo;
  42961. private _workingVector;
  42962. private _workingQuaternion;
  42963. private _workingMatrix;
  42964. /**
  42965. * Teleports the users feet to the desired location
  42966. * @param location The location where the user's feet should be placed
  42967. */
  42968. teleportCamera(location: Vector3): void;
  42969. private _convertNormalToDirectionOfRay;
  42970. private _castRayAndSelectObject;
  42971. private _notifySelectedMeshUnselected;
  42972. /**
  42973. * Sets the color of the laser ray from the vr controllers.
  42974. * @param color new color for the ray.
  42975. */
  42976. changeLaserColor(color: Color3): void;
  42977. /**
  42978. * Sets the color of the ray from the vr headsets gaze.
  42979. * @param color new color for the ray.
  42980. */
  42981. changeGazeColor(color: Color3): void;
  42982. /**
  42983. * Exits VR and disposes of the vr experience helper
  42984. */
  42985. dispose(): void;
  42986. /**
  42987. * Gets the name of the VRExperienceHelper class
  42988. * @returns "VRExperienceHelper"
  42989. */
  42990. getClassName(): string;
  42991. }
  42992. }
  42993. declare module "babylonjs/Cameras/VR/index" {
  42994. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  42995. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  42996. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  42997. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  42998. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  42999. export * from "babylonjs/Cameras/VR/webVRCamera";
  43000. }
  43001. declare module "babylonjs/Cameras/XR/webXRTypes" {
  43002. import { Nullable } from "babylonjs/types";
  43003. import { IDisposable } from "babylonjs/scene";
  43004. /**
  43005. * States of the webXR experience
  43006. */
  43007. export enum WebXRState {
  43008. /**
  43009. * Transitioning to being in XR mode
  43010. */
  43011. ENTERING_XR = 0,
  43012. /**
  43013. * Transitioning to non XR mode
  43014. */
  43015. EXITING_XR = 1,
  43016. /**
  43017. * In XR mode and presenting
  43018. */
  43019. IN_XR = 2,
  43020. /**
  43021. * Not entered XR mode
  43022. */
  43023. NOT_IN_XR = 3
  43024. }
  43025. /**
  43026. * Abstraction of the XR render target
  43027. */
  43028. export interface WebXRRenderTarget extends IDisposable {
  43029. /**
  43030. * xrpresent context of the canvas which can be used to display/mirror xr content
  43031. */
  43032. canvasContext: WebGLRenderingContext;
  43033. /**
  43034. * xr layer for the canvas
  43035. */
  43036. xrLayer: Nullable<XRWebGLLayer>;
  43037. /**
  43038. * Initializes the xr layer for the session
  43039. * @param xrSession xr session
  43040. * @returns a promise that will resolve once the XR Layer has been created
  43041. */
  43042. initializeXRLayerAsync(xrSession: XRSession): Promise<void>;
  43043. }
  43044. }
  43045. declare module "babylonjs/Cameras/XR/webXRManagedOutputCanvas" {
  43046. import { Nullable } from "babylonjs/types";
  43047. import { Observable } from "babylonjs/Misc/observable";
  43048. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  43049. import { WebXRState, WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43050. /**
  43051. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  43052. */
  43053. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  43054. private _engine;
  43055. private _canvas;
  43056. /**
  43057. * xrpresent context of the canvas which can be used to display/mirror xr content
  43058. */
  43059. canvasContext: WebGLRenderingContext;
  43060. /**
  43061. * xr layer for the canvas
  43062. */
  43063. xrLayer: Nullable<XRWebGLLayer>;
  43064. /**
  43065. * Initializes the xr layer for the session
  43066. * @param xrSession xr session
  43067. * @returns a promise that will resolve once the XR Layer has been created
  43068. */
  43069. initializeXRLayerAsync(xrSession: any): any;
  43070. /**
  43071. * Initializes the canvas to be added/removed upon entering/exiting xr
  43072. * @param engine the Babylon engine
  43073. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  43074. * @param onStateChangedObservable the mechanism by which the canvas will be added/removed based on XR state
  43075. */
  43076. constructor(engine: ThinEngine, canvas?: HTMLCanvasElement, onStateChangedObservable?: Observable<WebXRState>);
  43077. /**
  43078. * Disposes of the object
  43079. */
  43080. dispose(): void;
  43081. private _setManagedOutputCanvas;
  43082. private _addCanvas;
  43083. private _removeCanvas;
  43084. }
  43085. }
  43086. declare module "babylonjs/Cameras/XR/webXRSessionManager" {
  43087. import { Observable } from "babylonjs/Misc/observable";
  43088. import { Nullable } from "babylonjs/types";
  43089. import { IDisposable, Scene } from "babylonjs/scene";
  43090. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  43091. import { WebXRRenderTarget, WebXRState } from "babylonjs/Cameras/XR/webXRTypes";
  43092. /**
  43093. * Manages an XRSession to work with Babylon's engine
  43094. * @see https://doc.babylonjs.com/how_to/webxr
  43095. */
  43096. export class WebXRSessionManager implements IDisposable {
  43097. private scene;
  43098. /**
  43099. * Fires every time a new xrFrame arrives which can be used to update the camera
  43100. */
  43101. onXRFrameObservable: Observable<any>;
  43102. /**
  43103. * Fires when the xr session is ended either by the device or manually done
  43104. */
  43105. onXRSessionEnded: Observable<any>;
  43106. /**
  43107. * Underlying xr session
  43108. */
  43109. session: XRSession;
  43110. /**
  43111. * Type of reference space used when creating the session
  43112. */
  43113. referenceSpace: XRReferenceSpace;
  43114. /**
  43115. * Current XR frame
  43116. */
  43117. currentFrame: Nullable<XRFrame>;
  43118. private _xrNavigator;
  43119. private baseLayer;
  43120. private _rttProvider;
  43121. private _sessionEnded;
  43122. /**
  43123. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  43124. * @param scene The scene which the session should be created for
  43125. */
  43126. constructor(scene: Scene);
  43127. /**
  43128. * Initializes the manager
  43129. * After initialization enterXR can be called to start an XR session
  43130. * @returns Promise which resolves after it is initialized
  43131. */
  43132. initializeAsync(): Promise<void>;
  43133. /**
  43134. * Initializes an xr session
  43135. * @param xrSessionMode mode to initialize
  43136. * @param optionalFeatures defines optional values to pass to the session builder
  43137. * @returns a promise which will resolve once the session has been initialized
  43138. */
  43139. initializeSessionAsync(xrSessionMode: XRSessionMode, optionalFeatures?: any): any;
  43140. /**
  43141. * Sets the reference space on the xr session
  43142. * @param referenceSpace space to set
  43143. * @returns a promise that will resolve once the reference space has been set
  43144. */
  43145. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  43146. /**
  43147. * Updates the render state of the session
  43148. * @param state state to set
  43149. * @returns a promise that resolves once the render state has been updated
  43150. */
  43151. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  43152. /**
  43153. * Starts rendering to the xr layer
  43154. * @returns a promise that will resolve once rendering has started
  43155. */
  43156. startRenderingToXRAsync(): Promise<void>;
  43157. /**
  43158. * Gets the correct render target texture to be rendered this frame for this eye
  43159. * @param eye the eye for which to get the render target
  43160. * @returns the render target for the specified eye
  43161. */
  43162. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  43163. /**
  43164. * Stops the xrSession and restores the renderloop
  43165. * @returns Promise which resolves after it exits XR
  43166. */
  43167. exitXRAsync(): Promise<void>;
  43168. /**
  43169. * Checks if a session would be supported for the creation options specified
  43170. * @param sessionMode session mode to check if supported eg. immersive-vr
  43171. * @returns true if supported
  43172. */
  43173. supportsSessionAsync(sessionMode: XRSessionMode): any;
  43174. /**
  43175. * Creates a WebXRRenderTarget object for the XR session
  43176. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  43177. * @returns a WebXR render target to which the session can render
  43178. */
  43179. getWebXRRenderTarget(onStateChangedObservable?: Observable<WebXRState>): WebXRRenderTarget;
  43180. /**
  43181. * @hidden
  43182. * Converts the render layer of xrSession to a render target
  43183. * @param session session to create render target for
  43184. * @param scene scene the new render target should be created for
  43185. */
  43186. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  43187. /**
  43188. * Disposes of the session manager
  43189. */
  43190. dispose(): void;
  43191. }
  43192. }
  43193. declare module "babylonjs/Cameras/XR/webXRCamera" {
  43194. import { Scene } from "babylonjs/scene";
  43195. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  43196. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  43197. /**
  43198. * WebXR Camera which holds the views for the xrSession
  43199. * @see https://doc.babylonjs.com/how_to/webxr
  43200. */
  43201. export class WebXRCamera extends FreeCamera {
  43202. private static _TmpMatrix;
  43203. /**
  43204. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  43205. * @param name the name of the camera
  43206. * @param scene the scene to add the camera to
  43207. */
  43208. constructor(name: string, scene: Scene);
  43209. private _updateNumberOfRigCameras;
  43210. /** @hidden */
  43211. _updateForDualEyeDebugging(): void;
  43212. /**
  43213. * Updates the cameras position from the current pose information of the XR session
  43214. * @param xrSessionManager the session containing pose information
  43215. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  43216. */
  43217. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  43218. }
  43219. }
  43220. declare module "babylonjs/Cameras/XR/webXRExperienceHelper" {
  43221. import { Observable } from "babylonjs/Misc/observable";
  43222. import { IDisposable, Scene } from "babylonjs/scene";
  43223. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  43224. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43225. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  43226. import { WebXRCamera } from "babylonjs/Cameras/XR/webXRCamera";
  43227. import { WebXRState, WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43228. /**
  43229. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  43230. * @see https://doc.babylonjs.com/how_to/webxr
  43231. */
  43232. export class WebXRExperienceHelper implements IDisposable {
  43233. private scene;
  43234. /**
  43235. * Container which stores the xr camera and controllers as children. This can be used to move the camera/user as the camera's position is updated by the xr device
  43236. */
  43237. container: AbstractMesh;
  43238. /**
  43239. * Camera used to render xr content
  43240. */
  43241. camera: WebXRCamera;
  43242. /**
  43243. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  43244. */
  43245. state: WebXRState;
  43246. private _setState;
  43247. private static _TmpVector;
  43248. /**
  43249. * Fires when the state of the experience helper has changed
  43250. */
  43251. onStateChangedObservable: Observable<WebXRState>;
  43252. /** Session manager used to keep track of xr session */
  43253. sessionManager: WebXRSessionManager;
  43254. private _nonVRCamera;
  43255. private _originalSceneAutoClear;
  43256. private _supported;
  43257. /**
  43258. * Creates the experience helper
  43259. * @param scene the scene to attach the experience helper to
  43260. * @returns a promise for the experience helper
  43261. */
  43262. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  43263. /**
  43264. * Creates a WebXRExperienceHelper
  43265. * @param scene The scene the helper should be created in
  43266. */
  43267. private constructor();
  43268. /**
  43269. * Exits XR mode and returns the scene to its original state
  43270. * @returns promise that resolves after xr mode has exited
  43271. */
  43272. exitXRAsync(): Promise<void>;
  43273. /**
  43274. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  43275. * @param sessionMode options for the XR session
  43276. * @param referenceSpaceType frame of reference of the XR session
  43277. * @param renderTarget the output canvas that will be used to enter XR mode
  43278. * @returns promise that resolves after xr mode has entered
  43279. */
  43280. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget: WebXRRenderTarget): any;
  43281. /**
  43282. * Updates the global position of the camera by moving the camera's container
  43283. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  43284. * @param position The desired global position of the camera
  43285. */
  43286. setPositionOfCameraUsingContainer(position: Vector3): void;
  43287. /**
  43288. * Rotates the xr camera by rotating the camera's container around the camera's position
  43289. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  43290. * @param rotation the desired quaternion rotation to apply to the camera
  43291. */
  43292. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  43293. /**
  43294. * Disposes of the experience helper
  43295. */
  43296. dispose(): void;
  43297. }
  43298. }
  43299. declare module "babylonjs/Cameras/XR/webXREnterExitUI" {
  43300. import { Nullable } from "babylonjs/types";
  43301. import { Observable } from "babylonjs/Misc/observable";
  43302. import { IDisposable, Scene } from "babylonjs/scene";
  43303. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43304. import { WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43305. /**
  43306. * Button which can be used to enter a different mode of XR
  43307. */
  43308. export class WebXREnterExitUIButton {
  43309. /** button element */
  43310. element: HTMLElement;
  43311. /** XR initialization options for the button */
  43312. sessionMode: XRSessionMode;
  43313. /** Reference space type */
  43314. referenceSpaceType: XRReferenceSpaceType;
  43315. /**
  43316. * Creates a WebXREnterExitUIButton
  43317. * @param element button element
  43318. * @param sessionMode XR initialization session mode
  43319. * @param referenceSpaceType the type of reference space to be used
  43320. */
  43321. constructor(
  43322. /** button element */
  43323. element: HTMLElement,
  43324. /** XR initialization options for the button */
  43325. sessionMode: XRSessionMode,
  43326. /** Reference space type */
  43327. referenceSpaceType: XRReferenceSpaceType);
  43328. /**
  43329. * Overwritable function which can be used to update the button's visuals when the state changes
  43330. * @param activeButton the current active button in the UI
  43331. */
  43332. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  43333. }
  43334. /**
  43335. * Options to create the webXR UI
  43336. */
  43337. export class WebXREnterExitUIOptions {
  43338. /**
  43339. * Context to enter xr with
  43340. */
  43341. renderTarget?: Nullable<WebXRRenderTarget>;
  43342. /**
  43343. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  43344. */
  43345. customButtons?: Array<WebXREnterExitUIButton>;
  43346. }
  43347. /**
  43348. * UI to allow the user to enter/exit XR mode
  43349. */
  43350. export class WebXREnterExitUI implements IDisposable {
  43351. private scene;
  43352. private _overlay;
  43353. private _buttons;
  43354. private _activeButton;
  43355. /**
  43356. * Fired every time the active button is changed.
  43357. *
  43358. * When xr is entered via a button that launches xr that button will be the callback parameter
  43359. *
  43360. * When exiting xr the callback parameter will be null)
  43361. */
  43362. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  43363. /**
  43364. * Creates UI to allow the user to enter/exit XR mode
  43365. * @param scene the scene to add the ui to
  43366. * @param helper the xr experience helper to enter/exit xr with
  43367. * @param options options to configure the UI
  43368. * @returns the created ui
  43369. */
  43370. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  43371. private constructor();
  43372. private _updateButtons;
  43373. /**
  43374. * Disposes of the object
  43375. */
  43376. dispose(): void;
  43377. }
  43378. }
  43379. declare module "babylonjs/Cameras/XR/webXRController" {
  43380. import { Nullable } from "babylonjs/types";
  43381. import { Observable } from "babylonjs/Misc/observable";
  43382. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43383. import { Ray } from "babylonjs/Culling/ray";
  43384. import { Scene } from "babylonjs/scene";
  43385. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43386. /**
  43387. * Represents an XR input
  43388. */
  43389. export class WebXRController {
  43390. private scene;
  43391. /** The underlying input source for the controller */
  43392. inputSource: XRInputSource;
  43393. private parentContainer;
  43394. /**
  43395. * 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
  43396. */
  43397. grip?: AbstractMesh;
  43398. /**
  43399. * Pointer which can be used to select objects or attach a visible laser to
  43400. */
  43401. pointer: AbstractMesh;
  43402. private _gamepadMode;
  43403. /**
  43404. * If available, this is the gamepad object related to this controller.
  43405. * Using this object it is possible to get click events and trackpad changes of the
  43406. * webxr controller that is currently being used.
  43407. */
  43408. gamepadController?: WebVRController;
  43409. /**
  43410. * Event that fires when the controller is removed/disposed
  43411. */
  43412. onDisposeObservable: Observable<{}>;
  43413. private _tmpMatrix;
  43414. private _tmpQuaternion;
  43415. private _tmpVector;
  43416. /**
  43417. * Creates the controller
  43418. * @see https://doc.babylonjs.com/how_to/webxr
  43419. * @param scene the scene which the controller should be associated to
  43420. * @param inputSource the underlying input source for the controller
  43421. * @param parentContainer parent that the controller meshes should be children of
  43422. */
  43423. constructor(scene: Scene,
  43424. /** The underlying input source for the controller */
  43425. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  43426. /**
  43427. * Updates the controller pose based on the given XRFrame
  43428. * @param xrFrame xr frame to update the pose with
  43429. * @param referenceSpace reference space to use
  43430. */
  43431. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  43432. /**
  43433. * Gets a world space ray coming from the controller
  43434. * @param result the resulting ray
  43435. */
  43436. getWorldPointerRayToRef(result: Ray): void;
  43437. /**
  43438. * Get the scene associated with this controller
  43439. * @returns the scene object
  43440. */
  43441. getScene(): Scene;
  43442. /**
  43443. * Disposes of the object
  43444. */
  43445. dispose(): void;
  43446. }
  43447. }
  43448. declare module "babylonjs/Cameras/XR/webXRInput" {
  43449. import { Observable } from "babylonjs/Misc/observable";
  43450. import { IDisposable } from "babylonjs/scene";
  43451. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43452. import { WebXRController } from "babylonjs/Cameras/XR/webXRController";
  43453. /**
  43454. * XR input used to track XR inputs such as controllers/rays
  43455. */
  43456. export class WebXRInput implements IDisposable {
  43457. /**
  43458. * Base experience the input listens to
  43459. */
  43460. baseExperience: WebXRExperienceHelper;
  43461. /**
  43462. * XR controllers being tracked
  43463. */
  43464. controllers: Array<WebXRController>;
  43465. private _frameObserver;
  43466. private _stateObserver;
  43467. /**
  43468. * Event when a controller has been connected/added
  43469. */
  43470. onControllerAddedObservable: Observable<WebXRController>;
  43471. /**
  43472. * Event when a controller has been removed/disconnected
  43473. */
  43474. onControllerRemovedObservable: Observable<WebXRController>;
  43475. /**
  43476. * Initializes the WebXRInput
  43477. * @param baseExperience experience helper which the input should be created for
  43478. */
  43479. constructor(
  43480. /**
  43481. * Base experience the input listens to
  43482. */
  43483. baseExperience: WebXRExperienceHelper);
  43484. private _onInputSourcesChange;
  43485. private _addAndRemoveControllers;
  43486. /**
  43487. * Disposes of the object
  43488. */
  43489. dispose(): void;
  43490. }
  43491. }
  43492. declare module "babylonjs/Cameras/XR/webXRControllerTeleportation" {
  43493. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43494. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43495. /**
  43496. * Enables teleportation
  43497. */
  43498. export class WebXRControllerTeleportation {
  43499. private _teleportationFillColor;
  43500. private _teleportationBorderColor;
  43501. private _tmpRay;
  43502. private _tmpVector;
  43503. /**
  43504. * Creates a WebXRControllerTeleportation
  43505. * @param input input manager to add teleportation to
  43506. * @param floorMeshes floormeshes which can be teleported to
  43507. */
  43508. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  43509. }
  43510. }
  43511. declare module "babylonjs/Cameras/XR/webXRControllerPointerSelection" {
  43512. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43513. /**
  43514. * Handles pointer input automatically for the pointer of XR controllers
  43515. */
  43516. export class WebXRControllerPointerSelection {
  43517. private static _idCounter;
  43518. private _tmpRay;
  43519. /**
  43520. * Creates a WebXRControllerPointerSelection
  43521. * @param input input manager to setup pointer selection
  43522. */
  43523. constructor(input: WebXRInput);
  43524. private _convertNormalToDirectionOfRay;
  43525. private _updatePointerDistance;
  43526. }
  43527. }
  43528. declare module "babylonjs/Loading/sceneLoader" {
  43529. import { Observable } from "babylonjs/Misc/observable";
  43530. import { Nullable } from "babylonjs/types";
  43531. import { Scene } from "babylonjs/scene";
  43532. import { Engine } from "babylonjs/Engines/engine";
  43533. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43534. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  43535. import { AssetContainer } from "babylonjs/assetContainer";
  43536. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  43537. import { Skeleton } from "babylonjs/Bones/skeleton";
  43538. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  43539. import { WebRequest } from "babylonjs/Misc/webRequest";
  43540. /**
  43541. * Class used to represent data loading progression
  43542. */
  43543. export class SceneLoaderProgressEvent {
  43544. /** defines if data length to load can be evaluated */
  43545. readonly lengthComputable: boolean;
  43546. /** defines the loaded data length */
  43547. readonly loaded: number;
  43548. /** defines the data length to load */
  43549. readonly total: number;
  43550. /**
  43551. * Create a new progress event
  43552. * @param lengthComputable defines if data length to load can be evaluated
  43553. * @param loaded defines the loaded data length
  43554. * @param total defines the data length to load
  43555. */
  43556. constructor(
  43557. /** defines if data length to load can be evaluated */
  43558. lengthComputable: boolean,
  43559. /** defines the loaded data length */
  43560. loaded: number,
  43561. /** defines the data length to load */
  43562. total: number);
  43563. /**
  43564. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  43565. * @param event defines the source event
  43566. * @returns a new SceneLoaderProgressEvent
  43567. */
  43568. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  43569. }
  43570. /**
  43571. * Interface used by SceneLoader plugins to define supported file extensions
  43572. */
  43573. export interface ISceneLoaderPluginExtensions {
  43574. /**
  43575. * Defines the list of supported extensions
  43576. */
  43577. [extension: string]: {
  43578. isBinary: boolean;
  43579. };
  43580. }
  43581. /**
  43582. * Interface used by SceneLoader plugin factory
  43583. */
  43584. export interface ISceneLoaderPluginFactory {
  43585. /**
  43586. * Defines the name of the factory
  43587. */
  43588. name: string;
  43589. /**
  43590. * Function called to create a new plugin
  43591. * @return the new plugin
  43592. */
  43593. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  43594. /**
  43595. * The callback that returns true if the data can be directly loaded.
  43596. * @param data string containing the file data
  43597. * @returns if the data can be loaded directly
  43598. */
  43599. canDirectLoad?(data: string): boolean;
  43600. }
  43601. /**
  43602. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  43603. */
  43604. export interface ISceneLoaderPluginBase {
  43605. /**
  43606. * The friendly name of this plugin.
  43607. */
  43608. name: string;
  43609. /**
  43610. * The file extensions supported by this plugin.
  43611. */
  43612. extensions: string | ISceneLoaderPluginExtensions;
  43613. /**
  43614. * The callback called when loading from a url.
  43615. * @param scene scene loading this url
  43616. * @param url url to load
  43617. * @param onSuccess callback called when the file successfully loads
  43618. * @param onProgress callback called while file is loading (if the server supports this mode)
  43619. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  43620. * @param onError callback called when the file fails to load
  43621. * @returns a file request object
  43622. */
  43623. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  43624. /**
  43625. * The callback called when loading from a file object.
  43626. * @param scene scene loading this file
  43627. * @param file defines the file to load
  43628. * @param onSuccess defines the callback to call when data is loaded
  43629. * @param onProgress defines the callback to call during loading process
  43630. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  43631. * @param onError defines the callback to call when an error occurs
  43632. * @returns a file request object
  43633. */
  43634. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  43635. /**
  43636. * The callback that returns true if the data can be directly loaded.
  43637. * @param data string containing the file data
  43638. * @returns if the data can be loaded directly
  43639. */
  43640. canDirectLoad?(data: string): boolean;
  43641. /**
  43642. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  43643. * @param scene scene loading this data
  43644. * @param data string containing the data
  43645. * @returns data to pass to the plugin
  43646. */
  43647. directLoad?(scene: Scene, data: string): any;
  43648. /**
  43649. * The callback that allows custom handling of the root url based on the response url.
  43650. * @param rootUrl the original root url
  43651. * @param responseURL the response url if available
  43652. * @returns the new root url
  43653. */
  43654. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  43655. }
  43656. /**
  43657. * Interface used to define a SceneLoader plugin
  43658. */
  43659. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  43660. /**
  43661. * Import meshes into a scene.
  43662. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43663. * @param scene The scene to import into
  43664. * @param data The data to import
  43665. * @param rootUrl The root url for scene and resources
  43666. * @param meshes The meshes array to import into
  43667. * @param particleSystems The particle systems array to import into
  43668. * @param skeletons The skeletons array to import into
  43669. * @param onError The callback when import fails
  43670. * @returns True if successful or false otherwise
  43671. */
  43672. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  43673. /**
  43674. * Load into a scene.
  43675. * @param scene The scene to load into
  43676. * @param data The data to import
  43677. * @param rootUrl The root url for scene and resources
  43678. * @param onError The callback when import fails
  43679. * @returns True if successful or false otherwise
  43680. */
  43681. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  43682. /**
  43683. * Load into an asset container.
  43684. * @param scene The scene to load into
  43685. * @param data The data to import
  43686. * @param rootUrl The root url for scene and resources
  43687. * @param onError The callback when import fails
  43688. * @returns The loaded asset container
  43689. */
  43690. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  43691. }
  43692. /**
  43693. * Interface used to define an async SceneLoader plugin
  43694. */
  43695. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  43696. /**
  43697. * Import meshes into a scene.
  43698. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43699. * @param scene The scene to import into
  43700. * @param data The data to import
  43701. * @param rootUrl The root url for scene and resources
  43702. * @param onProgress The callback when the load progresses
  43703. * @param fileName Defines the name of the file to load
  43704. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  43705. */
  43706. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  43707. meshes: AbstractMesh[];
  43708. particleSystems: IParticleSystem[];
  43709. skeletons: Skeleton[];
  43710. animationGroups: AnimationGroup[];
  43711. }>;
  43712. /**
  43713. * Load into a scene.
  43714. * @param scene The scene to load into
  43715. * @param data The data to import
  43716. * @param rootUrl The root url for scene and resources
  43717. * @param onProgress The callback when the load progresses
  43718. * @param fileName Defines the name of the file to load
  43719. * @returns Nothing
  43720. */
  43721. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  43722. /**
  43723. * Load into an asset container.
  43724. * @param scene The scene to load into
  43725. * @param data The data to import
  43726. * @param rootUrl The root url for scene and resources
  43727. * @param onProgress The callback when the load progresses
  43728. * @param fileName Defines the name of the file to load
  43729. * @returns The loaded asset container
  43730. */
  43731. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  43732. }
  43733. /**
  43734. * Class used to load scene from various file formats using registered plugins
  43735. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  43736. */
  43737. export class SceneLoader {
  43738. /**
  43739. * No logging while loading
  43740. */
  43741. static readonly NO_LOGGING: number;
  43742. /**
  43743. * Minimal logging while loading
  43744. */
  43745. static readonly MINIMAL_LOGGING: number;
  43746. /**
  43747. * Summary logging while loading
  43748. */
  43749. static readonly SUMMARY_LOGGING: number;
  43750. /**
  43751. * Detailled logging while loading
  43752. */
  43753. static readonly DETAILED_LOGGING: number;
  43754. /**
  43755. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  43756. */
  43757. static ForceFullSceneLoadingForIncremental: boolean;
  43758. /**
  43759. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  43760. */
  43761. static ShowLoadingScreen: boolean;
  43762. /**
  43763. * Defines the current logging level (while loading the scene)
  43764. * @ignorenaming
  43765. */
  43766. static loggingLevel: number;
  43767. /**
  43768. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  43769. */
  43770. static CleanBoneMatrixWeights: boolean;
  43771. /**
  43772. * Event raised when a plugin is used to load a scene
  43773. */
  43774. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43775. private static _registeredPlugins;
  43776. private static _getDefaultPlugin;
  43777. private static _getPluginForExtension;
  43778. private static _getPluginForDirectLoad;
  43779. private static _getPluginForFilename;
  43780. private static _getDirectLoad;
  43781. private static _loadData;
  43782. private static _getFileInfo;
  43783. /**
  43784. * Gets a plugin that can load the given extension
  43785. * @param extension defines the extension to load
  43786. * @returns a plugin or null if none works
  43787. */
  43788. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  43789. /**
  43790. * Gets a boolean indicating that the given extension can be loaded
  43791. * @param extension defines the extension to load
  43792. * @returns true if the extension is supported
  43793. */
  43794. static IsPluginForExtensionAvailable(extension: string): boolean;
  43795. /**
  43796. * Adds a new plugin to the list of registered plugins
  43797. * @param plugin defines the plugin to add
  43798. */
  43799. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  43800. /**
  43801. * Import meshes into a scene
  43802. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43803. * @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)
  43804. * @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)
  43805. * @param scene the instance of BABYLON.Scene to append to
  43806. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  43807. * @param onProgress a callback with a progress event for each file being loaded
  43808. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43809. * @param pluginExtension the extension used to determine the plugin
  43810. * @returns The loaded plugin
  43811. */
  43812. 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: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43813. /**
  43814. * Import meshes into a scene
  43815. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43816. * @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)
  43817. * @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)
  43818. * @param scene the instance of BABYLON.Scene to append to
  43819. * @param onProgress a callback with a progress event for each file being loaded
  43820. * @param pluginExtension the extension used to determine the plugin
  43821. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  43822. */
  43823. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  43824. meshes: AbstractMesh[];
  43825. particleSystems: IParticleSystem[];
  43826. skeletons: Skeleton[];
  43827. animationGroups: AnimationGroup[];
  43828. }>;
  43829. /**
  43830. * Load a scene
  43831. * @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)
  43832. * @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)
  43833. * @param engine is the instance of BABYLON.Engine to use to create the scene
  43834. * @param onSuccess a callback with the scene when import succeeds
  43835. * @param onProgress a callback with a progress event for each file being loaded
  43836. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43837. * @param pluginExtension the extension used to determine the plugin
  43838. * @returns The loaded plugin
  43839. */
  43840. static Load(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43841. /**
  43842. * Load a scene
  43843. * @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)
  43844. * @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)
  43845. * @param engine is the instance of BABYLON.Engine to use to create the scene
  43846. * @param onProgress a callback with a progress event for each file being loaded
  43847. * @param pluginExtension the extension used to determine the plugin
  43848. * @returns The loaded scene
  43849. */
  43850. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  43851. /**
  43852. * Append a scene
  43853. * @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)
  43854. * @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)
  43855. * @param scene is the instance of BABYLON.Scene to append to
  43856. * @param onSuccess a callback with the scene when import succeeds
  43857. * @param onProgress a callback with a progress event for each file being loaded
  43858. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43859. * @param pluginExtension the extension used to determine the plugin
  43860. * @returns The loaded plugin
  43861. */
  43862. static Append(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43863. /**
  43864. * Append a scene
  43865. * @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)
  43866. * @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)
  43867. * @param scene is the instance of BABYLON.Scene to append to
  43868. * @param onProgress a callback with a progress event for each file being loaded
  43869. * @param pluginExtension the extension used to determine the plugin
  43870. * @returns The given scene
  43871. */
  43872. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  43873. /**
  43874. * Load a scene into an asset container
  43875. * @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)
  43876. * @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)
  43877. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  43878. * @param onSuccess a callback with the scene when import succeeds
  43879. * @param onProgress a callback with a progress event for each file being loaded
  43880. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43881. * @param pluginExtension the extension used to determine the plugin
  43882. * @returns The loaded plugin
  43883. */
  43884. static LoadAssetContainer(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43885. /**
  43886. * Load a scene into an asset container
  43887. * @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)
  43888. * @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)
  43889. * @param scene is the instance of Scene to append to
  43890. * @param onProgress a callback with a progress event for each file being loaded
  43891. * @param pluginExtension the extension used to determine the plugin
  43892. * @returns The loaded asset container
  43893. */
  43894. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  43895. }
  43896. }
  43897. declare module "babylonjs/Gamepads/Controllers/genericController" {
  43898. import { Scene } from "babylonjs/scene";
  43899. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43900. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43901. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43902. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43903. /**
  43904. * Generic Controller
  43905. */
  43906. export class GenericController extends WebVRController {
  43907. /**
  43908. * Base Url for the controller model.
  43909. */
  43910. static readonly MODEL_BASE_URL: string;
  43911. /**
  43912. * File name for the controller model.
  43913. */
  43914. static readonly MODEL_FILENAME: string;
  43915. /**
  43916. * Creates a new GenericController from a gamepad
  43917. * @param vrGamepad the gamepad that the controller should be created from
  43918. */
  43919. constructor(vrGamepad: any);
  43920. /**
  43921. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  43922. * @param scene scene in which to add meshes
  43923. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  43924. */
  43925. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  43926. /**
  43927. * Called once for each button that changed state since the last frame
  43928. * @param buttonIdx Which button index changed
  43929. * @param state New state of the button
  43930. * @param changes Which properties on the state changed since last frame
  43931. */
  43932. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  43933. }
  43934. }
  43935. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  43936. import { Observable } from "babylonjs/Misc/observable";
  43937. import { Scene } from "babylonjs/scene";
  43938. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43939. import { Ray } from "babylonjs/Culling/ray";
  43940. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43941. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43942. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43943. /**
  43944. * Defines the WindowsMotionController object that the state of the windows motion controller
  43945. */
  43946. export class WindowsMotionController extends WebVRController {
  43947. /**
  43948. * The base url used to load the left and right controller models
  43949. */
  43950. static MODEL_BASE_URL: string;
  43951. /**
  43952. * The name of the left controller model file
  43953. */
  43954. static MODEL_LEFT_FILENAME: string;
  43955. /**
  43956. * The name of the right controller model file
  43957. */
  43958. static MODEL_RIGHT_FILENAME: string;
  43959. /**
  43960. * The controller name prefix for this controller type
  43961. */
  43962. static readonly GAMEPAD_ID_PREFIX: string;
  43963. /**
  43964. * The controller id pattern for this controller type
  43965. */
  43966. private static readonly GAMEPAD_ID_PATTERN;
  43967. private _loadedMeshInfo;
  43968. private readonly _mapping;
  43969. /**
  43970. * Fired when the trackpad on this controller is clicked
  43971. */
  43972. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  43973. /**
  43974. * Fired when the trackpad on this controller is modified
  43975. */
  43976. onTrackpadValuesChangedObservable: Observable<StickValues>;
  43977. /**
  43978. * The current x and y values of this controller's trackpad
  43979. */
  43980. trackpad: StickValues;
  43981. /**
  43982. * Creates a new WindowsMotionController from a gamepad
  43983. * @param vrGamepad the gamepad that the controller should be created from
  43984. */
  43985. constructor(vrGamepad: any);
  43986. /**
  43987. * Fired when the trigger on this controller is modified
  43988. */
  43989. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43990. /**
  43991. * Fired when the menu button on this controller is modified
  43992. */
  43993. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43994. /**
  43995. * Fired when the grip button on this controller is modified
  43996. */
  43997. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43998. /**
  43999. * Fired when the thumbstick button on this controller is modified
  44000. */
  44001. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44002. /**
  44003. * Fired when the touchpad button on this controller is modified
  44004. */
  44005. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44006. /**
  44007. * Fired when the touchpad values on this controller are modified
  44008. */
  44009. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  44010. private _updateTrackpad;
  44011. /**
  44012. * Called once per frame by the engine.
  44013. */
  44014. update(): void;
  44015. /**
  44016. * Called once for each button that changed state since the last frame
  44017. * @param buttonIdx Which button index changed
  44018. * @param state New state of the button
  44019. * @param changes Which properties on the state changed since last frame
  44020. */
  44021. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44022. /**
  44023. * Moves the buttons on the controller mesh based on their current state
  44024. * @param buttonName the name of the button to move
  44025. * @param buttonValue the value of the button which determines the buttons new position
  44026. */
  44027. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  44028. /**
  44029. * Moves the axis on the controller mesh based on its current state
  44030. * @param axis the index of the axis
  44031. * @param axisValue the value of the axis which determines the meshes new position
  44032. * @hidden
  44033. */
  44034. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  44035. /**
  44036. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44037. * @param scene scene in which to add meshes
  44038. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44039. */
  44040. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  44041. /**
  44042. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  44043. * can be transformed by button presses and axes values, based on this._mapping.
  44044. *
  44045. * @param scene scene in which the meshes exist
  44046. * @param meshes list of meshes that make up the controller model to process
  44047. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  44048. */
  44049. private processModel;
  44050. private createMeshInfo;
  44051. /**
  44052. * Gets the ray of the controller in the direction the controller is pointing
  44053. * @param length the length the resulting ray should be
  44054. * @returns a ray in the direction the controller is pointing
  44055. */
  44056. getForwardRay(length?: number): Ray;
  44057. /**
  44058. * Disposes of the controller
  44059. */
  44060. dispose(): void;
  44061. }
  44062. }
  44063. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  44064. import { Observable } from "babylonjs/Misc/observable";
  44065. import { Scene } from "babylonjs/scene";
  44066. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44067. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44068. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44069. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44070. /**
  44071. * Oculus Touch Controller
  44072. */
  44073. export class OculusTouchController extends WebVRController {
  44074. /**
  44075. * Base Url for the controller model.
  44076. */
  44077. static MODEL_BASE_URL: string;
  44078. /**
  44079. * File name for the left controller model.
  44080. */
  44081. static MODEL_LEFT_FILENAME: string;
  44082. /**
  44083. * File name for the right controller model.
  44084. */
  44085. static MODEL_RIGHT_FILENAME: string;
  44086. /**
  44087. * Base Url for the Quest controller model.
  44088. */
  44089. static QUEST_MODEL_BASE_URL: string;
  44090. /**
  44091. * @hidden
  44092. * If the controllers are running on a device that needs the updated Quest controller models
  44093. */
  44094. static _IsQuest: boolean;
  44095. /**
  44096. * Fired when the secondary trigger on this controller is modified
  44097. */
  44098. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  44099. /**
  44100. * Fired when the thumb rest on this controller is modified
  44101. */
  44102. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  44103. /**
  44104. * Creates a new OculusTouchController from a gamepad
  44105. * @param vrGamepad the gamepad that the controller should be created from
  44106. */
  44107. constructor(vrGamepad: any);
  44108. /**
  44109. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44110. * @param scene scene in which to add meshes
  44111. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44112. */
  44113. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44114. /**
  44115. * Fired when the A button on this controller is modified
  44116. */
  44117. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44118. /**
  44119. * Fired when the B button on this controller is modified
  44120. */
  44121. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44122. /**
  44123. * Fired when the X button on this controller is modified
  44124. */
  44125. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44126. /**
  44127. * Fired when the Y button on this controller is modified
  44128. */
  44129. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44130. /**
  44131. * Called once for each button that changed state since the last frame
  44132. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  44133. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  44134. * 2) secondary trigger (same)
  44135. * 3) A (right) X (left), touch, pressed = value
  44136. * 4) B / Y
  44137. * 5) thumb rest
  44138. * @param buttonIdx Which button index changed
  44139. * @param state New state of the button
  44140. * @param changes Which properties on the state changed since last frame
  44141. */
  44142. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44143. }
  44144. }
  44145. declare module "babylonjs/Gamepads/Controllers/viveController" {
  44146. import { Scene } from "babylonjs/scene";
  44147. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44148. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44149. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44150. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44151. import { Observable } from "babylonjs/Misc/observable";
  44152. /**
  44153. * Vive Controller
  44154. */
  44155. export class ViveController extends WebVRController {
  44156. /**
  44157. * Base Url for the controller model.
  44158. */
  44159. static MODEL_BASE_URL: string;
  44160. /**
  44161. * File name for the controller model.
  44162. */
  44163. static MODEL_FILENAME: string;
  44164. /**
  44165. * Creates a new ViveController from a gamepad
  44166. * @param vrGamepad the gamepad that the controller should be created from
  44167. */
  44168. constructor(vrGamepad: any);
  44169. /**
  44170. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44171. * @param scene scene in which to add meshes
  44172. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44173. */
  44174. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44175. /**
  44176. * Fired when the left button on this controller is modified
  44177. */
  44178. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44179. /**
  44180. * Fired when the right button on this controller is modified
  44181. */
  44182. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44183. /**
  44184. * Fired when the menu button on this controller is modified
  44185. */
  44186. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44187. /**
  44188. * Called once for each button that changed state since the last frame
  44189. * Vive mapping:
  44190. * 0: touchpad
  44191. * 1: trigger
  44192. * 2: left AND right buttons
  44193. * 3: menu button
  44194. * @param buttonIdx Which button index changed
  44195. * @param state New state of the button
  44196. * @param changes Which properties on the state changed since last frame
  44197. */
  44198. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44199. }
  44200. }
  44201. declare module "babylonjs/Cameras/XR/webXRControllerModelLoader" {
  44202. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  44203. /**
  44204. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  44205. */
  44206. export class WebXRControllerModelLoader {
  44207. /**
  44208. * Creates the WebXRControllerModelLoader
  44209. * @param input xr input that creates the controllers
  44210. */
  44211. constructor(input: WebXRInput);
  44212. }
  44213. }
  44214. declare module "babylonjs/Cameras/XR/index" {
  44215. export * from "babylonjs/Cameras/XR/webXRCamera";
  44216. export * from "babylonjs/Cameras/XR/webXREnterExitUI";
  44217. export * from "babylonjs/Cameras/XR/webXRExperienceHelper";
  44218. export * from "babylonjs/Cameras/XR/webXRInput";
  44219. export * from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  44220. export * from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  44221. export * from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  44222. export * from "babylonjs/Cameras/XR/webXRController";
  44223. export * from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  44224. export * from "babylonjs/Cameras/XR/webXRTypes";
  44225. export * from "babylonjs/Cameras/XR/webXRSessionManager";
  44226. }
  44227. declare module "babylonjs/Cameras/RigModes/index" {
  44228. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  44229. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  44230. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  44231. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  44232. }
  44233. declare module "babylonjs/Cameras/index" {
  44234. export * from "babylonjs/Cameras/Inputs/index";
  44235. export * from "babylonjs/Cameras/cameraInputsManager";
  44236. export * from "babylonjs/Cameras/camera";
  44237. export * from "babylonjs/Cameras/targetCamera";
  44238. export * from "babylonjs/Cameras/freeCamera";
  44239. export * from "babylonjs/Cameras/freeCameraInputsManager";
  44240. export * from "babylonjs/Cameras/touchCamera";
  44241. export * from "babylonjs/Cameras/arcRotateCamera";
  44242. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44243. export * from "babylonjs/Cameras/deviceOrientationCamera";
  44244. export * from "babylonjs/Cameras/flyCamera";
  44245. export * from "babylonjs/Cameras/flyCameraInputsManager";
  44246. export * from "babylonjs/Cameras/followCamera";
  44247. export * from "babylonjs/Cameras/followCameraInputsManager";
  44248. export * from "babylonjs/Cameras/gamepadCamera";
  44249. export * from "babylonjs/Cameras/Stereoscopic/index";
  44250. export * from "babylonjs/Cameras/universalCamera";
  44251. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  44252. export * from "babylonjs/Cameras/VR/index";
  44253. export * from "babylonjs/Cameras/XR/index";
  44254. export * from "babylonjs/Cameras/RigModes/index";
  44255. }
  44256. declare module "babylonjs/Collisions/index" {
  44257. export * from "babylonjs/Collisions/collider";
  44258. export * from "babylonjs/Collisions/collisionCoordinator";
  44259. export * from "babylonjs/Collisions/pickingInfo";
  44260. export * from "babylonjs/Collisions/intersectionInfo";
  44261. export * from "babylonjs/Collisions/meshCollisionData";
  44262. }
  44263. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  44264. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  44265. import { Vector3 } from "babylonjs/Maths/math.vector";
  44266. import { Ray } from "babylonjs/Culling/ray";
  44267. import { Plane } from "babylonjs/Maths/math.plane";
  44268. /**
  44269. * Contains an array of blocks representing the octree
  44270. */
  44271. export interface IOctreeContainer<T> {
  44272. /**
  44273. * Blocks within the octree
  44274. */
  44275. blocks: Array<OctreeBlock<T>>;
  44276. }
  44277. /**
  44278. * Class used to store a cell in an octree
  44279. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44280. */
  44281. export class OctreeBlock<T> {
  44282. /**
  44283. * Gets the content of the current block
  44284. */
  44285. entries: T[];
  44286. /**
  44287. * Gets the list of block children
  44288. */
  44289. blocks: Array<OctreeBlock<T>>;
  44290. private _depth;
  44291. private _maxDepth;
  44292. private _capacity;
  44293. private _minPoint;
  44294. private _maxPoint;
  44295. private _boundingVectors;
  44296. private _creationFunc;
  44297. /**
  44298. * Creates a new block
  44299. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  44300. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  44301. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  44302. * @param depth defines the current depth of this block in the octree
  44303. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  44304. * @param creationFunc defines a callback to call when an element is added to the block
  44305. */
  44306. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  44307. /**
  44308. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  44309. */
  44310. readonly capacity: number;
  44311. /**
  44312. * Gets the minimum vector (in world space) of the block's bounding box
  44313. */
  44314. readonly minPoint: Vector3;
  44315. /**
  44316. * Gets the maximum vector (in world space) of the block's bounding box
  44317. */
  44318. readonly maxPoint: Vector3;
  44319. /**
  44320. * Add a new element to this block
  44321. * @param entry defines the element to add
  44322. */
  44323. addEntry(entry: T): void;
  44324. /**
  44325. * Remove an element from this block
  44326. * @param entry defines the element to remove
  44327. */
  44328. removeEntry(entry: T): void;
  44329. /**
  44330. * Add an array of elements to this block
  44331. * @param entries defines the array of elements to add
  44332. */
  44333. addEntries(entries: T[]): void;
  44334. /**
  44335. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  44336. * @param frustumPlanes defines the frustum planes to test
  44337. * @param selection defines the array to store current content if selection is positive
  44338. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44339. */
  44340. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  44341. /**
  44342. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  44343. * @param sphereCenter defines the bounding sphere center
  44344. * @param sphereRadius defines the bounding sphere radius
  44345. * @param selection defines the array to store current content if selection is positive
  44346. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44347. */
  44348. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  44349. /**
  44350. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  44351. * @param ray defines the ray to test with
  44352. * @param selection defines the array to store current content if selection is positive
  44353. */
  44354. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  44355. /**
  44356. * Subdivide the content into child blocks (this block will then be empty)
  44357. */
  44358. createInnerBlocks(): void;
  44359. /**
  44360. * @hidden
  44361. */
  44362. 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;
  44363. }
  44364. }
  44365. declare module "babylonjs/Culling/Octrees/octree" {
  44366. import { SmartArray } from "babylonjs/Misc/smartArray";
  44367. import { Vector3 } from "babylonjs/Maths/math.vector";
  44368. import { SubMesh } from "babylonjs/Meshes/subMesh";
  44369. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44370. import { Ray } from "babylonjs/Culling/ray";
  44371. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  44372. import { Plane } from "babylonjs/Maths/math.plane";
  44373. /**
  44374. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  44375. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44376. */
  44377. export class Octree<T> {
  44378. /** 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.) */
  44379. maxDepth: number;
  44380. /**
  44381. * Blocks within the octree containing objects
  44382. */
  44383. blocks: Array<OctreeBlock<T>>;
  44384. /**
  44385. * Content stored in the octree
  44386. */
  44387. dynamicContent: T[];
  44388. private _maxBlockCapacity;
  44389. private _selectionContent;
  44390. private _creationFunc;
  44391. /**
  44392. * Creates a octree
  44393. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44394. * @param creationFunc function to be used to instatiate the octree
  44395. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  44396. * @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.)
  44397. */
  44398. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  44399. /** 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.) */
  44400. maxDepth?: number);
  44401. /**
  44402. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  44403. * @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);
  44404. * @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);
  44405. * @param entries meshes to be added to the octree blocks
  44406. */
  44407. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  44408. /**
  44409. * Adds a mesh to the octree
  44410. * @param entry Mesh to add to the octree
  44411. */
  44412. addMesh(entry: T): void;
  44413. /**
  44414. * Remove an element from the octree
  44415. * @param entry defines the element to remove
  44416. */
  44417. removeMesh(entry: T): void;
  44418. /**
  44419. * Selects an array of meshes within the frustum
  44420. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  44421. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  44422. * @returns array of meshes within the frustum
  44423. */
  44424. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  44425. /**
  44426. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  44427. * @param sphereCenter defines the bounding sphere center
  44428. * @param sphereRadius defines the bounding sphere radius
  44429. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44430. * @returns an array of objects that intersect the sphere
  44431. */
  44432. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  44433. /**
  44434. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  44435. * @param ray defines the ray to test with
  44436. * @returns array of intersected objects
  44437. */
  44438. intersectsRay(ray: Ray): SmartArray<T>;
  44439. /**
  44440. * Adds a mesh into the octree block if it intersects the block
  44441. */
  44442. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  44443. /**
  44444. * Adds a submesh into the octree block if it intersects the block
  44445. */
  44446. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  44447. }
  44448. }
  44449. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  44450. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  44451. import { Scene } from "babylonjs/scene";
  44452. import { SubMesh } from "babylonjs/Meshes/subMesh";
  44453. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44454. import { Ray } from "babylonjs/Culling/ray";
  44455. import { Octree } from "babylonjs/Culling/Octrees/octree";
  44456. import { Collider } from "babylonjs/Collisions/collider";
  44457. module "babylonjs/scene" {
  44458. interface Scene {
  44459. /**
  44460. * @hidden
  44461. * Backing Filed
  44462. */
  44463. _selectionOctree: Octree<AbstractMesh>;
  44464. /**
  44465. * Gets the octree used to boost mesh selection (picking)
  44466. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44467. */
  44468. selectionOctree: Octree<AbstractMesh>;
  44469. /**
  44470. * Creates or updates the octree used to boost selection (picking)
  44471. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44472. * @param maxCapacity defines the maximum capacity per leaf
  44473. * @param maxDepth defines the maximum depth of the octree
  44474. * @returns an octree of AbstractMesh
  44475. */
  44476. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  44477. }
  44478. }
  44479. module "babylonjs/Meshes/abstractMesh" {
  44480. interface AbstractMesh {
  44481. /**
  44482. * @hidden
  44483. * Backing Field
  44484. */
  44485. _submeshesOctree: Octree<SubMesh>;
  44486. /**
  44487. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  44488. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  44489. * @param maxCapacity defines the maximum size of each block (64 by default)
  44490. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  44491. * @returns the new octree
  44492. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  44493. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44494. */
  44495. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  44496. }
  44497. }
  44498. /**
  44499. * Defines the octree scene component responsible to manage any octrees
  44500. * in a given scene.
  44501. */
  44502. export class OctreeSceneComponent {
  44503. /**
  44504. * The component name help to identify the component in the list of scene components.
  44505. */
  44506. readonly name: string;
  44507. /**
  44508. * The scene the component belongs to.
  44509. */
  44510. scene: Scene;
  44511. /**
  44512. * Indicates if the meshes have been checked to make sure they are isEnabled()
  44513. */
  44514. readonly checksIsEnabled: boolean;
  44515. /**
  44516. * Creates a new instance of the component for the given scene
  44517. * @param scene Defines the scene to register the component in
  44518. */
  44519. constructor(scene: Scene);
  44520. /**
  44521. * Registers the component in a given scene
  44522. */
  44523. register(): void;
  44524. /**
  44525. * Return the list of active meshes
  44526. * @returns the list of active meshes
  44527. */
  44528. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  44529. /**
  44530. * Return the list of active sub meshes
  44531. * @param mesh The mesh to get the candidates sub meshes from
  44532. * @returns the list of active sub meshes
  44533. */
  44534. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  44535. private _tempRay;
  44536. /**
  44537. * Return the list of sub meshes intersecting with a given local ray
  44538. * @param mesh defines the mesh to find the submesh for
  44539. * @param localRay defines the ray in local space
  44540. * @returns the list of intersecting sub meshes
  44541. */
  44542. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  44543. /**
  44544. * Return the list of sub meshes colliding with a collider
  44545. * @param mesh defines the mesh to find the submesh for
  44546. * @param collider defines the collider to evaluate the collision against
  44547. * @returns the list of colliding sub meshes
  44548. */
  44549. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  44550. /**
  44551. * Rebuilds the elements related to this component in case of
  44552. * context lost for instance.
  44553. */
  44554. rebuild(): void;
  44555. /**
  44556. * Disposes the component and the associated ressources.
  44557. */
  44558. dispose(): void;
  44559. }
  44560. }
  44561. declare module "babylonjs/Culling/Octrees/index" {
  44562. export * from "babylonjs/Culling/Octrees/octree";
  44563. export * from "babylonjs/Culling/Octrees/octreeBlock";
  44564. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  44565. }
  44566. declare module "babylonjs/Culling/index" {
  44567. export * from "babylonjs/Culling/boundingBox";
  44568. export * from "babylonjs/Culling/boundingInfo";
  44569. export * from "babylonjs/Culling/boundingSphere";
  44570. export * from "babylonjs/Culling/Octrees/index";
  44571. export * from "babylonjs/Culling/ray";
  44572. }
  44573. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  44574. import { IDisposable, Scene } from "babylonjs/scene";
  44575. import { Nullable } from "babylonjs/types";
  44576. import { Observable } from "babylonjs/Misc/observable";
  44577. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44578. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  44579. import { Camera } from "babylonjs/Cameras/camera";
  44580. /**
  44581. * Renders a layer on top of an existing scene
  44582. */
  44583. export class UtilityLayerRenderer implements IDisposable {
  44584. /** the original scene that will be rendered on top of */
  44585. originalScene: Scene;
  44586. private _pointerCaptures;
  44587. private _lastPointerEvents;
  44588. private static _DefaultUtilityLayer;
  44589. private static _DefaultKeepDepthUtilityLayer;
  44590. private _sharedGizmoLight;
  44591. private _renderCamera;
  44592. /**
  44593. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  44594. * @returns the camera that is used when rendering the utility layer
  44595. */
  44596. getRenderCamera(): Nullable<Camera>;
  44597. /**
  44598. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  44599. * @param cam the camera that should be used when rendering the utility layer
  44600. */
  44601. setRenderCamera(cam: Nullable<Camera>): void;
  44602. /**
  44603. * @hidden
  44604. * Light which used by gizmos to get light shading
  44605. */
  44606. _getSharedGizmoLight(): HemisphericLight;
  44607. /**
  44608. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  44609. */
  44610. pickUtilitySceneFirst: boolean;
  44611. /**
  44612. * 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)
  44613. */
  44614. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  44615. /**
  44616. * 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)
  44617. */
  44618. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  44619. /**
  44620. * The scene that is rendered on top of the original scene
  44621. */
  44622. utilityLayerScene: Scene;
  44623. /**
  44624. * If the utility layer should automatically be rendered on top of existing scene
  44625. */
  44626. shouldRender: boolean;
  44627. /**
  44628. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  44629. */
  44630. onlyCheckPointerDownEvents: boolean;
  44631. /**
  44632. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  44633. */
  44634. processAllEvents: boolean;
  44635. /**
  44636. * Observable raised when the pointer move from the utility layer scene to the main scene
  44637. */
  44638. onPointerOutObservable: Observable<number>;
  44639. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  44640. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  44641. private _afterRenderObserver;
  44642. private _sceneDisposeObserver;
  44643. private _originalPointerObserver;
  44644. /**
  44645. * Instantiates a UtilityLayerRenderer
  44646. * @param originalScene the original scene that will be rendered on top of
  44647. * @param handleEvents boolean indicating if the utility layer should handle events
  44648. */
  44649. constructor(
  44650. /** the original scene that will be rendered on top of */
  44651. originalScene: Scene, handleEvents?: boolean);
  44652. private _notifyObservers;
  44653. /**
  44654. * Renders the utility layers scene on top of the original scene
  44655. */
  44656. render(): void;
  44657. /**
  44658. * Disposes of the renderer
  44659. */
  44660. dispose(): void;
  44661. private _updateCamera;
  44662. }
  44663. }
  44664. declare module "babylonjs/Gizmos/gizmo" {
  44665. import { Nullable } from "babylonjs/types";
  44666. import { IDisposable } from "babylonjs/scene";
  44667. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44668. import { Mesh } from "babylonjs/Meshes/mesh";
  44669. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44670. /**
  44671. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  44672. */
  44673. export class Gizmo implements IDisposable {
  44674. /** The utility layer the gizmo will be added to */
  44675. gizmoLayer: UtilityLayerRenderer;
  44676. /**
  44677. * The root mesh of the gizmo
  44678. */
  44679. _rootMesh: Mesh;
  44680. private _attachedMesh;
  44681. /**
  44682. * Ratio for the scale of the gizmo (Default: 1)
  44683. */
  44684. scaleRatio: number;
  44685. /**
  44686. * If a custom mesh has been set (Default: false)
  44687. */
  44688. protected _customMeshSet: boolean;
  44689. /**
  44690. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  44691. * * When set, interactions will be enabled
  44692. */
  44693. attachedMesh: Nullable<AbstractMesh>;
  44694. /**
  44695. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  44696. * @param mesh The mesh to replace the default mesh of the gizmo
  44697. */
  44698. setCustomMesh(mesh: Mesh): void;
  44699. /**
  44700. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  44701. */
  44702. updateGizmoRotationToMatchAttachedMesh: boolean;
  44703. /**
  44704. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  44705. */
  44706. updateGizmoPositionToMatchAttachedMesh: boolean;
  44707. /**
  44708. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  44709. */
  44710. updateScale: boolean;
  44711. protected _interactionsEnabled: boolean;
  44712. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44713. private _beforeRenderObserver;
  44714. private _tempVector;
  44715. /**
  44716. * Creates a gizmo
  44717. * @param gizmoLayer The utility layer the gizmo will be added to
  44718. */
  44719. constructor(
  44720. /** The utility layer the gizmo will be added to */
  44721. gizmoLayer?: UtilityLayerRenderer);
  44722. /**
  44723. * Updates the gizmo to match the attached mesh's position/rotation
  44724. */
  44725. protected _update(): void;
  44726. /**
  44727. * Disposes of the gizmo
  44728. */
  44729. dispose(): void;
  44730. }
  44731. }
  44732. declare module "babylonjs/Gizmos/planeDragGizmo" {
  44733. import { Observable } from "babylonjs/Misc/observable";
  44734. import { Nullable } from "babylonjs/types";
  44735. import { Vector3 } from "babylonjs/Maths/math.vector";
  44736. import { Color3 } from "babylonjs/Maths/math.color";
  44737. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44738. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44739. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  44740. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44741. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44742. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  44743. import { Scene } from "babylonjs/scene";
  44744. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  44745. /**
  44746. * Single plane drag gizmo
  44747. */
  44748. export class PlaneDragGizmo extends Gizmo {
  44749. /**
  44750. * Drag behavior responsible for the gizmos dragging interactions
  44751. */
  44752. dragBehavior: PointerDragBehavior;
  44753. private _pointerObserver;
  44754. /**
  44755. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44756. */
  44757. snapDistance: number;
  44758. /**
  44759. * Event that fires each time the gizmo snaps to a new location.
  44760. * * snapDistance is the the change in distance
  44761. */
  44762. onSnapObservable: Observable<{
  44763. snapDistance: number;
  44764. }>;
  44765. private _plane;
  44766. private _coloredMaterial;
  44767. private _hoverMaterial;
  44768. private _isEnabled;
  44769. private _parent;
  44770. /** @hidden */
  44771. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  44772. /** @hidden */
  44773. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  44774. /**
  44775. * Creates a PlaneDragGizmo
  44776. * @param gizmoLayer The utility layer the gizmo will be added to
  44777. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  44778. * @param color The color of the gizmo
  44779. */
  44780. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  44781. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44782. /**
  44783. * If the gizmo is enabled
  44784. */
  44785. isEnabled: boolean;
  44786. /**
  44787. * Disposes of the gizmo
  44788. */
  44789. dispose(): void;
  44790. }
  44791. }
  44792. declare module "babylonjs/Gizmos/positionGizmo" {
  44793. import { Observable } from "babylonjs/Misc/observable";
  44794. import { Nullable } from "babylonjs/types";
  44795. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44796. import { Mesh } from "babylonjs/Meshes/mesh";
  44797. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44798. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  44799. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  44800. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44801. /**
  44802. * Gizmo that enables dragging a mesh along 3 axis
  44803. */
  44804. export class PositionGizmo extends Gizmo {
  44805. /**
  44806. * Internal gizmo used for interactions on the x axis
  44807. */
  44808. xGizmo: AxisDragGizmo;
  44809. /**
  44810. * Internal gizmo used for interactions on the y axis
  44811. */
  44812. yGizmo: AxisDragGizmo;
  44813. /**
  44814. * Internal gizmo used for interactions on the z axis
  44815. */
  44816. zGizmo: AxisDragGizmo;
  44817. /**
  44818. * Internal gizmo used for interactions on the yz plane
  44819. */
  44820. xPlaneGizmo: PlaneDragGizmo;
  44821. /**
  44822. * Internal gizmo used for interactions on the xz plane
  44823. */
  44824. yPlaneGizmo: PlaneDragGizmo;
  44825. /**
  44826. * Internal gizmo used for interactions on the xy plane
  44827. */
  44828. zPlaneGizmo: PlaneDragGizmo;
  44829. /**
  44830. * private variables
  44831. */
  44832. private _meshAttached;
  44833. private _updateGizmoRotationToMatchAttachedMesh;
  44834. private _snapDistance;
  44835. private _scaleRatio;
  44836. /** Fires an event when any of it's sub gizmos are dragged */
  44837. onDragStartObservable: Observable<unknown>;
  44838. /** Fires an event when any of it's sub gizmos are released from dragging */
  44839. onDragEndObservable: Observable<unknown>;
  44840. /**
  44841. * If set to true, planar drag is enabled
  44842. */
  44843. private _planarGizmoEnabled;
  44844. attachedMesh: Nullable<AbstractMesh>;
  44845. /**
  44846. * Creates a PositionGizmo
  44847. * @param gizmoLayer The utility layer the gizmo will be added to
  44848. */
  44849. constructor(gizmoLayer?: UtilityLayerRenderer);
  44850. /**
  44851. * If the planar drag gizmo is enabled
  44852. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  44853. */
  44854. planarGizmoEnabled: boolean;
  44855. updateGizmoRotationToMatchAttachedMesh: boolean;
  44856. /**
  44857. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44858. */
  44859. snapDistance: number;
  44860. /**
  44861. * Ratio for the scale of the gizmo (Default: 1)
  44862. */
  44863. scaleRatio: number;
  44864. /**
  44865. * Disposes of the gizmo
  44866. */
  44867. dispose(): void;
  44868. /**
  44869. * CustomMeshes are not supported by this gizmo
  44870. * @param mesh The mesh to replace the default mesh of the gizmo
  44871. */
  44872. setCustomMesh(mesh: Mesh): void;
  44873. }
  44874. }
  44875. declare module "babylonjs/Gizmos/axisDragGizmo" {
  44876. import { Observable } from "babylonjs/Misc/observable";
  44877. import { Nullable } from "babylonjs/types";
  44878. import { Vector3 } from "babylonjs/Maths/math.vector";
  44879. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44880. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44881. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  44882. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44883. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44884. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  44885. import { Scene } from "babylonjs/scene";
  44886. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  44887. import { Color3 } from "babylonjs/Maths/math.color";
  44888. /**
  44889. * Single axis drag gizmo
  44890. */
  44891. export class AxisDragGizmo extends Gizmo {
  44892. /**
  44893. * Drag behavior responsible for the gizmos dragging interactions
  44894. */
  44895. dragBehavior: PointerDragBehavior;
  44896. private _pointerObserver;
  44897. /**
  44898. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44899. */
  44900. snapDistance: number;
  44901. /**
  44902. * Event that fires each time the gizmo snaps to a new location.
  44903. * * snapDistance is the the change in distance
  44904. */
  44905. onSnapObservable: Observable<{
  44906. snapDistance: number;
  44907. }>;
  44908. private _isEnabled;
  44909. private _parent;
  44910. private _arrow;
  44911. private _coloredMaterial;
  44912. private _hoverMaterial;
  44913. /** @hidden */
  44914. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  44915. /** @hidden */
  44916. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  44917. /**
  44918. * Creates an AxisDragGizmo
  44919. * @param gizmoLayer The utility layer the gizmo will be added to
  44920. * @param dragAxis The axis which the gizmo will be able to drag on
  44921. * @param color The color of the gizmo
  44922. */
  44923. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  44924. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44925. /**
  44926. * If the gizmo is enabled
  44927. */
  44928. isEnabled: boolean;
  44929. /**
  44930. * Disposes of the gizmo
  44931. */
  44932. dispose(): void;
  44933. }
  44934. }
  44935. declare module "babylonjs/Debug/axesViewer" {
  44936. import { Vector3 } from "babylonjs/Maths/math.vector";
  44937. import { Nullable } from "babylonjs/types";
  44938. import { Scene } from "babylonjs/scene";
  44939. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44940. /**
  44941. * The Axes viewer will show 3 axes in a specific point in space
  44942. */
  44943. export class AxesViewer {
  44944. private _xAxis;
  44945. private _yAxis;
  44946. private _zAxis;
  44947. private _scaleLinesFactor;
  44948. private _instanced;
  44949. /**
  44950. * Gets the hosting scene
  44951. */
  44952. scene: Scene;
  44953. /**
  44954. * Gets or sets a number used to scale line length
  44955. */
  44956. scaleLines: number;
  44957. /** Gets the node hierarchy used to render x-axis */
  44958. readonly xAxis: TransformNode;
  44959. /** Gets the node hierarchy used to render y-axis */
  44960. readonly yAxis: TransformNode;
  44961. /** Gets the node hierarchy used to render z-axis */
  44962. readonly zAxis: TransformNode;
  44963. /**
  44964. * Creates a new AxesViewer
  44965. * @param scene defines the hosting scene
  44966. * @param scaleLines defines a number used to scale line length (1 by default)
  44967. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  44968. * @param xAxis defines the node hierarchy used to render the x-axis
  44969. * @param yAxis defines the node hierarchy used to render the y-axis
  44970. * @param zAxis defines the node hierarchy used to render the z-axis
  44971. */
  44972. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  44973. /**
  44974. * Force the viewer to update
  44975. * @param position defines the position of the viewer
  44976. * @param xaxis defines the x axis of the viewer
  44977. * @param yaxis defines the y axis of the viewer
  44978. * @param zaxis defines the z axis of the viewer
  44979. */
  44980. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  44981. /**
  44982. * Creates an instance of this axes viewer.
  44983. * @returns a new axes viewer with instanced meshes
  44984. */
  44985. createInstance(): AxesViewer;
  44986. /** Releases resources */
  44987. dispose(): void;
  44988. private static _SetRenderingGroupId;
  44989. }
  44990. }
  44991. declare module "babylonjs/Debug/boneAxesViewer" {
  44992. import { Nullable } from "babylonjs/types";
  44993. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  44994. import { Vector3 } from "babylonjs/Maths/math.vector";
  44995. import { Mesh } from "babylonjs/Meshes/mesh";
  44996. import { Bone } from "babylonjs/Bones/bone";
  44997. import { Scene } from "babylonjs/scene";
  44998. /**
  44999. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  45000. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  45001. */
  45002. export class BoneAxesViewer extends AxesViewer {
  45003. /**
  45004. * Gets or sets the target mesh where to display the axes viewer
  45005. */
  45006. mesh: Nullable<Mesh>;
  45007. /**
  45008. * Gets or sets the target bone where to display the axes viewer
  45009. */
  45010. bone: Nullable<Bone>;
  45011. /** Gets current position */
  45012. pos: Vector3;
  45013. /** Gets direction of X axis */
  45014. xaxis: Vector3;
  45015. /** Gets direction of Y axis */
  45016. yaxis: Vector3;
  45017. /** Gets direction of Z axis */
  45018. zaxis: Vector3;
  45019. /**
  45020. * Creates a new BoneAxesViewer
  45021. * @param scene defines the hosting scene
  45022. * @param bone defines the target bone
  45023. * @param mesh defines the target mesh
  45024. * @param scaleLines defines a scaling factor for line length (1 by default)
  45025. */
  45026. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  45027. /**
  45028. * Force the viewer to update
  45029. */
  45030. update(): void;
  45031. /** Releases resources */
  45032. dispose(): void;
  45033. }
  45034. }
  45035. declare module "babylonjs/Debug/debugLayer" {
  45036. import { Scene } from "babylonjs/scene";
  45037. /**
  45038. * Interface used to define scene explorer extensibility option
  45039. */
  45040. export interface IExplorerExtensibilityOption {
  45041. /**
  45042. * Define the option label
  45043. */
  45044. label: string;
  45045. /**
  45046. * Defines the action to execute on click
  45047. */
  45048. action: (entity: any) => void;
  45049. }
  45050. /**
  45051. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  45052. */
  45053. export interface IExplorerExtensibilityGroup {
  45054. /**
  45055. * Defines a predicate to test if a given type mut be extended
  45056. */
  45057. predicate: (entity: any) => boolean;
  45058. /**
  45059. * Gets the list of options added to a type
  45060. */
  45061. entries: IExplorerExtensibilityOption[];
  45062. }
  45063. /**
  45064. * Interface used to define the options to use to create the Inspector
  45065. */
  45066. export interface IInspectorOptions {
  45067. /**
  45068. * Display in overlay mode (default: false)
  45069. */
  45070. overlay?: boolean;
  45071. /**
  45072. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  45073. */
  45074. globalRoot?: HTMLElement;
  45075. /**
  45076. * Display the Scene explorer
  45077. */
  45078. showExplorer?: boolean;
  45079. /**
  45080. * Display the property inspector
  45081. */
  45082. showInspector?: boolean;
  45083. /**
  45084. * Display in embed mode (both panes on the right)
  45085. */
  45086. embedMode?: boolean;
  45087. /**
  45088. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  45089. */
  45090. handleResize?: boolean;
  45091. /**
  45092. * Allow the panes to popup (default: true)
  45093. */
  45094. enablePopup?: boolean;
  45095. /**
  45096. * Allow the panes to be closed by users (default: true)
  45097. */
  45098. enableClose?: boolean;
  45099. /**
  45100. * Optional list of extensibility entries
  45101. */
  45102. explorerExtensibility?: IExplorerExtensibilityGroup[];
  45103. /**
  45104. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  45105. */
  45106. inspectorURL?: string;
  45107. }
  45108. module "babylonjs/scene" {
  45109. interface Scene {
  45110. /**
  45111. * @hidden
  45112. * Backing field
  45113. */
  45114. _debugLayer: DebugLayer;
  45115. /**
  45116. * Gets the debug layer (aka Inspector) associated with the scene
  45117. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45118. */
  45119. debugLayer: DebugLayer;
  45120. }
  45121. }
  45122. /**
  45123. * The debug layer (aka Inspector) is the go to tool in order to better understand
  45124. * what is happening in your scene
  45125. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45126. */
  45127. export class DebugLayer {
  45128. /**
  45129. * Define the url to get the inspector script from.
  45130. * By default it uses the babylonjs CDN.
  45131. * @ignoreNaming
  45132. */
  45133. static InspectorURL: string;
  45134. private _scene;
  45135. private BJSINSPECTOR;
  45136. private _onPropertyChangedObservable?;
  45137. /**
  45138. * Observable triggered when a property is changed through the inspector.
  45139. */
  45140. readonly onPropertyChangedObservable: any;
  45141. /**
  45142. * Instantiates a new debug layer.
  45143. * The debug layer (aka Inspector) is the go to tool in order to better understand
  45144. * what is happening in your scene
  45145. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45146. * @param scene Defines the scene to inspect
  45147. */
  45148. constructor(scene: Scene);
  45149. /** Creates the inspector window. */
  45150. private _createInspector;
  45151. /**
  45152. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  45153. * @param entity defines the entity to select
  45154. * @param lineContainerTitle defines the specific block to highlight
  45155. */
  45156. select(entity: any, lineContainerTitle?: string): void;
  45157. /** Get the inspector from bundle or global */
  45158. private _getGlobalInspector;
  45159. /**
  45160. * Get if the inspector is visible or not.
  45161. * @returns true if visible otherwise, false
  45162. */
  45163. isVisible(): boolean;
  45164. /**
  45165. * Hide the inspector and close its window.
  45166. */
  45167. hide(): void;
  45168. /**
  45169. * Launch the debugLayer.
  45170. * @param config Define the configuration of the inspector
  45171. * @return a promise fulfilled when the debug layer is visible
  45172. */
  45173. show(config?: IInspectorOptions): Promise<DebugLayer>;
  45174. }
  45175. }
  45176. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  45177. import { Nullable } from "babylonjs/types";
  45178. import { Scene } from "babylonjs/scene";
  45179. import { Vector4 } from "babylonjs/Maths/math.vector";
  45180. import { Color4 } from "babylonjs/Maths/math.color";
  45181. import { Mesh } from "babylonjs/Meshes/mesh";
  45182. /**
  45183. * Class containing static functions to help procedurally build meshes
  45184. */
  45185. export class BoxBuilder {
  45186. /**
  45187. * Creates a box mesh
  45188. * * The parameter `size` sets the size (float) of each box side (default 1)
  45189. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  45190. * * 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)
  45191. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  45192. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45193. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45194. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45195. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  45196. * @param name defines the name of the mesh
  45197. * @param options defines the options used to create the mesh
  45198. * @param scene defines the hosting scene
  45199. * @returns the box mesh
  45200. */
  45201. static CreateBox(name: string, options: {
  45202. size?: number;
  45203. width?: number;
  45204. height?: number;
  45205. depth?: number;
  45206. faceUV?: Vector4[];
  45207. faceColors?: Color4[];
  45208. sideOrientation?: number;
  45209. frontUVs?: Vector4;
  45210. backUVs?: Vector4;
  45211. wrap?: boolean;
  45212. topBaseAt?: number;
  45213. bottomBaseAt?: number;
  45214. updatable?: boolean;
  45215. }, scene?: Nullable<Scene>): Mesh;
  45216. }
  45217. }
  45218. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  45219. import { Vector4 } from "babylonjs/Maths/math.vector";
  45220. import { Mesh } from "babylonjs/Meshes/mesh";
  45221. import { Scene } from "babylonjs/scene";
  45222. import { Nullable } from "babylonjs/types";
  45223. /**
  45224. * Class containing static functions to help procedurally build meshes
  45225. */
  45226. export class SphereBuilder {
  45227. /**
  45228. * Creates a sphere mesh
  45229. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  45230. * * 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`)
  45231. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  45232. * * 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
  45233. * * 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)
  45234. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45235. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45236. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45237. * @param name defines the name of the mesh
  45238. * @param options defines the options used to create the mesh
  45239. * @param scene defines the hosting scene
  45240. * @returns the sphere mesh
  45241. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  45242. */
  45243. static CreateSphere(name: string, options: {
  45244. segments?: number;
  45245. diameter?: number;
  45246. diameterX?: number;
  45247. diameterY?: number;
  45248. diameterZ?: number;
  45249. arc?: number;
  45250. slice?: number;
  45251. sideOrientation?: number;
  45252. frontUVs?: Vector4;
  45253. backUVs?: Vector4;
  45254. updatable?: boolean;
  45255. }, scene?: Nullable<Scene>): Mesh;
  45256. }
  45257. }
  45258. declare module "babylonjs/Debug/physicsViewer" {
  45259. import { Nullable } from "babylonjs/types";
  45260. import { Scene } from "babylonjs/scene";
  45261. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45262. import { Mesh } from "babylonjs/Meshes/mesh";
  45263. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  45264. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  45265. /**
  45266. * Used to show the physics impostor around the specific mesh
  45267. */
  45268. export class PhysicsViewer {
  45269. /** @hidden */
  45270. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  45271. /** @hidden */
  45272. protected _meshes: Array<Nullable<AbstractMesh>>;
  45273. /** @hidden */
  45274. protected _scene: Nullable<Scene>;
  45275. /** @hidden */
  45276. protected _numMeshes: number;
  45277. /** @hidden */
  45278. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  45279. private _renderFunction;
  45280. private _utilityLayer;
  45281. private _debugBoxMesh;
  45282. private _debugSphereMesh;
  45283. private _debugCylinderMesh;
  45284. private _debugMaterial;
  45285. private _debugMeshMeshes;
  45286. /**
  45287. * Creates a new PhysicsViewer
  45288. * @param scene defines the hosting scene
  45289. */
  45290. constructor(scene: Scene);
  45291. /** @hidden */
  45292. protected _updateDebugMeshes(): void;
  45293. /**
  45294. * Renders a specified physic impostor
  45295. * @param impostor defines the impostor to render
  45296. * @param targetMesh defines the mesh represented by the impostor
  45297. * @returns the new debug mesh used to render the impostor
  45298. */
  45299. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  45300. /**
  45301. * Hides a specified physic impostor
  45302. * @param impostor defines the impostor to hide
  45303. */
  45304. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  45305. private _getDebugMaterial;
  45306. private _getDebugBoxMesh;
  45307. private _getDebugSphereMesh;
  45308. private _getDebugCylinderMesh;
  45309. private _getDebugMeshMesh;
  45310. private _getDebugMesh;
  45311. /** Releases all resources */
  45312. dispose(): void;
  45313. }
  45314. }
  45315. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  45316. import { Vector3 } from "babylonjs/Maths/math.vector";
  45317. import { Color4 } from "babylonjs/Maths/math.color";
  45318. import { Nullable } from "babylonjs/types";
  45319. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  45320. import { Scene } from "babylonjs/scene";
  45321. /**
  45322. * Class containing static functions to help procedurally build meshes
  45323. */
  45324. export class LinesBuilder {
  45325. /**
  45326. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  45327. * * 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
  45328. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  45329. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  45330. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  45331. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  45332. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  45333. * * 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
  45334. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  45335. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45336. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  45337. * @param name defines the name of the new line system
  45338. * @param options defines the options used to create the line system
  45339. * @param scene defines the hosting scene
  45340. * @returns a new line system mesh
  45341. */
  45342. static CreateLineSystem(name: string, options: {
  45343. lines: Vector3[][];
  45344. updatable?: boolean;
  45345. instance?: Nullable<LinesMesh>;
  45346. colors?: Nullable<Color4[][]>;
  45347. useVertexAlpha?: boolean;
  45348. }, scene: Nullable<Scene>): LinesMesh;
  45349. /**
  45350. * Creates a line mesh
  45351. * 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
  45352. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  45353. * * The parameter `points` is an array successive Vector3
  45354. * * 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
  45355. * * The optional parameter `colors` is an array of successive Color4, one per line point
  45356. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  45357. * * When updating an instance, remember that only point positions can change, not the number of points
  45358. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45359. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  45360. * @param name defines the name of the new line system
  45361. * @param options defines the options used to create the line system
  45362. * @param scene defines the hosting scene
  45363. * @returns a new line mesh
  45364. */
  45365. static CreateLines(name: string, options: {
  45366. points: Vector3[];
  45367. updatable?: boolean;
  45368. instance?: Nullable<LinesMesh>;
  45369. colors?: Color4[];
  45370. useVertexAlpha?: boolean;
  45371. }, scene?: Nullable<Scene>): LinesMesh;
  45372. /**
  45373. * Creates a dashed line mesh
  45374. * * 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
  45375. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  45376. * * The parameter `points` is an array successive Vector3
  45377. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  45378. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  45379. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  45380. * * 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
  45381. * * When updating an instance, remember that only point positions can change, not the number of points
  45382. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45383. * @param name defines the name of the mesh
  45384. * @param options defines the options used to create the mesh
  45385. * @param scene defines the hosting scene
  45386. * @returns the dashed line mesh
  45387. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  45388. */
  45389. static CreateDashedLines(name: string, options: {
  45390. points: Vector3[];
  45391. dashSize?: number;
  45392. gapSize?: number;
  45393. dashNb?: number;
  45394. updatable?: boolean;
  45395. instance?: LinesMesh;
  45396. }, scene?: Nullable<Scene>): LinesMesh;
  45397. }
  45398. }
  45399. declare module "babylonjs/Debug/rayHelper" {
  45400. import { Nullable } from "babylonjs/types";
  45401. import { Ray } from "babylonjs/Culling/ray";
  45402. import { Vector3 } from "babylonjs/Maths/math.vector";
  45403. import { Color3 } from "babylonjs/Maths/math.color";
  45404. import { Scene } from "babylonjs/scene";
  45405. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45406. import "babylonjs/Meshes/Builders/linesBuilder";
  45407. /**
  45408. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  45409. * in order to better appreciate the issue one might have.
  45410. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  45411. */
  45412. export class RayHelper {
  45413. /**
  45414. * Defines the ray we are currently tryin to visualize.
  45415. */
  45416. ray: Nullable<Ray>;
  45417. private _renderPoints;
  45418. private _renderLine;
  45419. private _renderFunction;
  45420. private _scene;
  45421. private _updateToMeshFunction;
  45422. private _attachedToMesh;
  45423. private _meshSpaceDirection;
  45424. private _meshSpaceOrigin;
  45425. /**
  45426. * Helper function to create a colored helper in a scene in one line.
  45427. * @param ray Defines the ray we are currently tryin to visualize
  45428. * @param scene Defines the scene the ray is used in
  45429. * @param color Defines the color we want to see the ray in
  45430. * @returns The newly created ray helper.
  45431. */
  45432. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  45433. /**
  45434. * Instantiate a new ray helper.
  45435. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  45436. * in order to better appreciate the issue one might have.
  45437. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  45438. * @param ray Defines the ray we are currently tryin to visualize
  45439. */
  45440. constructor(ray: Ray);
  45441. /**
  45442. * Shows the ray we are willing to debug.
  45443. * @param scene Defines the scene the ray needs to be rendered in
  45444. * @param color Defines the color the ray needs to be rendered in
  45445. */
  45446. show(scene: Scene, color?: Color3): void;
  45447. /**
  45448. * Hides the ray we are debugging.
  45449. */
  45450. hide(): void;
  45451. private _render;
  45452. /**
  45453. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  45454. * @param mesh Defines the mesh we want the helper attached to
  45455. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  45456. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  45457. * @param length Defines the length of the ray
  45458. */
  45459. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  45460. /**
  45461. * Detach the ray helper from the mesh it has previously been attached to.
  45462. */
  45463. detachFromMesh(): void;
  45464. private _updateToMesh;
  45465. /**
  45466. * Dispose the helper and release its associated resources.
  45467. */
  45468. dispose(): void;
  45469. }
  45470. }
  45471. declare module "babylonjs/Debug/skeletonViewer" {
  45472. import { Color3 } from "babylonjs/Maths/math.color";
  45473. import { Scene } from "babylonjs/scene";
  45474. import { Nullable } from "babylonjs/types";
  45475. import { Skeleton } from "babylonjs/Bones/skeleton";
  45476. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45477. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  45478. /**
  45479. * Class used to render a debug view of a given skeleton
  45480. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  45481. */
  45482. export class SkeletonViewer {
  45483. /** defines the skeleton to render */
  45484. skeleton: Skeleton;
  45485. /** defines the mesh attached to the skeleton */
  45486. mesh: AbstractMesh;
  45487. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45488. autoUpdateBonesMatrices: boolean;
  45489. /** defines the rendering group id to use with the viewer */
  45490. renderingGroupId: number;
  45491. /** Gets or sets the color used to render the skeleton */
  45492. color: Color3;
  45493. private _scene;
  45494. private _debugLines;
  45495. private _debugMesh;
  45496. private _isEnabled;
  45497. private _renderFunction;
  45498. private _utilityLayer;
  45499. /**
  45500. * Returns the mesh used to render the bones
  45501. */
  45502. readonly debugMesh: Nullable<LinesMesh>;
  45503. /**
  45504. * Creates a new SkeletonViewer
  45505. * @param skeleton defines the skeleton to render
  45506. * @param mesh defines the mesh attached to the skeleton
  45507. * @param scene defines the hosting scene
  45508. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  45509. * @param renderingGroupId defines the rendering group id to use with the viewer
  45510. */
  45511. constructor(
  45512. /** defines the skeleton to render */
  45513. skeleton: Skeleton,
  45514. /** defines the mesh attached to the skeleton */
  45515. mesh: AbstractMesh, scene: Scene,
  45516. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45517. autoUpdateBonesMatrices?: boolean,
  45518. /** defines the rendering group id to use with the viewer */
  45519. renderingGroupId?: number);
  45520. /** Gets or sets a boolean indicating if the viewer is enabled */
  45521. isEnabled: boolean;
  45522. private _getBonePosition;
  45523. private _getLinesForBonesWithLength;
  45524. private _getLinesForBonesNoLength;
  45525. /** Update the viewer to sync with current skeleton state */
  45526. update(): void;
  45527. /** Release associated resources */
  45528. dispose(): void;
  45529. }
  45530. }
  45531. declare module "babylonjs/Debug/index" {
  45532. export * from "babylonjs/Debug/axesViewer";
  45533. export * from "babylonjs/Debug/boneAxesViewer";
  45534. export * from "babylonjs/Debug/debugLayer";
  45535. export * from "babylonjs/Debug/physicsViewer";
  45536. export * from "babylonjs/Debug/rayHelper";
  45537. export * from "babylonjs/Debug/skeletonViewer";
  45538. }
  45539. declare module "babylonjs/Engines/nullEngine" {
  45540. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  45541. import { Scene } from "babylonjs/scene";
  45542. import { Engine } from "babylonjs/Engines/engine";
  45543. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  45544. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  45545. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  45546. import { Effect } from "babylonjs/Materials/effect";
  45547. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  45548. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  45549. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  45550. /**
  45551. * Options to create the null engine
  45552. */
  45553. export class NullEngineOptions {
  45554. /**
  45555. * Render width (Default: 512)
  45556. */
  45557. renderWidth: number;
  45558. /**
  45559. * Render height (Default: 256)
  45560. */
  45561. renderHeight: number;
  45562. /**
  45563. * Texture size (Default: 512)
  45564. */
  45565. textureSize: number;
  45566. /**
  45567. * If delta time between frames should be constant
  45568. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45569. */
  45570. deterministicLockstep: boolean;
  45571. /**
  45572. * Maximum about of steps between frames (Default: 4)
  45573. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45574. */
  45575. lockstepMaxSteps: number;
  45576. }
  45577. /**
  45578. * The null engine class provides support for headless version of babylon.js.
  45579. * This can be used in server side scenario or for testing purposes
  45580. */
  45581. export class NullEngine extends Engine {
  45582. private _options;
  45583. /**
  45584. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  45585. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45586. * @returns true if engine is in deterministic lock step mode
  45587. */
  45588. isDeterministicLockStep(): boolean;
  45589. /**
  45590. * Gets the max steps when engine is running in deterministic lock step
  45591. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45592. * @returns the max steps
  45593. */
  45594. getLockstepMaxSteps(): number;
  45595. /**
  45596. * Gets the current hardware scaling level.
  45597. * By default the hardware scaling level is computed from the window device ratio.
  45598. * 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.
  45599. * @returns a number indicating the current hardware scaling level
  45600. */
  45601. getHardwareScalingLevel(): number;
  45602. constructor(options?: NullEngineOptions);
  45603. /**
  45604. * Creates a vertex buffer
  45605. * @param vertices the data for the vertex buffer
  45606. * @returns the new WebGL static buffer
  45607. */
  45608. createVertexBuffer(vertices: FloatArray): DataBuffer;
  45609. /**
  45610. * Creates a new index buffer
  45611. * @param indices defines the content of the index buffer
  45612. * @param updatable defines if the index buffer must be updatable
  45613. * @returns a new webGL buffer
  45614. */
  45615. createIndexBuffer(indices: IndicesArray): DataBuffer;
  45616. /**
  45617. * Clear the current render buffer or the current render target (if any is set up)
  45618. * @param color defines the color to use
  45619. * @param backBuffer defines if the back buffer must be cleared
  45620. * @param depth defines if the depth buffer must be cleared
  45621. * @param stencil defines if the stencil buffer must be cleared
  45622. */
  45623. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  45624. /**
  45625. * Gets the current render width
  45626. * @param useScreen defines if screen size must be used (or the current render target if any)
  45627. * @returns a number defining the current render width
  45628. */
  45629. getRenderWidth(useScreen?: boolean): number;
  45630. /**
  45631. * Gets the current render height
  45632. * @param useScreen defines if screen size must be used (or the current render target if any)
  45633. * @returns a number defining the current render height
  45634. */
  45635. getRenderHeight(useScreen?: boolean): number;
  45636. /**
  45637. * Set the WebGL's viewport
  45638. * @param viewport defines the viewport element to be used
  45639. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  45640. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  45641. */
  45642. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  45643. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  45644. /**
  45645. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  45646. * @param pipelineContext defines the pipeline context to use
  45647. * @param uniformsNames defines the list of uniform names
  45648. * @returns an array of webGL uniform locations
  45649. */
  45650. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  45651. /**
  45652. * Gets the lsit of active attributes for a given webGL program
  45653. * @param pipelineContext defines the pipeline context to use
  45654. * @param attributesNames defines the list of attribute names to get
  45655. * @returns an array of indices indicating the offset of each attribute
  45656. */
  45657. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  45658. /**
  45659. * Binds an effect to the webGL context
  45660. * @param effect defines the effect to bind
  45661. */
  45662. bindSamplers(effect: Effect): void;
  45663. /**
  45664. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  45665. * @param effect defines the effect to activate
  45666. */
  45667. enableEffect(effect: Effect): void;
  45668. /**
  45669. * Set various states to the webGL context
  45670. * @param culling defines backface culling state
  45671. * @param zOffset defines the value to apply to zOffset (0 by default)
  45672. * @param force defines if states must be applied even if cache is up to date
  45673. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  45674. */
  45675. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  45676. /**
  45677. * Set the value of an uniform to an array of int32
  45678. * @param uniform defines the webGL uniform location where to store the value
  45679. * @param array defines the array of int32 to store
  45680. */
  45681. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  45682. /**
  45683. * Set the value of an uniform to an array of int32 (stored as vec2)
  45684. * @param uniform defines the webGL uniform location where to store the value
  45685. * @param array defines the array of int32 to store
  45686. */
  45687. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  45688. /**
  45689. * Set the value of an uniform to an array of int32 (stored as vec3)
  45690. * @param uniform defines the webGL uniform location where to store the value
  45691. * @param array defines the array of int32 to store
  45692. */
  45693. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  45694. /**
  45695. * Set the value of an uniform to an array of int32 (stored as vec4)
  45696. * @param uniform defines the webGL uniform location where to store the value
  45697. * @param array defines the array of int32 to store
  45698. */
  45699. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  45700. /**
  45701. * Set the value of an uniform to an array of float32
  45702. * @param uniform defines the webGL uniform location where to store the value
  45703. * @param array defines the array of float32 to store
  45704. */
  45705. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  45706. /**
  45707. * Set the value of an uniform to an array of float32 (stored as vec2)
  45708. * @param uniform defines the webGL uniform location where to store the value
  45709. * @param array defines the array of float32 to store
  45710. */
  45711. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  45712. /**
  45713. * Set the value of an uniform to an array of float32 (stored as vec3)
  45714. * @param uniform defines the webGL uniform location where to store the value
  45715. * @param array defines the array of float32 to store
  45716. */
  45717. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  45718. /**
  45719. * Set the value of an uniform to an array of float32 (stored as vec4)
  45720. * @param uniform defines the webGL uniform location where to store the value
  45721. * @param array defines the array of float32 to store
  45722. */
  45723. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  45724. /**
  45725. * Set the value of an uniform to an array of number
  45726. * @param uniform defines the webGL uniform location where to store the value
  45727. * @param array defines the array of number to store
  45728. */
  45729. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  45730. /**
  45731. * Set the value of an uniform to an array of number (stored as vec2)
  45732. * @param uniform defines the webGL uniform location where to store the value
  45733. * @param array defines the array of number to store
  45734. */
  45735. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  45736. /**
  45737. * Set the value of an uniform to an array of number (stored as vec3)
  45738. * @param uniform defines the webGL uniform location where to store the value
  45739. * @param array defines the array of number to store
  45740. */
  45741. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  45742. /**
  45743. * Set the value of an uniform to an array of number (stored as vec4)
  45744. * @param uniform defines the webGL uniform location where to store the value
  45745. * @param array defines the array of number to store
  45746. */
  45747. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  45748. /**
  45749. * Set the value of an uniform to an array of float32 (stored as matrices)
  45750. * @param uniform defines the webGL uniform location where to store the value
  45751. * @param matrices defines the array of float32 to store
  45752. */
  45753. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  45754. /**
  45755. * Set the value of an uniform to a matrix (3x3)
  45756. * @param uniform defines the webGL uniform location where to store the value
  45757. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  45758. */
  45759. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45760. /**
  45761. * Set the value of an uniform to a matrix (2x2)
  45762. * @param uniform defines the webGL uniform location where to store the value
  45763. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  45764. */
  45765. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45766. /**
  45767. * Set the value of an uniform to a number (float)
  45768. * @param uniform defines the webGL uniform location where to store the value
  45769. * @param value defines the float number to store
  45770. */
  45771. setFloat(uniform: WebGLUniformLocation, value: number): void;
  45772. /**
  45773. * Set the value of an uniform to a vec2
  45774. * @param uniform defines the webGL uniform location where to store the value
  45775. * @param x defines the 1st component of the value
  45776. * @param y defines the 2nd component of the value
  45777. */
  45778. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  45779. /**
  45780. * Set the value of an uniform to a vec3
  45781. * @param uniform defines the webGL uniform location where to store the value
  45782. * @param x defines the 1st component of the value
  45783. * @param y defines the 2nd component of the value
  45784. * @param z defines the 3rd component of the value
  45785. */
  45786. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  45787. /**
  45788. * Set the value of an uniform to a boolean
  45789. * @param uniform defines the webGL uniform location where to store the value
  45790. * @param bool defines the boolean to store
  45791. */
  45792. setBool(uniform: WebGLUniformLocation, bool: number): void;
  45793. /**
  45794. * Set the value of an uniform to a vec4
  45795. * @param uniform defines the webGL uniform location where to store the value
  45796. * @param x defines the 1st component of the value
  45797. * @param y defines the 2nd component of the value
  45798. * @param z defines the 3rd component of the value
  45799. * @param w defines the 4th component of the value
  45800. */
  45801. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  45802. /**
  45803. * Sets the current alpha mode
  45804. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  45805. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  45806. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  45807. */
  45808. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  45809. /**
  45810. * Bind webGl buffers directly to the webGL context
  45811. * @param vertexBuffers defines the vertex buffer to bind
  45812. * @param indexBuffer defines the index buffer to bind
  45813. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  45814. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  45815. * @param effect defines the effect associated with the vertex buffer
  45816. */
  45817. bindBuffers(vertexBuffers: {
  45818. [key: string]: VertexBuffer;
  45819. }, indexBuffer: DataBuffer, effect: Effect): void;
  45820. /**
  45821. * Force the entire cache to be cleared
  45822. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  45823. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  45824. */
  45825. wipeCaches(bruteForce?: boolean): void;
  45826. /**
  45827. * Send a draw order
  45828. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  45829. * @param indexStart defines the starting index
  45830. * @param indexCount defines the number of index to draw
  45831. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  45832. */
  45833. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  45834. /**
  45835. * Draw a list of indexed primitives
  45836. * @param fillMode defines the primitive to use
  45837. * @param indexStart defines the starting index
  45838. * @param indexCount defines the number of index to draw
  45839. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  45840. */
  45841. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  45842. /**
  45843. * Draw a list of unindexed primitives
  45844. * @param fillMode defines the primitive to use
  45845. * @param verticesStart defines the index of first vertex to draw
  45846. * @param verticesCount defines the count of vertices to draw
  45847. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  45848. */
  45849. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  45850. /** @hidden */
  45851. _createTexture(): WebGLTexture;
  45852. /** @hidden */
  45853. _releaseTexture(texture: InternalTexture): void;
  45854. /**
  45855. * Usually called from Texture.ts.
  45856. * Passed information to create a WebGLTexture
  45857. * @param urlArg defines a value which contains one of the following:
  45858. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  45859. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  45860. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  45861. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  45862. * @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)
  45863. * @param scene needed for loading to the correct scene
  45864. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  45865. * @param onLoad optional callback to be called upon successful completion
  45866. * @param onError optional callback to be called upon failure
  45867. * @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
  45868. * @param fallBack an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  45869. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  45870. * @param forcedExtension defines the extension to use to pick the right loader
  45871. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  45872. * @returns a InternalTexture for assignment back into BABYLON.Texture
  45873. */
  45874. createTexture(urlArg: string, noMipmap: boolean, invertY: boolean, scene: Scene, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<ArrayBuffer | HTMLImageElement>, fallBack?: InternalTexture, format?: number): InternalTexture;
  45875. /**
  45876. * Creates a new render target texture
  45877. * @param size defines the size of the texture
  45878. * @param options defines the options used to create the texture
  45879. * @returns a new render target texture stored in an InternalTexture
  45880. */
  45881. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  45882. /**
  45883. * Update the sampling mode of a given texture
  45884. * @param samplingMode defines the required sampling mode
  45885. * @param texture defines the texture to update
  45886. */
  45887. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  45888. /**
  45889. * Binds the frame buffer to the specified texture.
  45890. * @param texture The texture to render to or null for the default canvas
  45891. * @param faceIndex The face of the texture to render to in case of cube texture
  45892. * @param requiredWidth The width of the target to render to
  45893. * @param requiredHeight The height of the target to render to
  45894. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  45895. * @param depthStencilTexture The depth stencil texture to use to render
  45896. * @param lodLevel defines le lod level to bind to the frame buffer
  45897. */
  45898. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  45899. /**
  45900. * Unbind the current render target texture from the webGL context
  45901. * @param texture defines the render target texture to unbind
  45902. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  45903. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  45904. */
  45905. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  45906. /**
  45907. * Creates a dynamic vertex buffer
  45908. * @param vertices the data for the dynamic vertex buffer
  45909. * @returns the new WebGL dynamic buffer
  45910. */
  45911. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  45912. /**
  45913. * Update the content of a dynamic texture
  45914. * @param texture defines the texture to update
  45915. * @param canvas defines the canvas containing the source
  45916. * @param invertY defines if data must be stored with Y axis inverted
  45917. * @param premulAlpha defines if alpha is stored as premultiplied
  45918. * @param format defines the format of the data
  45919. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  45920. */
  45921. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  45922. /**
  45923. * Gets a boolean indicating if all created effects are ready
  45924. * @returns true if all effects are ready
  45925. */
  45926. areAllEffectsReady(): boolean;
  45927. /**
  45928. * @hidden
  45929. * Get the current error code of the webGL context
  45930. * @returns the error code
  45931. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  45932. */
  45933. getError(): number;
  45934. /** @hidden */
  45935. _getUnpackAlignement(): number;
  45936. /** @hidden */
  45937. _unpackFlipY(value: boolean): void;
  45938. /**
  45939. * Update a dynamic index buffer
  45940. * @param indexBuffer defines the target index buffer
  45941. * @param indices defines the data to update
  45942. * @param offset defines the offset in the target index buffer where update should start
  45943. */
  45944. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  45945. /**
  45946. * Updates a dynamic vertex buffer.
  45947. * @param vertexBuffer the vertex buffer to update
  45948. * @param vertices the data used to update the vertex buffer
  45949. * @param byteOffset the byte offset of the data (optional)
  45950. * @param byteLength the byte length of the data (optional)
  45951. */
  45952. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  45953. /** @hidden */
  45954. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  45955. /** @hidden */
  45956. _bindTexture(channel: number, texture: InternalTexture): void;
  45957. protected _deleteBuffer(buffer: WebGLBuffer): void;
  45958. /**
  45959. * 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
  45960. */
  45961. releaseEffects(): void;
  45962. displayLoadingUI(): void;
  45963. hideLoadingUI(): void;
  45964. /** @hidden */
  45965. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45966. /** @hidden */
  45967. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45968. /** @hidden */
  45969. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45970. /** @hidden */
  45971. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  45972. }
  45973. }
  45974. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  45975. import { Nullable, int } from "babylonjs/types";
  45976. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  45977. /** @hidden */
  45978. export class _OcclusionDataStorage {
  45979. /** @hidden */
  45980. occlusionInternalRetryCounter: number;
  45981. /** @hidden */
  45982. isOcclusionQueryInProgress: boolean;
  45983. /** @hidden */
  45984. isOccluded: boolean;
  45985. /** @hidden */
  45986. occlusionRetryCount: number;
  45987. /** @hidden */
  45988. occlusionType: number;
  45989. /** @hidden */
  45990. occlusionQueryAlgorithmType: number;
  45991. }
  45992. module "babylonjs/Engines/engine" {
  45993. interface Engine {
  45994. /**
  45995. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  45996. * @return the new query
  45997. */
  45998. createQuery(): WebGLQuery;
  45999. /**
  46000. * Delete and release a webGL query
  46001. * @param query defines the query to delete
  46002. * @return the current engine
  46003. */
  46004. deleteQuery(query: WebGLQuery): Engine;
  46005. /**
  46006. * Check if a given query has resolved and got its value
  46007. * @param query defines the query to check
  46008. * @returns true if the query got its value
  46009. */
  46010. isQueryResultAvailable(query: WebGLQuery): boolean;
  46011. /**
  46012. * Gets the value of a given query
  46013. * @param query defines the query to check
  46014. * @returns the value of the query
  46015. */
  46016. getQueryResult(query: WebGLQuery): number;
  46017. /**
  46018. * Initiates an occlusion query
  46019. * @param algorithmType defines the algorithm to use
  46020. * @param query defines the query to use
  46021. * @returns the current engine
  46022. * @see http://doc.babylonjs.com/features/occlusionquery
  46023. */
  46024. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  46025. /**
  46026. * Ends an occlusion query
  46027. * @see http://doc.babylonjs.com/features/occlusionquery
  46028. * @param algorithmType defines the algorithm to use
  46029. * @returns the current engine
  46030. */
  46031. endOcclusionQuery(algorithmType: number): Engine;
  46032. /**
  46033. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  46034. * Please note that only one query can be issued at a time
  46035. * @returns a time token used to track the time span
  46036. */
  46037. startTimeQuery(): Nullable<_TimeToken>;
  46038. /**
  46039. * Ends a time query
  46040. * @param token defines the token used to measure the time span
  46041. * @returns the time spent (in ns)
  46042. */
  46043. endTimeQuery(token: _TimeToken): int;
  46044. /** @hidden */
  46045. _currentNonTimestampToken: Nullable<_TimeToken>;
  46046. /** @hidden */
  46047. _createTimeQuery(): WebGLQuery;
  46048. /** @hidden */
  46049. _deleteTimeQuery(query: WebGLQuery): void;
  46050. /** @hidden */
  46051. _getGlAlgorithmType(algorithmType: number): number;
  46052. /** @hidden */
  46053. _getTimeQueryResult(query: WebGLQuery): any;
  46054. /** @hidden */
  46055. _getTimeQueryAvailability(query: WebGLQuery): any;
  46056. }
  46057. }
  46058. module "babylonjs/Meshes/abstractMesh" {
  46059. interface AbstractMesh {
  46060. /**
  46061. * Backing filed
  46062. * @hidden
  46063. */
  46064. __occlusionDataStorage: _OcclusionDataStorage;
  46065. /**
  46066. * Access property
  46067. * @hidden
  46068. */
  46069. _occlusionDataStorage: _OcclusionDataStorage;
  46070. /**
  46071. * 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.
  46072. * The default value is -1 which means don't break the query and wait till the result
  46073. * @see http://doc.babylonjs.com/features/occlusionquery
  46074. */
  46075. occlusionRetryCount: number;
  46076. /**
  46077. * 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:
  46078. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  46079. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  46080. * * 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.
  46081. * @see http://doc.babylonjs.com/features/occlusionquery
  46082. */
  46083. occlusionType: number;
  46084. /**
  46085. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  46086. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  46087. * * 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.
  46088. * @see http://doc.babylonjs.com/features/occlusionquery
  46089. */
  46090. occlusionQueryAlgorithmType: number;
  46091. /**
  46092. * 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
  46093. * @see http://doc.babylonjs.com/features/occlusionquery
  46094. */
  46095. isOccluded: boolean;
  46096. /**
  46097. * Flag to check the progress status of the query
  46098. * @see http://doc.babylonjs.com/features/occlusionquery
  46099. */
  46100. isOcclusionQueryInProgress: boolean;
  46101. }
  46102. }
  46103. }
  46104. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  46105. import { Nullable } from "babylonjs/types";
  46106. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  46107. /** @hidden */
  46108. export var _forceTransformFeedbackToBundle: boolean;
  46109. module "babylonjs/Engines/engine" {
  46110. interface Engine {
  46111. /**
  46112. * Creates a webGL transform feedback object
  46113. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  46114. * @returns the webGL transform feedback object
  46115. */
  46116. createTransformFeedback(): WebGLTransformFeedback;
  46117. /**
  46118. * Delete a webGL transform feedback object
  46119. * @param value defines the webGL transform feedback object to delete
  46120. */
  46121. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  46122. /**
  46123. * Bind a webGL transform feedback object to the webgl context
  46124. * @param value defines the webGL transform feedback object to bind
  46125. */
  46126. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  46127. /**
  46128. * Begins a transform feedback operation
  46129. * @param usePoints defines if points or triangles must be used
  46130. */
  46131. beginTransformFeedback(usePoints: boolean): void;
  46132. /**
  46133. * Ends a transform feedback operation
  46134. */
  46135. endTransformFeedback(): void;
  46136. /**
  46137. * Specify the varyings to use with transform feedback
  46138. * @param program defines the associated webGL program
  46139. * @param value defines the list of strings representing the varying names
  46140. */
  46141. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  46142. /**
  46143. * Bind a webGL buffer for a transform feedback operation
  46144. * @param value defines the webGL buffer to bind
  46145. */
  46146. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  46147. }
  46148. }
  46149. }
  46150. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  46151. import { Scene } from "babylonjs/scene";
  46152. import { Engine } from "babylonjs/Engines/engine";
  46153. import { Texture } from "babylonjs/Materials/Textures/texture";
  46154. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  46155. import "babylonjs/Engines/Extensions/engine.multiRender";
  46156. /**
  46157. * Creation options of the multi render target texture.
  46158. */
  46159. export interface IMultiRenderTargetOptions {
  46160. /**
  46161. * Define if the texture needs to create mip maps after render.
  46162. */
  46163. generateMipMaps?: boolean;
  46164. /**
  46165. * Define the types of all the draw buffers we want to create
  46166. */
  46167. types?: number[];
  46168. /**
  46169. * Define the sampling modes of all the draw buffers we want to create
  46170. */
  46171. samplingModes?: number[];
  46172. /**
  46173. * Define if a depth buffer is required
  46174. */
  46175. generateDepthBuffer?: boolean;
  46176. /**
  46177. * Define if a stencil buffer is required
  46178. */
  46179. generateStencilBuffer?: boolean;
  46180. /**
  46181. * Define if a depth texture is required instead of a depth buffer
  46182. */
  46183. generateDepthTexture?: boolean;
  46184. /**
  46185. * Define the number of desired draw buffers
  46186. */
  46187. textureCount?: number;
  46188. /**
  46189. * Define if aspect ratio should be adapted to the texture or stay the scene one
  46190. */
  46191. doNotChangeAspectRatio?: boolean;
  46192. /**
  46193. * Define the default type of the buffers we are creating
  46194. */
  46195. defaultType?: number;
  46196. }
  46197. /**
  46198. * A multi render target, like a render target provides the ability to render to a texture.
  46199. * Unlike the render target, it can render to several draw buffers in one draw.
  46200. * This is specially interesting in deferred rendering or for any effects requiring more than
  46201. * just one color from a single pass.
  46202. */
  46203. export class MultiRenderTarget extends RenderTargetTexture {
  46204. private _internalTextures;
  46205. private _textures;
  46206. private _multiRenderTargetOptions;
  46207. /**
  46208. * Get if draw buffers are currently supported by the used hardware and browser.
  46209. */
  46210. readonly isSupported: boolean;
  46211. /**
  46212. * Get the list of textures generated by the multi render target.
  46213. */
  46214. readonly textures: Texture[];
  46215. /**
  46216. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  46217. */
  46218. readonly depthTexture: Texture;
  46219. /**
  46220. * Set the wrapping mode on U of all the textures we are rendering to.
  46221. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  46222. */
  46223. wrapU: number;
  46224. /**
  46225. * Set the wrapping mode on V of all the textures we are rendering to.
  46226. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  46227. */
  46228. wrapV: number;
  46229. /**
  46230. * Instantiate a new multi render target texture.
  46231. * A multi render target, like a render target provides the ability to render to a texture.
  46232. * Unlike the render target, it can render to several draw buffers in one draw.
  46233. * This is specially interesting in deferred rendering or for any effects requiring more than
  46234. * just one color from a single pass.
  46235. * @param name Define the name of the texture
  46236. * @param size Define the size of the buffers to render to
  46237. * @param count Define the number of target we are rendering into
  46238. * @param scene Define the scene the texture belongs to
  46239. * @param options Define the options used to create the multi render target
  46240. */
  46241. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  46242. /** @hidden */
  46243. _rebuild(): void;
  46244. private _createInternalTextures;
  46245. private _createTextures;
  46246. /**
  46247. * Define the number of samples used if MSAA is enabled.
  46248. */
  46249. samples: number;
  46250. /**
  46251. * Resize all the textures in the multi render target.
  46252. * Be carrefull as it will recreate all the data in the new texture.
  46253. * @param size Define the new size
  46254. */
  46255. resize(size: any): void;
  46256. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  46257. /**
  46258. * Dispose the render targets and their associated resources
  46259. */
  46260. dispose(): void;
  46261. /**
  46262. * Release all the underlying texture used as draw buffers.
  46263. */
  46264. releaseInternalTextures(): void;
  46265. }
  46266. }
  46267. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  46268. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46269. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  46270. import { Nullable } from "babylonjs/types";
  46271. module "babylonjs/Engines/thinEngine" {
  46272. interface ThinEngine {
  46273. /**
  46274. * Unbind a list of render target textures from the webGL context
  46275. * This is used only when drawBuffer extension or webGL2 are active
  46276. * @param textures defines the render target textures to unbind
  46277. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  46278. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  46279. */
  46280. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  46281. /**
  46282. * Create a multi render target texture
  46283. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  46284. * @param size defines the size of the texture
  46285. * @param options defines the creation options
  46286. * @returns the cube texture as an InternalTexture
  46287. */
  46288. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  46289. /**
  46290. * Update the sample count for a given multiple render target texture
  46291. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  46292. * @param textures defines the textures to update
  46293. * @param samples defines the sample count to set
  46294. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  46295. */
  46296. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  46297. }
  46298. }
  46299. }
  46300. declare module "babylonjs/Engines/Extensions/engine.views" {
  46301. import { Camera } from "babylonjs/Cameras/camera";
  46302. module "babylonjs/Engines/engine" {
  46303. interface Engine {
  46304. /** Gets or sets the list of views */
  46305. views: {
  46306. target: HTMLCanvasElement;
  46307. camera: Camera;
  46308. }[];
  46309. /**
  46310. * Register a new child canvas
  46311. * @param canvas defines the canvas to register
  46312. * @param camera defines the camera to use with this canvas (it will overwrite the scene.camera for this view)
  46313. * @returns the current engine
  46314. */
  46315. registerView(canvas: HTMLCanvasElement, camera: Camera): Engine;
  46316. /**
  46317. * Remove a registered child canvas
  46318. * @param canvas defines the canvas to remove
  46319. * @returns the current engine
  46320. */
  46321. unRegisterView(canvas: HTMLCanvasElement): Engine;
  46322. }
  46323. }
  46324. }
  46325. declare module "babylonjs/Engines/Extensions/index" {
  46326. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  46327. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  46328. export * from "babylonjs/Engines/Extensions/engine.multiview";
  46329. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  46330. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  46331. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  46332. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  46333. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  46334. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  46335. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  46336. export * from "babylonjs/Engines/Extensions/engine.webVR";
  46337. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  46338. export * from "babylonjs/Engines/Extensions/engine.views";
  46339. }
  46340. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  46341. import { Nullable } from "babylonjs/types";
  46342. /**
  46343. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  46344. */
  46345. export interface CubeMapInfo {
  46346. /**
  46347. * The pixel array for the front face.
  46348. * This is stored in format, left to right, up to down format.
  46349. */
  46350. front: Nullable<ArrayBufferView>;
  46351. /**
  46352. * The pixel array for the back face.
  46353. * This is stored in format, left to right, up to down format.
  46354. */
  46355. back: Nullable<ArrayBufferView>;
  46356. /**
  46357. * The pixel array for the left face.
  46358. * This is stored in format, left to right, up to down format.
  46359. */
  46360. left: Nullable<ArrayBufferView>;
  46361. /**
  46362. * The pixel array for the right face.
  46363. * This is stored in format, left to right, up to down format.
  46364. */
  46365. right: Nullable<ArrayBufferView>;
  46366. /**
  46367. * The pixel array for the up face.
  46368. * This is stored in format, left to right, up to down format.
  46369. */
  46370. up: Nullable<ArrayBufferView>;
  46371. /**
  46372. * The pixel array for the down face.
  46373. * This is stored in format, left to right, up to down format.
  46374. */
  46375. down: Nullable<ArrayBufferView>;
  46376. /**
  46377. * The size of the cubemap stored.
  46378. *
  46379. * Each faces will be size * size pixels.
  46380. */
  46381. size: number;
  46382. /**
  46383. * The format of the texture.
  46384. *
  46385. * RGBA, RGB.
  46386. */
  46387. format: number;
  46388. /**
  46389. * The type of the texture data.
  46390. *
  46391. * UNSIGNED_INT, FLOAT.
  46392. */
  46393. type: number;
  46394. /**
  46395. * Specifies whether the texture is in gamma space.
  46396. */
  46397. gammaSpace: boolean;
  46398. }
  46399. /**
  46400. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  46401. */
  46402. export class PanoramaToCubeMapTools {
  46403. private static FACE_FRONT;
  46404. private static FACE_BACK;
  46405. private static FACE_RIGHT;
  46406. private static FACE_LEFT;
  46407. private static FACE_DOWN;
  46408. private static FACE_UP;
  46409. /**
  46410. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  46411. *
  46412. * @param float32Array The source data.
  46413. * @param inputWidth The width of the input panorama.
  46414. * @param inputHeight The height of the input panorama.
  46415. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  46416. * @return The cubemap data
  46417. */
  46418. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  46419. private static CreateCubemapTexture;
  46420. private static CalcProjectionSpherical;
  46421. }
  46422. }
  46423. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  46424. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46425. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46426. import { Nullable } from "babylonjs/types";
  46427. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  46428. /**
  46429. * Helper class dealing with the extraction of spherical polynomial dataArray
  46430. * from a cube map.
  46431. */
  46432. export class CubeMapToSphericalPolynomialTools {
  46433. private static FileFaces;
  46434. /**
  46435. * Converts a texture to the according Spherical Polynomial data.
  46436. * This extracts the first 3 orders only as they are the only one used in the lighting.
  46437. *
  46438. * @param texture The texture to extract the information from.
  46439. * @return The Spherical Polynomial data.
  46440. */
  46441. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  46442. /**
  46443. * Converts a cubemap to the according Spherical Polynomial data.
  46444. * This extracts the first 3 orders only as they are the only one used in the lighting.
  46445. *
  46446. * @param cubeInfo The Cube map to extract the information from.
  46447. * @return The Spherical Polynomial data.
  46448. */
  46449. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  46450. }
  46451. }
  46452. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  46453. import { Nullable } from "babylonjs/types";
  46454. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46455. module "babylonjs/Materials/Textures/baseTexture" {
  46456. interface BaseTexture {
  46457. /**
  46458. * Get the polynomial representation of the texture data.
  46459. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  46460. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  46461. */
  46462. sphericalPolynomial: Nullable<SphericalPolynomial>;
  46463. }
  46464. }
  46465. }
  46466. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  46467. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46468. /** @hidden */
  46469. export var rgbdEncodePixelShader: {
  46470. name: string;
  46471. shader: string;
  46472. };
  46473. }
  46474. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  46475. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46476. /** @hidden */
  46477. export var rgbdDecodePixelShader: {
  46478. name: string;
  46479. shader: string;
  46480. };
  46481. }
  46482. declare module "babylonjs/Misc/environmentTextureTools" {
  46483. import { Nullable } from "babylonjs/types";
  46484. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46485. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46486. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  46487. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  46488. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  46489. import "babylonjs/Shaders/rgbdEncode.fragment";
  46490. import "babylonjs/Shaders/rgbdDecode.fragment";
  46491. /**
  46492. * Raw texture data and descriptor sufficient for WebGL texture upload
  46493. */
  46494. export interface EnvironmentTextureInfo {
  46495. /**
  46496. * Version of the environment map
  46497. */
  46498. version: number;
  46499. /**
  46500. * Width of image
  46501. */
  46502. width: number;
  46503. /**
  46504. * Irradiance information stored in the file.
  46505. */
  46506. irradiance: any;
  46507. /**
  46508. * Specular information stored in the file.
  46509. */
  46510. specular: any;
  46511. }
  46512. /**
  46513. * Defines One Image in the file. It requires only the position in the file
  46514. * as well as the length.
  46515. */
  46516. interface BufferImageData {
  46517. /**
  46518. * Length of the image data.
  46519. */
  46520. length: number;
  46521. /**
  46522. * Position of the data from the null terminator delimiting the end of the JSON.
  46523. */
  46524. position: number;
  46525. }
  46526. /**
  46527. * Defines the specular data enclosed in the file.
  46528. * This corresponds to the version 1 of the data.
  46529. */
  46530. export interface EnvironmentTextureSpecularInfoV1 {
  46531. /**
  46532. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  46533. */
  46534. specularDataPosition?: number;
  46535. /**
  46536. * This contains all the images data needed to reconstruct the cubemap.
  46537. */
  46538. mipmaps: Array<BufferImageData>;
  46539. /**
  46540. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  46541. */
  46542. lodGenerationScale: number;
  46543. }
  46544. /**
  46545. * Sets of helpers addressing the serialization and deserialization of environment texture
  46546. * stored in a BabylonJS env file.
  46547. * Those files are usually stored as .env files.
  46548. */
  46549. export class EnvironmentTextureTools {
  46550. /**
  46551. * Magic number identifying the env file.
  46552. */
  46553. private static _MagicBytes;
  46554. /**
  46555. * Gets the environment info from an env file.
  46556. * @param data The array buffer containing the .env bytes.
  46557. * @returns the environment file info (the json header) if successfully parsed.
  46558. */
  46559. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  46560. /**
  46561. * Creates an environment texture from a loaded cube texture.
  46562. * @param texture defines the cube texture to convert in env file
  46563. * @return a promise containing the environment data if succesfull.
  46564. */
  46565. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  46566. /**
  46567. * Creates a JSON representation of the spherical data.
  46568. * @param texture defines the texture containing the polynomials
  46569. * @return the JSON representation of the spherical info
  46570. */
  46571. private static _CreateEnvTextureIrradiance;
  46572. /**
  46573. * Creates the ArrayBufferViews used for initializing environment texture image data.
  46574. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  46575. * @param info parameters that determine what views will be created for accessing the underlying buffer
  46576. * @return the views described by info providing access to the underlying buffer
  46577. */
  46578. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  46579. /**
  46580. * Uploads the texture info contained in the env file to the GPU.
  46581. * @param texture defines the internal texture to upload to
  46582. * @param arrayBuffer defines the buffer cotaining the data to load
  46583. * @param info defines the texture info retrieved through the GetEnvInfo method
  46584. * @returns a promise
  46585. */
  46586. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  46587. private static _OnImageReadyAsync;
  46588. /**
  46589. * Uploads the levels of image data to the GPU.
  46590. * @param texture defines the internal texture to upload to
  46591. * @param imageData defines the array buffer views of image data [mipmap][face]
  46592. * @returns a promise
  46593. */
  46594. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  46595. /**
  46596. * Uploads spherical polynomials information to the texture.
  46597. * @param texture defines the texture we are trying to upload the information to
  46598. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  46599. */
  46600. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  46601. /** @hidden */
  46602. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  46603. }
  46604. }
  46605. declare module "babylonjs/Maths/math.vertexFormat" {
  46606. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  46607. /**
  46608. * Contains position and normal vectors for a vertex
  46609. */
  46610. export class PositionNormalVertex {
  46611. /** the position of the vertex (defaut: 0,0,0) */
  46612. position: Vector3;
  46613. /** the normal of the vertex (defaut: 0,1,0) */
  46614. normal: Vector3;
  46615. /**
  46616. * Creates a PositionNormalVertex
  46617. * @param position the position of the vertex (defaut: 0,0,0)
  46618. * @param normal the normal of the vertex (defaut: 0,1,0)
  46619. */
  46620. constructor(
  46621. /** the position of the vertex (defaut: 0,0,0) */
  46622. position?: Vector3,
  46623. /** the normal of the vertex (defaut: 0,1,0) */
  46624. normal?: Vector3);
  46625. /**
  46626. * Clones the PositionNormalVertex
  46627. * @returns the cloned PositionNormalVertex
  46628. */
  46629. clone(): PositionNormalVertex;
  46630. }
  46631. /**
  46632. * Contains position, normal and uv vectors for a vertex
  46633. */
  46634. export class PositionNormalTextureVertex {
  46635. /** the position of the vertex (defaut: 0,0,0) */
  46636. position: Vector3;
  46637. /** the normal of the vertex (defaut: 0,1,0) */
  46638. normal: Vector3;
  46639. /** the uv of the vertex (default: 0,0) */
  46640. uv: Vector2;
  46641. /**
  46642. * Creates a PositionNormalTextureVertex
  46643. * @param position the position of the vertex (defaut: 0,0,0)
  46644. * @param normal the normal of the vertex (defaut: 0,1,0)
  46645. * @param uv the uv of the vertex (default: 0,0)
  46646. */
  46647. constructor(
  46648. /** the position of the vertex (defaut: 0,0,0) */
  46649. position?: Vector3,
  46650. /** the normal of the vertex (defaut: 0,1,0) */
  46651. normal?: Vector3,
  46652. /** the uv of the vertex (default: 0,0) */
  46653. uv?: Vector2);
  46654. /**
  46655. * Clones the PositionNormalTextureVertex
  46656. * @returns the cloned PositionNormalTextureVertex
  46657. */
  46658. clone(): PositionNormalTextureVertex;
  46659. }
  46660. }
  46661. declare module "babylonjs/Maths/math" {
  46662. export * from "babylonjs/Maths/math.axis";
  46663. export * from "babylonjs/Maths/math.color";
  46664. export * from "babylonjs/Maths/math.constants";
  46665. export * from "babylonjs/Maths/math.frustum";
  46666. export * from "babylonjs/Maths/math.path";
  46667. export * from "babylonjs/Maths/math.plane";
  46668. export * from "babylonjs/Maths/math.size";
  46669. export * from "babylonjs/Maths/math.vector";
  46670. export * from "babylonjs/Maths/math.vertexFormat";
  46671. export * from "babylonjs/Maths/math.viewport";
  46672. }
  46673. declare module "babylonjs/Engines/Native/nativeShaderProcessor" {
  46674. import { WebGL2ShaderProcessor } from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  46675. /** @hidden */
  46676. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  46677. private _genericAttributeLocation;
  46678. private _varyingLocationCount;
  46679. private _varyingLocationMap;
  46680. private _replacements;
  46681. private _textureCount;
  46682. private _uniforms;
  46683. lineProcessor(line: string): string;
  46684. attributeProcessor(attribute: string): string;
  46685. varyingProcessor(varying: string, isFragment: boolean): string;
  46686. uniformProcessor(uniform: string): string;
  46687. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  46688. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  46689. }
  46690. }
  46691. declare module "babylonjs/Engines/nativeEngine" {
  46692. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  46693. import { Engine } from "babylonjs/Engines/engine";
  46694. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  46695. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46696. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46697. import { Effect } from "babylonjs/Materials/effect";
  46698. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  46699. import { Color4, Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  46700. import { Scene } from "babylonjs/scene";
  46701. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  46702. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  46703. /**
  46704. * Container for accessors for natively-stored mesh data buffers.
  46705. */
  46706. class NativeDataBuffer extends DataBuffer {
  46707. /**
  46708. * Accessor value used to identify/retrieve a natively-stored index buffer.
  46709. */
  46710. nativeIndexBuffer?: any;
  46711. /**
  46712. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  46713. */
  46714. nativeVertexBuffer?: any;
  46715. }
  46716. /** @hidden */
  46717. class NativeTexture extends InternalTexture {
  46718. getInternalTexture(): InternalTexture;
  46719. getViewCount(): number;
  46720. }
  46721. /** @hidden */
  46722. export class NativeEngine extends Engine {
  46723. private readonly _native;
  46724. getHardwareScalingLevel(): number;
  46725. constructor();
  46726. /**
  46727. * Can be used to override the current requestAnimationFrame requester.
  46728. * @hidden
  46729. */
  46730. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  46731. /**
  46732. * Override default engine behavior.
  46733. * @param color
  46734. * @param backBuffer
  46735. * @param depth
  46736. * @param stencil
  46737. */
  46738. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  46739. clear(color: Color4, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  46740. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  46741. createVertexBuffer(data: DataArray): NativeDataBuffer;
  46742. recordVertexArrayObject(vertexBuffers: {
  46743. [key: string]: VertexBuffer;
  46744. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  46745. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  46746. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  46747. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  46748. /**
  46749. * Draw a list of indexed primitives
  46750. * @param fillMode defines the primitive to use
  46751. * @param indexStart defines the starting index
  46752. * @param indexCount defines the number of index to draw
  46753. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46754. */
  46755. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  46756. /**
  46757. * Draw a list of unindexed primitives
  46758. * @param fillMode defines the primitive to use
  46759. * @param verticesStart defines the index of first vertex to draw
  46760. * @param verticesCount defines the count of vertices to draw
  46761. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46762. */
  46763. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  46764. createPipelineContext(): IPipelineContext;
  46765. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  46766. /** @hidden */
  46767. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  46768. /** @hidden */
  46769. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  46770. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  46771. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  46772. protected _setProgram(program: WebGLProgram): void;
  46773. _releaseEffect(effect: Effect): void;
  46774. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  46775. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  46776. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  46777. bindSamplers(effect: Effect): void;
  46778. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  46779. getRenderWidth(useScreen?: boolean): number;
  46780. getRenderHeight(useScreen?: boolean): number;
  46781. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  46782. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  46783. /**
  46784. * Set the z offset to apply to current rendering
  46785. * @param value defines the offset to apply
  46786. */
  46787. setZOffset(value: number): void;
  46788. /**
  46789. * Gets the current value of the zOffset
  46790. * @returns the current zOffset state
  46791. */
  46792. getZOffset(): number;
  46793. /**
  46794. * Enable or disable depth buffering
  46795. * @param enable defines the state to set
  46796. */
  46797. setDepthBuffer(enable: boolean): void;
  46798. /**
  46799. * Gets a boolean indicating if depth writing is enabled
  46800. * @returns the current depth writing state
  46801. */
  46802. getDepthWrite(): boolean;
  46803. /**
  46804. * Enable or disable depth writing
  46805. * @param enable defines the state to set
  46806. */
  46807. setDepthWrite(enable: boolean): void;
  46808. /**
  46809. * Enable or disable color writing
  46810. * @param enable defines the state to set
  46811. */
  46812. setColorWrite(enable: boolean): void;
  46813. /**
  46814. * Gets a boolean indicating if color writing is enabled
  46815. * @returns the current color writing state
  46816. */
  46817. getColorWrite(): boolean;
  46818. /**
  46819. * Sets alpha constants used by some alpha blending modes
  46820. * @param r defines the red component
  46821. * @param g defines the green component
  46822. * @param b defines the blue component
  46823. * @param a defines the alpha component
  46824. */
  46825. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  46826. /**
  46827. * Sets the current alpha mode
  46828. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  46829. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  46830. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  46831. */
  46832. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  46833. /**
  46834. * Gets the current alpha mode
  46835. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  46836. * @returns the current alpha mode
  46837. */
  46838. getAlphaMode(): number;
  46839. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  46840. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  46841. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  46842. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  46843. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  46844. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  46845. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  46846. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  46847. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  46848. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  46849. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  46850. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  46851. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  46852. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  46853. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  46854. setFloat(uniform: WebGLUniformLocation, value: number): void;
  46855. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  46856. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  46857. setBool(uniform: WebGLUniformLocation, bool: number): void;
  46858. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  46859. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  46860. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  46861. wipeCaches(bruteForce?: boolean): void;
  46862. _createTexture(): WebGLTexture;
  46863. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  46864. /**
  46865. * Usually called from BABYLON.Texture.ts.
  46866. * Passed information to create a WebGLTexture
  46867. * @param urlArg defines a value which contains one of the following:
  46868. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  46869. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  46870. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  46871. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  46872. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  46873. * @param scene needed for loading to the correct scene
  46874. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  46875. * @param onLoad optional callback to be called upon successful completion
  46876. * @param onError optional callback to be called upon failure
  46877. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  46878. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  46879. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  46880. * @param forcedExtension defines the extension to use to pick the right loader
  46881. * @returns a InternalTexture for assignment back into BABYLON.Texture
  46882. */
  46883. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<Scene>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>): InternalTexture;
  46884. /**
  46885. * Creates a cube texture
  46886. * @param rootUrl defines the url where the files to load is located
  46887. * @param scene defines the current scene
  46888. * @param files defines the list of files to load (1 per face)
  46889. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  46890. * @param onLoad defines an optional callback raised when the texture is loaded
  46891. * @param onError defines an optional callback raised if there is an issue to load the texture
  46892. * @param format defines the format of the data
  46893. * @param forcedExtension defines the extension to use to pick the right loader
  46894. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  46895. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  46896. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  46897. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  46898. * @returns the cube texture as an InternalTexture
  46899. */
  46900. 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;
  46901. private _getSamplingFilter;
  46902. private static _GetNativeTextureFormat;
  46903. createRenderTargetTexture(size: number | {
  46904. width: number;
  46905. height: number;
  46906. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  46907. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  46908. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  46909. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  46910. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  46911. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  46912. /**
  46913. * Updates a dynamic vertex buffer.
  46914. * @param vertexBuffer the vertex buffer to update
  46915. * @param data the data used to update the vertex buffer
  46916. * @param byteOffset the byte offset of the data (optional)
  46917. * @param byteLength the byte length of the data (optional)
  46918. */
  46919. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  46920. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  46921. private _updateAnisotropicLevel;
  46922. private _getAddressMode;
  46923. /** @hidden */
  46924. _bindTexture(channel: number, texture: InternalTexture): void;
  46925. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  46926. releaseEffects(): void;
  46927. /** @hidden */
  46928. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46929. /** @hidden */
  46930. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46931. /** @hidden */
  46932. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46933. /** @hidden */
  46934. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  46935. }
  46936. }
  46937. declare module "babylonjs/Engines/index" {
  46938. export * from "babylonjs/Engines/constants";
  46939. export * from "babylonjs/Engines/engineCapabilities";
  46940. export * from "babylonjs/Engines/instancingAttributeInfo";
  46941. export * from "babylonjs/Engines/thinEngine";
  46942. export * from "babylonjs/Engines/engine";
  46943. export * from "babylonjs/Engines/engineStore";
  46944. export * from "babylonjs/Engines/nullEngine";
  46945. export * from "babylonjs/Engines/Extensions/index";
  46946. export * from "babylonjs/Engines/IPipelineContext";
  46947. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  46948. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  46949. export * from "babylonjs/Engines/nativeEngine";
  46950. }
  46951. declare module "babylonjs/Events/clipboardEvents" {
  46952. /**
  46953. * Gather the list of clipboard event types as constants.
  46954. */
  46955. export class ClipboardEventTypes {
  46956. /**
  46957. * The clipboard event is fired when a copy command is active (pressed).
  46958. */
  46959. static readonly COPY: number;
  46960. /**
  46961. * The clipboard event is fired when a cut command is active (pressed).
  46962. */
  46963. static readonly CUT: number;
  46964. /**
  46965. * The clipboard event is fired when a paste command is active (pressed).
  46966. */
  46967. static readonly PASTE: number;
  46968. }
  46969. /**
  46970. * This class is used to store clipboard related info for the onClipboardObservable event.
  46971. */
  46972. export class ClipboardInfo {
  46973. /**
  46974. * Defines the type of event (BABYLON.ClipboardEventTypes)
  46975. */
  46976. type: number;
  46977. /**
  46978. * Defines the related dom event
  46979. */
  46980. event: ClipboardEvent;
  46981. /**
  46982. *Creates an instance of ClipboardInfo.
  46983. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  46984. * @param event Defines the related dom event
  46985. */
  46986. constructor(
  46987. /**
  46988. * Defines the type of event (BABYLON.ClipboardEventTypes)
  46989. */
  46990. type: number,
  46991. /**
  46992. * Defines the related dom event
  46993. */
  46994. event: ClipboardEvent);
  46995. /**
  46996. * Get the clipboard event's type from the keycode.
  46997. * @param keyCode Defines the keyCode for the current keyboard event.
  46998. * @return {number}
  46999. */
  47000. static GetTypeFromCharacter(keyCode: number): number;
  47001. }
  47002. }
  47003. declare module "babylonjs/Events/index" {
  47004. export * from "babylonjs/Events/keyboardEvents";
  47005. export * from "babylonjs/Events/pointerEvents";
  47006. export * from "babylonjs/Events/clipboardEvents";
  47007. }
  47008. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  47009. import { Scene } from "babylonjs/scene";
  47010. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47011. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  47012. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  47013. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47014. /**
  47015. * Google Daydream controller
  47016. */
  47017. export class DaydreamController extends WebVRController {
  47018. /**
  47019. * Base Url for the controller model.
  47020. */
  47021. static MODEL_BASE_URL: string;
  47022. /**
  47023. * File name for the controller model.
  47024. */
  47025. static MODEL_FILENAME: string;
  47026. /**
  47027. * Gamepad Id prefix used to identify Daydream Controller.
  47028. */
  47029. static readonly GAMEPAD_ID_PREFIX: string;
  47030. /**
  47031. * Creates a new DaydreamController from a gamepad
  47032. * @param vrGamepad the gamepad that the controller should be created from
  47033. */
  47034. constructor(vrGamepad: any);
  47035. /**
  47036. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  47037. * @param scene scene in which to add meshes
  47038. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  47039. */
  47040. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  47041. /**
  47042. * Called once for each button that changed state since the last frame
  47043. * @param buttonIdx Which button index changed
  47044. * @param state New state of the button
  47045. * @param changes Which properties on the state changed since last frame
  47046. */
  47047. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  47048. }
  47049. }
  47050. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  47051. import { Scene } from "babylonjs/scene";
  47052. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47053. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  47054. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  47055. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47056. /**
  47057. * Gear VR Controller
  47058. */
  47059. export class GearVRController extends WebVRController {
  47060. /**
  47061. * Base Url for the controller model.
  47062. */
  47063. static MODEL_BASE_URL: string;
  47064. /**
  47065. * File name for the controller model.
  47066. */
  47067. static MODEL_FILENAME: string;
  47068. /**
  47069. * Gamepad Id prefix used to identify this controller.
  47070. */
  47071. static readonly GAMEPAD_ID_PREFIX: string;
  47072. private readonly _buttonIndexToObservableNameMap;
  47073. /**
  47074. * Creates a new GearVRController from a gamepad
  47075. * @param vrGamepad the gamepad that the controller should be created from
  47076. */
  47077. constructor(vrGamepad: any);
  47078. /**
  47079. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  47080. * @param scene scene in which to add meshes
  47081. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  47082. */
  47083. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  47084. /**
  47085. * Called once for each button that changed state since the last frame
  47086. * @param buttonIdx Which button index changed
  47087. * @param state New state of the button
  47088. * @param changes Which properties on the state changed since last frame
  47089. */
  47090. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  47091. }
  47092. }
  47093. declare module "babylonjs/Gamepads/Controllers/index" {
  47094. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  47095. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  47096. export * from "babylonjs/Gamepads/Controllers/genericController";
  47097. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  47098. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47099. export * from "babylonjs/Gamepads/Controllers/viveController";
  47100. export * from "babylonjs/Gamepads/Controllers/webVRController";
  47101. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  47102. }
  47103. declare module "babylonjs/Gamepads/index" {
  47104. export * from "babylonjs/Gamepads/Controllers/index";
  47105. export * from "babylonjs/Gamepads/gamepad";
  47106. export * from "babylonjs/Gamepads/gamepadManager";
  47107. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  47108. export * from "babylonjs/Gamepads/xboxGamepad";
  47109. export * from "babylonjs/Gamepads/dualShockGamepad";
  47110. }
  47111. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  47112. import { Scene } from "babylonjs/scene";
  47113. import { Vector4 } from "babylonjs/Maths/math.vector";
  47114. import { Color4 } from "babylonjs/Maths/math.color";
  47115. import { Mesh } from "babylonjs/Meshes/mesh";
  47116. import { Nullable } from "babylonjs/types";
  47117. /**
  47118. * Class containing static functions to help procedurally build meshes
  47119. */
  47120. export class PolyhedronBuilder {
  47121. /**
  47122. * Creates a polyhedron mesh
  47123. * * 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
  47124. * * The parameter `size` (positive float, default 1) sets the polygon size
  47125. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  47126. * * 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`
  47127. * * 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
  47128. * * 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)`)
  47129. * * 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
  47130. * * 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
  47131. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  47132. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  47133. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  47134. * @param name defines the name of the mesh
  47135. * @param options defines the options used to create the mesh
  47136. * @param scene defines the hosting scene
  47137. * @returns the polyhedron mesh
  47138. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  47139. */
  47140. static CreatePolyhedron(name: string, options: {
  47141. type?: number;
  47142. size?: number;
  47143. sizeX?: number;
  47144. sizeY?: number;
  47145. sizeZ?: number;
  47146. custom?: any;
  47147. faceUV?: Vector4[];
  47148. faceColors?: Color4[];
  47149. flat?: boolean;
  47150. updatable?: boolean;
  47151. sideOrientation?: number;
  47152. frontUVs?: Vector4;
  47153. backUVs?: Vector4;
  47154. }, scene?: Nullable<Scene>): Mesh;
  47155. }
  47156. }
  47157. declare module "babylonjs/Gizmos/scaleGizmo" {
  47158. import { Observable } from "babylonjs/Misc/observable";
  47159. import { Nullable } from "babylonjs/types";
  47160. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47161. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47162. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  47163. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47164. /**
  47165. * Gizmo that enables scaling a mesh along 3 axis
  47166. */
  47167. export class ScaleGizmo extends Gizmo {
  47168. /**
  47169. * Internal gizmo used for interactions on the x axis
  47170. */
  47171. xGizmo: AxisScaleGizmo;
  47172. /**
  47173. * Internal gizmo used for interactions on the y axis
  47174. */
  47175. yGizmo: AxisScaleGizmo;
  47176. /**
  47177. * Internal gizmo used for interactions on the z axis
  47178. */
  47179. zGizmo: AxisScaleGizmo;
  47180. /**
  47181. * Internal gizmo used to scale all axis equally
  47182. */
  47183. uniformScaleGizmo: AxisScaleGizmo;
  47184. private _meshAttached;
  47185. private _updateGizmoRotationToMatchAttachedMesh;
  47186. private _snapDistance;
  47187. private _scaleRatio;
  47188. private _uniformScalingMesh;
  47189. private _octahedron;
  47190. /** Fires an event when any of it's sub gizmos are dragged */
  47191. onDragStartObservable: Observable<unknown>;
  47192. /** Fires an event when any of it's sub gizmos are released from dragging */
  47193. onDragEndObservable: Observable<unknown>;
  47194. attachedMesh: Nullable<AbstractMesh>;
  47195. /**
  47196. * Creates a ScaleGizmo
  47197. * @param gizmoLayer The utility layer the gizmo will be added to
  47198. */
  47199. constructor(gizmoLayer?: UtilityLayerRenderer);
  47200. updateGizmoRotationToMatchAttachedMesh: boolean;
  47201. /**
  47202. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47203. */
  47204. snapDistance: number;
  47205. /**
  47206. * Ratio for the scale of the gizmo (Default: 1)
  47207. */
  47208. scaleRatio: number;
  47209. /**
  47210. * Disposes of the gizmo
  47211. */
  47212. dispose(): void;
  47213. }
  47214. }
  47215. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  47216. import { Observable } from "babylonjs/Misc/observable";
  47217. import { Nullable } from "babylonjs/types";
  47218. import { Vector3 } from "babylonjs/Maths/math.vector";
  47219. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47220. import { Mesh } from "babylonjs/Meshes/mesh";
  47221. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  47222. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47223. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47224. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  47225. import { Color3 } from "babylonjs/Maths/math.color";
  47226. /**
  47227. * Single axis scale gizmo
  47228. */
  47229. export class AxisScaleGizmo extends Gizmo {
  47230. /**
  47231. * Drag behavior responsible for the gizmos dragging interactions
  47232. */
  47233. dragBehavior: PointerDragBehavior;
  47234. private _pointerObserver;
  47235. /**
  47236. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47237. */
  47238. snapDistance: number;
  47239. /**
  47240. * Event that fires each time the gizmo snaps to a new location.
  47241. * * snapDistance is the the change in distance
  47242. */
  47243. onSnapObservable: Observable<{
  47244. snapDistance: number;
  47245. }>;
  47246. /**
  47247. * If the scaling operation should be done on all axis (default: false)
  47248. */
  47249. uniformScaling: boolean;
  47250. private _isEnabled;
  47251. private _parent;
  47252. private _arrow;
  47253. private _coloredMaterial;
  47254. private _hoverMaterial;
  47255. /**
  47256. * Creates an AxisScaleGizmo
  47257. * @param gizmoLayer The utility layer the gizmo will be added to
  47258. * @param dragAxis The axis which the gizmo will be able to scale on
  47259. * @param color The color of the gizmo
  47260. */
  47261. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  47262. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47263. /**
  47264. * If the gizmo is enabled
  47265. */
  47266. isEnabled: boolean;
  47267. /**
  47268. * Disposes of the gizmo
  47269. */
  47270. dispose(): void;
  47271. /**
  47272. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  47273. * @param mesh The mesh to replace the default mesh of the gizmo
  47274. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  47275. */
  47276. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  47277. }
  47278. }
  47279. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  47280. import { Observable } from "babylonjs/Misc/observable";
  47281. import { Nullable } from "babylonjs/types";
  47282. import { Vector3 } from "babylonjs/Maths/math.vector";
  47283. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47284. import { Mesh } from "babylonjs/Meshes/mesh";
  47285. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47286. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47287. import { Color3 } from "babylonjs/Maths/math.color";
  47288. import "babylonjs/Meshes/Builders/boxBuilder";
  47289. /**
  47290. * Bounding box gizmo
  47291. */
  47292. export class BoundingBoxGizmo extends Gizmo {
  47293. private _lineBoundingBox;
  47294. private _rotateSpheresParent;
  47295. private _scaleBoxesParent;
  47296. private _boundingDimensions;
  47297. private _renderObserver;
  47298. private _pointerObserver;
  47299. private _scaleDragSpeed;
  47300. private _tmpQuaternion;
  47301. private _tmpVector;
  47302. private _tmpRotationMatrix;
  47303. /**
  47304. * 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)
  47305. */
  47306. ignoreChildren: boolean;
  47307. /**
  47308. * 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)
  47309. */
  47310. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  47311. /**
  47312. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  47313. */
  47314. rotationSphereSize: number;
  47315. /**
  47316. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  47317. */
  47318. scaleBoxSize: number;
  47319. /**
  47320. * 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)
  47321. */
  47322. fixedDragMeshScreenSize: boolean;
  47323. /**
  47324. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  47325. */
  47326. fixedDragMeshScreenSizeDistanceFactor: number;
  47327. /**
  47328. * Fired when a rotation sphere or scale box is dragged
  47329. */
  47330. onDragStartObservable: Observable<{}>;
  47331. /**
  47332. * Fired when a scale box is dragged
  47333. */
  47334. onScaleBoxDragObservable: Observable<{}>;
  47335. /**
  47336. * Fired when a scale box drag is ended
  47337. */
  47338. onScaleBoxDragEndObservable: Observable<{}>;
  47339. /**
  47340. * Fired when a rotation sphere is dragged
  47341. */
  47342. onRotationSphereDragObservable: Observable<{}>;
  47343. /**
  47344. * Fired when a rotation sphere drag is ended
  47345. */
  47346. onRotationSphereDragEndObservable: Observable<{}>;
  47347. /**
  47348. * Relative bounding box pivot used when scaling the attached mesh. 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)
  47349. */
  47350. scalePivot: Nullable<Vector3>;
  47351. /**
  47352. * Mesh used as a pivot to rotate the attached mesh
  47353. */
  47354. private _anchorMesh;
  47355. private _existingMeshScale;
  47356. private _dragMesh;
  47357. private pointerDragBehavior;
  47358. private coloredMaterial;
  47359. private hoverColoredMaterial;
  47360. /**
  47361. * Sets the color of the bounding box gizmo
  47362. * @param color the color to set
  47363. */
  47364. setColor(color: Color3): void;
  47365. /**
  47366. * Creates an BoundingBoxGizmo
  47367. * @param gizmoLayer The utility layer the gizmo will be added to
  47368. * @param color The color of the gizmo
  47369. */
  47370. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  47371. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47372. private _selectNode;
  47373. /**
  47374. * Updates the bounding box information for the Gizmo
  47375. */
  47376. updateBoundingBox(): void;
  47377. private _updateRotationSpheres;
  47378. private _updateScaleBoxes;
  47379. /**
  47380. * Enables rotation on the specified axis and disables rotation on the others
  47381. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  47382. */
  47383. setEnabledRotationAxis(axis: string): void;
  47384. /**
  47385. * Enables/disables scaling
  47386. * @param enable if scaling should be enabled
  47387. */
  47388. setEnabledScaling(enable: boolean): void;
  47389. private _updateDummy;
  47390. /**
  47391. * Enables a pointer drag behavior on the bounding box of the gizmo
  47392. */
  47393. enableDragBehavior(): void;
  47394. /**
  47395. * Disposes of the gizmo
  47396. */
  47397. dispose(): void;
  47398. /**
  47399. * 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)
  47400. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  47401. * @returns the bounding box mesh with the passed in mesh as a child
  47402. */
  47403. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  47404. /**
  47405. * CustomMeshes are not supported by this gizmo
  47406. * @param mesh The mesh to replace the default mesh of the gizmo
  47407. */
  47408. setCustomMesh(mesh: Mesh): void;
  47409. }
  47410. }
  47411. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  47412. import { Observable } from "babylonjs/Misc/observable";
  47413. import { Nullable } from "babylonjs/types";
  47414. import { Vector3 } from "babylonjs/Maths/math.vector";
  47415. import { Color3 } from "babylonjs/Maths/math.color";
  47416. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47417. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  47418. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47419. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47420. import "babylonjs/Meshes/Builders/linesBuilder";
  47421. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  47422. /**
  47423. * Single plane rotation gizmo
  47424. */
  47425. export class PlaneRotationGizmo extends Gizmo {
  47426. /**
  47427. * Drag behavior responsible for the gizmos dragging interactions
  47428. */
  47429. dragBehavior: PointerDragBehavior;
  47430. private _pointerObserver;
  47431. /**
  47432. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  47433. */
  47434. snapDistance: number;
  47435. /**
  47436. * Event that fires each time the gizmo snaps to a new location.
  47437. * * snapDistance is the the change in distance
  47438. */
  47439. onSnapObservable: Observable<{
  47440. snapDistance: number;
  47441. }>;
  47442. private _isEnabled;
  47443. private _parent;
  47444. /**
  47445. * Creates a PlaneRotationGizmo
  47446. * @param gizmoLayer The utility layer the gizmo will be added to
  47447. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  47448. * @param color The color of the gizmo
  47449. * @param tessellation Amount of tessellation to be used when creating rotation circles
  47450. * @param useEulerRotation Use and update Euler angle instead of quaternion
  47451. */
  47452. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  47453. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47454. /**
  47455. * If the gizmo is enabled
  47456. */
  47457. isEnabled: boolean;
  47458. /**
  47459. * Disposes of the gizmo
  47460. */
  47461. dispose(): void;
  47462. }
  47463. }
  47464. declare module "babylonjs/Gizmos/rotationGizmo" {
  47465. import { Observable } from "babylonjs/Misc/observable";
  47466. import { Nullable } from "babylonjs/types";
  47467. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47468. import { Mesh } from "babylonjs/Meshes/mesh";
  47469. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47470. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  47471. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47472. /**
  47473. * Gizmo that enables rotating a mesh along 3 axis
  47474. */
  47475. export class RotationGizmo extends Gizmo {
  47476. /**
  47477. * Internal gizmo used for interactions on the x axis
  47478. */
  47479. xGizmo: PlaneRotationGizmo;
  47480. /**
  47481. * Internal gizmo used for interactions on the y axis
  47482. */
  47483. yGizmo: PlaneRotationGizmo;
  47484. /**
  47485. * Internal gizmo used for interactions on the z axis
  47486. */
  47487. zGizmo: PlaneRotationGizmo;
  47488. /** Fires an event when any of it's sub gizmos are dragged */
  47489. onDragStartObservable: Observable<unknown>;
  47490. /** Fires an event when any of it's sub gizmos are released from dragging */
  47491. onDragEndObservable: Observable<unknown>;
  47492. private _meshAttached;
  47493. attachedMesh: Nullable<AbstractMesh>;
  47494. /**
  47495. * Creates a RotationGizmo
  47496. * @param gizmoLayer The utility layer the gizmo will be added to
  47497. * @param tessellation Amount of tessellation to be used when creating rotation circles
  47498. * @param useEulerRotation Use and update Euler angle instead of quaternion
  47499. */
  47500. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  47501. updateGizmoRotationToMatchAttachedMesh: boolean;
  47502. /**
  47503. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47504. */
  47505. snapDistance: number;
  47506. /**
  47507. * Ratio for the scale of the gizmo (Default: 1)
  47508. */
  47509. scaleRatio: number;
  47510. /**
  47511. * Disposes of the gizmo
  47512. */
  47513. dispose(): void;
  47514. /**
  47515. * CustomMeshes are not supported by this gizmo
  47516. * @param mesh The mesh to replace the default mesh of the gizmo
  47517. */
  47518. setCustomMesh(mesh: Mesh): void;
  47519. }
  47520. }
  47521. declare module "babylonjs/Gizmos/gizmoManager" {
  47522. import { Observable } from "babylonjs/Misc/observable";
  47523. import { Nullable } from "babylonjs/types";
  47524. import { Scene, IDisposable } from "babylonjs/scene";
  47525. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47526. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47527. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  47528. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  47529. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  47530. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  47531. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  47532. /**
  47533. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  47534. */
  47535. export class GizmoManager implements IDisposable {
  47536. private scene;
  47537. /**
  47538. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  47539. */
  47540. gizmos: {
  47541. positionGizmo: Nullable<PositionGizmo>;
  47542. rotationGizmo: Nullable<RotationGizmo>;
  47543. scaleGizmo: Nullable<ScaleGizmo>;
  47544. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  47545. };
  47546. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  47547. clearGizmoOnEmptyPointerEvent: boolean;
  47548. /** Fires an event when the manager is attached to a mesh */
  47549. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  47550. private _gizmosEnabled;
  47551. private _pointerObserver;
  47552. private _attachedMesh;
  47553. private _boundingBoxColor;
  47554. private _defaultUtilityLayer;
  47555. private _defaultKeepDepthUtilityLayer;
  47556. /**
  47557. * When bounding box gizmo is enabled, this can be used to track drag/end events
  47558. */
  47559. boundingBoxDragBehavior: SixDofDragBehavior;
  47560. /**
  47561. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  47562. */
  47563. attachableMeshes: Nullable<Array<AbstractMesh>>;
  47564. /**
  47565. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  47566. */
  47567. usePointerToAttachGizmos: boolean;
  47568. /**
  47569. * Utility layer that the bounding box gizmo belongs to
  47570. */
  47571. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  47572. /**
  47573. * Utility layer that all gizmos besides bounding box belong to
  47574. */
  47575. readonly utilityLayer: UtilityLayerRenderer;
  47576. /**
  47577. * Instatiates a gizmo manager
  47578. * @param scene the scene to overlay the gizmos on top of
  47579. */
  47580. constructor(scene: Scene);
  47581. /**
  47582. * Attaches a set of gizmos to the specified mesh
  47583. * @param mesh The mesh the gizmo's should be attached to
  47584. */
  47585. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  47586. /**
  47587. * If the position gizmo is enabled
  47588. */
  47589. positionGizmoEnabled: boolean;
  47590. /**
  47591. * If the rotation gizmo is enabled
  47592. */
  47593. rotationGizmoEnabled: boolean;
  47594. /**
  47595. * If the scale gizmo is enabled
  47596. */
  47597. scaleGizmoEnabled: boolean;
  47598. /**
  47599. * If the boundingBox gizmo is enabled
  47600. */
  47601. boundingBoxGizmoEnabled: boolean;
  47602. /**
  47603. * Disposes of the gizmo manager
  47604. */
  47605. dispose(): void;
  47606. }
  47607. }
  47608. declare module "babylonjs/Lights/directionalLight" {
  47609. import { Camera } from "babylonjs/Cameras/camera";
  47610. import { Scene } from "babylonjs/scene";
  47611. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  47612. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47613. import { Light } from "babylonjs/Lights/light";
  47614. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  47615. import { Effect } from "babylonjs/Materials/effect";
  47616. /**
  47617. * A directional light is defined by a direction (what a surprise!).
  47618. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  47619. * 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.
  47620. * Documentation: https://doc.babylonjs.com/babylon101/lights
  47621. */
  47622. export class DirectionalLight extends ShadowLight {
  47623. private _shadowFrustumSize;
  47624. /**
  47625. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  47626. */
  47627. /**
  47628. * Specifies a fix frustum size for the shadow generation.
  47629. */
  47630. shadowFrustumSize: number;
  47631. private _shadowOrthoScale;
  47632. /**
  47633. * Gets the shadow projection scale against the optimal computed one.
  47634. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  47635. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  47636. */
  47637. /**
  47638. * Sets the shadow projection scale against the optimal computed one.
  47639. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  47640. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  47641. */
  47642. shadowOrthoScale: number;
  47643. /**
  47644. * Automatically compute the projection matrix to best fit (including all the casters)
  47645. * on each frame.
  47646. */
  47647. autoUpdateExtends: boolean;
  47648. private _orthoLeft;
  47649. private _orthoRight;
  47650. private _orthoTop;
  47651. private _orthoBottom;
  47652. /**
  47653. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  47654. * The directional light is emitted from everywhere in the given direction.
  47655. * It can cast shadows.
  47656. * Documentation : https://doc.babylonjs.com/babylon101/lights
  47657. * @param name The friendly name of the light
  47658. * @param direction The direction of the light
  47659. * @param scene The scene the light belongs to
  47660. */
  47661. constructor(name: string, direction: Vector3, scene: Scene);
  47662. /**
  47663. * Returns the string "DirectionalLight".
  47664. * @return The class name
  47665. */
  47666. getClassName(): string;
  47667. /**
  47668. * Returns the integer 1.
  47669. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  47670. */
  47671. getTypeID(): number;
  47672. /**
  47673. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  47674. * Returns the DirectionalLight Shadow projection matrix.
  47675. */
  47676. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  47677. /**
  47678. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  47679. * Returns the DirectionalLight Shadow projection matrix.
  47680. */
  47681. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  47682. /**
  47683. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  47684. * Returns the DirectionalLight Shadow projection matrix.
  47685. */
  47686. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  47687. protected _buildUniformLayout(): void;
  47688. /**
  47689. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  47690. * @param effect The effect to update
  47691. * @param lightIndex The index of the light in the effect to update
  47692. * @returns The directional light
  47693. */
  47694. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  47695. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  47696. /**
  47697. * Gets the minZ used for shadow according to both the scene and the light.
  47698. *
  47699. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  47700. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  47701. * @param activeCamera The camera we are returning the min for
  47702. * @returns the depth min z
  47703. */
  47704. getDepthMinZ(activeCamera: Camera): number;
  47705. /**
  47706. * Gets the maxZ used for shadow according to both the scene and the light.
  47707. *
  47708. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  47709. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  47710. * @param activeCamera The camera we are returning the max for
  47711. * @returns the depth max z
  47712. */
  47713. getDepthMaxZ(activeCamera: Camera): number;
  47714. /**
  47715. * Prepares the list of defines specific to the light type.
  47716. * @param defines the list of defines
  47717. * @param lightIndex defines the index of the light for the effect
  47718. */
  47719. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  47720. }
  47721. }
  47722. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  47723. import { Mesh } from "babylonjs/Meshes/mesh";
  47724. /**
  47725. * Class containing static functions to help procedurally build meshes
  47726. */
  47727. export class HemisphereBuilder {
  47728. /**
  47729. * Creates a hemisphere mesh
  47730. * @param name defines the name of the mesh
  47731. * @param options defines the options used to create the mesh
  47732. * @param scene defines the hosting scene
  47733. * @returns the hemisphere mesh
  47734. */
  47735. static CreateHemisphere(name: string, options: {
  47736. segments?: number;
  47737. diameter?: number;
  47738. sideOrientation?: number;
  47739. }, scene: any): Mesh;
  47740. }
  47741. }
  47742. declare module "babylonjs/Lights/spotLight" {
  47743. import { Nullable } from "babylonjs/types";
  47744. import { Scene } from "babylonjs/scene";
  47745. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  47746. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47747. import { Effect } from "babylonjs/Materials/effect";
  47748. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47749. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  47750. /**
  47751. * A spot light is defined by a position, a direction, an angle, and an exponent.
  47752. * These values define a cone of light starting from the position, emitting toward the direction.
  47753. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  47754. * and the exponent defines the speed of the decay of the light with distance (reach).
  47755. * Documentation: https://doc.babylonjs.com/babylon101/lights
  47756. */
  47757. export class SpotLight extends ShadowLight {
  47758. private _angle;
  47759. private _innerAngle;
  47760. private _cosHalfAngle;
  47761. private _lightAngleScale;
  47762. private _lightAngleOffset;
  47763. /**
  47764. * Gets the cone angle of the spot light in Radians.
  47765. */
  47766. /**
  47767. * Sets the cone angle of the spot light in Radians.
  47768. */
  47769. angle: number;
  47770. /**
  47771. * Only used in gltf falloff mode, this defines the angle where
  47772. * the directional falloff will start before cutting at angle which could be seen
  47773. * as outer angle.
  47774. */
  47775. /**
  47776. * Only used in gltf falloff mode, this defines the angle where
  47777. * the directional falloff will start before cutting at angle which could be seen
  47778. * as outer angle.
  47779. */
  47780. innerAngle: number;
  47781. private _shadowAngleScale;
  47782. /**
  47783. * Allows scaling the angle of the light for shadow generation only.
  47784. */
  47785. /**
  47786. * Allows scaling the angle of the light for shadow generation only.
  47787. */
  47788. shadowAngleScale: number;
  47789. /**
  47790. * The light decay speed with the distance from the emission spot.
  47791. */
  47792. exponent: number;
  47793. private _projectionTextureMatrix;
  47794. /**
  47795. * Allows reading the projecton texture
  47796. */
  47797. readonly projectionTextureMatrix: Matrix;
  47798. protected _projectionTextureLightNear: number;
  47799. /**
  47800. * Gets the near clip of the Spotlight for texture projection.
  47801. */
  47802. /**
  47803. * Sets the near clip of the Spotlight for texture projection.
  47804. */
  47805. projectionTextureLightNear: number;
  47806. protected _projectionTextureLightFar: number;
  47807. /**
  47808. * Gets the far clip of the Spotlight for texture projection.
  47809. */
  47810. /**
  47811. * Sets the far clip of the Spotlight for texture projection.
  47812. */
  47813. projectionTextureLightFar: number;
  47814. protected _projectionTextureUpDirection: Vector3;
  47815. /**
  47816. * Gets the Up vector of the Spotlight for texture projection.
  47817. */
  47818. /**
  47819. * Sets the Up vector of the Spotlight for texture projection.
  47820. */
  47821. projectionTextureUpDirection: Vector3;
  47822. private _projectionTexture;
  47823. /**
  47824. * Gets the projection texture of the light.
  47825. */
  47826. /**
  47827. * Sets the projection texture of the light.
  47828. */
  47829. projectionTexture: Nullable<BaseTexture>;
  47830. private _projectionTextureViewLightDirty;
  47831. private _projectionTextureProjectionLightDirty;
  47832. private _projectionTextureDirty;
  47833. private _projectionTextureViewTargetVector;
  47834. private _projectionTextureViewLightMatrix;
  47835. private _projectionTextureProjectionLightMatrix;
  47836. private _projectionTextureScalingMatrix;
  47837. /**
  47838. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  47839. * It can cast shadows.
  47840. * Documentation : https://doc.babylonjs.com/babylon101/lights
  47841. * @param name The light friendly name
  47842. * @param position The position of the spot light in the scene
  47843. * @param direction The direction of the light in the scene
  47844. * @param angle The cone angle of the light in Radians
  47845. * @param exponent The light decay speed with the distance from the emission spot
  47846. * @param scene The scene the lights belongs to
  47847. */
  47848. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  47849. /**
  47850. * Returns the string "SpotLight".
  47851. * @returns the class name
  47852. */
  47853. getClassName(): string;
  47854. /**
  47855. * Returns the integer 2.
  47856. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  47857. */
  47858. getTypeID(): number;
  47859. /**
  47860. * Overrides the direction setter to recompute the projection texture view light Matrix.
  47861. */
  47862. protected _setDirection(value: Vector3): void;
  47863. /**
  47864. * Overrides the position setter to recompute the projection texture view light Matrix.
  47865. */
  47866. protected _setPosition(value: Vector3): void;
  47867. /**
  47868. * 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.
  47869. * Returns the SpotLight.
  47870. */
  47871. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  47872. protected _computeProjectionTextureViewLightMatrix(): void;
  47873. protected _computeProjectionTextureProjectionLightMatrix(): void;
  47874. /**
  47875. * Main function for light texture projection matrix computing.
  47876. */
  47877. protected _computeProjectionTextureMatrix(): void;
  47878. protected _buildUniformLayout(): void;
  47879. private _computeAngleValues;
  47880. /**
  47881. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  47882. * @param effect The effect to update
  47883. * @param lightIndex The index of the light in the effect to update
  47884. * @returns The spot light
  47885. */
  47886. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  47887. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  47888. /**
  47889. * Disposes the light and the associated resources.
  47890. */
  47891. dispose(): void;
  47892. /**
  47893. * Prepares the list of defines specific to the light type.
  47894. * @param defines the list of defines
  47895. * @param lightIndex defines the index of the light for the effect
  47896. */
  47897. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  47898. }
  47899. }
  47900. declare module "babylonjs/Gizmos/lightGizmo" {
  47901. import { Nullable } from "babylonjs/types";
  47902. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47903. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47904. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  47905. import { Light } from "babylonjs/Lights/light";
  47906. /**
  47907. * Gizmo that enables viewing a light
  47908. */
  47909. export class LightGizmo extends Gizmo {
  47910. private _lightMesh;
  47911. private _material;
  47912. private cachedPosition;
  47913. private cachedForward;
  47914. /**
  47915. * Creates a LightGizmo
  47916. * @param gizmoLayer The utility layer the gizmo will be added to
  47917. */
  47918. constructor(gizmoLayer?: UtilityLayerRenderer);
  47919. private _light;
  47920. /**
  47921. * The light that the gizmo is attached to
  47922. */
  47923. light: Nullable<Light>;
  47924. /**
  47925. * Gets the material used to render the light gizmo
  47926. */
  47927. readonly material: StandardMaterial;
  47928. /**
  47929. * @hidden
  47930. * Updates the gizmo to match the attached mesh's position/rotation
  47931. */
  47932. protected _update(): void;
  47933. private static _Scale;
  47934. /**
  47935. * Creates the lines for a light mesh
  47936. */
  47937. private static _createLightLines;
  47938. /**
  47939. * Disposes of the light gizmo
  47940. */
  47941. dispose(): void;
  47942. private static _CreateHemisphericLightMesh;
  47943. private static _CreatePointLightMesh;
  47944. private static _CreateSpotLightMesh;
  47945. private static _CreateDirectionalLightMesh;
  47946. }
  47947. }
  47948. declare module "babylonjs/Gizmos/index" {
  47949. export * from "babylonjs/Gizmos/axisDragGizmo";
  47950. export * from "babylonjs/Gizmos/axisScaleGizmo";
  47951. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  47952. export * from "babylonjs/Gizmos/gizmo";
  47953. export * from "babylonjs/Gizmos/gizmoManager";
  47954. export * from "babylonjs/Gizmos/planeRotationGizmo";
  47955. export * from "babylonjs/Gizmos/positionGizmo";
  47956. export * from "babylonjs/Gizmos/rotationGizmo";
  47957. export * from "babylonjs/Gizmos/scaleGizmo";
  47958. export * from "babylonjs/Gizmos/lightGizmo";
  47959. export * from "babylonjs/Gizmos/planeDragGizmo";
  47960. }
  47961. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  47962. /** @hidden */
  47963. export var backgroundFragmentDeclaration: {
  47964. name: string;
  47965. shader: string;
  47966. };
  47967. }
  47968. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  47969. /** @hidden */
  47970. export var backgroundUboDeclaration: {
  47971. name: string;
  47972. shader: string;
  47973. };
  47974. }
  47975. declare module "babylonjs/Shaders/background.fragment" {
  47976. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  47977. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  47978. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  47979. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  47980. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  47981. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  47982. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  47983. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  47984. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  47985. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  47986. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  47987. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  47988. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  47989. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  47990. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  47991. /** @hidden */
  47992. export var backgroundPixelShader: {
  47993. name: string;
  47994. shader: string;
  47995. };
  47996. }
  47997. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  47998. /** @hidden */
  47999. export var backgroundVertexDeclaration: {
  48000. name: string;
  48001. shader: string;
  48002. };
  48003. }
  48004. declare module "babylonjs/Shaders/background.vertex" {
  48005. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  48006. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  48007. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  48008. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  48009. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  48010. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  48011. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  48012. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  48013. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  48014. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  48015. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  48016. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  48017. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  48018. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  48019. /** @hidden */
  48020. export var backgroundVertexShader: {
  48021. name: string;
  48022. shader: string;
  48023. };
  48024. }
  48025. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  48026. import { Nullable, int, float } from "babylonjs/types";
  48027. import { Scene } from "babylonjs/scene";
  48028. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  48029. import { SubMesh } from "babylonjs/Meshes/subMesh";
  48030. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48031. import { Mesh } from "babylonjs/Meshes/mesh";
  48032. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  48033. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  48034. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  48035. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48036. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  48037. import { Color3 } from "babylonjs/Maths/math.color";
  48038. import "babylonjs/Shaders/background.fragment";
  48039. import "babylonjs/Shaders/background.vertex";
  48040. /**
  48041. * Background material used to create an efficient environement around your scene.
  48042. */
  48043. export class BackgroundMaterial extends PushMaterial {
  48044. /**
  48045. * Standard reflectance value at parallel view angle.
  48046. */
  48047. static StandardReflectance0: number;
  48048. /**
  48049. * Standard reflectance value at grazing angle.
  48050. */
  48051. static StandardReflectance90: number;
  48052. protected _primaryColor: Color3;
  48053. /**
  48054. * Key light Color (multiply against the environement texture)
  48055. */
  48056. primaryColor: Color3;
  48057. protected __perceptualColor: Nullable<Color3>;
  48058. /**
  48059. * Experimental Internal Use Only.
  48060. *
  48061. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  48062. * This acts as a helper to set the primary color to a more "human friendly" value.
  48063. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  48064. * output color as close as possible from the chosen value.
  48065. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  48066. * part of lighting setup.)
  48067. */
  48068. _perceptualColor: Nullable<Color3>;
  48069. protected _primaryColorShadowLevel: float;
  48070. /**
  48071. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  48072. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  48073. */
  48074. primaryColorShadowLevel: float;
  48075. protected _primaryColorHighlightLevel: float;
  48076. /**
  48077. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  48078. * The primary color is used at the level chosen to define what the white area would look.
  48079. */
  48080. primaryColorHighlightLevel: float;
  48081. protected _reflectionTexture: Nullable<BaseTexture>;
  48082. /**
  48083. * Reflection Texture used in the material.
  48084. * Should be author in a specific way for the best result (refer to the documentation).
  48085. */
  48086. reflectionTexture: Nullable<BaseTexture>;
  48087. protected _reflectionBlur: float;
  48088. /**
  48089. * Reflection Texture level of blur.
  48090. *
  48091. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  48092. * texture twice.
  48093. */
  48094. reflectionBlur: float;
  48095. protected _diffuseTexture: Nullable<BaseTexture>;
  48096. /**
  48097. * Diffuse Texture used in the material.
  48098. * Should be author in a specific way for the best result (refer to the documentation).
  48099. */
  48100. diffuseTexture: Nullable<BaseTexture>;
  48101. protected _shadowLights: Nullable<IShadowLight[]>;
  48102. /**
  48103. * Specify the list of lights casting shadow on the material.
  48104. * All scene shadow lights will be included if null.
  48105. */
  48106. shadowLights: Nullable<IShadowLight[]>;
  48107. protected _shadowLevel: float;
  48108. /**
  48109. * Helps adjusting the shadow to a softer level if required.
  48110. * 0 means black shadows and 1 means no shadows.
  48111. */
  48112. shadowLevel: float;
  48113. protected _sceneCenter: Vector3;
  48114. /**
  48115. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  48116. * It is usually zero but might be interesting to modify according to your setup.
  48117. */
  48118. sceneCenter: Vector3;
  48119. protected _opacityFresnel: boolean;
  48120. /**
  48121. * This helps specifying that the material is falling off to the sky box at grazing angle.
  48122. * This helps ensuring a nice transition when the camera goes under the ground.
  48123. */
  48124. opacityFresnel: boolean;
  48125. protected _reflectionFresnel: boolean;
  48126. /**
  48127. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  48128. * This helps adding a mirror texture on the ground.
  48129. */
  48130. reflectionFresnel: boolean;
  48131. protected _reflectionFalloffDistance: number;
  48132. /**
  48133. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  48134. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  48135. */
  48136. reflectionFalloffDistance: number;
  48137. protected _reflectionAmount: number;
  48138. /**
  48139. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  48140. */
  48141. reflectionAmount: number;
  48142. protected _reflectionReflectance0: number;
  48143. /**
  48144. * This specifies the weight of the reflection at grazing angle.
  48145. */
  48146. reflectionReflectance0: number;
  48147. protected _reflectionReflectance90: number;
  48148. /**
  48149. * This specifies the weight of the reflection at a perpendicular point of view.
  48150. */
  48151. reflectionReflectance90: number;
  48152. /**
  48153. * Sets the reflection reflectance fresnel values according to the default standard
  48154. * empirically know to work well :-)
  48155. */
  48156. reflectionStandardFresnelWeight: number;
  48157. protected _useRGBColor: boolean;
  48158. /**
  48159. * Helps to directly use the maps channels instead of their level.
  48160. */
  48161. useRGBColor: boolean;
  48162. protected _enableNoise: boolean;
  48163. /**
  48164. * This helps reducing the banding effect that could occur on the background.
  48165. */
  48166. enableNoise: boolean;
  48167. /**
  48168. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  48169. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  48170. * Recommended to be keep at 1.0 except for special cases.
  48171. */
  48172. fovMultiplier: number;
  48173. private _fovMultiplier;
  48174. /**
  48175. * Enable the FOV adjustment feature controlled by fovMultiplier.
  48176. */
  48177. useEquirectangularFOV: boolean;
  48178. private _maxSimultaneousLights;
  48179. /**
  48180. * Number of Simultaneous lights allowed on the material.
  48181. */
  48182. maxSimultaneousLights: int;
  48183. /**
  48184. * Default configuration related to image processing available in the Background Material.
  48185. */
  48186. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  48187. /**
  48188. * Keep track of the image processing observer to allow dispose and replace.
  48189. */
  48190. private _imageProcessingObserver;
  48191. /**
  48192. * Attaches a new image processing configuration to the PBR Material.
  48193. * @param configuration (if null the scene configuration will be use)
  48194. */
  48195. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  48196. /**
  48197. * Gets the image processing configuration used either in this material.
  48198. */
  48199. /**
  48200. * Sets the Default image processing configuration used either in the this material.
  48201. *
  48202. * If sets to null, the scene one is in use.
  48203. */
  48204. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  48205. /**
  48206. * Gets wether the color curves effect is enabled.
  48207. */
  48208. /**
  48209. * Sets wether the color curves effect is enabled.
  48210. */
  48211. cameraColorCurvesEnabled: boolean;
  48212. /**
  48213. * Gets wether the color grading effect is enabled.
  48214. */
  48215. /**
  48216. * Gets wether the color grading effect is enabled.
  48217. */
  48218. cameraColorGradingEnabled: boolean;
  48219. /**
  48220. * Gets wether tonemapping is enabled or not.
  48221. */
  48222. /**
  48223. * Sets wether tonemapping is enabled or not
  48224. */
  48225. cameraToneMappingEnabled: boolean;
  48226. /**
  48227. * The camera exposure used on this material.
  48228. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  48229. * This corresponds to a photographic exposure.
  48230. */
  48231. /**
  48232. * The camera exposure used on this material.
  48233. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  48234. * This corresponds to a photographic exposure.
  48235. */
  48236. cameraExposure: float;
  48237. /**
  48238. * Gets The camera contrast used on this material.
  48239. */
  48240. /**
  48241. * Sets The camera contrast used on this material.
  48242. */
  48243. cameraContrast: float;
  48244. /**
  48245. * Gets the Color Grading 2D Lookup Texture.
  48246. */
  48247. /**
  48248. * Sets the Color Grading 2D Lookup Texture.
  48249. */
  48250. cameraColorGradingTexture: Nullable<BaseTexture>;
  48251. /**
  48252. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  48253. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  48254. * 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;
  48255. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  48256. */
  48257. /**
  48258. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  48259. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  48260. * 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;
  48261. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  48262. */
  48263. cameraColorCurves: Nullable<ColorCurves>;
  48264. /**
  48265. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  48266. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  48267. */
  48268. switchToBGR: boolean;
  48269. private _renderTargets;
  48270. private _reflectionControls;
  48271. private _white;
  48272. private _primaryShadowColor;
  48273. private _primaryHighlightColor;
  48274. /**
  48275. * Instantiates a Background Material in the given scene
  48276. * @param name The friendly name of the material
  48277. * @param scene The scene to add the material to
  48278. */
  48279. constructor(name: string, scene: Scene);
  48280. /**
  48281. * Gets a boolean indicating that current material needs to register RTT
  48282. */
  48283. readonly hasRenderTargetTextures: boolean;
  48284. /**
  48285. * The entire material has been created in order to prevent overdraw.
  48286. * @returns false
  48287. */
  48288. needAlphaTesting(): boolean;
  48289. /**
  48290. * The entire material has been created in order to prevent overdraw.
  48291. * @returns true if blending is enable
  48292. */
  48293. needAlphaBlending(): boolean;
  48294. /**
  48295. * Checks wether the material is ready to be rendered for a given mesh.
  48296. * @param mesh The mesh to render
  48297. * @param subMesh The submesh to check against
  48298. * @param useInstances Specify wether or not the material is used with instances
  48299. * @returns true if all the dependencies are ready (Textures, Effects...)
  48300. */
  48301. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  48302. /**
  48303. * Compute the primary color according to the chosen perceptual color.
  48304. */
  48305. private _computePrimaryColorFromPerceptualColor;
  48306. /**
  48307. * Compute the highlights and shadow colors according to their chosen levels.
  48308. */
  48309. private _computePrimaryColors;
  48310. /**
  48311. * Build the uniform buffer used in the material.
  48312. */
  48313. buildUniformLayout(): void;
  48314. /**
  48315. * Unbind the material.
  48316. */
  48317. unbind(): void;
  48318. /**
  48319. * Bind only the world matrix to the material.
  48320. * @param world The world matrix to bind.
  48321. */
  48322. bindOnlyWorldMatrix(world: Matrix): void;
  48323. /**
  48324. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  48325. * @param world The world matrix to bind.
  48326. * @param subMesh The submesh to bind for.
  48327. */
  48328. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  48329. /**
  48330. * Checks to see if a texture is used in the material.
  48331. * @param texture - Base texture to use.
  48332. * @returns - Boolean specifying if a texture is used in the material.
  48333. */
  48334. hasTexture(texture: BaseTexture): boolean;
  48335. /**
  48336. * Dispose the material.
  48337. * @param forceDisposeEffect Force disposal of the associated effect.
  48338. * @param forceDisposeTextures Force disposal of the associated textures.
  48339. */
  48340. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  48341. /**
  48342. * Clones the material.
  48343. * @param name The cloned name.
  48344. * @returns The cloned material.
  48345. */
  48346. clone(name: string): BackgroundMaterial;
  48347. /**
  48348. * Serializes the current material to its JSON representation.
  48349. * @returns The JSON representation.
  48350. */
  48351. serialize(): any;
  48352. /**
  48353. * Gets the class name of the material
  48354. * @returns "BackgroundMaterial"
  48355. */
  48356. getClassName(): string;
  48357. /**
  48358. * Parse a JSON input to create back a background material.
  48359. * @param source The JSON data to parse
  48360. * @param scene The scene to create the parsed material in
  48361. * @param rootUrl The root url of the assets the material depends upon
  48362. * @returns the instantiated BackgroundMaterial.
  48363. */
  48364. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  48365. }
  48366. }
  48367. declare module "babylonjs/Helpers/environmentHelper" {
  48368. import { Observable } from "babylonjs/Misc/observable";
  48369. import { Nullable } from "babylonjs/types";
  48370. import { Scene } from "babylonjs/scene";
  48371. import { Vector3 } from "babylonjs/Maths/math.vector";
  48372. import { Color3 } from "babylonjs/Maths/math.color";
  48373. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48374. import { Mesh } from "babylonjs/Meshes/mesh";
  48375. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48376. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  48377. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  48378. import "babylonjs/Meshes/Builders/planeBuilder";
  48379. import "babylonjs/Meshes/Builders/boxBuilder";
  48380. /**
  48381. * Represents the different options available during the creation of
  48382. * a Environment helper.
  48383. *
  48384. * This can control the default ground, skybox and image processing setup of your scene.
  48385. */
  48386. export interface IEnvironmentHelperOptions {
  48387. /**
  48388. * Specifies wether or not to create a ground.
  48389. * True by default.
  48390. */
  48391. createGround: boolean;
  48392. /**
  48393. * Specifies the ground size.
  48394. * 15 by default.
  48395. */
  48396. groundSize: number;
  48397. /**
  48398. * The texture used on the ground for the main color.
  48399. * Comes from the BabylonJS CDN by default.
  48400. *
  48401. * Remarks: Can be either a texture or a url.
  48402. */
  48403. groundTexture: string | BaseTexture;
  48404. /**
  48405. * The color mixed in the ground texture by default.
  48406. * BabylonJS clearColor by default.
  48407. */
  48408. groundColor: Color3;
  48409. /**
  48410. * Specifies the ground opacity.
  48411. * 1 by default.
  48412. */
  48413. groundOpacity: number;
  48414. /**
  48415. * Enables the ground to receive shadows.
  48416. * True by default.
  48417. */
  48418. enableGroundShadow: boolean;
  48419. /**
  48420. * Helps preventing the shadow to be fully black on the ground.
  48421. * 0.5 by default.
  48422. */
  48423. groundShadowLevel: number;
  48424. /**
  48425. * Creates a mirror texture attach to the ground.
  48426. * false by default.
  48427. */
  48428. enableGroundMirror: boolean;
  48429. /**
  48430. * Specifies the ground mirror size ratio.
  48431. * 0.3 by default as the default kernel is 64.
  48432. */
  48433. groundMirrorSizeRatio: number;
  48434. /**
  48435. * Specifies the ground mirror blur kernel size.
  48436. * 64 by default.
  48437. */
  48438. groundMirrorBlurKernel: number;
  48439. /**
  48440. * Specifies the ground mirror visibility amount.
  48441. * 1 by default
  48442. */
  48443. groundMirrorAmount: number;
  48444. /**
  48445. * Specifies the ground mirror reflectance weight.
  48446. * This uses the standard weight of the background material to setup the fresnel effect
  48447. * of the mirror.
  48448. * 1 by default.
  48449. */
  48450. groundMirrorFresnelWeight: number;
  48451. /**
  48452. * Specifies the ground mirror Falloff distance.
  48453. * This can helps reducing the size of the reflection.
  48454. * 0 by Default.
  48455. */
  48456. groundMirrorFallOffDistance: number;
  48457. /**
  48458. * Specifies the ground mirror texture type.
  48459. * Unsigned Int by Default.
  48460. */
  48461. groundMirrorTextureType: number;
  48462. /**
  48463. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  48464. * the shown objects.
  48465. */
  48466. groundYBias: number;
  48467. /**
  48468. * Specifies wether or not to create a skybox.
  48469. * True by default.
  48470. */
  48471. createSkybox: boolean;
  48472. /**
  48473. * Specifies the skybox size.
  48474. * 20 by default.
  48475. */
  48476. skyboxSize: number;
  48477. /**
  48478. * The texture used on the skybox for the main color.
  48479. * Comes from the BabylonJS CDN by default.
  48480. *
  48481. * Remarks: Can be either a texture or a url.
  48482. */
  48483. skyboxTexture: string | BaseTexture;
  48484. /**
  48485. * The color mixed in the skybox texture by default.
  48486. * BabylonJS clearColor by default.
  48487. */
  48488. skyboxColor: Color3;
  48489. /**
  48490. * The background rotation around the Y axis of the scene.
  48491. * This helps aligning the key lights of your scene with the background.
  48492. * 0 by default.
  48493. */
  48494. backgroundYRotation: number;
  48495. /**
  48496. * Compute automatically the size of the elements to best fit with the scene.
  48497. */
  48498. sizeAuto: boolean;
  48499. /**
  48500. * Default position of the rootMesh if autoSize is not true.
  48501. */
  48502. rootPosition: Vector3;
  48503. /**
  48504. * Sets up the image processing in the scene.
  48505. * true by default.
  48506. */
  48507. setupImageProcessing: boolean;
  48508. /**
  48509. * The texture used as your environment texture in the scene.
  48510. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  48511. *
  48512. * Remarks: Can be either a texture or a url.
  48513. */
  48514. environmentTexture: string | BaseTexture;
  48515. /**
  48516. * The value of the exposure to apply to the scene.
  48517. * 0.6 by default if setupImageProcessing is true.
  48518. */
  48519. cameraExposure: number;
  48520. /**
  48521. * The value of the contrast to apply to the scene.
  48522. * 1.6 by default if setupImageProcessing is true.
  48523. */
  48524. cameraContrast: number;
  48525. /**
  48526. * Specifies wether or not tonemapping should be enabled in the scene.
  48527. * true by default if setupImageProcessing is true.
  48528. */
  48529. toneMappingEnabled: boolean;
  48530. }
  48531. /**
  48532. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  48533. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  48534. * It also helps with the default setup of your imageProcessing configuration.
  48535. */
  48536. export class EnvironmentHelper {
  48537. /**
  48538. * Default ground texture URL.
  48539. */
  48540. private static _groundTextureCDNUrl;
  48541. /**
  48542. * Default skybox texture URL.
  48543. */
  48544. private static _skyboxTextureCDNUrl;
  48545. /**
  48546. * Default environment texture URL.
  48547. */
  48548. private static _environmentTextureCDNUrl;
  48549. /**
  48550. * Creates the default options for the helper.
  48551. */
  48552. private static _getDefaultOptions;
  48553. private _rootMesh;
  48554. /**
  48555. * Gets the root mesh created by the helper.
  48556. */
  48557. readonly rootMesh: Mesh;
  48558. private _skybox;
  48559. /**
  48560. * Gets the skybox created by the helper.
  48561. */
  48562. readonly skybox: Nullable<Mesh>;
  48563. private _skyboxTexture;
  48564. /**
  48565. * Gets the skybox texture created by the helper.
  48566. */
  48567. readonly skyboxTexture: Nullable<BaseTexture>;
  48568. private _skyboxMaterial;
  48569. /**
  48570. * Gets the skybox material created by the helper.
  48571. */
  48572. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  48573. private _ground;
  48574. /**
  48575. * Gets the ground mesh created by the helper.
  48576. */
  48577. readonly ground: Nullable<Mesh>;
  48578. private _groundTexture;
  48579. /**
  48580. * Gets the ground texture created by the helper.
  48581. */
  48582. readonly groundTexture: Nullable<BaseTexture>;
  48583. private _groundMirror;
  48584. /**
  48585. * Gets the ground mirror created by the helper.
  48586. */
  48587. readonly groundMirror: Nullable<MirrorTexture>;
  48588. /**
  48589. * Gets the ground mirror render list to helps pushing the meshes
  48590. * you wish in the ground reflection.
  48591. */
  48592. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  48593. private _groundMaterial;
  48594. /**
  48595. * Gets the ground material created by the helper.
  48596. */
  48597. readonly groundMaterial: Nullable<BackgroundMaterial>;
  48598. /**
  48599. * Stores the creation options.
  48600. */
  48601. private readonly _scene;
  48602. private _options;
  48603. /**
  48604. * This observable will be notified with any error during the creation of the environment,
  48605. * mainly texture creation errors.
  48606. */
  48607. onErrorObservable: Observable<{
  48608. message?: string;
  48609. exception?: any;
  48610. }>;
  48611. /**
  48612. * constructor
  48613. * @param options Defines the options we want to customize the helper
  48614. * @param scene The scene to add the material to
  48615. */
  48616. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  48617. /**
  48618. * Updates the background according to the new options
  48619. * @param options
  48620. */
  48621. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  48622. /**
  48623. * Sets the primary color of all the available elements.
  48624. * @param color the main color to affect to the ground and the background
  48625. */
  48626. setMainColor(color: Color3): void;
  48627. /**
  48628. * Setup the image processing according to the specified options.
  48629. */
  48630. private _setupImageProcessing;
  48631. /**
  48632. * Setup the environment texture according to the specified options.
  48633. */
  48634. private _setupEnvironmentTexture;
  48635. /**
  48636. * Setup the background according to the specified options.
  48637. */
  48638. private _setupBackground;
  48639. /**
  48640. * Get the scene sizes according to the setup.
  48641. */
  48642. private _getSceneSize;
  48643. /**
  48644. * Setup the ground according to the specified options.
  48645. */
  48646. private _setupGround;
  48647. /**
  48648. * Setup the ground material according to the specified options.
  48649. */
  48650. private _setupGroundMaterial;
  48651. /**
  48652. * Setup the ground diffuse texture according to the specified options.
  48653. */
  48654. private _setupGroundDiffuseTexture;
  48655. /**
  48656. * Setup the ground mirror texture according to the specified options.
  48657. */
  48658. private _setupGroundMirrorTexture;
  48659. /**
  48660. * Setup the ground to receive the mirror texture.
  48661. */
  48662. private _setupMirrorInGroundMaterial;
  48663. /**
  48664. * Setup the skybox according to the specified options.
  48665. */
  48666. private _setupSkybox;
  48667. /**
  48668. * Setup the skybox material according to the specified options.
  48669. */
  48670. private _setupSkyboxMaterial;
  48671. /**
  48672. * Setup the skybox reflection texture according to the specified options.
  48673. */
  48674. private _setupSkyboxReflectionTexture;
  48675. private _errorHandler;
  48676. /**
  48677. * Dispose all the elements created by the Helper.
  48678. */
  48679. dispose(): void;
  48680. }
  48681. }
  48682. declare module "babylonjs/Helpers/photoDome" {
  48683. import { Observable } from "babylonjs/Misc/observable";
  48684. import { Nullable } from "babylonjs/types";
  48685. import { Scene } from "babylonjs/scene";
  48686. import { TransformNode } from "babylonjs/Meshes/transformNode";
  48687. import { Mesh } from "babylonjs/Meshes/mesh";
  48688. import { Texture } from "babylonjs/Materials/Textures/texture";
  48689. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  48690. import "babylonjs/Meshes/Builders/sphereBuilder";
  48691. /**
  48692. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  48693. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  48694. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  48695. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  48696. */
  48697. export class PhotoDome extends TransformNode {
  48698. /**
  48699. * Define the image as a Monoscopic panoramic 360 image.
  48700. */
  48701. static readonly MODE_MONOSCOPIC: number;
  48702. /**
  48703. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  48704. */
  48705. static readonly MODE_TOPBOTTOM: number;
  48706. /**
  48707. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  48708. */
  48709. static readonly MODE_SIDEBYSIDE: number;
  48710. private _useDirectMapping;
  48711. /**
  48712. * The texture being displayed on the sphere
  48713. */
  48714. protected _photoTexture: Texture;
  48715. /**
  48716. * Gets or sets the texture being displayed on the sphere
  48717. */
  48718. photoTexture: Texture;
  48719. /**
  48720. * Observable raised when an error occured while loading the 360 image
  48721. */
  48722. onLoadErrorObservable: Observable<string>;
  48723. /**
  48724. * The skybox material
  48725. */
  48726. protected _material: BackgroundMaterial;
  48727. /**
  48728. * The surface used for the skybox
  48729. */
  48730. protected _mesh: Mesh;
  48731. /**
  48732. * Gets the mesh used for the skybox.
  48733. */
  48734. readonly mesh: Mesh;
  48735. /**
  48736. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  48737. * Also see the options.resolution property.
  48738. */
  48739. fovMultiplier: number;
  48740. private _imageMode;
  48741. /**
  48742. * Gets or set the current video mode for the video. It can be:
  48743. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  48744. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  48745. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  48746. */
  48747. imageMode: number;
  48748. /**
  48749. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  48750. * @param name Element's name, child elements will append suffixes for their own names.
  48751. * @param urlsOfPhoto defines the url of the photo to display
  48752. * @param options defines an object containing optional or exposed sub element properties
  48753. * @param onError defines a callback called when an error occured while loading the texture
  48754. */
  48755. constructor(name: string, urlOfPhoto: string, options: {
  48756. resolution?: number;
  48757. size?: number;
  48758. useDirectMapping?: boolean;
  48759. faceForward?: boolean;
  48760. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  48761. private _onBeforeCameraRenderObserver;
  48762. private _changeImageMode;
  48763. /**
  48764. * Releases resources associated with this node.
  48765. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  48766. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  48767. */
  48768. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  48769. }
  48770. }
  48771. declare module "babylonjs/Misc/rgbdTextureTools" {
  48772. import "babylonjs/Shaders/rgbdDecode.fragment";
  48773. import "babylonjs/Engines/Extensions/engine.renderTarget";
  48774. import { Texture } from "babylonjs/Materials/Textures/texture";
  48775. /**
  48776. * Class used to host RGBD texture specific utilities
  48777. */
  48778. export class RGBDTextureTools {
  48779. /**
  48780. * Expand the RGBD Texture from RGBD to Half Float if possible.
  48781. * @param texture the texture to expand.
  48782. */
  48783. static ExpandRGBDTexture(texture: Texture): void;
  48784. }
  48785. }
  48786. declare module "babylonjs/Misc/brdfTextureTools" {
  48787. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48788. import { Scene } from "babylonjs/scene";
  48789. /**
  48790. * Class used to host texture specific utilities
  48791. */
  48792. export class BRDFTextureTools {
  48793. /**
  48794. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  48795. * @param scene defines the hosting scene
  48796. * @returns the environment BRDF texture
  48797. */
  48798. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  48799. private static _environmentBRDFBase64Texture;
  48800. }
  48801. }
  48802. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  48803. import { Nullable } from "babylonjs/types";
  48804. import { Color3 } from "babylonjs/Maths/math.color";
  48805. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48806. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  48807. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  48808. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  48809. import { Engine } from "babylonjs/Engines/engine";
  48810. import { Scene } from "babylonjs/scene";
  48811. /**
  48812. * @hidden
  48813. */
  48814. export interface IMaterialClearCoatDefines {
  48815. CLEARCOAT: boolean;
  48816. CLEARCOAT_DEFAULTIOR: boolean;
  48817. CLEARCOAT_TEXTURE: boolean;
  48818. CLEARCOAT_TEXTUREDIRECTUV: number;
  48819. CLEARCOAT_BUMP: boolean;
  48820. CLEARCOAT_BUMPDIRECTUV: number;
  48821. CLEARCOAT_TINT: boolean;
  48822. CLEARCOAT_TINT_TEXTURE: boolean;
  48823. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  48824. /** @hidden */
  48825. _areTexturesDirty: boolean;
  48826. }
  48827. /**
  48828. * Define the code related to the clear coat parameters of the pbr material.
  48829. */
  48830. export class PBRClearCoatConfiguration {
  48831. /**
  48832. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  48833. * The default fits with a polyurethane material.
  48834. */
  48835. private static readonly _DefaultIndexOfRefraction;
  48836. private _isEnabled;
  48837. /**
  48838. * Defines if the clear coat is enabled in the material.
  48839. */
  48840. isEnabled: boolean;
  48841. /**
  48842. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  48843. */
  48844. intensity: number;
  48845. /**
  48846. * Defines the clear coat layer roughness.
  48847. */
  48848. roughness: number;
  48849. private _indexOfRefraction;
  48850. /**
  48851. * Defines the index of refraction of the clear coat.
  48852. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  48853. * The default fits with a polyurethane material.
  48854. * Changing the default value is more performance intensive.
  48855. */
  48856. indexOfRefraction: number;
  48857. private _texture;
  48858. /**
  48859. * Stores the clear coat values in a texture.
  48860. */
  48861. texture: Nullable<BaseTexture>;
  48862. private _bumpTexture;
  48863. /**
  48864. * Define the clear coat specific bump texture.
  48865. */
  48866. bumpTexture: Nullable<BaseTexture>;
  48867. private _isTintEnabled;
  48868. /**
  48869. * Defines if the clear coat tint is enabled in the material.
  48870. */
  48871. isTintEnabled: boolean;
  48872. /**
  48873. * Defines the clear coat tint of the material.
  48874. * This is only use if tint is enabled
  48875. */
  48876. tintColor: Color3;
  48877. /**
  48878. * Defines the distance at which the tint color should be found in the
  48879. * clear coat media.
  48880. * This is only use if tint is enabled
  48881. */
  48882. tintColorAtDistance: number;
  48883. /**
  48884. * Defines the clear coat layer thickness.
  48885. * This is only use if tint is enabled
  48886. */
  48887. tintThickness: number;
  48888. private _tintTexture;
  48889. /**
  48890. * Stores the clear tint values in a texture.
  48891. * rgb is tint
  48892. * a is a thickness factor
  48893. */
  48894. tintTexture: Nullable<BaseTexture>;
  48895. /** @hidden */
  48896. private _internalMarkAllSubMeshesAsTexturesDirty;
  48897. /** @hidden */
  48898. _markAllSubMeshesAsTexturesDirty(): void;
  48899. /**
  48900. * Instantiate a new istance of clear coat configuration.
  48901. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  48902. */
  48903. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  48904. /**
  48905. * Gets wehter the submesh is ready to be used or not.
  48906. * @param defines the list of "defines" to update.
  48907. * @param scene defines the scene the material belongs to.
  48908. * @param engine defines the engine the material belongs to.
  48909. * @param disableBumpMap defines wether the material disables bump or not.
  48910. * @returns - boolean indicating that the submesh is ready or not.
  48911. */
  48912. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  48913. /**
  48914. * Checks to see if a texture is used in the material.
  48915. * @param defines the list of "defines" to update.
  48916. * @param scene defines the scene to the material belongs to.
  48917. */
  48918. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  48919. /**
  48920. * Binds the material data.
  48921. * @param uniformBuffer defines the Uniform buffer to fill in.
  48922. * @param scene defines the scene the material belongs to.
  48923. * @param engine defines the engine the material belongs to.
  48924. * @param disableBumpMap defines wether the material disables bump or not.
  48925. * @param isFrozen defines wether the material is frozen or not.
  48926. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  48927. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  48928. */
  48929. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  48930. /**
  48931. * Checks to see if a texture is used in the material.
  48932. * @param texture - Base texture to use.
  48933. * @returns - Boolean specifying if a texture is used in the material.
  48934. */
  48935. hasTexture(texture: BaseTexture): boolean;
  48936. /**
  48937. * Returns an array of the actively used textures.
  48938. * @param activeTextures Array of BaseTextures
  48939. */
  48940. getActiveTextures(activeTextures: BaseTexture[]): void;
  48941. /**
  48942. * Returns the animatable textures.
  48943. * @param animatables Array of animatable textures.
  48944. */
  48945. getAnimatables(animatables: IAnimatable[]): void;
  48946. /**
  48947. * Disposes the resources of the material.
  48948. * @param forceDisposeTextures - Forces the disposal of all textures.
  48949. */
  48950. dispose(forceDisposeTextures?: boolean): void;
  48951. /**
  48952. * Get the current class name of the texture useful for serialization or dynamic coding.
  48953. * @returns "PBRClearCoatConfiguration"
  48954. */
  48955. getClassName(): string;
  48956. /**
  48957. * Add fallbacks to the effect fallbacks list.
  48958. * @param defines defines the Base texture to use.
  48959. * @param fallbacks defines the current fallback list.
  48960. * @param currentRank defines the current fallback rank.
  48961. * @returns the new fallback rank.
  48962. */
  48963. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  48964. /**
  48965. * Add the required uniforms to the current list.
  48966. * @param uniforms defines the current uniform list.
  48967. */
  48968. static AddUniforms(uniforms: string[]): void;
  48969. /**
  48970. * Add the required samplers to the current list.
  48971. * @param samplers defines the current sampler list.
  48972. */
  48973. static AddSamplers(samplers: string[]): void;
  48974. /**
  48975. * Add the required uniforms to the current buffer.
  48976. * @param uniformBuffer defines the current uniform buffer.
  48977. */
  48978. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  48979. /**
  48980. * Makes a duplicate of the current configuration into another one.
  48981. * @param clearCoatConfiguration define the config where to copy the info
  48982. */
  48983. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  48984. /**
  48985. * Serializes this clear coat configuration.
  48986. * @returns - An object with the serialized config.
  48987. */
  48988. serialize(): any;
  48989. /**
  48990. * Parses a anisotropy Configuration from a serialized object.
  48991. * @param source - Serialized object.
  48992. * @param scene Defines the scene we are parsing for
  48993. * @param rootUrl Defines the rootUrl to load from
  48994. */
  48995. parse(source: any, scene: Scene, rootUrl: string): void;
  48996. }
  48997. }
  48998. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  48999. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49000. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49001. import { Vector2 } from "babylonjs/Maths/math.vector";
  49002. import { Scene } from "babylonjs/scene";
  49003. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49004. import { Nullable } from "babylonjs/types";
  49005. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49006. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49007. /**
  49008. * @hidden
  49009. */
  49010. export interface IMaterialAnisotropicDefines {
  49011. ANISOTROPIC: boolean;
  49012. ANISOTROPIC_TEXTURE: boolean;
  49013. ANISOTROPIC_TEXTUREDIRECTUV: number;
  49014. MAINUV1: boolean;
  49015. _areTexturesDirty: boolean;
  49016. _needUVs: boolean;
  49017. }
  49018. /**
  49019. * Define the code related to the anisotropic parameters of the pbr material.
  49020. */
  49021. export class PBRAnisotropicConfiguration {
  49022. private _isEnabled;
  49023. /**
  49024. * Defines if the anisotropy is enabled in the material.
  49025. */
  49026. isEnabled: boolean;
  49027. /**
  49028. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  49029. */
  49030. intensity: number;
  49031. /**
  49032. * Defines if the effect is along the tangents, bitangents or in between.
  49033. * By default, the effect is "strectching" the highlights along the tangents.
  49034. */
  49035. direction: Vector2;
  49036. private _texture;
  49037. /**
  49038. * Stores the anisotropy values in a texture.
  49039. * rg is direction (like normal from -1 to 1)
  49040. * b is a intensity
  49041. */
  49042. texture: Nullable<BaseTexture>;
  49043. /** @hidden */
  49044. private _internalMarkAllSubMeshesAsTexturesDirty;
  49045. /** @hidden */
  49046. _markAllSubMeshesAsTexturesDirty(): void;
  49047. /**
  49048. * Instantiate a new istance of anisotropy configuration.
  49049. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49050. */
  49051. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49052. /**
  49053. * Specifies that the submesh is ready to be used.
  49054. * @param defines the list of "defines" to update.
  49055. * @param scene defines the scene the material belongs to.
  49056. * @returns - boolean indicating that the submesh is ready or not.
  49057. */
  49058. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  49059. /**
  49060. * Checks to see if a texture is used in the material.
  49061. * @param defines the list of "defines" to update.
  49062. * @param mesh the mesh we are preparing the defines for.
  49063. * @param scene defines the scene the material belongs to.
  49064. */
  49065. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  49066. /**
  49067. * Binds the material data.
  49068. * @param uniformBuffer defines the Uniform buffer to fill in.
  49069. * @param scene defines the scene the material belongs to.
  49070. * @param isFrozen defines wether the material is frozen or not.
  49071. */
  49072. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  49073. /**
  49074. * Checks to see if a texture is used in the material.
  49075. * @param texture - Base texture to use.
  49076. * @returns - Boolean specifying if a texture is used in the material.
  49077. */
  49078. hasTexture(texture: BaseTexture): boolean;
  49079. /**
  49080. * Returns an array of the actively used textures.
  49081. * @param activeTextures Array of BaseTextures
  49082. */
  49083. getActiveTextures(activeTextures: BaseTexture[]): void;
  49084. /**
  49085. * Returns the animatable textures.
  49086. * @param animatables Array of animatable textures.
  49087. */
  49088. getAnimatables(animatables: IAnimatable[]): void;
  49089. /**
  49090. * Disposes the resources of the material.
  49091. * @param forceDisposeTextures - Forces the disposal of all textures.
  49092. */
  49093. dispose(forceDisposeTextures?: boolean): void;
  49094. /**
  49095. * Get the current class name of the texture useful for serialization or dynamic coding.
  49096. * @returns "PBRAnisotropicConfiguration"
  49097. */
  49098. getClassName(): string;
  49099. /**
  49100. * Add fallbacks to the effect fallbacks list.
  49101. * @param defines defines the Base texture to use.
  49102. * @param fallbacks defines the current fallback list.
  49103. * @param currentRank defines the current fallback rank.
  49104. * @returns the new fallback rank.
  49105. */
  49106. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49107. /**
  49108. * Add the required uniforms to the current list.
  49109. * @param uniforms defines the current uniform list.
  49110. */
  49111. static AddUniforms(uniforms: string[]): void;
  49112. /**
  49113. * Add the required uniforms to the current buffer.
  49114. * @param uniformBuffer defines the current uniform buffer.
  49115. */
  49116. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49117. /**
  49118. * Add the required samplers to the current list.
  49119. * @param samplers defines the current sampler list.
  49120. */
  49121. static AddSamplers(samplers: string[]): void;
  49122. /**
  49123. * Makes a duplicate of the current configuration into another one.
  49124. * @param anisotropicConfiguration define the config where to copy the info
  49125. */
  49126. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  49127. /**
  49128. * Serializes this anisotropy configuration.
  49129. * @returns - An object with the serialized config.
  49130. */
  49131. serialize(): any;
  49132. /**
  49133. * Parses a anisotropy Configuration from a serialized object.
  49134. * @param source - Serialized object.
  49135. * @param scene Defines the scene we are parsing for
  49136. * @param rootUrl Defines the rootUrl to load from
  49137. */
  49138. parse(source: any, scene: Scene, rootUrl: string): void;
  49139. }
  49140. }
  49141. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  49142. import { Scene } from "babylonjs/scene";
  49143. /**
  49144. * @hidden
  49145. */
  49146. export interface IMaterialBRDFDefines {
  49147. BRDF_V_HEIGHT_CORRELATED: boolean;
  49148. MS_BRDF_ENERGY_CONSERVATION: boolean;
  49149. SPHERICAL_HARMONICS: boolean;
  49150. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  49151. /** @hidden */
  49152. _areMiscDirty: boolean;
  49153. }
  49154. /**
  49155. * Define the code related to the BRDF parameters of the pbr material.
  49156. */
  49157. export class PBRBRDFConfiguration {
  49158. /**
  49159. * Default value used for the energy conservation.
  49160. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  49161. */
  49162. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  49163. /**
  49164. * Default value used for the Smith Visibility Height Correlated mode.
  49165. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  49166. */
  49167. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  49168. /**
  49169. * Default value used for the IBL diffuse part.
  49170. * This can help switching back to the polynomials mode globally which is a tiny bit
  49171. * less GPU intensive at the drawback of a lower quality.
  49172. */
  49173. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  49174. /**
  49175. * Default value used for activating energy conservation for the specular workflow.
  49176. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  49177. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  49178. */
  49179. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  49180. private _useEnergyConservation;
  49181. /**
  49182. * Defines if the material uses energy conservation.
  49183. */
  49184. useEnergyConservation: boolean;
  49185. private _useSmithVisibilityHeightCorrelated;
  49186. /**
  49187. * LEGACY Mode set to false
  49188. * Defines if the material uses height smith correlated visibility term.
  49189. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  49190. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  49191. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  49192. * Not relying on height correlated will also disable energy conservation.
  49193. */
  49194. useSmithVisibilityHeightCorrelated: boolean;
  49195. private _useSphericalHarmonics;
  49196. /**
  49197. * LEGACY Mode set to false
  49198. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  49199. * diffuse part of the IBL.
  49200. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  49201. * to the ground truth.
  49202. */
  49203. useSphericalHarmonics: boolean;
  49204. private _useSpecularGlossinessInputEnergyConservation;
  49205. /**
  49206. * Defines if the material uses energy conservation, when the specular workflow is active.
  49207. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  49208. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  49209. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  49210. */
  49211. useSpecularGlossinessInputEnergyConservation: boolean;
  49212. /** @hidden */
  49213. private _internalMarkAllSubMeshesAsMiscDirty;
  49214. /** @hidden */
  49215. _markAllSubMeshesAsMiscDirty(): void;
  49216. /**
  49217. * Instantiate a new istance of clear coat configuration.
  49218. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  49219. */
  49220. constructor(markAllSubMeshesAsMiscDirty: () => void);
  49221. /**
  49222. * Checks to see if a texture is used in the material.
  49223. * @param defines the list of "defines" to update.
  49224. */
  49225. prepareDefines(defines: IMaterialBRDFDefines): void;
  49226. /**
  49227. * Get the current class name of the texture useful for serialization or dynamic coding.
  49228. * @returns "PBRClearCoatConfiguration"
  49229. */
  49230. getClassName(): string;
  49231. /**
  49232. * Makes a duplicate of the current configuration into another one.
  49233. * @param brdfConfiguration define the config where to copy the info
  49234. */
  49235. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  49236. /**
  49237. * Serializes this BRDF configuration.
  49238. * @returns - An object with the serialized config.
  49239. */
  49240. serialize(): any;
  49241. /**
  49242. * Parses a anisotropy Configuration from a serialized object.
  49243. * @param source - Serialized object.
  49244. * @param scene Defines the scene we are parsing for
  49245. * @param rootUrl Defines the rootUrl to load from
  49246. */
  49247. parse(source: any, scene: Scene, rootUrl: string): void;
  49248. }
  49249. }
  49250. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  49251. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49252. import { Color3 } from "babylonjs/Maths/math.color";
  49253. import { Scene } from "babylonjs/scene";
  49254. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49255. import { Nullable } from "babylonjs/types";
  49256. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49257. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49258. /**
  49259. * @hidden
  49260. */
  49261. export interface IMaterialSheenDefines {
  49262. SHEEN: boolean;
  49263. SHEEN_TEXTURE: boolean;
  49264. SHEEN_TEXTUREDIRECTUV: number;
  49265. SHEEN_LINKWITHALBEDO: boolean;
  49266. /** @hidden */
  49267. _areTexturesDirty: boolean;
  49268. }
  49269. /**
  49270. * Define the code related to the Sheen parameters of the pbr material.
  49271. */
  49272. export class PBRSheenConfiguration {
  49273. private _isEnabled;
  49274. /**
  49275. * Defines if the material uses sheen.
  49276. */
  49277. isEnabled: boolean;
  49278. private _linkSheenWithAlbedo;
  49279. /**
  49280. * Defines if the sheen is linked to the sheen color.
  49281. */
  49282. linkSheenWithAlbedo: boolean;
  49283. /**
  49284. * Defines the sheen intensity.
  49285. */
  49286. intensity: number;
  49287. /**
  49288. * Defines the sheen color.
  49289. */
  49290. color: Color3;
  49291. private _texture;
  49292. /**
  49293. * Stores the sheen tint values in a texture.
  49294. * rgb is tint
  49295. * a is a intensity
  49296. */
  49297. texture: Nullable<BaseTexture>;
  49298. /** @hidden */
  49299. private _internalMarkAllSubMeshesAsTexturesDirty;
  49300. /** @hidden */
  49301. _markAllSubMeshesAsTexturesDirty(): void;
  49302. /**
  49303. * Instantiate a new istance of clear coat configuration.
  49304. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49305. */
  49306. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49307. /**
  49308. * Specifies that the submesh is ready to be used.
  49309. * @param defines the list of "defines" to update.
  49310. * @param scene defines the scene the material belongs to.
  49311. * @returns - boolean indicating that the submesh is ready or not.
  49312. */
  49313. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  49314. /**
  49315. * Checks to see if a texture is used in the material.
  49316. * @param defines the list of "defines" to update.
  49317. * @param scene defines the scene the material belongs to.
  49318. */
  49319. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  49320. /**
  49321. * Binds the material data.
  49322. * @param uniformBuffer defines the Uniform buffer to fill in.
  49323. * @param scene defines the scene the material belongs to.
  49324. * @param isFrozen defines wether the material is frozen or not.
  49325. */
  49326. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  49327. /**
  49328. * Checks to see if a texture is used in the material.
  49329. * @param texture - Base texture to use.
  49330. * @returns - Boolean specifying if a texture is used in the material.
  49331. */
  49332. hasTexture(texture: BaseTexture): boolean;
  49333. /**
  49334. * Returns an array of the actively used textures.
  49335. * @param activeTextures Array of BaseTextures
  49336. */
  49337. getActiveTextures(activeTextures: BaseTexture[]): void;
  49338. /**
  49339. * Returns the animatable textures.
  49340. * @param animatables Array of animatable textures.
  49341. */
  49342. getAnimatables(animatables: IAnimatable[]): void;
  49343. /**
  49344. * Disposes the resources of the material.
  49345. * @param forceDisposeTextures - Forces the disposal of all textures.
  49346. */
  49347. dispose(forceDisposeTextures?: boolean): void;
  49348. /**
  49349. * Get the current class name of the texture useful for serialization or dynamic coding.
  49350. * @returns "PBRSheenConfiguration"
  49351. */
  49352. getClassName(): string;
  49353. /**
  49354. * Add fallbacks to the effect fallbacks list.
  49355. * @param defines defines the Base texture to use.
  49356. * @param fallbacks defines the current fallback list.
  49357. * @param currentRank defines the current fallback rank.
  49358. * @returns the new fallback rank.
  49359. */
  49360. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49361. /**
  49362. * Add the required uniforms to the current list.
  49363. * @param uniforms defines the current uniform list.
  49364. */
  49365. static AddUniforms(uniforms: string[]): void;
  49366. /**
  49367. * Add the required uniforms to the current buffer.
  49368. * @param uniformBuffer defines the current uniform buffer.
  49369. */
  49370. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49371. /**
  49372. * Add the required samplers to the current list.
  49373. * @param samplers defines the current sampler list.
  49374. */
  49375. static AddSamplers(samplers: string[]): void;
  49376. /**
  49377. * Makes a duplicate of the current configuration into another one.
  49378. * @param sheenConfiguration define the config where to copy the info
  49379. */
  49380. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  49381. /**
  49382. * Serializes this BRDF configuration.
  49383. * @returns - An object with the serialized config.
  49384. */
  49385. serialize(): any;
  49386. /**
  49387. * Parses a anisotropy Configuration from a serialized object.
  49388. * @param source - Serialized object.
  49389. * @param scene Defines the scene we are parsing for
  49390. * @param rootUrl Defines the rootUrl to load from
  49391. */
  49392. parse(source: any, scene: Scene, rootUrl: string): void;
  49393. }
  49394. }
  49395. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  49396. import { Nullable } from "babylonjs/types";
  49397. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49398. import { Color3 } from "babylonjs/Maths/math.color";
  49399. import { SmartArray } from "babylonjs/Misc/smartArray";
  49400. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49401. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  49402. import { Effect } from "babylonjs/Materials/effect";
  49403. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49404. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49405. import { Engine } from "babylonjs/Engines/engine";
  49406. import { Scene } from "babylonjs/scene";
  49407. /**
  49408. * @hidden
  49409. */
  49410. export interface IMaterialSubSurfaceDefines {
  49411. SUBSURFACE: boolean;
  49412. SS_REFRACTION: boolean;
  49413. SS_TRANSLUCENCY: boolean;
  49414. SS_SCATERRING: boolean;
  49415. SS_THICKNESSANDMASK_TEXTURE: boolean;
  49416. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  49417. SS_REFRACTIONMAP_3D: boolean;
  49418. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  49419. SS_LODINREFRACTIONALPHA: boolean;
  49420. SS_GAMMAREFRACTION: boolean;
  49421. SS_RGBDREFRACTION: boolean;
  49422. SS_LINEARSPECULARREFRACTION: boolean;
  49423. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  49424. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  49425. /** @hidden */
  49426. _areTexturesDirty: boolean;
  49427. }
  49428. /**
  49429. * Define the code related to the sub surface parameters of the pbr material.
  49430. */
  49431. export class PBRSubSurfaceConfiguration {
  49432. private _isRefractionEnabled;
  49433. /**
  49434. * Defines if the refraction is enabled in the material.
  49435. */
  49436. isRefractionEnabled: boolean;
  49437. private _isTranslucencyEnabled;
  49438. /**
  49439. * Defines if the translucency is enabled in the material.
  49440. */
  49441. isTranslucencyEnabled: boolean;
  49442. private _isScatteringEnabled;
  49443. /**
  49444. * Defines the refraction intensity of the material.
  49445. * The refraction when enabled replaces the Diffuse part of the material.
  49446. * The intensity helps transitionning between diffuse and refraction.
  49447. */
  49448. refractionIntensity: number;
  49449. /**
  49450. * Defines the translucency intensity of the material.
  49451. * When translucency has been enabled, this defines how much of the "translucency"
  49452. * is addded to the diffuse part of the material.
  49453. */
  49454. translucencyIntensity: number;
  49455. /**
  49456. * Defines the scattering intensity of the material.
  49457. * When scattering has been enabled, this defines how much of the "scattered light"
  49458. * is addded to the diffuse part of the material.
  49459. */
  49460. scatteringIntensity: number;
  49461. private _thicknessTexture;
  49462. /**
  49463. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  49464. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  49465. * 0 would mean minimumThickness
  49466. * 1 would mean maximumThickness
  49467. * The other channels might be use as a mask to vary the different effects intensity.
  49468. */
  49469. thicknessTexture: Nullable<BaseTexture>;
  49470. private _refractionTexture;
  49471. /**
  49472. * Defines the texture to use for refraction.
  49473. */
  49474. refractionTexture: Nullable<BaseTexture>;
  49475. private _indexOfRefraction;
  49476. /**
  49477. * Defines the index of refraction used in the material.
  49478. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  49479. */
  49480. indexOfRefraction: number;
  49481. private _invertRefractionY;
  49482. /**
  49483. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  49484. */
  49485. invertRefractionY: boolean;
  49486. private _linkRefractionWithTransparency;
  49487. /**
  49488. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  49489. * Materials half opaque for instance using refraction could benefit from this control.
  49490. */
  49491. linkRefractionWithTransparency: boolean;
  49492. /**
  49493. * Defines the minimum thickness stored in the thickness map.
  49494. * If no thickness map is defined, this value will be used to simulate thickness.
  49495. */
  49496. minimumThickness: number;
  49497. /**
  49498. * Defines the maximum thickness stored in the thickness map.
  49499. */
  49500. maximumThickness: number;
  49501. /**
  49502. * Defines the volume tint of the material.
  49503. * This is used for both translucency and scattering.
  49504. */
  49505. tintColor: Color3;
  49506. /**
  49507. * Defines the distance at which the tint color should be found in the media.
  49508. * This is used for refraction only.
  49509. */
  49510. tintColorAtDistance: number;
  49511. /**
  49512. * Defines how far each channel transmit through the media.
  49513. * It is defined as a color to simplify it selection.
  49514. */
  49515. diffusionDistance: Color3;
  49516. private _useMaskFromThicknessTexture;
  49517. /**
  49518. * Stores the intensity of the different subsurface effects in the thickness texture.
  49519. * * the green channel is the translucency intensity.
  49520. * * the blue channel is the scattering intensity.
  49521. * * the alpha channel is the refraction intensity.
  49522. */
  49523. useMaskFromThicknessTexture: boolean;
  49524. /** @hidden */
  49525. private _internalMarkAllSubMeshesAsTexturesDirty;
  49526. /** @hidden */
  49527. _markAllSubMeshesAsTexturesDirty(): void;
  49528. /**
  49529. * Instantiate a new istance of sub surface configuration.
  49530. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49531. */
  49532. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49533. /**
  49534. * Gets wehter the submesh is ready to be used or not.
  49535. * @param defines the list of "defines" to update.
  49536. * @param scene defines the scene the material belongs to.
  49537. * @returns - boolean indicating that the submesh is ready or not.
  49538. */
  49539. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  49540. /**
  49541. * Checks to see if a texture is used in the material.
  49542. * @param defines the list of "defines" to update.
  49543. * @param scene defines the scene to the material belongs to.
  49544. */
  49545. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  49546. /**
  49547. * Binds the material data.
  49548. * @param uniformBuffer defines the Uniform buffer to fill in.
  49549. * @param scene defines the scene the material belongs to.
  49550. * @param engine defines the engine the material belongs to.
  49551. * @param isFrozen defines wether the material is frozen or not.
  49552. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  49553. */
  49554. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  49555. /**
  49556. * Unbinds the material from the mesh.
  49557. * @param activeEffect defines the effect that should be unbound from.
  49558. * @returns true if unbound, otherwise false
  49559. */
  49560. unbind(activeEffect: Effect): boolean;
  49561. /**
  49562. * Returns the texture used for refraction or null if none is used.
  49563. * @param scene defines the scene the material belongs to.
  49564. * @returns - Refraction texture if present. If no refraction texture and refraction
  49565. * is linked with transparency, returns environment texture. Otherwise, returns null.
  49566. */
  49567. private _getRefractionTexture;
  49568. /**
  49569. * Returns true if alpha blending should be disabled.
  49570. */
  49571. readonly disableAlphaBlending: boolean;
  49572. /**
  49573. * Fills the list of render target textures.
  49574. * @param renderTargets the list of render targets to update
  49575. */
  49576. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  49577. /**
  49578. * Checks to see if a texture is used in the material.
  49579. * @param texture - Base texture to use.
  49580. * @returns - Boolean specifying if a texture is used in the material.
  49581. */
  49582. hasTexture(texture: BaseTexture): boolean;
  49583. /**
  49584. * Gets a boolean indicating that current material needs to register RTT
  49585. * @returns true if this uses a render target otherwise false.
  49586. */
  49587. hasRenderTargetTextures(): boolean;
  49588. /**
  49589. * Returns an array of the actively used textures.
  49590. * @param activeTextures Array of BaseTextures
  49591. */
  49592. getActiveTextures(activeTextures: BaseTexture[]): void;
  49593. /**
  49594. * Returns the animatable textures.
  49595. * @param animatables Array of animatable textures.
  49596. */
  49597. getAnimatables(animatables: IAnimatable[]): void;
  49598. /**
  49599. * Disposes the resources of the material.
  49600. * @param forceDisposeTextures - Forces the disposal of all textures.
  49601. */
  49602. dispose(forceDisposeTextures?: boolean): void;
  49603. /**
  49604. * Get the current class name of the texture useful for serialization or dynamic coding.
  49605. * @returns "PBRSubSurfaceConfiguration"
  49606. */
  49607. getClassName(): string;
  49608. /**
  49609. * Add fallbacks to the effect fallbacks list.
  49610. * @param defines defines the Base texture to use.
  49611. * @param fallbacks defines the current fallback list.
  49612. * @param currentRank defines the current fallback rank.
  49613. * @returns the new fallback rank.
  49614. */
  49615. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49616. /**
  49617. * Add the required uniforms to the current list.
  49618. * @param uniforms defines the current uniform list.
  49619. */
  49620. static AddUniforms(uniforms: string[]): void;
  49621. /**
  49622. * Add the required samplers to the current list.
  49623. * @param samplers defines the current sampler list.
  49624. */
  49625. static AddSamplers(samplers: string[]): void;
  49626. /**
  49627. * Add the required uniforms to the current buffer.
  49628. * @param uniformBuffer defines the current uniform buffer.
  49629. */
  49630. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49631. /**
  49632. * Makes a duplicate of the current configuration into another one.
  49633. * @param configuration define the config where to copy the info
  49634. */
  49635. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  49636. /**
  49637. * Serializes this Sub Surface configuration.
  49638. * @returns - An object with the serialized config.
  49639. */
  49640. serialize(): any;
  49641. /**
  49642. * Parses a anisotropy Configuration from a serialized object.
  49643. * @param source - Serialized object.
  49644. * @param scene Defines the scene we are parsing for
  49645. * @param rootUrl Defines the rootUrl to load from
  49646. */
  49647. parse(source: any, scene: Scene, rootUrl: string): void;
  49648. }
  49649. }
  49650. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  49651. /** @hidden */
  49652. export var pbrFragmentDeclaration: {
  49653. name: string;
  49654. shader: string;
  49655. };
  49656. }
  49657. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  49658. /** @hidden */
  49659. export var pbrUboDeclaration: {
  49660. name: string;
  49661. shader: string;
  49662. };
  49663. }
  49664. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  49665. /** @hidden */
  49666. export var pbrFragmentExtraDeclaration: {
  49667. name: string;
  49668. shader: string;
  49669. };
  49670. }
  49671. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  49672. /** @hidden */
  49673. export var pbrFragmentSamplersDeclaration: {
  49674. name: string;
  49675. shader: string;
  49676. };
  49677. }
  49678. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  49679. /** @hidden */
  49680. export var pbrHelperFunctions: {
  49681. name: string;
  49682. shader: string;
  49683. };
  49684. }
  49685. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  49686. /** @hidden */
  49687. export var harmonicsFunctions: {
  49688. name: string;
  49689. shader: string;
  49690. };
  49691. }
  49692. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  49693. /** @hidden */
  49694. export var pbrDirectLightingSetupFunctions: {
  49695. name: string;
  49696. shader: string;
  49697. };
  49698. }
  49699. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  49700. /** @hidden */
  49701. export var pbrDirectLightingFalloffFunctions: {
  49702. name: string;
  49703. shader: string;
  49704. };
  49705. }
  49706. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  49707. /** @hidden */
  49708. export var pbrBRDFFunctions: {
  49709. name: string;
  49710. shader: string;
  49711. };
  49712. }
  49713. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  49714. /** @hidden */
  49715. export var pbrDirectLightingFunctions: {
  49716. name: string;
  49717. shader: string;
  49718. };
  49719. }
  49720. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  49721. /** @hidden */
  49722. export var pbrIBLFunctions: {
  49723. name: string;
  49724. shader: string;
  49725. };
  49726. }
  49727. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  49728. /** @hidden */
  49729. export var pbrDebug: {
  49730. name: string;
  49731. shader: string;
  49732. };
  49733. }
  49734. declare module "babylonjs/Shaders/pbr.fragment" {
  49735. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  49736. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  49737. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  49738. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  49739. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  49740. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  49741. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  49742. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  49743. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  49744. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  49745. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  49746. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  49747. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  49748. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  49749. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  49750. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  49751. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  49752. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  49753. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  49754. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  49755. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  49756. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  49757. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  49758. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  49759. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  49760. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  49761. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  49762. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  49763. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  49764. /** @hidden */
  49765. export var pbrPixelShader: {
  49766. name: string;
  49767. shader: string;
  49768. };
  49769. }
  49770. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  49771. /** @hidden */
  49772. export var pbrVertexDeclaration: {
  49773. name: string;
  49774. shader: string;
  49775. };
  49776. }
  49777. declare module "babylonjs/Shaders/pbr.vertex" {
  49778. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  49779. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  49780. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  49781. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  49782. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  49783. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  49784. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  49785. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  49786. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  49787. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  49788. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  49789. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  49790. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  49791. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  49792. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  49793. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  49794. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  49795. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  49796. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  49797. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  49798. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  49799. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  49800. /** @hidden */
  49801. export var pbrVertexShader: {
  49802. name: string;
  49803. shader: string;
  49804. };
  49805. }
  49806. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  49807. import { Nullable } from "babylonjs/types";
  49808. import { Scene } from "babylonjs/scene";
  49809. import { Matrix } from "babylonjs/Maths/math.vector";
  49810. import { SubMesh } from "babylonjs/Meshes/subMesh";
  49811. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49812. import { Mesh } from "babylonjs/Meshes/mesh";
  49813. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  49814. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  49815. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  49816. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  49817. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  49818. import { Color3 } from "babylonjs/Maths/math.color";
  49819. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  49820. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  49821. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  49822. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  49823. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49824. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49825. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  49826. import "babylonjs/Shaders/pbr.fragment";
  49827. import "babylonjs/Shaders/pbr.vertex";
  49828. /**
  49829. * Manages the defines for the PBR Material.
  49830. * @hidden
  49831. */
  49832. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  49833. PBR: boolean;
  49834. MAINUV1: boolean;
  49835. MAINUV2: boolean;
  49836. UV1: boolean;
  49837. UV2: boolean;
  49838. ALBEDO: boolean;
  49839. ALBEDODIRECTUV: number;
  49840. VERTEXCOLOR: boolean;
  49841. AMBIENT: boolean;
  49842. AMBIENTDIRECTUV: number;
  49843. AMBIENTINGRAYSCALE: boolean;
  49844. OPACITY: boolean;
  49845. VERTEXALPHA: boolean;
  49846. OPACITYDIRECTUV: number;
  49847. OPACITYRGB: boolean;
  49848. ALPHATEST: boolean;
  49849. DEPTHPREPASS: boolean;
  49850. ALPHABLEND: boolean;
  49851. ALPHAFROMALBEDO: boolean;
  49852. ALPHATESTVALUE: string;
  49853. SPECULAROVERALPHA: boolean;
  49854. RADIANCEOVERALPHA: boolean;
  49855. ALPHAFRESNEL: boolean;
  49856. LINEARALPHAFRESNEL: boolean;
  49857. PREMULTIPLYALPHA: boolean;
  49858. EMISSIVE: boolean;
  49859. EMISSIVEDIRECTUV: number;
  49860. REFLECTIVITY: boolean;
  49861. REFLECTIVITYDIRECTUV: number;
  49862. SPECULARTERM: boolean;
  49863. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  49864. MICROSURFACEAUTOMATIC: boolean;
  49865. LODBASEDMICROSFURACE: boolean;
  49866. MICROSURFACEMAP: boolean;
  49867. MICROSURFACEMAPDIRECTUV: number;
  49868. METALLICWORKFLOW: boolean;
  49869. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  49870. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  49871. METALLNESSSTOREINMETALMAPBLUE: boolean;
  49872. AOSTOREINMETALMAPRED: boolean;
  49873. METALLICF0FACTORFROMMETALLICMAP: boolean;
  49874. ENVIRONMENTBRDF: boolean;
  49875. ENVIRONMENTBRDF_RGBD: boolean;
  49876. NORMAL: boolean;
  49877. TANGENT: boolean;
  49878. BUMP: boolean;
  49879. BUMPDIRECTUV: number;
  49880. OBJECTSPACE_NORMALMAP: boolean;
  49881. PARALLAX: boolean;
  49882. PARALLAXOCCLUSION: boolean;
  49883. NORMALXYSCALE: boolean;
  49884. LIGHTMAP: boolean;
  49885. LIGHTMAPDIRECTUV: number;
  49886. USELIGHTMAPASSHADOWMAP: boolean;
  49887. GAMMALIGHTMAP: boolean;
  49888. RGBDLIGHTMAP: boolean;
  49889. REFLECTION: boolean;
  49890. REFLECTIONMAP_3D: boolean;
  49891. REFLECTIONMAP_SPHERICAL: boolean;
  49892. REFLECTIONMAP_PLANAR: boolean;
  49893. REFLECTIONMAP_CUBIC: boolean;
  49894. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  49895. REFLECTIONMAP_PROJECTION: boolean;
  49896. REFLECTIONMAP_SKYBOX: boolean;
  49897. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  49898. REFLECTIONMAP_EXPLICIT: boolean;
  49899. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  49900. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  49901. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  49902. INVERTCUBICMAP: boolean;
  49903. USESPHERICALFROMREFLECTIONMAP: boolean;
  49904. USEIRRADIANCEMAP: boolean;
  49905. SPHERICAL_HARMONICS: boolean;
  49906. USESPHERICALINVERTEX: boolean;
  49907. REFLECTIONMAP_OPPOSITEZ: boolean;
  49908. LODINREFLECTIONALPHA: boolean;
  49909. GAMMAREFLECTION: boolean;
  49910. RGBDREFLECTION: boolean;
  49911. LINEARSPECULARREFLECTION: boolean;
  49912. RADIANCEOCCLUSION: boolean;
  49913. HORIZONOCCLUSION: boolean;
  49914. INSTANCES: boolean;
  49915. NUM_BONE_INFLUENCERS: number;
  49916. BonesPerMesh: number;
  49917. BONETEXTURE: boolean;
  49918. NONUNIFORMSCALING: boolean;
  49919. MORPHTARGETS: boolean;
  49920. MORPHTARGETS_NORMAL: boolean;
  49921. MORPHTARGETS_TANGENT: boolean;
  49922. MORPHTARGETS_UV: boolean;
  49923. NUM_MORPH_INFLUENCERS: number;
  49924. IMAGEPROCESSING: boolean;
  49925. VIGNETTE: boolean;
  49926. VIGNETTEBLENDMODEMULTIPLY: boolean;
  49927. VIGNETTEBLENDMODEOPAQUE: boolean;
  49928. TONEMAPPING: boolean;
  49929. TONEMAPPING_ACES: boolean;
  49930. CONTRAST: boolean;
  49931. COLORCURVES: boolean;
  49932. COLORGRADING: boolean;
  49933. COLORGRADING3D: boolean;
  49934. SAMPLER3DGREENDEPTH: boolean;
  49935. SAMPLER3DBGRMAP: boolean;
  49936. IMAGEPROCESSINGPOSTPROCESS: boolean;
  49937. EXPOSURE: boolean;
  49938. MULTIVIEW: boolean;
  49939. USEPHYSICALLIGHTFALLOFF: boolean;
  49940. USEGLTFLIGHTFALLOFF: boolean;
  49941. TWOSIDEDLIGHTING: boolean;
  49942. SHADOWFLOAT: boolean;
  49943. CLIPPLANE: boolean;
  49944. CLIPPLANE2: boolean;
  49945. CLIPPLANE3: boolean;
  49946. CLIPPLANE4: boolean;
  49947. POINTSIZE: boolean;
  49948. FOG: boolean;
  49949. LOGARITHMICDEPTH: boolean;
  49950. FORCENORMALFORWARD: boolean;
  49951. SPECULARAA: boolean;
  49952. CLEARCOAT: boolean;
  49953. CLEARCOAT_DEFAULTIOR: boolean;
  49954. CLEARCOAT_TEXTURE: boolean;
  49955. CLEARCOAT_TEXTUREDIRECTUV: number;
  49956. CLEARCOAT_BUMP: boolean;
  49957. CLEARCOAT_BUMPDIRECTUV: number;
  49958. CLEARCOAT_TINT: boolean;
  49959. CLEARCOAT_TINT_TEXTURE: boolean;
  49960. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  49961. ANISOTROPIC: boolean;
  49962. ANISOTROPIC_TEXTURE: boolean;
  49963. ANISOTROPIC_TEXTUREDIRECTUV: number;
  49964. BRDF_V_HEIGHT_CORRELATED: boolean;
  49965. MS_BRDF_ENERGY_CONSERVATION: boolean;
  49966. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  49967. SHEEN: boolean;
  49968. SHEEN_TEXTURE: boolean;
  49969. SHEEN_TEXTUREDIRECTUV: number;
  49970. SHEEN_LINKWITHALBEDO: boolean;
  49971. SUBSURFACE: boolean;
  49972. SS_REFRACTION: boolean;
  49973. SS_TRANSLUCENCY: boolean;
  49974. SS_SCATERRING: boolean;
  49975. SS_THICKNESSANDMASK_TEXTURE: boolean;
  49976. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  49977. SS_REFRACTIONMAP_3D: boolean;
  49978. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  49979. SS_LODINREFRACTIONALPHA: boolean;
  49980. SS_GAMMAREFRACTION: boolean;
  49981. SS_RGBDREFRACTION: boolean;
  49982. SS_LINEARSPECULARREFRACTION: boolean;
  49983. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  49984. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  49985. UNLIT: boolean;
  49986. DEBUGMODE: number;
  49987. /**
  49988. * Initializes the PBR Material defines.
  49989. */
  49990. constructor();
  49991. /**
  49992. * Resets the PBR Material defines.
  49993. */
  49994. reset(): void;
  49995. }
  49996. /**
  49997. * The Physically based material base class of BJS.
  49998. *
  49999. * This offers the main features of a standard PBR material.
  50000. * For more information, please refer to the documentation :
  50001. * https://doc.babylonjs.com/how_to/physically_based_rendering
  50002. */
  50003. export abstract class PBRBaseMaterial extends PushMaterial {
  50004. /**
  50005. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  50006. */
  50007. static readonly PBRMATERIAL_OPAQUE: number;
  50008. /**
  50009. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  50010. */
  50011. static readonly PBRMATERIAL_ALPHATEST: number;
  50012. /**
  50013. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50014. */
  50015. static readonly PBRMATERIAL_ALPHABLEND: number;
  50016. /**
  50017. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50018. * They are also discarded below the alpha cutoff threshold to improve performances.
  50019. */
  50020. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  50021. /**
  50022. * Defines the default value of how much AO map is occluding the analytical lights
  50023. * (point spot...).
  50024. */
  50025. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  50026. /**
  50027. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  50028. */
  50029. static readonly LIGHTFALLOFF_PHYSICAL: number;
  50030. /**
  50031. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  50032. * to enhance interoperability with other engines.
  50033. */
  50034. static readonly LIGHTFALLOFF_GLTF: number;
  50035. /**
  50036. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  50037. * to enhance interoperability with other materials.
  50038. */
  50039. static readonly LIGHTFALLOFF_STANDARD: number;
  50040. /**
  50041. * Intensity of the direct lights e.g. the four lights available in your scene.
  50042. * This impacts both the direct diffuse and specular highlights.
  50043. */
  50044. protected _directIntensity: number;
  50045. /**
  50046. * Intensity of the emissive part of the material.
  50047. * This helps controlling the emissive effect without modifying the emissive color.
  50048. */
  50049. protected _emissiveIntensity: number;
  50050. /**
  50051. * Intensity of the environment e.g. how much the environment will light the object
  50052. * either through harmonics for rough material or through the refelction for shiny ones.
  50053. */
  50054. protected _environmentIntensity: number;
  50055. /**
  50056. * This is a special control allowing the reduction of the specular highlights coming from the
  50057. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  50058. */
  50059. protected _specularIntensity: number;
  50060. /**
  50061. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  50062. */
  50063. private _lightingInfos;
  50064. /**
  50065. * Debug Control allowing disabling the bump map on this material.
  50066. */
  50067. protected _disableBumpMap: boolean;
  50068. /**
  50069. * AKA Diffuse Texture in standard nomenclature.
  50070. */
  50071. protected _albedoTexture: Nullable<BaseTexture>;
  50072. /**
  50073. * AKA Occlusion Texture in other nomenclature.
  50074. */
  50075. protected _ambientTexture: Nullable<BaseTexture>;
  50076. /**
  50077. * AKA Occlusion Texture Intensity in other nomenclature.
  50078. */
  50079. protected _ambientTextureStrength: number;
  50080. /**
  50081. * Defines how much the AO map is occluding the analytical lights (point spot...).
  50082. * 1 means it completely occludes it
  50083. * 0 mean it has no impact
  50084. */
  50085. protected _ambientTextureImpactOnAnalyticalLights: number;
  50086. /**
  50087. * Stores the alpha values in a texture.
  50088. */
  50089. protected _opacityTexture: Nullable<BaseTexture>;
  50090. /**
  50091. * Stores the reflection values in a texture.
  50092. */
  50093. protected _reflectionTexture: Nullable<BaseTexture>;
  50094. /**
  50095. * Stores the emissive values in a texture.
  50096. */
  50097. protected _emissiveTexture: Nullable<BaseTexture>;
  50098. /**
  50099. * AKA Specular texture in other nomenclature.
  50100. */
  50101. protected _reflectivityTexture: Nullable<BaseTexture>;
  50102. /**
  50103. * Used to switch from specular/glossiness to metallic/roughness workflow.
  50104. */
  50105. protected _metallicTexture: Nullable<BaseTexture>;
  50106. /**
  50107. * Specifies the metallic scalar of the metallic/roughness workflow.
  50108. * Can also be used to scale the metalness values of the metallic texture.
  50109. */
  50110. protected _metallic: Nullable<number>;
  50111. /**
  50112. * Specifies the roughness scalar of the metallic/roughness workflow.
  50113. * Can also be used to scale the roughness values of the metallic texture.
  50114. */
  50115. protected _roughness: Nullable<number>;
  50116. /**
  50117. * Specifies the an F0 factor to help configuring the material F0.
  50118. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  50119. * to 0.5 the previously hard coded value stays the same.
  50120. * Can also be used to scale the F0 values of the metallic texture.
  50121. */
  50122. protected _metallicF0Factor: number;
  50123. /**
  50124. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  50125. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  50126. * your expectation as it multiplies with the texture data.
  50127. */
  50128. protected _useMetallicF0FactorFromMetallicTexture: boolean;
  50129. /**
  50130. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  50131. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  50132. */
  50133. protected _microSurfaceTexture: Nullable<BaseTexture>;
  50134. /**
  50135. * Stores surface normal data used to displace a mesh in a texture.
  50136. */
  50137. protected _bumpTexture: Nullable<BaseTexture>;
  50138. /**
  50139. * Stores the pre-calculated light information of a mesh in a texture.
  50140. */
  50141. protected _lightmapTexture: Nullable<BaseTexture>;
  50142. /**
  50143. * The color of a material in ambient lighting.
  50144. */
  50145. protected _ambientColor: Color3;
  50146. /**
  50147. * AKA Diffuse Color in other nomenclature.
  50148. */
  50149. protected _albedoColor: Color3;
  50150. /**
  50151. * AKA Specular Color in other nomenclature.
  50152. */
  50153. protected _reflectivityColor: Color3;
  50154. /**
  50155. * The color applied when light is reflected from a material.
  50156. */
  50157. protected _reflectionColor: Color3;
  50158. /**
  50159. * The color applied when light is emitted from a material.
  50160. */
  50161. protected _emissiveColor: Color3;
  50162. /**
  50163. * AKA Glossiness in other nomenclature.
  50164. */
  50165. protected _microSurface: number;
  50166. /**
  50167. * Specifies that the material will use the light map as a show map.
  50168. */
  50169. protected _useLightmapAsShadowmap: boolean;
  50170. /**
  50171. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  50172. * makes the reflect vector face the model (under horizon).
  50173. */
  50174. protected _useHorizonOcclusion: boolean;
  50175. /**
  50176. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  50177. * too much the area relying on ambient texture to define their ambient occlusion.
  50178. */
  50179. protected _useRadianceOcclusion: boolean;
  50180. /**
  50181. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  50182. */
  50183. protected _useAlphaFromAlbedoTexture: boolean;
  50184. /**
  50185. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  50186. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  50187. */
  50188. protected _useSpecularOverAlpha: boolean;
  50189. /**
  50190. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  50191. */
  50192. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  50193. /**
  50194. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  50195. */
  50196. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  50197. /**
  50198. * Specifies if the metallic texture contains the roughness information in its green channel.
  50199. */
  50200. protected _useRoughnessFromMetallicTextureGreen: boolean;
  50201. /**
  50202. * Specifies if the metallic texture contains the metallness information in its blue channel.
  50203. */
  50204. protected _useMetallnessFromMetallicTextureBlue: boolean;
  50205. /**
  50206. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  50207. */
  50208. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  50209. /**
  50210. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  50211. */
  50212. protected _useAmbientInGrayScale: boolean;
  50213. /**
  50214. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  50215. * The material will try to infer what glossiness each pixel should be.
  50216. */
  50217. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  50218. /**
  50219. * Defines the falloff type used in this material.
  50220. * It by default is Physical.
  50221. */
  50222. protected _lightFalloff: number;
  50223. /**
  50224. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  50225. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  50226. */
  50227. protected _useRadianceOverAlpha: boolean;
  50228. /**
  50229. * Allows using an object space normal map (instead of tangent space).
  50230. */
  50231. protected _useObjectSpaceNormalMap: boolean;
  50232. /**
  50233. * Allows using the bump map in parallax mode.
  50234. */
  50235. protected _useParallax: boolean;
  50236. /**
  50237. * Allows using the bump map in parallax occlusion mode.
  50238. */
  50239. protected _useParallaxOcclusion: boolean;
  50240. /**
  50241. * Controls the scale bias of the parallax mode.
  50242. */
  50243. protected _parallaxScaleBias: number;
  50244. /**
  50245. * If sets to true, disables all the lights affecting the material.
  50246. */
  50247. protected _disableLighting: boolean;
  50248. /**
  50249. * Number of Simultaneous lights allowed on the material.
  50250. */
  50251. protected _maxSimultaneousLights: number;
  50252. /**
  50253. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  50254. */
  50255. protected _invertNormalMapX: boolean;
  50256. /**
  50257. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  50258. */
  50259. protected _invertNormalMapY: boolean;
  50260. /**
  50261. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  50262. */
  50263. protected _twoSidedLighting: boolean;
  50264. /**
  50265. * Defines the alpha limits in alpha test mode.
  50266. */
  50267. protected _alphaCutOff: number;
  50268. /**
  50269. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  50270. */
  50271. protected _forceAlphaTest: boolean;
  50272. /**
  50273. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50274. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  50275. */
  50276. protected _useAlphaFresnel: boolean;
  50277. /**
  50278. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50279. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  50280. */
  50281. protected _useLinearAlphaFresnel: boolean;
  50282. /**
  50283. * The transparency mode of the material.
  50284. */
  50285. protected _transparencyMode: Nullable<number>;
  50286. /**
  50287. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  50288. * from cos thetav and roughness:
  50289. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  50290. */
  50291. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  50292. /**
  50293. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  50294. */
  50295. protected _forceIrradianceInFragment: boolean;
  50296. /**
  50297. * Force normal to face away from face.
  50298. */
  50299. protected _forceNormalForward: boolean;
  50300. /**
  50301. * Enables specular anti aliasing in the PBR shader.
  50302. * It will both interacts on the Geometry for analytical and IBL lighting.
  50303. * It also prefilter the roughness map based on the bump values.
  50304. */
  50305. protected _enableSpecularAntiAliasing: boolean;
  50306. /**
  50307. * Default configuration related to image processing available in the PBR Material.
  50308. */
  50309. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  50310. /**
  50311. * Keep track of the image processing observer to allow dispose and replace.
  50312. */
  50313. private _imageProcessingObserver;
  50314. /**
  50315. * Attaches a new image processing configuration to the PBR Material.
  50316. * @param configuration
  50317. */
  50318. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  50319. /**
  50320. * Stores the available render targets.
  50321. */
  50322. private _renderTargets;
  50323. /**
  50324. * Sets the global ambient color for the material used in lighting calculations.
  50325. */
  50326. private _globalAmbientColor;
  50327. /**
  50328. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  50329. */
  50330. private _useLogarithmicDepth;
  50331. /**
  50332. * If set to true, no lighting calculations will be applied.
  50333. */
  50334. private _unlit;
  50335. private _debugMode;
  50336. /**
  50337. * @hidden
  50338. * This is reserved for the inspector.
  50339. * Defines the material debug mode.
  50340. * It helps seeing only some components of the material while troubleshooting.
  50341. */
  50342. debugMode: number;
  50343. /**
  50344. * @hidden
  50345. * This is reserved for the inspector.
  50346. * Specify from where on screen the debug mode should start.
  50347. * The value goes from -1 (full screen) to 1 (not visible)
  50348. * It helps with side by side comparison against the final render
  50349. * This defaults to -1
  50350. */
  50351. private debugLimit;
  50352. /**
  50353. * @hidden
  50354. * This is reserved for the inspector.
  50355. * As the default viewing range might not be enough (if the ambient is really small for instance)
  50356. * You can use the factor to better multiply the final value.
  50357. */
  50358. private debugFactor;
  50359. /**
  50360. * Defines the clear coat layer parameters for the material.
  50361. */
  50362. readonly clearCoat: PBRClearCoatConfiguration;
  50363. /**
  50364. * Defines the anisotropic parameters for the material.
  50365. */
  50366. readonly anisotropy: PBRAnisotropicConfiguration;
  50367. /**
  50368. * Defines the BRDF parameters for the material.
  50369. */
  50370. readonly brdf: PBRBRDFConfiguration;
  50371. /**
  50372. * Defines the Sheen parameters for the material.
  50373. */
  50374. readonly sheen: PBRSheenConfiguration;
  50375. /**
  50376. * Defines the SubSurface parameters for the material.
  50377. */
  50378. readonly subSurface: PBRSubSurfaceConfiguration;
  50379. /**
  50380. * Custom callback helping to override the default shader used in the material.
  50381. */
  50382. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  50383. protected _rebuildInParallel: boolean;
  50384. /**
  50385. * Instantiates a new PBRMaterial instance.
  50386. *
  50387. * @param name The material name
  50388. * @param scene The scene the material will be use in.
  50389. */
  50390. constructor(name: string, scene: Scene);
  50391. /**
  50392. * Gets a boolean indicating that current material needs to register RTT
  50393. */
  50394. readonly hasRenderTargetTextures: boolean;
  50395. /**
  50396. * Gets the name of the material class.
  50397. */
  50398. getClassName(): string;
  50399. /**
  50400. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  50401. */
  50402. /**
  50403. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  50404. */
  50405. useLogarithmicDepth: boolean;
  50406. /**
  50407. * Gets the current transparency mode.
  50408. */
  50409. /**
  50410. * Sets the transparency mode of the material.
  50411. *
  50412. * | Value | Type | Description |
  50413. * | ----- | ----------------------------------- | ----------- |
  50414. * | 0 | OPAQUE | |
  50415. * | 1 | ALPHATEST | |
  50416. * | 2 | ALPHABLEND | |
  50417. * | 3 | ALPHATESTANDBLEND | |
  50418. *
  50419. */
  50420. transparencyMode: Nullable<number>;
  50421. /**
  50422. * Returns true if alpha blending should be disabled.
  50423. */
  50424. private readonly _disableAlphaBlending;
  50425. /**
  50426. * Specifies whether or not this material should be rendered in alpha blend mode.
  50427. */
  50428. needAlphaBlending(): boolean;
  50429. /**
  50430. * Specifies if the mesh will require alpha blending.
  50431. * @param mesh - BJS mesh.
  50432. */
  50433. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  50434. /**
  50435. * Specifies whether or not this material should be rendered in alpha test mode.
  50436. */
  50437. needAlphaTesting(): boolean;
  50438. /**
  50439. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  50440. */
  50441. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  50442. /**
  50443. * Gets the texture used for the alpha test.
  50444. */
  50445. getAlphaTestTexture(): Nullable<BaseTexture>;
  50446. /**
  50447. * Specifies that the submesh is ready to be used.
  50448. * @param mesh - BJS mesh.
  50449. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  50450. * @param useInstances - Specifies that instances should be used.
  50451. * @returns - boolean indicating that the submesh is ready or not.
  50452. */
  50453. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  50454. /**
  50455. * Specifies if the material uses metallic roughness workflow.
  50456. * @returns boolean specifiying if the material uses metallic roughness workflow.
  50457. */
  50458. isMetallicWorkflow(): boolean;
  50459. private _prepareEffect;
  50460. private _prepareDefines;
  50461. /**
  50462. * Force shader compilation
  50463. */
  50464. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  50465. /**
  50466. * Initializes the uniform buffer layout for the shader.
  50467. */
  50468. buildUniformLayout(): void;
  50469. /**
  50470. * Unbinds the material from the mesh
  50471. */
  50472. unbind(): void;
  50473. /**
  50474. * Binds the submesh data.
  50475. * @param world - The world matrix.
  50476. * @param mesh - The BJS mesh.
  50477. * @param subMesh - A submesh of the BJS mesh.
  50478. */
  50479. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  50480. /**
  50481. * Returns the animatable textures.
  50482. * @returns - Array of animatable textures.
  50483. */
  50484. getAnimatables(): IAnimatable[];
  50485. /**
  50486. * Returns the texture used for reflections.
  50487. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  50488. */
  50489. private _getReflectionTexture;
  50490. /**
  50491. * Returns an array of the actively used textures.
  50492. * @returns - Array of BaseTextures
  50493. */
  50494. getActiveTextures(): BaseTexture[];
  50495. /**
  50496. * Checks to see if a texture is used in the material.
  50497. * @param texture - Base texture to use.
  50498. * @returns - Boolean specifying if a texture is used in the material.
  50499. */
  50500. hasTexture(texture: BaseTexture): boolean;
  50501. /**
  50502. * Disposes the resources of the material.
  50503. * @param forceDisposeEffect - Forces the disposal of effects.
  50504. * @param forceDisposeTextures - Forces the disposal of all textures.
  50505. */
  50506. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  50507. }
  50508. }
  50509. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  50510. import { Nullable } from "babylonjs/types";
  50511. import { Scene } from "babylonjs/scene";
  50512. import { Color3 } from "babylonjs/Maths/math.color";
  50513. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  50514. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  50515. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  50516. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  50517. /**
  50518. * The Physically based material of BJS.
  50519. *
  50520. * This offers the main features of a standard PBR material.
  50521. * For more information, please refer to the documentation :
  50522. * https://doc.babylonjs.com/how_to/physically_based_rendering
  50523. */
  50524. export class PBRMaterial extends PBRBaseMaterial {
  50525. /**
  50526. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  50527. */
  50528. static readonly PBRMATERIAL_OPAQUE: number;
  50529. /**
  50530. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  50531. */
  50532. static readonly PBRMATERIAL_ALPHATEST: number;
  50533. /**
  50534. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50535. */
  50536. static readonly PBRMATERIAL_ALPHABLEND: number;
  50537. /**
  50538. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50539. * They are also discarded below the alpha cutoff threshold to improve performances.
  50540. */
  50541. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  50542. /**
  50543. * Defines the default value of how much AO map is occluding the analytical lights
  50544. * (point spot...).
  50545. */
  50546. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  50547. /**
  50548. * Intensity of the direct lights e.g. the four lights available in your scene.
  50549. * This impacts both the direct diffuse and specular highlights.
  50550. */
  50551. directIntensity: number;
  50552. /**
  50553. * Intensity of the emissive part of the material.
  50554. * This helps controlling the emissive effect without modifying the emissive color.
  50555. */
  50556. emissiveIntensity: number;
  50557. /**
  50558. * Intensity of the environment e.g. how much the environment will light the object
  50559. * either through harmonics for rough material or through the refelction for shiny ones.
  50560. */
  50561. environmentIntensity: number;
  50562. /**
  50563. * This is a special control allowing the reduction of the specular highlights coming from the
  50564. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  50565. */
  50566. specularIntensity: number;
  50567. /**
  50568. * Debug Control allowing disabling the bump map on this material.
  50569. */
  50570. disableBumpMap: boolean;
  50571. /**
  50572. * AKA Diffuse Texture in standard nomenclature.
  50573. */
  50574. albedoTexture: BaseTexture;
  50575. /**
  50576. * AKA Occlusion Texture in other nomenclature.
  50577. */
  50578. ambientTexture: BaseTexture;
  50579. /**
  50580. * AKA Occlusion Texture Intensity in other nomenclature.
  50581. */
  50582. ambientTextureStrength: number;
  50583. /**
  50584. * Defines how much the AO map is occluding the analytical lights (point spot...).
  50585. * 1 means it completely occludes it
  50586. * 0 mean it has no impact
  50587. */
  50588. ambientTextureImpactOnAnalyticalLights: number;
  50589. /**
  50590. * Stores the alpha values in a texture.
  50591. */
  50592. opacityTexture: BaseTexture;
  50593. /**
  50594. * Stores the reflection values in a texture.
  50595. */
  50596. reflectionTexture: Nullable<BaseTexture>;
  50597. /**
  50598. * Stores the emissive values in a texture.
  50599. */
  50600. emissiveTexture: BaseTexture;
  50601. /**
  50602. * AKA Specular texture in other nomenclature.
  50603. */
  50604. reflectivityTexture: BaseTexture;
  50605. /**
  50606. * Used to switch from specular/glossiness to metallic/roughness workflow.
  50607. */
  50608. metallicTexture: BaseTexture;
  50609. /**
  50610. * Specifies the metallic scalar of the metallic/roughness workflow.
  50611. * Can also be used to scale the metalness values of the metallic texture.
  50612. */
  50613. metallic: Nullable<number>;
  50614. /**
  50615. * Specifies the roughness scalar of the metallic/roughness workflow.
  50616. * Can also be used to scale the roughness values of the metallic texture.
  50617. */
  50618. roughness: Nullable<number>;
  50619. /**
  50620. * Specifies the an F0 factor to help configuring the material F0.
  50621. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  50622. * to 0.5 the previously hard coded value stays the same.
  50623. * Can also be used to scale the F0 values of the metallic texture.
  50624. */
  50625. metallicF0Factor: number;
  50626. /**
  50627. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  50628. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  50629. * your expectation as it multiplies with the texture data.
  50630. */
  50631. useMetallicF0FactorFromMetallicTexture: boolean;
  50632. /**
  50633. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  50634. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  50635. */
  50636. microSurfaceTexture: BaseTexture;
  50637. /**
  50638. * Stores surface normal data used to displace a mesh in a texture.
  50639. */
  50640. bumpTexture: BaseTexture;
  50641. /**
  50642. * Stores the pre-calculated light information of a mesh in a texture.
  50643. */
  50644. lightmapTexture: BaseTexture;
  50645. /**
  50646. * Stores the refracted light information in a texture.
  50647. */
  50648. refractionTexture: Nullable<BaseTexture>;
  50649. /**
  50650. * The color of a material in ambient lighting.
  50651. */
  50652. ambientColor: Color3;
  50653. /**
  50654. * AKA Diffuse Color in other nomenclature.
  50655. */
  50656. albedoColor: Color3;
  50657. /**
  50658. * AKA Specular Color in other nomenclature.
  50659. */
  50660. reflectivityColor: Color3;
  50661. /**
  50662. * The color reflected from the material.
  50663. */
  50664. reflectionColor: Color3;
  50665. /**
  50666. * The color emitted from the material.
  50667. */
  50668. emissiveColor: Color3;
  50669. /**
  50670. * AKA Glossiness in other nomenclature.
  50671. */
  50672. microSurface: number;
  50673. /**
  50674. * source material index of refraction (IOR)' / 'destination material IOR.
  50675. */
  50676. indexOfRefraction: number;
  50677. /**
  50678. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  50679. */
  50680. invertRefractionY: boolean;
  50681. /**
  50682. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  50683. * Materials half opaque for instance using refraction could benefit from this control.
  50684. */
  50685. linkRefractionWithTransparency: boolean;
  50686. /**
  50687. * If true, the light map contains occlusion information instead of lighting info.
  50688. */
  50689. useLightmapAsShadowmap: boolean;
  50690. /**
  50691. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  50692. */
  50693. useAlphaFromAlbedoTexture: boolean;
  50694. /**
  50695. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  50696. */
  50697. forceAlphaTest: boolean;
  50698. /**
  50699. * Defines the alpha limits in alpha test mode.
  50700. */
  50701. alphaCutOff: number;
  50702. /**
  50703. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  50704. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  50705. */
  50706. useSpecularOverAlpha: boolean;
  50707. /**
  50708. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  50709. */
  50710. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  50711. /**
  50712. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  50713. */
  50714. useRoughnessFromMetallicTextureAlpha: boolean;
  50715. /**
  50716. * Specifies if the metallic texture contains the roughness information in its green channel.
  50717. */
  50718. useRoughnessFromMetallicTextureGreen: boolean;
  50719. /**
  50720. * Specifies if the metallic texture contains the metallness information in its blue channel.
  50721. */
  50722. useMetallnessFromMetallicTextureBlue: boolean;
  50723. /**
  50724. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  50725. */
  50726. useAmbientOcclusionFromMetallicTextureRed: boolean;
  50727. /**
  50728. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  50729. */
  50730. useAmbientInGrayScale: boolean;
  50731. /**
  50732. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  50733. * The material will try to infer what glossiness each pixel should be.
  50734. */
  50735. useAutoMicroSurfaceFromReflectivityMap: boolean;
  50736. /**
  50737. * BJS is using an harcoded light falloff based on a manually sets up range.
  50738. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  50739. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  50740. */
  50741. /**
  50742. * BJS is using an harcoded light falloff based on a manually sets up range.
  50743. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  50744. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  50745. */
  50746. usePhysicalLightFalloff: boolean;
  50747. /**
  50748. * In order to support the falloff compatibility with gltf, a special mode has been added
  50749. * to reproduce the gltf light falloff.
  50750. */
  50751. /**
  50752. * In order to support the falloff compatibility with gltf, a special mode has been added
  50753. * to reproduce the gltf light falloff.
  50754. */
  50755. useGLTFLightFalloff: boolean;
  50756. /**
  50757. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  50758. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  50759. */
  50760. useRadianceOverAlpha: boolean;
  50761. /**
  50762. * Allows using an object space normal map (instead of tangent space).
  50763. */
  50764. useObjectSpaceNormalMap: boolean;
  50765. /**
  50766. * Allows using the bump map in parallax mode.
  50767. */
  50768. useParallax: boolean;
  50769. /**
  50770. * Allows using the bump map in parallax occlusion mode.
  50771. */
  50772. useParallaxOcclusion: boolean;
  50773. /**
  50774. * Controls the scale bias of the parallax mode.
  50775. */
  50776. parallaxScaleBias: number;
  50777. /**
  50778. * If sets to true, disables all the lights affecting the material.
  50779. */
  50780. disableLighting: boolean;
  50781. /**
  50782. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  50783. */
  50784. forceIrradianceInFragment: boolean;
  50785. /**
  50786. * Number of Simultaneous lights allowed on the material.
  50787. */
  50788. maxSimultaneousLights: number;
  50789. /**
  50790. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  50791. */
  50792. invertNormalMapX: boolean;
  50793. /**
  50794. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  50795. */
  50796. invertNormalMapY: boolean;
  50797. /**
  50798. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  50799. */
  50800. twoSidedLighting: boolean;
  50801. /**
  50802. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50803. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  50804. */
  50805. useAlphaFresnel: boolean;
  50806. /**
  50807. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50808. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  50809. */
  50810. useLinearAlphaFresnel: boolean;
  50811. /**
  50812. * Let user defines the brdf lookup texture used for IBL.
  50813. * A default 8bit version is embedded but you could point at :
  50814. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  50815. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  50816. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  50817. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  50818. */
  50819. environmentBRDFTexture: Nullable<BaseTexture>;
  50820. /**
  50821. * Force normal to face away from face.
  50822. */
  50823. forceNormalForward: boolean;
  50824. /**
  50825. * Enables specular anti aliasing in the PBR shader.
  50826. * It will both interacts on the Geometry for analytical and IBL lighting.
  50827. * It also prefilter the roughness map based on the bump values.
  50828. */
  50829. enableSpecularAntiAliasing: boolean;
  50830. /**
  50831. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  50832. * makes the reflect vector face the model (under horizon).
  50833. */
  50834. useHorizonOcclusion: boolean;
  50835. /**
  50836. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  50837. * too much the area relying on ambient texture to define their ambient occlusion.
  50838. */
  50839. useRadianceOcclusion: boolean;
  50840. /**
  50841. * If set to true, no lighting calculations will be applied.
  50842. */
  50843. unlit: boolean;
  50844. /**
  50845. * Gets the image processing configuration used either in this material.
  50846. */
  50847. /**
  50848. * Sets the Default image processing configuration used either in the this material.
  50849. *
  50850. * If sets to null, the scene one is in use.
  50851. */
  50852. imageProcessingConfiguration: ImageProcessingConfiguration;
  50853. /**
  50854. * Gets wether the color curves effect is enabled.
  50855. */
  50856. /**
  50857. * Sets wether the color curves effect is enabled.
  50858. */
  50859. cameraColorCurvesEnabled: boolean;
  50860. /**
  50861. * Gets wether the color grading effect is enabled.
  50862. */
  50863. /**
  50864. * Gets wether the color grading effect is enabled.
  50865. */
  50866. cameraColorGradingEnabled: boolean;
  50867. /**
  50868. * Gets wether tonemapping is enabled or not.
  50869. */
  50870. /**
  50871. * Sets wether tonemapping is enabled or not
  50872. */
  50873. cameraToneMappingEnabled: boolean;
  50874. /**
  50875. * The camera exposure used on this material.
  50876. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  50877. * This corresponds to a photographic exposure.
  50878. */
  50879. /**
  50880. * The camera exposure used on this material.
  50881. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  50882. * This corresponds to a photographic exposure.
  50883. */
  50884. cameraExposure: number;
  50885. /**
  50886. * Gets The camera contrast used on this material.
  50887. */
  50888. /**
  50889. * Sets The camera contrast used on this material.
  50890. */
  50891. cameraContrast: number;
  50892. /**
  50893. * Gets the Color Grading 2D Lookup Texture.
  50894. */
  50895. /**
  50896. * Sets the Color Grading 2D Lookup Texture.
  50897. */
  50898. cameraColorGradingTexture: Nullable<BaseTexture>;
  50899. /**
  50900. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  50901. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  50902. * 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;
  50903. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  50904. */
  50905. /**
  50906. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  50907. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  50908. * 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;
  50909. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  50910. */
  50911. cameraColorCurves: Nullable<ColorCurves>;
  50912. /**
  50913. * Instantiates a new PBRMaterial instance.
  50914. *
  50915. * @param name The material name
  50916. * @param scene The scene the material will be use in.
  50917. */
  50918. constructor(name: string, scene: Scene);
  50919. /**
  50920. * Returns the name of this material class.
  50921. */
  50922. getClassName(): string;
  50923. /**
  50924. * Makes a duplicate of the current material.
  50925. * @param name - name to use for the new material.
  50926. */
  50927. clone(name: string): PBRMaterial;
  50928. /**
  50929. * Serializes this PBR Material.
  50930. * @returns - An object with the serialized material.
  50931. */
  50932. serialize(): any;
  50933. /**
  50934. * Parses a PBR Material from a serialized object.
  50935. * @param source - Serialized object.
  50936. * @param scene - BJS scene instance.
  50937. * @param rootUrl - url for the scene object
  50938. * @returns - PBRMaterial
  50939. */
  50940. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  50941. }
  50942. }
  50943. declare module "babylonjs/Misc/dds" {
  50944. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  50945. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  50946. import { Nullable } from "babylonjs/types";
  50947. import { Scene } from "babylonjs/scene";
  50948. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  50949. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  50950. /**
  50951. * Direct draw surface info
  50952. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  50953. */
  50954. export interface DDSInfo {
  50955. /**
  50956. * Width of the texture
  50957. */
  50958. width: number;
  50959. /**
  50960. * Width of the texture
  50961. */
  50962. height: number;
  50963. /**
  50964. * Number of Mipmaps for the texture
  50965. * @see https://en.wikipedia.org/wiki/Mipmap
  50966. */
  50967. mipmapCount: number;
  50968. /**
  50969. * If the textures format is a known fourCC format
  50970. * @see https://www.fourcc.org/
  50971. */
  50972. isFourCC: boolean;
  50973. /**
  50974. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  50975. */
  50976. isRGB: boolean;
  50977. /**
  50978. * If the texture is a lumincance format
  50979. */
  50980. isLuminance: boolean;
  50981. /**
  50982. * If this is a cube texture
  50983. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  50984. */
  50985. isCube: boolean;
  50986. /**
  50987. * If the texture is a compressed format eg. FOURCC_DXT1
  50988. */
  50989. isCompressed: boolean;
  50990. /**
  50991. * The dxgiFormat of the texture
  50992. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  50993. */
  50994. dxgiFormat: number;
  50995. /**
  50996. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  50997. */
  50998. textureType: number;
  50999. /**
  51000. * Sphericle polynomial created for the dds texture
  51001. */
  51002. sphericalPolynomial?: SphericalPolynomial;
  51003. }
  51004. /**
  51005. * Class used to provide DDS decompression tools
  51006. */
  51007. export class DDSTools {
  51008. /**
  51009. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  51010. */
  51011. static StoreLODInAlphaChannel: boolean;
  51012. /**
  51013. * Gets DDS information from an array buffer
  51014. * @param arrayBuffer defines the array buffer to read data from
  51015. * @returns the DDS information
  51016. */
  51017. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  51018. private static _FloatView;
  51019. private static _Int32View;
  51020. private static _ToHalfFloat;
  51021. private static _FromHalfFloat;
  51022. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  51023. private static _GetHalfFloatRGBAArrayBuffer;
  51024. private static _GetFloatRGBAArrayBuffer;
  51025. private static _GetFloatAsUIntRGBAArrayBuffer;
  51026. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  51027. private static _GetRGBAArrayBuffer;
  51028. private static _ExtractLongWordOrder;
  51029. private static _GetRGBArrayBuffer;
  51030. private static _GetLuminanceArrayBuffer;
  51031. /**
  51032. * Uploads DDS Levels to a Babylon Texture
  51033. * @hidden
  51034. */
  51035. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  51036. }
  51037. module "babylonjs/Engines/thinEngine" {
  51038. interface ThinEngine {
  51039. /**
  51040. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  51041. * @param rootUrl defines the url where the file to load is located
  51042. * @param scene defines the current scene
  51043. * @param lodScale defines scale to apply to the mip map selection
  51044. * @param lodOffset defines offset to apply to the mip map selection
  51045. * @param onLoad defines an optional callback raised when the texture is loaded
  51046. * @param onError defines an optional callback raised if there is an issue to load the texture
  51047. * @param format defines the format of the data
  51048. * @param forcedExtension defines the extension to use to pick the right loader
  51049. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  51050. * @returns the cube texture as an InternalTexture
  51051. */
  51052. 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;
  51053. }
  51054. }
  51055. }
  51056. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  51057. import { Nullable } from "babylonjs/types";
  51058. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51059. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51060. /**
  51061. * Implementation of the DDS Texture Loader.
  51062. * @hidden
  51063. */
  51064. export class _DDSTextureLoader implements IInternalTextureLoader {
  51065. /**
  51066. * Defines wether the loader supports cascade loading the different faces.
  51067. */
  51068. readonly supportCascades: boolean;
  51069. /**
  51070. * This returns if the loader support the current file information.
  51071. * @param extension defines the file extension of the file being loaded
  51072. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51073. * @param fallback defines the fallback internal texture if any
  51074. * @param isBase64 defines whether the texture is encoded as a base64
  51075. * @param isBuffer defines whether the texture data are stored as a buffer
  51076. * @returns true if the loader can load the specified file
  51077. */
  51078. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51079. /**
  51080. * Transform the url before loading if required.
  51081. * @param rootUrl the url of the texture
  51082. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51083. * @returns the transformed texture
  51084. */
  51085. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51086. /**
  51087. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51088. * @param rootUrl the url of the texture
  51089. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51090. * @returns the fallback texture
  51091. */
  51092. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51093. /**
  51094. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51095. * @param data contains the texture data
  51096. * @param texture defines the BabylonJS internal texture
  51097. * @param createPolynomials will be true if polynomials have been requested
  51098. * @param onLoad defines the callback to trigger once the texture is ready
  51099. * @param onError defines the callback to trigger in case of error
  51100. */
  51101. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51102. /**
  51103. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51104. * @param data contains the texture data
  51105. * @param texture defines the BabylonJS internal texture
  51106. * @param callback defines the method to call once ready to upload
  51107. */
  51108. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  51109. }
  51110. }
  51111. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  51112. import { Nullable } from "babylonjs/types";
  51113. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51114. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51115. /**
  51116. * Implementation of the ENV Texture Loader.
  51117. * @hidden
  51118. */
  51119. export class _ENVTextureLoader implements IInternalTextureLoader {
  51120. /**
  51121. * Defines wether the loader supports cascade loading the different faces.
  51122. */
  51123. readonly supportCascades: boolean;
  51124. /**
  51125. * This returns if the loader support the current file information.
  51126. * @param extension defines the file extension of the file being loaded
  51127. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51128. * @param fallback defines the fallback internal texture if any
  51129. * @param isBase64 defines whether the texture is encoded as a base64
  51130. * @param isBuffer defines whether the texture data are stored as a buffer
  51131. * @returns true if the loader can load the specified file
  51132. */
  51133. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51134. /**
  51135. * Transform the url before loading if required.
  51136. * @param rootUrl the url of the texture
  51137. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51138. * @returns the transformed texture
  51139. */
  51140. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51141. /**
  51142. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51143. * @param rootUrl the url of the texture
  51144. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51145. * @returns the fallback texture
  51146. */
  51147. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51148. /**
  51149. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51150. * @param data contains the texture data
  51151. * @param texture defines the BabylonJS internal texture
  51152. * @param createPolynomials will be true if polynomials have been requested
  51153. * @param onLoad defines the callback to trigger once the texture is ready
  51154. * @param onError defines the callback to trigger in case of error
  51155. */
  51156. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51157. /**
  51158. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51159. * @param data contains the texture data
  51160. * @param texture defines the BabylonJS internal texture
  51161. * @param callback defines the method to call once ready to upload
  51162. */
  51163. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  51164. }
  51165. }
  51166. declare module "babylonjs/Misc/khronosTextureContainer" {
  51167. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51168. /**
  51169. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  51170. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  51171. */
  51172. export class KhronosTextureContainer {
  51173. /** contents of the KTX container file */
  51174. arrayBuffer: any;
  51175. private static HEADER_LEN;
  51176. private static COMPRESSED_2D;
  51177. private static COMPRESSED_3D;
  51178. private static TEX_2D;
  51179. private static TEX_3D;
  51180. /**
  51181. * Gets the openGL type
  51182. */
  51183. glType: number;
  51184. /**
  51185. * Gets the openGL type size
  51186. */
  51187. glTypeSize: number;
  51188. /**
  51189. * Gets the openGL format
  51190. */
  51191. glFormat: number;
  51192. /**
  51193. * Gets the openGL internal format
  51194. */
  51195. glInternalFormat: number;
  51196. /**
  51197. * Gets the base internal format
  51198. */
  51199. glBaseInternalFormat: number;
  51200. /**
  51201. * Gets image width in pixel
  51202. */
  51203. pixelWidth: number;
  51204. /**
  51205. * Gets image height in pixel
  51206. */
  51207. pixelHeight: number;
  51208. /**
  51209. * Gets image depth in pixels
  51210. */
  51211. pixelDepth: number;
  51212. /**
  51213. * Gets the number of array elements
  51214. */
  51215. numberOfArrayElements: number;
  51216. /**
  51217. * Gets the number of faces
  51218. */
  51219. numberOfFaces: number;
  51220. /**
  51221. * Gets the number of mipmap levels
  51222. */
  51223. numberOfMipmapLevels: number;
  51224. /**
  51225. * Gets the bytes of key value data
  51226. */
  51227. bytesOfKeyValueData: number;
  51228. /**
  51229. * Gets the load type
  51230. */
  51231. loadType: number;
  51232. /**
  51233. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  51234. */
  51235. isInvalid: boolean;
  51236. /**
  51237. * Creates a new KhronosTextureContainer
  51238. * @param arrayBuffer contents of the KTX container file
  51239. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  51240. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  51241. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  51242. */
  51243. constructor(
  51244. /** contents of the KTX container file */
  51245. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  51246. /**
  51247. * Uploads KTX content to a Babylon Texture.
  51248. * It is assumed that the texture has already been created & is currently bound
  51249. * @hidden
  51250. */
  51251. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  51252. private _upload2DCompressedLevels;
  51253. }
  51254. }
  51255. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  51256. import { Nullable } from "babylonjs/types";
  51257. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51258. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51259. /**
  51260. * Implementation of the KTX Texture Loader.
  51261. * @hidden
  51262. */
  51263. export class _KTXTextureLoader implements IInternalTextureLoader {
  51264. /**
  51265. * Defines wether the loader supports cascade loading the different faces.
  51266. */
  51267. readonly supportCascades: boolean;
  51268. /**
  51269. * This returns if the loader support the current file information.
  51270. * @param extension defines the file extension of the file being loaded
  51271. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51272. * @param fallback defines the fallback internal texture if any
  51273. * @param isBase64 defines whether the texture is encoded as a base64
  51274. * @param isBuffer defines whether the texture data are stored as a buffer
  51275. * @returns true if the loader can load the specified file
  51276. */
  51277. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51278. /**
  51279. * Transform the url before loading if required.
  51280. * @param rootUrl the url of the texture
  51281. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51282. * @returns the transformed texture
  51283. */
  51284. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51285. /**
  51286. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51287. * @param rootUrl the url of the texture
  51288. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51289. * @returns the fallback texture
  51290. */
  51291. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51292. /**
  51293. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51294. * @param data contains the texture data
  51295. * @param texture defines the BabylonJS internal texture
  51296. * @param createPolynomials will be true if polynomials have been requested
  51297. * @param onLoad defines the callback to trigger once the texture is ready
  51298. * @param onError defines the callback to trigger in case of error
  51299. */
  51300. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51301. /**
  51302. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51303. * @param data contains the texture data
  51304. * @param texture defines the BabylonJS internal texture
  51305. * @param callback defines the method to call once ready to upload
  51306. */
  51307. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  51308. }
  51309. }
  51310. declare module "babylonjs/Cameras/XR/webXRDefaultExperience" {
  51311. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  51312. import { Scene } from "babylonjs/scene";
  51313. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  51314. import { WebXRControllerModelLoader } from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  51315. import { WebXRControllerPointerSelection } from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  51316. import { WebXRControllerTeleportation } from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  51317. import { WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  51318. import { WebXREnterExitUI } from "babylonjs/Cameras/XR/webXREnterExitUI";
  51319. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51320. /**
  51321. * Options for the default xr helper
  51322. */
  51323. export class WebXRDefaultExperienceOptions {
  51324. /**
  51325. * Floor meshes that should be used for teleporting
  51326. */
  51327. floorMeshes: Array<AbstractMesh>;
  51328. /**
  51329. * Enable or disable default UI to enter XR
  51330. */
  51331. disableDefaultUI: boolean;
  51332. }
  51333. /**
  51334. * Default experience which provides a similar setup to the previous webVRExperience
  51335. */
  51336. export class WebXRDefaultExperience {
  51337. /**
  51338. * Base experience
  51339. */
  51340. baseExperience: WebXRExperienceHelper;
  51341. /**
  51342. * Input experience extension
  51343. */
  51344. input: WebXRInput;
  51345. /**
  51346. * Loads the controller models
  51347. */
  51348. controllerModelLoader: WebXRControllerModelLoader;
  51349. /**
  51350. * Enables laser pointer and selection
  51351. */
  51352. pointerSelection: WebXRControllerPointerSelection;
  51353. /**
  51354. * Enables teleportation
  51355. */
  51356. teleportation: WebXRControllerTeleportation;
  51357. /**
  51358. * Enables ui for enetering/exiting xr
  51359. */
  51360. enterExitUI: WebXREnterExitUI;
  51361. /**
  51362. * Default target xr should render to
  51363. */
  51364. renderTarget: WebXRRenderTarget;
  51365. /**
  51366. * Creates the default xr experience
  51367. * @param scene scene
  51368. * @param options options for basic configuration
  51369. * @returns resulting WebXRDefaultExperience
  51370. */
  51371. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51372. private constructor();
  51373. /**
  51374. * DIsposes of the experience helper
  51375. */
  51376. dispose(): void;
  51377. }
  51378. }
  51379. declare module "babylonjs/Helpers/sceneHelpers" {
  51380. import { Nullable } from "babylonjs/types";
  51381. import { Mesh } from "babylonjs/Meshes/mesh";
  51382. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  51383. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  51384. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  51385. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  51386. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  51387. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  51388. import "babylonjs/Meshes/Builders/boxBuilder";
  51389. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/Cameras/XR/webXRDefaultExperience";
  51390. /** @hidden */
  51391. export var _forceSceneHelpersToBundle: boolean;
  51392. module "babylonjs/scene" {
  51393. interface Scene {
  51394. /**
  51395. * Creates a default light for the scene.
  51396. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  51397. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  51398. */
  51399. createDefaultLight(replace?: boolean): void;
  51400. /**
  51401. * Creates a default camera for the scene.
  51402. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  51403. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  51404. * @param replace has default false, when true replaces the active camera in the scene
  51405. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  51406. */
  51407. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  51408. /**
  51409. * Creates a default camera and a default light.
  51410. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  51411. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  51412. * @param replace has the default false, when true replaces the active camera/light in the scene
  51413. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  51414. */
  51415. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  51416. /**
  51417. * Creates a new sky box
  51418. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  51419. * @param environmentTexture defines the texture to use as environment texture
  51420. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  51421. * @param scale defines the overall scale of the skybox
  51422. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  51423. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  51424. * @returns a new mesh holding the sky box
  51425. */
  51426. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  51427. /**
  51428. * Creates a new environment
  51429. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  51430. * @param options defines the options you can use to configure the environment
  51431. * @returns the new EnvironmentHelper
  51432. */
  51433. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  51434. /**
  51435. * Creates a new VREXperienceHelper
  51436. * @see http://doc.babylonjs.com/how_to/webvr_helper
  51437. * @param webVROptions defines the options used to create the new VREXperienceHelper
  51438. * @returns a new VREXperienceHelper
  51439. */
  51440. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  51441. /**
  51442. * Creates a new WebXRDefaultExperience
  51443. * @see http://doc.babylonjs.com/how_to/webxr
  51444. * @param options experience options
  51445. * @returns a promise for a new WebXRDefaultExperience
  51446. */
  51447. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51448. }
  51449. }
  51450. }
  51451. declare module "babylonjs/Helpers/videoDome" {
  51452. import { Scene } from "babylonjs/scene";
  51453. import { TransformNode } from "babylonjs/Meshes/transformNode";
  51454. import { Mesh } from "babylonjs/Meshes/mesh";
  51455. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  51456. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  51457. import "babylonjs/Meshes/Builders/sphereBuilder";
  51458. /**
  51459. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  51460. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  51461. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  51462. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  51463. */
  51464. export class VideoDome extends TransformNode {
  51465. /**
  51466. * Define the video source as a Monoscopic panoramic 360 video.
  51467. */
  51468. static readonly MODE_MONOSCOPIC: number;
  51469. /**
  51470. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  51471. */
  51472. static readonly MODE_TOPBOTTOM: number;
  51473. /**
  51474. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  51475. */
  51476. static readonly MODE_SIDEBYSIDE: number;
  51477. private _halfDome;
  51478. private _useDirectMapping;
  51479. /**
  51480. * The video texture being displayed on the sphere
  51481. */
  51482. protected _videoTexture: VideoTexture;
  51483. /**
  51484. * Gets the video texture being displayed on the sphere
  51485. */
  51486. readonly videoTexture: VideoTexture;
  51487. /**
  51488. * The skybox material
  51489. */
  51490. protected _material: BackgroundMaterial;
  51491. /**
  51492. * The surface used for the skybox
  51493. */
  51494. protected _mesh: Mesh;
  51495. /**
  51496. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  51497. */
  51498. private _halfDomeMask;
  51499. /**
  51500. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  51501. * Also see the options.resolution property.
  51502. */
  51503. fovMultiplier: number;
  51504. private _videoMode;
  51505. /**
  51506. * Gets or set the current video mode for the video. It can be:
  51507. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  51508. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  51509. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  51510. */
  51511. videoMode: number;
  51512. /**
  51513. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  51514. *
  51515. */
  51516. /**
  51517. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  51518. */
  51519. halfDome: boolean;
  51520. /**
  51521. * Oberserver used in Stereoscopic VR Mode.
  51522. */
  51523. private _onBeforeCameraRenderObserver;
  51524. /**
  51525. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  51526. * @param name Element's name, child elements will append suffixes for their own names.
  51527. * @param urlsOrVideo defines the url(s) or the video element to use
  51528. * @param options An object containing optional or exposed sub element properties
  51529. */
  51530. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  51531. resolution?: number;
  51532. clickToPlay?: boolean;
  51533. autoPlay?: boolean;
  51534. loop?: boolean;
  51535. size?: number;
  51536. poster?: string;
  51537. faceForward?: boolean;
  51538. useDirectMapping?: boolean;
  51539. halfDomeMode?: boolean;
  51540. }, scene: Scene);
  51541. private _changeVideoMode;
  51542. /**
  51543. * Releases resources associated with this node.
  51544. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  51545. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  51546. */
  51547. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  51548. }
  51549. }
  51550. declare module "babylonjs/Helpers/index" {
  51551. export * from "babylonjs/Helpers/environmentHelper";
  51552. export * from "babylonjs/Helpers/photoDome";
  51553. export * from "babylonjs/Helpers/sceneHelpers";
  51554. export * from "babylonjs/Helpers/videoDome";
  51555. }
  51556. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  51557. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  51558. import { IDisposable } from "babylonjs/scene";
  51559. import { Engine } from "babylonjs/Engines/engine";
  51560. /**
  51561. * This class can be used to get instrumentation data from a Babylon engine
  51562. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  51563. */
  51564. export class EngineInstrumentation implements IDisposable {
  51565. /**
  51566. * Define the instrumented engine.
  51567. */
  51568. engine: Engine;
  51569. private _captureGPUFrameTime;
  51570. private _gpuFrameTimeToken;
  51571. private _gpuFrameTime;
  51572. private _captureShaderCompilationTime;
  51573. private _shaderCompilationTime;
  51574. private _onBeginFrameObserver;
  51575. private _onEndFrameObserver;
  51576. private _onBeforeShaderCompilationObserver;
  51577. private _onAfterShaderCompilationObserver;
  51578. /**
  51579. * Gets the perf counter used for GPU frame time
  51580. */
  51581. readonly gpuFrameTimeCounter: PerfCounter;
  51582. /**
  51583. * Gets the GPU frame time capture status
  51584. */
  51585. /**
  51586. * Enable or disable the GPU frame time capture
  51587. */
  51588. captureGPUFrameTime: boolean;
  51589. /**
  51590. * Gets the perf counter used for shader compilation time
  51591. */
  51592. readonly shaderCompilationTimeCounter: PerfCounter;
  51593. /**
  51594. * Gets the shader compilation time capture status
  51595. */
  51596. /**
  51597. * Enable or disable the shader compilation time capture
  51598. */
  51599. captureShaderCompilationTime: boolean;
  51600. /**
  51601. * Instantiates a new engine instrumentation.
  51602. * This class can be used to get instrumentation data from a Babylon engine
  51603. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  51604. * @param engine Defines the engine to instrument
  51605. */
  51606. constructor(
  51607. /**
  51608. * Define the instrumented engine.
  51609. */
  51610. engine: Engine);
  51611. /**
  51612. * Dispose and release associated resources.
  51613. */
  51614. dispose(): void;
  51615. }
  51616. }
  51617. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  51618. import { Scene, IDisposable } from "babylonjs/scene";
  51619. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  51620. /**
  51621. * This class can be used to get instrumentation data from a Babylon engine
  51622. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  51623. */
  51624. export class SceneInstrumentation implements IDisposable {
  51625. /**
  51626. * Defines the scene to instrument
  51627. */
  51628. scene: Scene;
  51629. private _captureActiveMeshesEvaluationTime;
  51630. private _activeMeshesEvaluationTime;
  51631. private _captureRenderTargetsRenderTime;
  51632. private _renderTargetsRenderTime;
  51633. private _captureFrameTime;
  51634. private _frameTime;
  51635. private _captureRenderTime;
  51636. private _renderTime;
  51637. private _captureInterFrameTime;
  51638. private _interFrameTime;
  51639. private _captureParticlesRenderTime;
  51640. private _particlesRenderTime;
  51641. private _captureSpritesRenderTime;
  51642. private _spritesRenderTime;
  51643. private _capturePhysicsTime;
  51644. private _physicsTime;
  51645. private _captureAnimationsTime;
  51646. private _animationsTime;
  51647. private _captureCameraRenderTime;
  51648. private _cameraRenderTime;
  51649. private _onBeforeActiveMeshesEvaluationObserver;
  51650. private _onAfterActiveMeshesEvaluationObserver;
  51651. private _onBeforeRenderTargetsRenderObserver;
  51652. private _onAfterRenderTargetsRenderObserver;
  51653. private _onAfterRenderObserver;
  51654. private _onBeforeDrawPhaseObserver;
  51655. private _onAfterDrawPhaseObserver;
  51656. private _onBeforeAnimationsObserver;
  51657. private _onBeforeParticlesRenderingObserver;
  51658. private _onAfterParticlesRenderingObserver;
  51659. private _onBeforeSpritesRenderingObserver;
  51660. private _onAfterSpritesRenderingObserver;
  51661. private _onBeforePhysicsObserver;
  51662. private _onAfterPhysicsObserver;
  51663. private _onAfterAnimationsObserver;
  51664. private _onBeforeCameraRenderObserver;
  51665. private _onAfterCameraRenderObserver;
  51666. /**
  51667. * Gets the perf counter used for active meshes evaluation time
  51668. */
  51669. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  51670. /**
  51671. * Gets the active meshes evaluation time capture status
  51672. */
  51673. /**
  51674. * Enable or disable the active meshes evaluation time capture
  51675. */
  51676. captureActiveMeshesEvaluationTime: boolean;
  51677. /**
  51678. * Gets the perf counter used for render targets render time
  51679. */
  51680. readonly renderTargetsRenderTimeCounter: PerfCounter;
  51681. /**
  51682. * Gets the render targets render time capture status
  51683. */
  51684. /**
  51685. * Enable or disable the render targets render time capture
  51686. */
  51687. captureRenderTargetsRenderTime: boolean;
  51688. /**
  51689. * Gets the perf counter used for particles render time
  51690. */
  51691. readonly particlesRenderTimeCounter: PerfCounter;
  51692. /**
  51693. * Gets the particles render time capture status
  51694. */
  51695. /**
  51696. * Enable or disable the particles render time capture
  51697. */
  51698. captureParticlesRenderTime: boolean;
  51699. /**
  51700. * Gets the perf counter used for sprites render time
  51701. */
  51702. readonly spritesRenderTimeCounter: PerfCounter;
  51703. /**
  51704. * Gets the sprites render time capture status
  51705. */
  51706. /**
  51707. * Enable or disable the sprites render time capture
  51708. */
  51709. captureSpritesRenderTime: boolean;
  51710. /**
  51711. * Gets the perf counter used for physics time
  51712. */
  51713. readonly physicsTimeCounter: PerfCounter;
  51714. /**
  51715. * Gets the physics time capture status
  51716. */
  51717. /**
  51718. * Enable or disable the physics time capture
  51719. */
  51720. capturePhysicsTime: boolean;
  51721. /**
  51722. * Gets the perf counter used for animations time
  51723. */
  51724. readonly animationsTimeCounter: PerfCounter;
  51725. /**
  51726. * Gets the animations time capture status
  51727. */
  51728. /**
  51729. * Enable or disable the animations time capture
  51730. */
  51731. captureAnimationsTime: boolean;
  51732. /**
  51733. * Gets the perf counter used for frame time capture
  51734. */
  51735. readonly frameTimeCounter: PerfCounter;
  51736. /**
  51737. * Gets the frame time capture status
  51738. */
  51739. /**
  51740. * Enable or disable the frame time capture
  51741. */
  51742. captureFrameTime: boolean;
  51743. /**
  51744. * Gets the perf counter used for inter-frames time capture
  51745. */
  51746. readonly interFrameTimeCounter: PerfCounter;
  51747. /**
  51748. * Gets the inter-frames time capture status
  51749. */
  51750. /**
  51751. * Enable or disable the inter-frames time capture
  51752. */
  51753. captureInterFrameTime: boolean;
  51754. /**
  51755. * Gets the perf counter used for render time capture
  51756. */
  51757. readonly renderTimeCounter: PerfCounter;
  51758. /**
  51759. * Gets the render time capture status
  51760. */
  51761. /**
  51762. * Enable or disable the render time capture
  51763. */
  51764. captureRenderTime: boolean;
  51765. /**
  51766. * Gets the perf counter used for camera render time capture
  51767. */
  51768. readonly cameraRenderTimeCounter: PerfCounter;
  51769. /**
  51770. * Gets the camera render time capture status
  51771. */
  51772. /**
  51773. * Enable or disable the camera render time capture
  51774. */
  51775. captureCameraRenderTime: boolean;
  51776. /**
  51777. * Gets the perf counter used for draw calls
  51778. */
  51779. readonly drawCallsCounter: PerfCounter;
  51780. /**
  51781. * Instantiates a new scene instrumentation.
  51782. * This class can be used to get instrumentation data from a Babylon engine
  51783. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  51784. * @param scene Defines the scene to instrument
  51785. */
  51786. constructor(
  51787. /**
  51788. * Defines the scene to instrument
  51789. */
  51790. scene: Scene);
  51791. /**
  51792. * Dispose and release associated resources.
  51793. */
  51794. dispose(): void;
  51795. }
  51796. }
  51797. declare module "babylonjs/Instrumentation/index" {
  51798. export * from "babylonjs/Instrumentation/engineInstrumentation";
  51799. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  51800. export * from "babylonjs/Instrumentation/timeToken";
  51801. }
  51802. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  51803. /** @hidden */
  51804. export var glowMapGenerationPixelShader: {
  51805. name: string;
  51806. shader: string;
  51807. };
  51808. }
  51809. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  51810. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  51811. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  51812. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  51813. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  51814. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  51815. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  51816. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  51817. /** @hidden */
  51818. export var glowMapGenerationVertexShader: {
  51819. name: string;
  51820. shader: string;
  51821. };
  51822. }
  51823. declare module "babylonjs/Layers/effectLayer" {
  51824. import { Observable } from "babylonjs/Misc/observable";
  51825. import { Nullable } from "babylonjs/types";
  51826. import { Camera } from "babylonjs/Cameras/camera";
  51827. import { Scene } from "babylonjs/scene";
  51828. import { ISize } from "babylonjs/Maths/math.size";
  51829. import { Color4 } from "babylonjs/Maths/math.color";
  51830. import { Engine } from "babylonjs/Engines/engine";
  51831. import { SubMesh } from "babylonjs/Meshes/subMesh";
  51832. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51833. import { Mesh } from "babylonjs/Meshes/mesh";
  51834. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  51835. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  51836. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  51837. import { Effect } from "babylonjs/Materials/effect";
  51838. import { Material } from "babylonjs/Materials/material";
  51839. import "babylonjs/Shaders/glowMapGeneration.fragment";
  51840. import "babylonjs/Shaders/glowMapGeneration.vertex";
  51841. /**
  51842. * Effect layer options. This helps customizing the behaviour
  51843. * of the effect layer.
  51844. */
  51845. export interface IEffectLayerOptions {
  51846. /**
  51847. * Multiplication factor apply to the canvas size to compute the render target size
  51848. * used to generated the objects (the smaller the faster).
  51849. */
  51850. mainTextureRatio: number;
  51851. /**
  51852. * Enforces a fixed size texture to ensure effect stability across devices.
  51853. */
  51854. mainTextureFixedSize?: number;
  51855. /**
  51856. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  51857. */
  51858. alphaBlendingMode: number;
  51859. /**
  51860. * The camera attached to the layer.
  51861. */
  51862. camera: Nullable<Camera>;
  51863. /**
  51864. * The rendering group to draw the layer in.
  51865. */
  51866. renderingGroupId: number;
  51867. }
  51868. /**
  51869. * The effect layer Helps adding post process effect blended with the main pass.
  51870. *
  51871. * This can be for instance use to generate glow or higlight effects on the scene.
  51872. *
  51873. * The effect layer class can not be used directly and is intented to inherited from to be
  51874. * customized per effects.
  51875. */
  51876. export abstract class EffectLayer {
  51877. private _vertexBuffers;
  51878. private _indexBuffer;
  51879. private _cachedDefines;
  51880. private _effectLayerMapGenerationEffect;
  51881. private _effectLayerOptions;
  51882. private _mergeEffect;
  51883. protected _scene: Scene;
  51884. protected _engine: Engine;
  51885. protected _maxSize: number;
  51886. protected _mainTextureDesiredSize: ISize;
  51887. protected _mainTexture: RenderTargetTexture;
  51888. protected _shouldRender: boolean;
  51889. protected _postProcesses: PostProcess[];
  51890. protected _textures: BaseTexture[];
  51891. protected _emissiveTextureAndColor: {
  51892. texture: Nullable<BaseTexture>;
  51893. color: Color4;
  51894. };
  51895. /**
  51896. * The name of the layer
  51897. */
  51898. name: string;
  51899. /**
  51900. * The clear color of the texture used to generate the glow map.
  51901. */
  51902. neutralColor: Color4;
  51903. /**
  51904. * Specifies wether the highlight layer is enabled or not.
  51905. */
  51906. isEnabled: boolean;
  51907. /**
  51908. * Gets the camera attached to the layer.
  51909. */
  51910. readonly camera: Nullable<Camera>;
  51911. /**
  51912. * Gets the rendering group id the layer should render in.
  51913. */
  51914. renderingGroupId: number;
  51915. /**
  51916. * An event triggered when the effect layer has been disposed.
  51917. */
  51918. onDisposeObservable: Observable<EffectLayer>;
  51919. /**
  51920. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  51921. */
  51922. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  51923. /**
  51924. * An event triggered when the generated texture is being merged in the scene.
  51925. */
  51926. onBeforeComposeObservable: Observable<EffectLayer>;
  51927. /**
  51928. * An event triggered when the mesh is rendered into the effect render target.
  51929. */
  51930. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  51931. /**
  51932. * An event triggered after the mesh has been rendered into the effect render target.
  51933. */
  51934. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  51935. /**
  51936. * An event triggered when the generated texture has been merged in the scene.
  51937. */
  51938. onAfterComposeObservable: Observable<EffectLayer>;
  51939. /**
  51940. * An event triggered when the efffect layer changes its size.
  51941. */
  51942. onSizeChangedObservable: Observable<EffectLayer>;
  51943. /** @hidden */
  51944. static _SceneComponentInitialization: (scene: Scene) => void;
  51945. /**
  51946. * Instantiates a new effect Layer and references it in the scene.
  51947. * @param name The name of the layer
  51948. * @param scene The scene to use the layer in
  51949. */
  51950. constructor(
  51951. /** The Friendly of the effect in the scene */
  51952. name: string, scene: Scene);
  51953. /**
  51954. * Get the effect name of the layer.
  51955. * @return The effect name
  51956. */
  51957. abstract getEffectName(): string;
  51958. /**
  51959. * Checks for the readiness of the element composing the layer.
  51960. * @param subMesh the mesh to check for
  51961. * @param useInstances specify wether or not to use instances to render the mesh
  51962. * @return true if ready otherwise, false
  51963. */
  51964. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  51965. /**
  51966. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  51967. * @returns true if the effect requires stencil during the main canvas render pass.
  51968. */
  51969. abstract needStencil(): boolean;
  51970. /**
  51971. * Create the merge effect. This is the shader use to blit the information back
  51972. * to the main canvas at the end of the scene rendering.
  51973. * @returns The effect containing the shader used to merge the effect on the main canvas
  51974. */
  51975. protected abstract _createMergeEffect(): Effect;
  51976. /**
  51977. * Creates the render target textures and post processes used in the effect layer.
  51978. */
  51979. protected abstract _createTextureAndPostProcesses(): void;
  51980. /**
  51981. * Implementation specific of rendering the generating effect on the main canvas.
  51982. * @param effect The effect used to render through
  51983. */
  51984. protected abstract _internalRender(effect: Effect): void;
  51985. /**
  51986. * Sets the required values for both the emissive texture and and the main color.
  51987. */
  51988. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  51989. /**
  51990. * Free any resources and references associated to a mesh.
  51991. * Internal use
  51992. * @param mesh The mesh to free.
  51993. */
  51994. abstract _disposeMesh(mesh: Mesh): void;
  51995. /**
  51996. * Serializes this layer (Glow or Highlight for example)
  51997. * @returns a serialized layer object
  51998. */
  51999. abstract serialize?(): any;
  52000. /**
  52001. * Initializes the effect layer with the required options.
  52002. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  52003. */
  52004. protected _init(options: Partial<IEffectLayerOptions>): void;
  52005. /**
  52006. * Generates the index buffer of the full screen quad blending to the main canvas.
  52007. */
  52008. private _generateIndexBuffer;
  52009. /**
  52010. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  52011. */
  52012. private _generateVertexBuffer;
  52013. /**
  52014. * Sets the main texture desired size which is the closest power of two
  52015. * of the engine canvas size.
  52016. */
  52017. private _setMainTextureSize;
  52018. /**
  52019. * Creates the main texture for the effect layer.
  52020. */
  52021. protected _createMainTexture(): void;
  52022. /**
  52023. * Adds specific effects defines.
  52024. * @param defines The defines to add specifics to.
  52025. */
  52026. protected _addCustomEffectDefines(defines: string[]): void;
  52027. /**
  52028. * Checks for the readiness of the element composing the layer.
  52029. * @param subMesh the mesh to check for
  52030. * @param useInstances specify wether or not to use instances to render the mesh
  52031. * @param emissiveTexture the associated emissive texture used to generate the glow
  52032. * @return true if ready otherwise, false
  52033. */
  52034. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  52035. /**
  52036. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  52037. */
  52038. render(): void;
  52039. /**
  52040. * Determine if a given mesh will be used in the current effect.
  52041. * @param mesh mesh to test
  52042. * @returns true if the mesh will be used
  52043. */
  52044. hasMesh(mesh: AbstractMesh): boolean;
  52045. /**
  52046. * Returns true if the layer contains information to display, otherwise false.
  52047. * @returns true if the glow layer should be rendered
  52048. */
  52049. shouldRender(): boolean;
  52050. /**
  52051. * Returns true if the mesh should render, otherwise false.
  52052. * @param mesh The mesh to render
  52053. * @returns true if it should render otherwise false
  52054. */
  52055. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  52056. /**
  52057. * Returns true if the mesh can be rendered, otherwise false.
  52058. * @param mesh The mesh to render
  52059. * @param material The material used on the mesh
  52060. * @returns true if it can be rendered otherwise false
  52061. */
  52062. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  52063. /**
  52064. * Returns true if the mesh should render, otherwise false.
  52065. * @param mesh The mesh to render
  52066. * @returns true if it should render otherwise false
  52067. */
  52068. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  52069. /**
  52070. * Renders the submesh passed in parameter to the generation map.
  52071. */
  52072. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  52073. /**
  52074. * Defines wether the current material of the mesh should be use to render the effect.
  52075. * @param mesh defines the current mesh to render
  52076. */
  52077. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  52078. /**
  52079. * Rebuild the required buffers.
  52080. * @hidden Internal use only.
  52081. */
  52082. _rebuild(): void;
  52083. /**
  52084. * Dispose only the render target textures and post process.
  52085. */
  52086. private _disposeTextureAndPostProcesses;
  52087. /**
  52088. * Dispose the highlight layer and free resources.
  52089. */
  52090. dispose(): void;
  52091. /**
  52092. * Gets the class name of the effect layer
  52093. * @returns the string with the class name of the effect layer
  52094. */
  52095. getClassName(): string;
  52096. /**
  52097. * Creates an effect layer from parsed effect layer data
  52098. * @param parsedEffectLayer defines effect layer data
  52099. * @param scene defines the current scene
  52100. * @param rootUrl defines the root URL containing the effect layer information
  52101. * @returns a parsed effect Layer
  52102. */
  52103. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  52104. }
  52105. }
  52106. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  52107. import { Scene } from "babylonjs/scene";
  52108. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  52109. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52110. import { AbstractScene } from "babylonjs/abstractScene";
  52111. module "babylonjs/abstractScene" {
  52112. interface AbstractScene {
  52113. /**
  52114. * The list of effect layers (highlights/glow) added to the scene
  52115. * @see http://doc.babylonjs.com/how_to/highlight_layer
  52116. * @see http://doc.babylonjs.com/how_to/glow_layer
  52117. */
  52118. effectLayers: Array<EffectLayer>;
  52119. /**
  52120. * Removes the given effect layer from this scene.
  52121. * @param toRemove defines the effect layer to remove
  52122. * @returns the index of the removed effect layer
  52123. */
  52124. removeEffectLayer(toRemove: EffectLayer): number;
  52125. /**
  52126. * Adds the given effect layer to this scene
  52127. * @param newEffectLayer defines the effect layer to add
  52128. */
  52129. addEffectLayer(newEffectLayer: EffectLayer): void;
  52130. }
  52131. }
  52132. /**
  52133. * Defines the layer scene component responsible to manage any effect layers
  52134. * in a given scene.
  52135. */
  52136. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  52137. /**
  52138. * The component name helpfull to identify the component in the list of scene components.
  52139. */
  52140. readonly name: string;
  52141. /**
  52142. * The scene the component belongs to.
  52143. */
  52144. scene: Scene;
  52145. private _engine;
  52146. private _renderEffects;
  52147. private _needStencil;
  52148. private _previousStencilState;
  52149. /**
  52150. * Creates a new instance of the component for the given scene
  52151. * @param scene Defines the scene to register the component in
  52152. */
  52153. constructor(scene: Scene);
  52154. /**
  52155. * Registers the component in a given scene
  52156. */
  52157. register(): void;
  52158. /**
  52159. * Rebuilds the elements related to this component in case of
  52160. * context lost for instance.
  52161. */
  52162. rebuild(): void;
  52163. /**
  52164. * Serializes the component data to the specified json object
  52165. * @param serializationObject The object to serialize to
  52166. */
  52167. serialize(serializationObject: any): void;
  52168. /**
  52169. * Adds all the elements from the container to the scene
  52170. * @param container the container holding the elements
  52171. */
  52172. addFromContainer(container: AbstractScene): void;
  52173. /**
  52174. * Removes all the elements in the container from the scene
  52175. * @param container contains the elements to remove
  52176. * @param dispose if the removed element should be disposed (default: false)
  52177. */
  52178. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  52179. /**
  52180. * Disposes the component and the associated ressources.
  52181. */
  52182. dispose(): void;
  52183. private _isReadyForMesh;
  52184. private _renderMainTexture;
  52185. private _setStencil;
  52186. private _setStencilBack;
  52187. private _draw;
  52188. private _drawCamera;
  52189. private _drawRenderingGroup;
  52190. }
  52191. }
  52192. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  52193. /** @hidden */
  52194. export var glowMapMergePixelShader: {
  52195. name: string;
  52196. shader: string;
  52197. };
  52198. }
  52199. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  52200. /** @hidden */
  52201. export var glowMapMergeVertexShader: {
  52202. name: string;
  52203. shader: string;
  52204. };
  52205. }
  52206. declare module "babylonjs/Layers/glowLayer" {
  52207. import { Nullable } from "babylonjs/types";
  52208. import { Camera } from "babylonjs/Cameras/camera";
  52209. import { Scene } from "babylonjs/scene";
  52210. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52211. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52212. import { Mesh } from "babylonjs/Meshes/mesh";
  52213. import { Texture } from "babylonjs/Materials/Textures/texture";
  52214. import { Effect } from "babylonjs/Materials/effect";
  52215. import { Material } from "babylonjs/Materials/material";
  52216. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52217. import { Color4 } from "babylonjs/Maths/math.color";
  52218. import "babylonjs/Shaders/glowMapMerge.fragment";
  52219. import "babylonjs/Shaders/glowMapMerge.vertex";
  52220. import "babylonjs/Layers/effectLayerSceneComponent";
  52221. module "babylonjs/abstractScene" {
  52222. interface AbstractScene {
  52223. /**
  52224. * Return a the first highlight layer of the scene with a given name.
  52225. * @param name The name of the highlight layer to look for.
  52226. * @return The highlight layer if found otherwise null.
  52227. */
  52228. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  52229. }
  52230. }
  52231. /**
  52232. * Glow layer options. This helps customizing the behaviour
  52233. * of the glow layer.
  52234. */
  52235. export interface IGlowLayerOptions {
  52236. /**
  52237. * Multiplication factor apply to the canvas size to compute the render target size
  52238. * used to generated the glowing objects (the smaller the faster).
  52239. */
  52240. mainTextureRatio: number;
  52241. /**
  52242. * Enforces a fixed size texture to ensure resize independant blur.
  52243. */
  52244. mainTextureFixedSize?: number;
  52245. /**
  52246. * How big is the kernel of the blur texture.
  52247. */
  52248. blurKernelSize: number;
  52249. /**
  52250. * The camera attached to the layer.
  52251. */
  52252. camera: Nullable<Camera>;
  52253. /**
  52254. * Enable MSAA by chosing the number of samples.
  52255. */
  52256. mainTextureSamples?: number;
  52257. /**
  52258. * The rendering group to draw the layer in.
  52259. */
  52260. renderingGroupId: number;
  52261. }
  52262. /**
  52263. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  52264. *
  52265. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  52266. *
  52267. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  52268. */
  52269. export class GlowLayer extends EffectLayer {
  52270. /**
  52271. * Effect Name of the layer.
  52272. */
  52273. static readonly EffectName: string;
  52274. /**
  52275. * The default blur kernel size used for the glow.
  52276. */
  52277. static DefaultBlurKernelSize: number;
  52278. /**
  52279. * The default texture size ratio used for the glow.
  52280. */
  52281. static DefaultTextureRatio: number;
  52282. /**
  52283. * Sets the kernel size of the blur.
  52284. */
  52285. /**
  52286. * Gets the kernel size of the blur.
  52287. */
  52288. blurKernelSize: number;
  52289. /**
  52290. * Sets the glow intensity.
  52291. */
  52292. /**
  52293. * Gets the glow intensity.
  52294. */
  52295. intensity: number;
  52296. private _options;
  52297. private _intensity;
  52298. private _horizontalBlurPostprocess1;
  52299. private _verticalBlurPostprocess1;
  52300. private _horizontalBlurPostprocess2;
  52301. private _verticalBlurPostprocess2;
  52302. private _blurTexture1;
  52303. private _blurTexture2;
  52304. private _postProcesses1;
  52305. private _postProcesses2;
  52306. private _includedOnlyMeshes;
  52307. private _excludedMeshes;
  52308. private _meshesUsingTheirOwnMaterials;
  52309. /**
  52310. * Callback used to let the user override the color selection on a per mesh basis
  52311. */
  52312. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  52313. /**
  52314. * Callback used to let the user override the texture selection on a per mesh basis
  52315. */
  52316. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  52317. /**
  52318. * Instantiates a new glow Layer and references it to the scene.
  52319. * @param name The name of the layer
  52320. * @param scene The scene to use the layer in
  52321. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  52322. */
  52323. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  52324. /**
  52325. * Get the effect name of the layer.
  52326. * @return The effect name
  52327. */
  52328. getEffectName(): string;
  52329. /**
  52330. * Create the merge effect. This is the shader use to blit the information back
  52331. * to the main canvas at the end of the scene rendering.
  52332. */
  52333. protected _createMergeEffect(): Effect;
  52334. /**
  52335. * Creates the render target textures and post processes used in the glow layer.
  52336. */
  52337. protected _createTextureAndPostProcesses(): void;
  52338. /**
  52339. * Checks for the readiness of the element composing the layer.
  52340. * @param subMesh the mesh to check for
  52341. * @param useInstances specify wether or not to use instances to render the mesh
  52342. * @param emissiveTexture the associated emissive texture used to generate the glow
  52343. * @return true if ready otherwise, false
  52344. */
  52345. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52346. /**
  52347. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52348. */
  52349. needStencil(): boolean;
  52350. /**
  52351. * Returns true if the mesh can be rendered, otherwise false.
  52352. * @param mesh The mesh to render
  52353. * @param material The material used on the mesh
  52354. * @returns true if it can be rendered otherwise false
  52355. */
  52356. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  52357. /**
  52358. * Implementation specific of rendering the generating effect on the main canvas.
  52359. * @param effect The effect used to render through
  52360. */
  52361. protected _internalRender(effect: Effect): void;
  52362. /**
  52363. * Sets the required values for both the emissive texture and and the main color.
  52364. */
  52365. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  52366. /**
  52367. * Returns true if the mesh should render, otherwise false.
  52368. * @param mesh The mesh to render
  52369. * @returns true if it should render otherwise false
  52370. */
  52371. protected _shouldRenderMesh(mesh: Mesh): boolean;
  52372. /**
  52373. * Adds specific effects defines.
  52374. * @param defines The defines to add specifics to.
  52375. */
  52376. protected _addCustomEffectDefines(defines: string[]): void;
  52377. /**
  52378. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  52379. * @param mesh The mesh to exclude from the glow layer
  52380. */
  52381. addExcludedMesh(mesh: Mesh): void;
  52382. /**
  52383. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  52384. * @param mesh The mesh to remove
  52385. */
  52386. removeExcludedMesh(mesh: Mesh): void;
  52387. /**
  52388. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  52389. * @param mesh The mesh to include in the glow layer
  52390. */
  52391. addIncludedOnlyMesh(mesh: Mesh): void;
  52392. /**
  52393. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  52394. * @param mesh The mesh to remove
  52395. */
  52396. removeIncludedOnlyMesh(mesh: Mesh): void;
  52397. /**
  52398. * Determine if a given mesh will be used in the glow layer
  52399. * @param mesh The mesh to test
  52400. * @returns true if the mesh will be highlighted by the current glow layer
  52401. */
  52402. hasMesh(mesh: AbstractMesh): boolean;
  52403. /**
  52404. * Defines wether the current material of the mesh should be use to render the effect.
  52405. * @param mesh defines the current mesh to render
  52406. */
  52407. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  52408. /**
  52409. * Add a mesh to be rendered through its own material and not with emissive only.
  52410. * @param mesh The mesh for which we need to use its material
  52411. */
  52412. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  52413. /**
  52414. * Remove a mesh from being rendered through its own material and not with emissive only.
  52415. * @param mesh The mesh for which we need to not use its material
  52416. */
  52417. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  52418. /**
  52419. * Free any resources and references associated to a mesh.
  52420. * Internal use
  52421. * @param mesh The mesh to free.
  52422. * @hidden
  52423. */
  52424. _disposeMesh(mesh: Mesh): void;
  52425. /**
  52426. * Gets the class name of the effect layer
  52427. * @returns the string with the class name of the effect layer
  52428. */
  52429. getClassName(): string;
  52430. /**
  52431. * Serializes this glow layer
  52432. * @returns a serialized glow layer object
  52433. */
  52434. serialize(): any;
  52435. /**
  52436. * Creates a Glow Layer from parsed glow layer data
  52437. * @param parsedGlowLayer defines glow layer data
  52438. * @param scene defines the current scene
  52439. * @param rootUrl defines the root URL containing the glow layer information
  52440. * @returns a parsed Glow Layer
  52441. */
  52442. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  52443. }
  52444. }
  52445. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  52446. /** @hidden */
  52447. export var glowBlurPostProcessPixelShader: {
  52448. name: string;
  52449. shader: string;
  52450. };
  52451. }
  52452. declare module "babylonjs/Layers/highlightLayer" {
  52453. import { Observable } from "babylonjs/Misc/observable";
  52454. import { Nullable } from "babylonjs/types";
  52455. import { Camera } from "babylonjs/Cameras/camera";
  52456. import { Scene } from "babylonjs/scene";
  52457. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52458. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52459. import { Mesh } from "babylonjs/Meshes/mesh";
  52460. import { Effect } from "babylonjs/Materials/effect";
  52461. import { Material } from "babylonjs/Materials/material";
  52462. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52463. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  52464. import "babylonjs/Shaders/glowMapMerge.fragment";
  52465. import "babylonjs/Shaders/glowMapMerge.vertex";
  52466. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  52467. module "babylonjs/abstractScene" {
  52468. interface AbstractScene {
  52469. /**
  52470. * Return a the first highlight layer of the scene with a given name.
  52471. * @param name The name of the highlight layer to look for.
  52472. * @return The highlight layer if found otherwise null.
  52473. */
  52474. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  52475. }
  52476. }
  52477. /**
  52478. * Highlight layer options. This helps customizing the behaviour
  52479. * of the highlight layer.
  52480. */
  52481. export interface IHighlightLayerOptions {
  52482. /**
  52483. * Multiplication factor apply to the canvas size to compute the render target size
  52484. * used to generated the glowing objects (the smaller the faster).
  52485. */
  52486. mainTextureRatio: number;
  52487. /**
  52488. * Enforces a fixed size texture to ensure resize independant blur.
  52489. */
  52490. mainTextureFixedSize?: number;
  52491. /**
  52492. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  52493. * of the picture to blur (the smaller the faster).
  52494. */
  52495. blurTextureSizeRatio: number;
  52496. /**
  52497. * How big in texel of the blur texture is the vertical blur.
  52498. */
  52499. blurVerticalSize: number;
  52500. /**
  52501. * How big in texel of the blur texture is the horizontal blur.
  52502. */
  52503. blurHorizontalSize: number;
  52504. /**
  52505. * Alpha blending mode used to apply the blur. Default is combine.
  52506. */
  52507. alphaBlendingMode: number;
  52508. /**
  52509. * The camera attached to the layer.
  52510. */
  52511. camera: Nullable<Camera>;
  52512. /**
  52513. * Should we display highlight as a solid stroke?
  52514. */
  52515. isStroke?: boolean;
  52516. /**
  52517. * The rendering group to draw the layer in.
  52518. */
  52519. renderingGroupId: number;
  52520. }
  52521. /**
  52522. * The highlight layer Helps adding a glow effect around a mesh.
  52523. *
  52524. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  52525. * glowy meshes to your scene.
  52526. *
  52527. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  52528. */
  52529. export class HighlightLayer extends EffectLayer {
  52530. name: string;
  52531. /**
  52532. * Effect Name of the highlight layer.
  52533. */
  52534. static readonly EffectName: string;
  52535. /**
  52536. * The neutral color used during the preparation of the glow effect.
  52537. * This is black by default as the blend operation is a blend operation.
  52538. */
  52539. static NeutralColor: Color4;
  52540. /**
  52541. * Stencil value used for glowing meshes.
  52542. */
  52543. static GlowingMeshStencilReference: number;
  52544. /**
  52545. * Stencil value used for the other meshes in the scene.
  52546. */
  52547. static NormalMeshStencilReference: number;
  52548. /**
  52549. * Specifies whether or not the inner glow is ACTIVE in the layer.
  52550. */
  52551. innerGlow: boolean;
  52552. /**
  52553. * Specifies whether or not the outer glow is ACTIVE in the layer.
  52554. */
  52555. outerGlow: boolean;
  52556. /**
  52557. * Specifies the horizontal size of the blur.
  52558. */
  52559. /**
  52560. * Gets the horizontal size of the blur.
  52561. */
  52562. blurHorizontalSize: number;
  52563. /**
  52564. * Specifies the vertical size of the blur.
  52565. */
  52566. /**
  52567. * Gets the vertical size of the blur.
  52568. */
  52569. blurVerticalSize: number;
  52570. /**
  52571. * An event triggered when the highlight layer is being blurred.
  52572. */
  52573. onBeforeBlurObservable: Observable<HighlightLayer>;
  52574. /**
  52575. * An event triggered when the highlight layer has been blurred.
  52576. */
  52577. onAfterBlurObservable: Observable<HighlightLayer>;
  52578. private _instanceGlowingMeshStencilReference;
  52579. private _options;
  52580. private _downSamplePostprocess;
  52581. private _horizontalBlurPostprocess;
  52582. private _verticalBlurPostprocess;
  52583. private _blurTexture;
  52584. private _meshes;
  52585. private _excludedMeshes;
  52586. /**
  52587. * Instantiates a new highlight Layer and references it to the scene..
  52588. * @param name The name of the layer
  52589. * @param scene The scene to use the layer in
  52590. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  52591. */
  52592. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  52593. /**
  52594. * Get the effect name of the layer.
  52595. * @return The effect name
  52596. */
  52597. getEffectName(): string;
  52598. /**
  52599. * Create the merge effect. This is the shader use to blit the information back
  52600. * to the main canvas at the end of the scene rendering.
  52601. */
  52602. protected _createMergeEffect(): Effect;
  52603. /**
  52604. * Creates the render target textures and post processes used in the highlight layer.
  52605. */
  52606. protected _createTextureAndPostProcesses(): void;
  52607. /**
  52608. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52609. */
  52610. needStencil(): boolean;
  52611. /**
  52612. * Checks for the readiness of the element composing the layer.
  52613. * @param subMesh the mesh to check for
  52614. * @param useInstances specify wether or not to use instances to render the mesh
  52615. * @param emissiveTexture the associated emissive texture used to generate the glow
  52616. * @return true if ready otherwise, false
  52617. */
  52618. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52619. /**
  52620. * Implementation specific of rendering the generating effect on the main canvas.
  52621. * @param effect The effect used to render through
  52622. */
  52623. protected _internalRender(effect: Effect): void;
  52624. /**
  52625. * Returns true if the layer contains information to display, otherwise false.
  52626. */
  52627. shouldRender(): boolean;
  52628. /**
  52629. * Returns true if the mesh should render, otherwise false.
  52630. * @param mesh The mesh to render
  52631. * @returns true if it should render otherwise false
  52632. */
  52633. protected _shouldRenderMesh(mesh: Mesh): boolean;
  52634. /**
  52635. * Sets the required values for both the emissive texture and and the main color.
  52636. */
  52637. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  52638. /**
  52639. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  52640. * @param mesh The mesh to exclude from the highlight layer
  52641. */
  52642. addExcludedMesh(mesh: Mesh): void;
  52643. /**
  52644. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  52645. * @param mesh The mesh to highlight
  52646. */
  52647. removeExcludedMesh(mesh: Mesh): void;
  52648. /**
  52649. * Determine if a given mesh will be highlighted by the current HighlightLayer
  52650. * @param mesh mesh to test
  52651. * @returns true if the mesh will be highlighted by the current HighlightLayer
  52652. */
  52653. hasMesh(mesh: AbstractMesh): boolean;
  52654. /**
  52655. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  52656. * @param mesh The mesh to highlight
  52657. * @param color The color of the highlight
  52658. * @param glowEmissiveOnly Extract the glow from the emissive texture
  52659. */
  52660. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  52661. /**
  52662. * Remove a mesh from the highlight layer in order to make it stop glowing.
  52663. * @param mesh The mesh to highlight
  52664. */
  52665. removeMesh(mesh: Mesh): void;
  52666. /**
  52667. * Force the stencil to the normal expected value for none glowing parts
  52668. */
  52669. private _defaultStencilReference;
  52670. /**
  52671. * Free any resources and references associated to a mesh.
  52672. * Internal use
  52673. * @param mesh The mesh to free.
  52674. * @hidden
  52675. */
  52676. _disposeMesh(mesh: Mesh): void;
  52677. /**
  52678. * Dispose the highlight layer and free resources.
  52679. */
  52680. dispose(): void;
  52681. /**
  52682. * Gets the class name of the effect layer
  52683. * @returns the string with the class name of the effect layer
  52684. */
  52685. getClassName(): string;
  52686. /**
  52687. * Serializes this Highlight layer
  52688. * @returns a serialized Highlight layer object
  52689. */
  52690. serialize(): any;
  52691. /**
  52692. * Creates a Highlight layer from parsed Highlight layer data
  52693. * @param parsedHightlightLayer defines the Highlight layer data
  52694. * @param scene defines the current scene
  52695. * @param rootUrl defines the root URL containing the Highlight layer information
  52696. * @returns a parsed Highlight layer
  52697. */
  52698. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  52699. }
  52700. }
  52701. declare module "babylonjs/Layers/layerSceneComponent" {
  52702. import { Scene } from "babylonjs/scene";
  52703. import { ISceneComponent } from "babylonjs/sceneComponent";
  52704. import { Layer } from "babylonjs/Layers/layer";
  52705. import { AbstractScene } from "babylonjs/abstractScene";
  52706. module "babylonjs/abstractScene" {
  52707. interface AbstractScene {
  52708. /**
  52709. * The list of layers (background and foreground) of the scene
  52710. */
  52711. layers: Array<Layer>;
  52712. }
  52713. }
  52714. /**
  52715. * Defines the layer scene component responsible to manage any layers
  52716. * in a given scene.
  52717. */
  52718. export class LayerSceneComponent implements ISceneComponent {
  52719. /**
  52720. * The component name helpfull to identify the component in the list of scene components.
  52721. */
  52722. readonly name: string;
  52723. /**
  52724. * The scene the component belongs to.
  52725. */
  52726. scene: Scene;
  52727. private _engine;
  52728. /**
  52729. * Creates a new instance of the component for the given scene
  52730. * @param scene Defines the scene to register the component in
  52731. */
  52732. constructor(scene: Scene);
  52733. /**
  52734. * Registers the component in a given scene
  52735. */
  52736. register(): void;
  52737. /**
  52738. * Rebuilds the elements related to this component in case of
  52739. * context lost for instance.
  52740. */
  52741. rebuild(): void;
  52742. /**
  52743. * Disposes the component and the associated ressources.
  52744. */
  52745. dispose(): void;
  52746. private _draw;
  52747. private _drawCameraPredicate;
  52748. private _drawCameraBackground;
  52749. private _drawCameraForeground;
  52750. private _drawRenderTargetPredicate;
  52751. private _drawRenderTargetBackground;
  52752. private _drawRenderTargetForeground;
  52753. /**
  52754. * Adds all the elements from the container to the scene
  52755. * @param container the container holding the elements
  52756. */
  52757. addFromContainer(container: AbstractScene): void;
  52758. /**
  52759. * Removes all the elements in the container from the scene
  52760. * @param container contains the elements to remove
  52761. * @param dispose if the removed element should be disposed (default: false)
  52762. */
  52763. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  52764. }
  52765. }
  52766. declare module "babylonjs/Shaders/layer.fragment" {
  52767. /** @hidden */
  52768. export var layerPixelShader: {
  52769. name: string;
  52770. shader: string;
  52771. };
  52772. }
  52773. declare module "babylonjs/Shaders/layer.vertex" {
  52774. /** @hidden */
  52775. export var layerVertexShader: {
  52776. name: string;
  52777. shader: string;
  52778. };
  52779. }
  52780. declare module "babylonjs/Layers/layer" {
  52781. import { Observable } from "babylonjs/Misc/observable";
  52782. import { Nullable } from "babylonjs/types";
  52783. import { Scene } from "babylonjs/scene";
  52784. import { Vector2 } from "babylonjs/Maths/math.vector";
  52785. import { Color4 } from "babylonjs/Maths/math.color";
  52786. import { Texture } from "babylonjs/Materials/Textures/texture";
  52787. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  52788. import "babylonjs/Shaders/layer.fragment";
  52789. import "babylonjs/Shaders/layer.vertex";
  52790. /**
  52791. * This represents a full screen 2d layer.
  52792. * This can be useful to display a picture in the background of your scene for instance.
  52793. * @see https://www.babylonjs-playground.com/#08A2BS#1
  52794. */
  52795. export class Layer {
  52796. /**
  52797. * Define the name of the layer.
  52798. */
  52799. name: string;
  52800. /**
  52801. * Define the texture the layer should display.
  52802. */
  52803. texture: Nullable<Texture>;
  52804. /**
  52805. * Is the layer in background or foreground.
  52806. */
  52807. isBackground: boolean;
  52808. /**
  52809. * Define the color of the layer (instead of texture).
  52810. */
  52811. color: Color4;
  52812. /**
  52813. * Define the scale of the layer in order to zoom in out of the texture.
  52814. */
  52815. scale: Vector2;
  52816. /**
  52817. * Define an offset for the layer in order to shift the texture.
  52818. */
  52819. offset: Vector2;
  52820. /**
  52821. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  52822. */
  52823. alphaBlendingMode: number;
  52824. /**
  52825. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  52826. * Alpha test will not mix with the background color in case of transparency.
  52827. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  52828. */
  52829. alphaTest: boolean;
  52830. /**
  52831. * Define a mask to restrict the layer to only some of the scene cameras.
  52832. */
  52833. layerMask: number;
  52834. /**
  52835. * Define the list of render target the layer is visible into.
  52836. */
  52837. renderTargetTextures: RenderTargetTexture[];
  52838. /**
  52839. * Define if the layer is only used in renderTarget or if it also
  52840. * renders in the main frame buffer of the canvas.
  52841. */
  52842. renderOnlyInRenderTargetTextures: boolean;
  52843. private _scene;
  52844. private _vertexBuffers;
  52845. private _indexBuffer;
  52846. private _effect;
  52847. private _alphaTestEffect;
  52848. /**
  52849. * An event triggered when the layer is disposed.
  52850. */
  52851. onDisposeObservable: Observable<Layer>;
  52852. private _onDisposeObserver;
  52853. /**
  52854. * Back compatibility with callback before the onDisposeObservable existed.
  52855. * The set callback will be triggered when the layer has been disposed.
  52856. */
  52857. onDispose: () => void;
  52858. /**
  52859. * An event triggered before rendering the scene
  52860. */
  52861. onBeforeRenderObservable: Observable<Layer>;
  52862. private _onBeforeRenderObserver;
  52863. /**
  52864. * Back compatibility with callback before the onBeforeRenderObservable existed.
  52865. * The set callback will be triggered just before rendering the layer.
  52866. */
  52867. onBeforeRender: () => void;
  52868. /**
  52869. * An event triggered after rendering the scene
  52870. */
  52871. onAfterRenderObservable: Observable<Layer>;
  52872. private _onAfterRenderObserver;
  52873. /**
  52874. * Back compatibility with callback before the onAfterRenderObservable existed.
  52875. * The set callback will be triggered just after rendering the layer.
  52876. */
  52877. onAfterRender: () => void;
  52878. /**
  52879. * Instantiates a new layer.
  52880. * This represents a full screen 2d layer.
  52881. * This can be useful to display a picture in the background of your scene for instance.
  52882. * @see https://www.babylonjs-playground.com/#08A2BS#1
  52883. * @param name Define the name of the layer in the scene
  52884. * @param imgUrl Define the url of the texture to display in the layer
  52885. * @param scene Define the scene the layer belongs to
  52886. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  52887. * @param color Defines a color for the layer
  52888. */
  52889. constructor(
  52890. /**
  52891. * Define the name of the layer.
  52892. */
  52893. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  52894. private _createIndexBuffer;
  52895. /** @hidden */
  52896. _rebuild(): void;
  52897. /**
  52898. * Renders the layer in the scene.
  52899. */
  52900. render(): void;
  52901. /**
  52902. * Disposes and releases the associated ressources.
  52903. */
  52904. dispose(): void;
  52905. }
  52906. }
  52907. declare module "babylonjs/Layers/index" {
  52908. export * from "babylonjs/Layers/effectLayer";
  52909. export * from "babylonjs/Layers/effectLayerSceneComponent";
  52910. export * from "babylonjs/Layers/glowLayer";
  52911. export * from "babylonjs/Layers/highlightLayer";
  52912. export * from "babylonjs/Layers/layer";
  52913. export * from "babylonjs/Layers/layerSceneComponent";
  52914. }
  52915. declare module "babylonjs/Shaders/lensFlare.fragment" {
  52916. /** @hidden */
  52917. export var lensFlarePixelShader: {
  52918. name: string;
  52919. shader: string;
  52920. };
  52921. }
  52922. declare module "babylonjs/Shaders/lensFlare.vertex" {
  52923. /** @hidden */
  52924. export var lensFlareVertexShader: {
  52925. name: string;
  52926. shader: string;
  52927. };
  52928. }
  52929. declare module "babylonjs/LensFlares/lensFlareSystem" {
  52930. import { Scene } from "babylonjs/scene";
  52931. import { Vector3 } from "babylonjs/Maths/math.vector";
  52932. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52933. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  52934. import "babylonjs/Shaders/lensFlare.fragment";
  52935. import "babylonjs/Shaders/lensFlare.vertex";
  52936. import { Viewport } from "babylonjs/Maths/math.viewport";
  52937. /**
  52938. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  52939. * It is usually composed of several `lensFlare`.
  52940. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  52941. */
  52942. export class LensFlareSystem {
  52943. /**
  52944. * Define the name of the lens flare system
  52945. */
  52946. name: string;
  52947. /**
  52948. * List of lens flares used in this system.
  52949. */
  52950. lensFlares: LensFlare[];
  52951. /**
  52952. * Define a limit from the border the lens flare can be visible.
  52953. */
  52954. borderLimit: number;
  52955. /**
  52956. * Define a viewport border we do not want to see the lens flare in.
  52957. */
  52958. viewportBorder: number;
  52959. /**
  52960. * Define a predicate which could limit the list of meshes able to occlude the effect.
  52961. */
  52962. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  52963. /**
  52964. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  52965. */
  52966. layerMask: number;
  52967. /**
  52968. * Define the id of the lens flare system in the scene.
  52969. * (equal to name by default)
  52970. */
  52971. id: string;
  52972. private _scene;
  52973. private _emitter;
  52974. private _vertexBuffers;
  52975. private _indexBuffer;
  52976. private _effect;
  52977. private _positionX;
  52978. private _positionY;
  52979. private _isEnabled;
  52980. /** @hidden */
  52981. static _SceneComponentInitialization: (scene: Scene) => void;
  52982. /**
  52983. * Instantiates a lens flare system.
  52984. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  52985. * It is usually composed of several `lensFlare`.
  52986. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  52987. * @param name Define the name of the lens flare system in the scene
  52988. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  52989. * @param scene Define the scene the lens flare system belongs to
  52990. */
  52991. constructor(
  52992. /**
  52993. * Define the name of the lens flare system
  52994. */
  52995. name: string, emitter: any, scene: Scene);
  52996. /**
  52997. * Define if the lens flare system is enabled.
  52998. */
  52999. isEnabled: boolean;
  53000. /**
  53001. * Get the scene the effects belongs to.
  53002. * @returns the scene holding the lens flare system
  53003. */
  53004. getScene(): Scene;
  53005. /**
  53006. * Get the emitter of the lens flare system.
  53007. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  53008. * @returns the emitter of the lens flare system
  53009. */
  53010. getEmitter(): any;
  53011. /**
  53012. * Set the emitter of the lens flare system.
  53013. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  53014. * @param newEmitter Define the new emitter of the system
  53015. */
  53016. setEmitter(newEmitter: any): void;
  53017. /**
  53018. * Get the lens flare system emitter position.
  53019. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  53020. * @returns the position
  53021. */
  53022. getEmitterPosition(): Vector3;
  53023. /**
  53024. * @hidden
  53025. */
  53026. computeEffectivePosition(globalViewport: Viewport): boolean;
  53027. /** @hidden */
  53028. _isVisible(): boolean;
  53029. /**
  53030. * @hidden
  53031. */
  53032. render(): boolean;
  53033. /**
  53034. * Dispose and release the lens flare with its associated resources.
  53035. */
  53036. dispose(): void;
  53037. /**
  53038. * Parse a lens flare system from a JSON repressentation
  53039. * @param parsedLensFlareSystem Define the JSON to parse
  53040. * @param scene Define the scene the parsed system should be instantiated in
  53041. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  53042. * @returns the parsed system
  53043. */
  53044. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  53045. /**
  53046. * Serialize the current Lens Flare System into a JSON representation.
  53047. * @returns the serialized JSON
  53048. */
  53049. serialize(): any;
  53050. }
  53051. }
  53052. declare module "babylonjs/LensFlares/lensFlare" {
  53053. import { Nullable } from "babylonjs/types";
  53054. import { Color3 } from "babylonjs/Maths/math.color";
  53055. import { Texture } from "babylonjs/Materials/Textures/texture";
  53056. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  53057. /**
  53058. * This represents one of the lens effect in a `lensFlareSystem`.
  53059. * It controls one of the indiviual texture used in the effect.
  53060. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53061. */
  53062. export class LensFlare {
  53063. /**
  53064. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  53065. */
  53066. size: number;
  53067. /**
  53068. * 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.
  53069. */
  53070. position: number;
  53071. /**
  53072. * Define the lens color.
  53073. */
  53074. color: Color3;
  53075. /**
  53076. * Define the lens texture.
  53077. */
  53078. texture: Nullable<Texture>;
  53079. /**
  53080. * Define the alpha mode to render this particular lens.
  53081. */
  53082. alphaMode: number;
  53083. private _system;
  53084. /**
  53085. * Creates a new Lens Flare.
  53086. * This represents one of the lens effect in a `lensFlareSystem`.
  53087. * It controls one of the indiviual texture used in the effect.
  53088. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53089. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  53090. * @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.
  53091. * @param color Define the lens color
  53092. * @param imgUrl Define the lens texture url
  53093. * @param system Define the `lensFlareSystem` this flare is part of
  53094. * @returns The newly created Lens Flare
  53095. */
  53096. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  53097. /**
  53098. * Instantiates a new Lens Flare.
  53099. * This represents one of the lens effect in a `lensFlareSystem`.
  53100. * It controls one of the indiviual texture used in the effect.
  53101. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53102. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  53103. * @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.
  53104. * @param color Define the lens color
  53105. * @param imgUrl Define the lens texture url
  53106. * @param system Define the `lensFlareSystem` this flare is part of
  53107. */
  53108. constructor(
  53109. /**
  53110. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  53111. */
  53112. size: number,
  53113. /**
  53114. * 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.
  53115. */
  53116. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  53117. /**
  53118. * Dispose and release the lens flare with its associated resources.
  53119. */
  53120. dispose(): void;
  53121. }
  53122. }
  53123. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  53124. import { Nullable } from "babylonjs/types";
  53125. import { Scene } from "babylonjs/scene";
  53126. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  53127. import { AbstractScene } from "babylonjs/abstractScene";
  53128. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  53129. module "babylonjs/abstractScene" {
  53130. interface AbstractScene {
  53131. /**
  53132. * The list of lens flare system added to the scene
  53133. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53134. */
  53135. lensFlareSystems: Array<LensFlareSystem>;
  53136. /**
  53137. * Removes the given lens flare system from this scene.
  53138. * @param toRemove The lens flare system to remove
  53139. * @returns The index of the removed lens flare system
  53140. */
  53141. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  53142. /**
  53143. * Adds the given lens flare system to this scene
  53144. * @param newLensFlareSystem The lens flare system to add
  53145. */
  53146. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  53147. /**
  53148. * Gets a lens flare system using its name
  53149. * @param name defines the name to look for
  53150. * @returns the lens flare system or null if not found
  53151. */
  53152. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  53153. /**
  53154. * Gets a lens flare system using its id
  53155. * @param id defines the id to look for
  53156. * @returns the lens flare system or null if not found
  53157. */
  53158. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  53159. }
  53160. }
  53161. /**
  53162. * Defines the lens flare scene component responsible to manage any lens flares
  53163. * in a given scene.
  53164. */
  53165. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  53166. /**
  53167. * The component name helpfull to identify the component in the list of scene components.
  53168. */
  53169. readonly name: string;
  53170. /**
  53171. * The scene the component belongs to.
  53172. */
  53173. scene: Scene;
  53174. /**
  53175. * Creates a new instance of the component for the given scene
  53176. * @param scene Defines the scene to register the component in
  53177. */
  53178. constructor(scene: Scene);
  53179. /**
  53180. * Registers the component in a given scene
  53181. */
  53182. register(): void;
  53183. /**
  53184. * Rebuilds the elements related to this component in case of
  53185. * context lost for instance.
  53186. */
  53187. rebuild(): void;
  53188. /**
  53189. * Adds all the elements from the container to the scene
  53190. * @param container the container holding the elements
  53191. */
  53192. addFromContainer(container: AbstractScene): void;
  53193. /**
  53194. * Removes all the elements in the container from the scene
  53195. * @param container contains the elements to remove
  53196. * @param dispose if the removed element should be disposed (default: false)
  53197. */
  53198. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53199. /**
  53200. * Serializes the component data to the specified json object
  53201. * @param serializationObject The object to serialize to
  53202. */
  53203. serialize(serializationObject: any): void;
  53204. /**
  53205. * Disposes the component and the associated ressources.
  53206. */
  53207. dispose(): void;
  53208. private _draw;
  53209. }
  53210. }
  53211. declare module "babylonjs/LensFlares/index" {
  53212. export * from "babylonjs/LensFlares/lensFlare";
  53213. export * from "babylonjs/LensFlares/lensFlareSystem";
  53214. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  53215. }
  53216. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  53217. import { Scene } from "babylonjs/scene";
  53218. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  53219. import { AbstractScene } from "babylonjs/abstractScene";
  53220. /**
  53221. * Defines the shadow generator component responsible to manage any shadow generators
  53222. * in a given scene.
  53223. */
  53224. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  53225. /**
  53226. * The component name helpfull to identify the component in the list of scene components.
  53227. */
  53228. readonly name: string;
  53229. /**
  53230. * The scene the component belongs to.
  53231. */
  53232. scene: Scene;
  53233. /**
  53234. * Creates a new instance of the component for the given scene
  53235. * @param scene Defines the scene to register the component in
  53236. */
  53237. constructor(scene: Scene);
  53238. /**
  53239. * Registers the component in a given scene
  53240. */
  53241. register(): void;
  53242. /**
  53243. * Rebuilds the elements related to this component in case of
  53244. * context lost for instance.
  53245. */
  53246. rebuild(): void;
  53247. /**
  53248. * Serializes the component data to the specified json object
  53249. * @param serializationObject The object to serialize to
  53250. */
  53251. serialize(serializationObject: any): void;
  53252. /**
  53253. * Adds all the elements from the container to the scene
  53254. * @param container the container holding the elements
  53255. */
  53256. addFromContainer(container: AbstractScene): void;
  53257. /**
  53258. * Removes all the elements in the container from the scene
  53259. * @param container contains the elements to remove
  53260. * @param dispose if the removed element should be disposed (default: false)
  53261. */
  53262. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53263. /**
  53264. * Rebuilds the elements related to this component in case of
  53265. * context lost for instance.
  53266. */
  53267. dispose(): void;
  53268. private _gatherRenderTargets;
  53269. }
  53270. }
  53271. declare module "babylonjs/Lights/Shadows/index" {
  53272. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  53273. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  53274. }
  53275. declare module "babylonjs/Lights/pointLight" {
  53276. import { Scene } from "babylonjs/scene";
  53277. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  53278. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53279. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  53280. import { Effect } from "babylonjs/Materials/effect";
  53281. /**
  53282. * A point light is a light defined by an unique point in world space.
  53283. * The light is emitted in every direction from this point.
  53284. * A good example of a point light is a standard light bulb.
  53285. * Documentation: https://doc.babylonjs.com/babylon101/lights
  53286. */
  53287. export class PointLight extends ShadowLight {
  53288. private _shadowAngle;
  53289. /**
  53290. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53291. * This specifies what angle the shadow will use to be created.
  53292. *
  53293. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  53294. */
  53295. /**
  53296. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53297. * This specifies what angle the shadow will use to be created.
  53298. *
  53299. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  53300. */
  53301. shadowAngle: number;
  53302. /**
  53303. * Gets the direction if it has been set.
  53304. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53305. */
  53306. /**
  53307. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53308. */
  53309. direction: Vector3;
  53310. /**
  53311. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  53312. * A PointLight emits the light in every direction.
  53313. * It can cast shadows.
  53314. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  53315. * ```javascript
  53316. * var pointLight = new PointLight("pl", camera.position, scene);
  53317. * ```
  53318. * Documentation : https://doc.babylonjs.com/babylon101/lights
  53319. * @param name The light friendly name
  53320. * @param position The position of the point light in the scene
  53321. * @param scene The scene the lights belongs to
  53322. */
  53323. constructor(name: string, position: Vector3, scene: Scene);
  53324. /**
  53325. * Returns the string "PointLight"
  53326. * @returns the class name
  53327. */
  53328. getClassName(): string;
  53329. /**
  53330. * Returns the integer 0.
  53331. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  53332. */
  53333. getTypeID(): number;
  53334. /**
  53335. * Specifies wether or not the shadowmap should be a cube texture.
  53336. * @returns true if the shadowmap needs to be a cube texture.
  53337. */
  53338. needCube(): boolean;
  53339. /**
  53340. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  53341. * @param faceIndex The index of the face we are computed the direction to generate shadow
  53342. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  53343. */
  53344. getShadowDirection(faceIndex?: number): Vector3;
  53345. /**
  53346. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  53347. * - fov = PI / 2
  53348. * - aspect ratio : 1.0
  53349. * - z-near and far equal to the active camera minZ and maxZ.
  53350. * Returns the PointLight.
  53351. */
  53352. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  53353. protected _buildUniformLayout(): void;
  53354. /**
  53355. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  53356. * @param effect The effect to update
  53357. * @param lightIndex The index of the light in the effect to update
  53358. * @returns The point light
  53359. */
  53360. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  53361. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  53362. /**
  53363. * Prepares the list of defines specific to the light type.
  53364. * @param defines the list of defines
  53365. * @param lightIndex defines the index of the light for the effect
  53366. */
  53367. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  53368. }
  53369. }
  53370. declare module "babylonjs/Lights/index" {
  53371. export * from "babylonjs/Lights/light";
  53372. export * from "babylonjs/Lights/shadowLight";
  53373. export * from "babylonjs/Lights/Shadows/index";
  53374. export * from "babylonjs/Lights/directionalLight";
  53375. export * from "babylonjs/Lights/hemisphericLight";
  53376. export * from "babylonjs/Lights/pointLight";
  53377. export * from "babylonjs/Lights/spotLight";
  53378. }
  53379. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  53380. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  53381. /**
  53382. * Header information of HDR texture files.
  53383. */
  53384. export interface HDRInfo {
  53385. /**
  53386. * The height of the texture in pixels.
  53387. */
  53388. height: number;
  53389. /**
  53390. * The width of the texture in pixels.
  53391. */
  53392. width: number;
  53393. /**
  53394. * The index of the beginning of the data in the binary file.
  53395. */
  53396. dataPosition: number;
  53397. }
  53398. /**
  53399. * This groups tools to convert HDR texture to native colors array.
  53400. */
  53401. export class HDRTools {
  53402. private static Ldexp;
  53403. private static Rgbe2float;
  53404. private static readStringLine;
  53405. /**
  53406. * Reads header information from an RGBE texture stored in a native array.
  53407. * More information on this format are available here:
  53408. * https://en.wikipedia.org/wiki/RGBE_image_format
  53409. *
  53410. * @param uint8array The binary file stored in native array.
  53411. * @return The header information.
  53412. */
  53413. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  53414. /**
  53415. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  53416. * This RGBE texture needs to store the information as a panorama.
  53417. *
  53418. * More information on this format are available here:
  53419. * https://en.wikipedia.org/wiki/RGBE_image_format
  53420. *
  53421. * @param buffer The binary file stored in an array buffer.
  53422. * @param size The expected size of the extracted cubemap.
  53423. * @return The Cube Map information.
  53424. */
  53425. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  53426. /**
  53427. * Returns the pixels data extracted from an RGBE texture.
  53428. * This pixels will be stored left to right up to down in the R G B order in one array.
  53429. *
  53430. * More information on this format are available here:
  53431. * https://en.wikipedia.org/wiki/RGBE_image_format
  53432. *
  53433. * @param uint8array The binary file stored in an array buffer.
  53434. * @param hdrInfo The header information of the file.
  53435. * @return The pixels data in RGB right to left up to down order.
  53436. */
  53437. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  53438. private static RGBE_ReadPixels_RLE;
  53439. }
  53440. }
  53441. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  53442. import { Nullable } from "babylonjs/types";
  53443. import { Scene } from "babylonjs/scene";
  53444. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  53445. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53446. import "babylonjs/Engines/Extensions/engine.rawTexture";
  53447. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  53448. /**
  53449. * This represents a texture coming from an HDR input.
  53450. *
  53451. * The only supported format is currently panorama picture stored in RGBE format.
  53452. * Example of such files can be found on HDRLib: http://hdrlib.com/
  53453. */
  53454. export class HDRCubeTexture extends BaseTexture {
  53455. private static _facesMapping;
  53456. private _generateHarmonics;
  53457. private _noMipmap;
  53458. private _textureMatrix;
  53459. private _size;
  53460. private _onLoad;
  53461. private _onError;
  53462. /**
  53463. * The texture URL.
  53464. */
  53465. url: string;
  53466. /**
  53467. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  53468. */
  53469. coordinatesMode: number;
  53470. protected _isBlocking: boolean;
  53471. /**
  53472. * Sets wether or not the texture is blocking during loading.
  53473. */
  53474. /**
  53475. * Gets wether or not the texture is blocking during loading.
  53476. */
  53477. isBlocking: boolean;
  53478. protected _rotationY: number;
  53479. /**
  53480. * Sets texture matrix rotation angle around Y axis in radians.
  53481. */
  53482. /**
  53483. * Gets texture matrix rotation angle around Y axis radians.
  53484. */
  53485. rotationY: number;
  53486. /**
  53487. * Gets or sets the center of the bounding box associated with the cube texture
  53488. * It must define where the camera used to render the texture was set
  53489. */
  53490. boundingBoxPosition: Vector3;
  53491. private _boundingBoxSize;
  53492. /**
  53493. * Gets or sets the size of the bounding box associated with the cube texture
  53494. * When defined, the cubemap will switch to local mode
  53495. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  53496. * @example https://www.babylonjs-playground.com/#RNASML
  53497. */
  53498. boundingBoxSize: Vector3;
  53499. /**
  53500. * Instantiates an HDRTexture from the following parameters.
  53501. *
  53502. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  53503. * @param scene The scene the texture will be used in
  53504. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  53505. * @param noMipmap Forces to not generate the mipmap if true
  53506. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  53507. * @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)
  53508. * @param reserved Reserved flag for internal use.
  53509. */
  53510. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  53511. /**
  53512. * Get the current class name of the texture useful for serialization or dynamic coding.
  53513. * @returns "HDRCubeTexture"
  53514. */
  53515. getClassName(): string;
  53516. /**
  53517. * Occurs when the file is raw .hdr file.
  53518. */
  53519. private loadTexture;
  53520. clone(): HDRCubeTexture;
  53521. delayLoad(): void;
  53522. /**
  53523. * Get the texture reflection matrix used to rotate/transform the reflection.
  53524. * @returns the reflection matrix
  53525. */
  53526. getReflectionTextureMatrix(): Matrix;
  53527. /**
  53528. * Set the texture reflection matrix used to rotate/transform the reflection.
  53529. * @param value Define the reflection matrix to set
  53530. */
  53531. setReflectionTextureMatrix(value: Matrix): void;
  53532. /**
  53533. * Parses a JSON representation of an HDR Texture in order to create the texture
  53534. * @param parsedTexture Define the JSON representation
  53535. * @param scene Define the scene the texture should be created in
  53536. * @param rootUrl Define the root url in case we need to load relative dependencies
  53537. * @returns the newly created texture after parsing
  53538. */
  53539. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  53540. serialize(): any;
  53541. }
  53542. }
  53543. declare module "babylonjs/Physics/physicsEngine" {
  53544. import { Nullable } from "babylonjs/types";
  53545. import { Vector3 } from "babylonjs/Maths/math.vector";
  53546. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  53547. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  53548. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  53549. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53550. /**
  53551. * Class used to control physics engine
  53552. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  53553. */
  53554. export class PhysicsEngine implements IPhysicsEngine {
  53555. private _physicsPlugin;
  53556. /**
  53557. * Global value used to control the smallest number supported by the simulation
  53558. */
  53559. static Epsilon: number;
  53560. private _impostors;
  53561. private _joints;
  53562. /**
  53563. * Gets the gravity vector used by the simulation
  53564. */
  53565. gravity: Vector3;
  53566. /**
  53567. * Factory used to create the default physics plugin.
  53568. * @returns The default physics plugin
  53569. */
  53570. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  53571. /**
  53572. * Creates a new Physics Engine
  53573. * @param gravity defines the gravity vector used by the simulation
  53574. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  53575. */
  53576. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  53577. /**
  53578. * Sets the gravity vector used by the simulation
  53579. * @param gravity defines the gravity vector to use
  53580. */
  53581. setGravity(gravity: Vector3): void;
  53582. /**
  53583. * Set the time step of the physics engine.
  53584. * Default is 1/60.
  53585. * To slow it down, enter 1/600 for example.
  53586. * To speed it up, 1/30
  53587. * @param newTimeStep defines the new timestep to apply to this world.
  53588. */
  53589. setTimeStep(newTimeStep?: number): void;
  53590. /**
  53591. * Get the time step of the physics engine.
  53592. * @returns the current time step
  53593. */
  53594. getTimeStep(): number;
  53595. /**
  53596. * Release all resources
  53597. */
  53598. dispose(): void;
  53599. /**
  53600. * Gets the name of the current physics plugin
  53601. * @returns the name of the plugin
  53602. */
  53603. getPhysicsPluginName(): string;
  53604. /**
  53605. * Adding a new impostor for the impostor tracking.
  53606. * This will be done by the impostor itself.
  53607. * @param impostor the impostor to add
  53608. */
  53609. addImpostor(impostor: PhysicsImpostor): void;
  53610. /**
  53611. * Remove an impostor from the engine.
  53612. * This impostor and its mesh will not longer be updated by the physics engine.
  53613. * @param impostor the impostor to remove
  53614. */
  53615. removeImpostor(impostor: PhysicsImpostor): void;
  53616. /**
  53617. * Add a joint to the physics engine
  53618. * @param mainImpostor defines the main impostor to which the joint is added.
  53619. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  53620. * @param joint defines the joint that will connect both impostors.
  53621. */
  53622. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  53623. /**
  53624. * Removes a joint from the simulation
  53625. * @param mainImpostor defines the impostor used with the joint
  53626. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  53627. * @param joint defines the joint to remove
  53628. */
  53629. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  53630. /**
  53631. * Called by the scene. No need to call it.
  53632. * @param delta defines the timespam between frames
  53633. */
  53634. _step(delta: number): void;
  53635. /**
  53636. * Gets the current plugin used to run the simulation
  53637. * @returns current plugin
  53638. */
  53639. getPhysicsPlugin(): IPhysicsEnginePlugin;
  53640. /**
  53641. * Gets the list of physic impostors
  53642. * @returns an array of PhysicsImpostor
  53643. */
  53644. getImpostors(): Array<PhysicsImpostor>;
  53645. /**
  53646. * Gets the impostor for a physics enabled object
  53647. * @param object defines the object impersonated by the impostor
  53648. * @returns the PhysicsImpostor or null if not found
  53649. */
  53650. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  53651. /**
  53652. * Gets the impostor for a physics body object
  53653. * @param body defines physics body used by the impostor
  53654. * @returns the PhysicsImpostor or null if not found
  53655. */
  53656. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  53657. /**
  53658. * Does a raycast in the physics world
  53659. * @param from when should the ray start?
  53660. * @param to when should the ray end?
  53661. * @returns PhysicsRaycastResult
  53662. */
  53663. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  53664. }
  53665. }
  53666. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  53667. import { Nullable } from "babylonjs/types";
  53668. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  53669. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53670. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  53671. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  53672. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  53673. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53674. /** @hidden */
  53675. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  53676. private _useDeltaForWorldStep;
  53677. world: any;
  53678. name: string;
  53679. private _physicsMaterials;
  53680. private _fixedTimeStep;
  53681. private _cannonRaycastResult;
  53682. private _raycastResult;
  53683. private _physicsBodysToRemoveAfterStep;
  53684. BJSCANNON: any;
  53685. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  53686. setGravity(gravity: Vector3): void;
  53687. setTimeStep(timeStep: number): void;
  53688. getTimeStep(): number;
  53689. executeStep(delta: number): void;
  53690. private _removeMarkedPhysicsBodiesFromWorld;
  53691. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53692. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53693. generatePhysicsBody(impostor: PhysicsImpostor): void;
  53694. private _processChildMeshes;
  53695. removePhysicsBody(impostor: PhysicsImpostor): void;
  53696. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  53697. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  53698. private _addMaterial;
  53699. private _checkWithEpsilon;
  53700. private _createShape;
  53701. private _createHeightmap;
  53702. private _minus90X;
  53703. private _plus90X;
  53704. private _tmpPosition;
  53705. private _tmpDeltaPosition;
  53706. private _tmpUnityRotation;
  53707. private _updatePhysicsBodyTransformation;
  53708. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  53709. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  53710. isSupported(): boolean;
  53711. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53712. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53713. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53714. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53715. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  53716. getBodyMass(impostor: PhysicsImpostor): number;
  53717. getBodyFriction(impostor: PhysicsImpostor): number;
  53718. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  53719. getBodyRestitution(impostor: PhysicsImpostor): number;
  53720. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  53721. sleepBody(impostor: PhysicsImpostor): void;
  53722. wakeUpBody(impostor: PhysicsImpostor): void;
  53723. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  53724. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  53725. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  53726. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  53727. getRadius(impostor: PhysicsImpostor): number;
  53728. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  53729. dispose(): void;
  53730. private _extendNamespace;
  53731. /**
  53732. * Does a raycast in the physics world
  53733. * @param from when should the ray start?
  53734. * @param to when should the ray end?
  53735. * @returns PhysicsRaycastResult
  53736. */
  53737. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  53738. }
  53739. }
  53740. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  53741. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  53742. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  53743. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  53744. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53745. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  53746. import { Nullable } from "babylonjs/types";
  53747. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53748. /** @hidden */
  53749. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  53750. world: any;
  53751. name: string;
  53752. BJSOIMO: any;
  53753. private _raycastResult;
  53754. constructor(iterations?: number, oimoInjection?: any);
  53755. setGravity(gravity: Vector3): void;
  53756. setTimeStep(timeStep: number): void;
  53757. getTimeStep(): number;
  53758. private _tmpImpostorsArray;
  53759. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  53760. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53761. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53762. generatePhysicsBody(impostor: PhysicsImpostor): void;
  53763. private _tmpPositionVector;
  53764. removePhysicsBody(impostor: PhysicsImpostor): void;
  53765. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  53766. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  53767. isSupported(): boolean;
  53768. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  53769. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  53770. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53771. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53772. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53773. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53774. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  53775. getBodyMass(impostor: PhysicsImpostor): number;
  53776. getBodyFriction(impostor: PhysicsImpostor): number;
  53777. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  53778. getBodyRestitution(impostor: PhysicsImpostor): number;
  53779. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  53780. sleepBody(impostor: PhysicsImpostor): void;
  53781. wakeUpBody(impostor: PhysicsImpostor): void;
  53782. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  53783. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  53784. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  53785. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  53786. getRadius(impostor: PhysicsImpostor): number;
  53787. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  53788. dispose(): void;
  53789. /**
  53790. * Does a raycast in the physics world
  53791. * @param from when should the ray start?
  53792. * @param to when should the ray end?
  53793. * @returns PhysicsRaycastResult
  53794. */
  53795. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  53796. }
  53797. }
  53798. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53799. import { Nullable } from "babylonjs/types";
  53800. import { Scene } from "babylonjs/scene";
  53801. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53802. import { Color4 } from "babylonjs/Maths/math.color";
  53803. import { Mesh } from "babylonjs/Meshes/mesh";
  53804. /**
  53805. * Class containing static functions to help procedurally build meshes
  53806. */
  53807. export class RibbonBuilder {
  53808. /**
  53809. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53810. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53811. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53812. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53813. * * 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
  53814. * * 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
  53815. * * 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
  53816. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53817. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53818. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53819. * * 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
  53820. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53821. * * 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
  53822. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53823. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53824. * @param name defines the name of the mesh
  53825. * @param options defines the options used to create the mesh
  53826. * @param scene defines the hosting scene
  53827. * @returns the ribbon mesh
  53828. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53829. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53830. */
  53831. static CreateRibbon(name: string, options: {
  53832. pathArray: Vector3[][];
  53833. closeArray?: boolean;
  53834. closePath?: boolean;
  53835. offset?: number;
  53836. updatable?: boolean;
  53837. sideOrientation?: number;
  53838. frontUVs?: Vector4;
  53839. backUVs?: Vector4;
  53840. instance?: Mesh;
  53841. invertUV?: boolean;
  53842. uvs?: Vector2[];
  53843. colors?: Color4[];
  53844. }, scene?: Nullable<Scene>): Mesh;
  53845. }
  53846. }
  53847. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53848. import { Nullable } from "babylonjs/types";
  53849. import { Scene } from "babylonjs/scene";
  53850. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53851. import { Mesh } from "babylonjs/Meshes/mesh";
  53852. /**
  53853. * Class containing static functions to help procedurally build meshes
  53854. */
  53855. export class ShapeBuilder {
  53856. /**
  53857. * 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.
  53858. * * 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.
  53859. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53860. * * 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.
  53861. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53862. * * 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
  53863. * * 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
  53864. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53865. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53866. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53867. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53868. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53869. * @param name defines the name of the mesh
  53870. * @param options defines the options used to create the mesh
  53871. * @param scene defines the hosting scene
  53872. * @returns the extruded shape mesh
  53873. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53874. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53875. */
  53876. static ExtrudeShape(name: string, options: {
  53877. shape: Vector3[];
  53878. path: Vector3[];
  53879. scale?: number;
  53880. rotation?: number;
  53881. cap?: number;
  53882. updatable?: boolean;
  53883. sideOrientation?: number;
  53884. frontUVs?: Vector4;
  53885. backUVs?: Vector4;
  53886. instance?: Mesh;
  53887. invertUV?: boolean;
  53888. }, scene?: Nullable<Scene>): Mesh;
  53889. /**
  53890. * Creates an custom extruded shape mesh.
  53891. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53892. * * 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.
  53893. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53894. * * 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
  53895. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53896. * * 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
  53897. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53898. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53899. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53900. * * 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
  53901. * * 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
  53902. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53903. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53904. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53905. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53906. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53907. * @param name defines the name of the mesh
  53908. * @param options defines the options used to create the mesh
  53909. * @param scene defines the hosting scene
  53910. * @returns the custom extruded shape mesh
  53911. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53912. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53913. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53914. */
  53915. static ExtrudeShapeCustom(name: string, options: {
  53916. shape: Vector3[];
  53917. path: Vector3[];
  53918. scaleFunction?: any;
  53919. rotationFunction?: any;
  53920. ribbonCloseArray?: boolean;
  53921. ribbonClosePath?: boolean;
  53922. cap?: number;
  53923. updatable?: boolean;
  53924. sideOrientation?: number;
  53925. frontUVs?: Vector4;
  53926. backUVs?: Vector4;
  53927. instance?: Mesh;
  53928. invertUV?: boolean;
  53929. }, scene?: Nullable<Scene>): Mesh;
  53930. private static _ExtrudeShapeGeneric;
  53931. }
  53932. }
  53933. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  53934. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  53935. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  53936. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  53937. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  53938. import { Nullable } from "babylonjs/types";
  53939. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53940. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53941. /**
  53942. * AmmoJS Physics plugin
  53943. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  53944. * @see https://github.com/kripken/ammo.js/
  53945. */
  53946. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  53947. private _useDeltaForWorldStep;
  53948. /**
  53949. * Reference to the Ammo library
  53950. */
  53951. bjsAMMO: any;
  53952. /**
  53953. * Created ammoJS world which physics bodies are added to
  53954. */
  53955. world: any;
  53956. /**
  53957. * Name of the plugin
  53958. */
  53959. name: string;
  53960. private _timeStep;
  53961. private _fixedTimeStep;
  53962. private _maxSteps;
  53963. private _tmpQuaternion;
  53964. private _tmpAmmoTransform;
  53965. private _tmpAmmoQuaternion;
  53966. private _tmpAmmoConcreteContactResultCallback;
  53967. private _collisionConfiguration;
  53968. private _dispatcher;
  53969. private _overlappingPairCache;
  53970. private _solver;
  53971. private _softBodySolver;
  53972. private _tmpAmmoVectorA;
  53973. private _tmpAmmoVectorB;
  53974. private _tmpAmmoVectorC;
  53975. private _tmpAmmoVectorD;
  53976. private _tmpContactCallbackResult;
  53977. private _tmpAmmoVectorRCA;
  53978. private _tmpAmmoVectorRCB;
  53979. private _raycastResult;
  53980. private static readonly DISABLE_COLLISION_FLAG;
  53981. private static readonly KINEMATIC_FLAG;
  53982. private static readonly DISABLE_DEACTIVATION_FLAG;
  53983. /**
  53984. * Initializes the ammoJS plugin
  53985. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  53986. * @param ammoInjection can be used to inject your own ammo reference
  53987. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  53988. */
  53989. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  53990. /**
  53991. * Sets the gravity of the physics world (m/(s^2))
  53992. * @param gravity Gravity to set
  53993. */
  53994. setGravity(gravity: Vector3): void;
  53995. /**
  53996. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  53997. * @param timeStep timestep to use in seconds
  53998. */
  53999. setTimeStep(timeStep: number): void;
  54000. /**
  54001. * 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)
  54002. * @param fixedTimeStep fixedTimeStep to use in seconds
  54003. */
  54004. setFixedTimeStep(fixedTimeStep: number): void;
  54005. /**
  54006. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  54007. * @param maxSteps the maximum number of steps by the physics engine per frame
  54008. */
  54009. setMaxSteps(maxSteps: number): void;
  54010. /**
  54011. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  54012. * @returns the current timestep in seconds
  54013. */
  54014. getTimeStep(): number;
  54015. private _isImpostorInContact;
  54016. private _isImpostorPairInContact;
  54017. private _stepSimulation;
  54018. /**
  54019. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  54020. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  54021. * After the step the babylon meshes are set to the position of the physics imposters
  54022. * @param delta amount of time to step forward
  54023. * @param impostors array of imposters to update before/after the step
  54024. */
  54025. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  54026. /**
  54027. * Update babylon mesh to match physics world object
  54028. * @param impostor imposter to match
  54029. */
  54030. private _afterSoftStep;
  54031. /**
  54032. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  54033. * @param impostor imposter to match
  54034. */
  54035. private _ropeStep;
  54036. /**
  54037. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  54038. * @param impostor imposter to match
  54039. */
  54040. private _softbodyOrClothStep;
  54041. private _tmpVector;
  54042. private _tmpMatrix;
  54043. /**
  54044. * Applies an impulse on the imposter
  54045. * @param impostor imposter to apply impulse to
  54046. * @param force amount of force to be applied to the imposter
  54047. * @param contactPoint the location to apply the impulse on the imposter
  54048. */
  54049. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54050. /**
  54051. * Applies a force on the imposter
  54052. * @param impostor imposter to apply force
  54053. * @param force amount of force to be applied to the imposter
  54054. * @param contactPoint the location to apply the force on the imposter
  54055. */
  54056. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54057. /**
  54058. * Creates a physics body using the plugin
  54059. * @param impostor the imposter to create the physics body on
  54060. */
  54061. generatePhysicsBody(impostor: PhysicsImpostor): void;
  54062. /**
  54063. * Removes the physics body from the imposter and disposes of the body's memory
  54064. * @param impostor imposter to remove the physics body from
  54065. */
  54066. removePhysicsBody(impostor: PhysicsImpostor): void;
  54067. /**
  54068. * Generates a joint
  54069. * @param impostorJoint the imposter joint to create the joint with
  54070. */
  54071. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  54072. /**
  54073. * Removes a joint
  54074. * @param impostorJoint the imposter joint to remove the joint from
  54075. */
  54076. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  54077. private _addMeshVerts;
  54078. /**
  54079. * Initialise the soft body vertices to match its object's (mesh) vertices
  54080. * Softbody vertices (nodes) are in world space and to match this
  54081. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  54082. * @param impostor to create the softbody for
  54083. */
  54084. private _softVertexData;
  54085. /**
  54086. * Create an impostor's soft body
  54087. * @param impostor to create the softbody for
  54088. */
  54089. private _createSoftbody;
  54090. /**
  54091. * Create cloth for an impostor
  54092. * @param impostor to create the softbody for
  54093. */
  54094. private _createCloth;
  54095. /**
  54096. * Create rope for an impostor
  54097. * @param impostor to create the softbody for
  54098. */
  54099. private _createRope;
  54100. private _addHullVerts;
  54101. private _createShape;
  54102. /**
  54103. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  54104. * @param impostor imposter containing the physics body and babylon object
  54105. */
  54106. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  54107. /**
  54108. * Sets the babylon object's position/rotation from the physics body's position/rotation
  54109. * @param impostor imposter containing the physics body and babylon object
  54110. * @param newPosition new position
  54111. * @param newRotation new rotation
  54112. */
  54113. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  54114. /**
  54115. * If this plugin is supported
  54116. * @returns true if its supported
  54117. */
  54118. isSupported(): boolean;
  54119. /**
  54120. * Sets the linear velocity of the physics body
  54121. * @param impostor imposter to set the velocity on
  54122. * @param velocity velocity to set
  54123. */
  54124. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54125. /**
  54126. * Sets the angular velocity of the physics body
  54127. * @param impostor imposter to set the velocity on
  54128. * @param velocity velocity to set
  54129. */
  54130. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54131. /**
  54132. * gets the linear velocity
  54133. * @param impostor imposter to get linear velocity from
  54134. * @returns linear velocity
  54135. */
  54136. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54137. /**
  54138. * gets the angular velocity
  54139. * @param impostor imposter to get angular velocity from
  54140. * @returns angular velocity
  54141. */
  54142. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54143. /**
  54144. * Sets the mass of physics body
  54145. * @param impostor imposter to set the mass on
  54146. * @param mass mass to set
  54147. */
  54148. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  54149. /**
  54150. * Gets the mass of the physics body
  54151. * @param impostor imposter to get the mass from
  54152. * @returns mass
  54153. */
  54154. getBodyMass(impostor: PhysicsImpostor): number;
  54155. /**
  54156. * Gets friction of the impostor
  54157. * @param impostor impostor to get friction from
  54158. * @returns friction value
  54159. */
  54160. getBodyFriction(impostor: PhysicsImpostor): number;
  54161. /**
  54162. * Sets friction of the impostor
  54163. * @param impostor impostor to set friction on
  54164. * @param friction friction value
  54165. */
  54166. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  54167. /**
  54168. * Gets restitution of the impostor
  54169. * @param impostor impostor to get restitution from
  54170. * @returns restitution value
  54171. */
  54172. getBodyRestitution(impostor: PhysicsImpostor): number;
  54173. /**
  54174. * Sets resitution of the impostor
  54175. * @param impostor impostor to set resitution on
  54176. * @param restitution resitution value
  54177. */
  54178. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  54179. /**
  54180. * Gets pressure inside the impostor
  54181. * @param impostor impostor to get pressure from
  54182. * @returns pressure value
  54183. */
  54184. getBodyPressure(impostor: PhysicsImpostor): number;
  54185. /**
  54186. * Sets pressure inside a soft body impostor
  54187. * Cloth and rope must remain 0 pressure
  54188. * @param impostor impostor to set pressure on
  54189. * @param pressure pressure value
  54190. */
  54191. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  54192. /**
  54193. * Gets stiffness of the impostor
  54194. * @param impostor impostor to get stiffness from
  54195. * @returns pressure value
  54196. */
  54197. getBodyStiffness(impostor: PhysicsImpostor): number;
  54198. /**
  54199. * Sets stiffness of the impostor
  54200. * @param impostor impostor to set stiffness on
  54201. * @param stiffness stiffness value from 0 to 1
  54202. */
  54203. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  54204. /**
  54205. * Gets velocityIterations of the impostor
  54206. * @param impostor impostor to get velocity iterations from
  54207. * @returns velocityIterations value
  54208. */
  54209. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  54210. /**
  54211. * Sets velocityIterations of the impostor
  54212. * @param impostor impostor to set velocity iterations on
  54213. * @param velocityIterations velocityIterations value
  54214. */
  54215. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  54216. /**
  54217. * Gets positionIterations of the impostor
  54218. * @param impostor impostor to get position iterations from
  54219. * @returns positionIterations value
  54220. */
  54221. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  54222. /**
  54223. * Sets positionIterations of the impostor
  54224. * @param impostor impostor to set position on
  54225. * @param positionIterations positionIterations value
  54226. */
  54227. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  54228. /**
  54229. * Append an anchor to a cloth object
  54230. * @param impostor is the cloth impostor to add anchor to
  54231. * @param otherImpostor is the rigid impostor to anchor to
  54232. * @param width ratio across width from 0 to 1
  54233. * @param height ratio up height from 0 to 1
  54234. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  54235. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  54236. */
  54237. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  54238. /**
  54239. * Append an hook to a rope object
  54240. * @param impostor is the rope impostor to add hook to
  54241. * @param otherImpostor is the rigid impostor to hook to
  54242. * @param length ratio along the rope from 0 to 1
  54243. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  54244. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  54245. */
  54246. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  54247. /**
  54248. * Sleeps the physics body and stops it from being active
  54249. * @param impostor impostor to sleep
  54250. */
  54251. sleepBody(impostor: PhysicsImpostor): void;
  54252. /**
  54253. * Activates the physics body
  54254. * @param impostor impostor to activate
  54255. */
  54256. wakeUpBody(impostor: PhysicsImpostor): void;
  54257. /**
  54258. * Updates the distance parameters of the joint
  54259. * @param joint joint to update
  54260. * @param maxDistance maximum distance of the joint
  54261. * @param minDistance minimum distance of the joint
  54262. */
  54263. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  54264. /**
  54265. * Sets a motor on the joint
  54266. * @param joint joint to set motor on
  54267. * @param speed speed of the motor
  54268. * @param maxForce maximum force of the motor
  54269. * @param motorIndex index of the motor
  54270. */
  54271. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  54272. /**
  54273. * Sets the motors limit
  54274. * @param joint joint to set limit on
  54275. * @param upperLimit upper limit
  54276. * @param lowerLimit lower limit
  54277. */
  54278. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  54279. /**
  54280. * Syncs the position and rotation of a mesh with the impostor
  54281. * @param mesh mesh to sync
  54282. * @param impostor impostor to update the mesh with
  54283. */
  54284. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  54285. /**
  54286. * Gets the radius of the impostor
  54287. * @param impostor impostor to get radius from
  54288. * @returns the radius
  54289. */
  54290. getRadius(impostor: PhysicsImpostor): number;
  54291. /**
  54292. * Gets the box size of the impostor
  54293. * @param impostor impostor to get box size from
  54294. * @param result the resulting box size
  54295. */
  54296. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  54297. /**
  54298. * Disposes of the impostor
  54299. */
  54300. dispose(): void;
  54301. /**
  54302. * Does a raycast in the physics world
  54303. * @param from when should the ray start?
  54304. * @param to when should the ray end?
  54305. * @returns PhysicsRaycastResult
  54306. */
  54307. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54308. }
  54309. }
  54310. declare module "babylonjs/Probes/reflectionProbe" {
  54311. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  54312. import { Vector3 } from "babylonjs/Maths/math.vector";
  54313. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54314. import { Nullable } from "babylonjs/types";
  54315. import { Scene } from "babylonjs/scene";
  54316. module "babylonjs/abstractScene" {
  54317. interface AbstractScene {
  54318. /**
  54319. * The list of reflection probes added to the scene
  54320. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  54321. */
  54322. reflectionProbes: Array<ReflectionProbe>;
  54323. /**
  54324. * Removes the given reflection probe from this scene.
  54325. * @param toRemove The reflection probe to remove
  54326. * @returns The index of the removed reflection probe
  54327. */
  54328. removeReflectionProbe(toRemove: ReflectionProbe): number;
  54329. /**
  54330. * Adds the given reflection probe to this scene.
  54331. * @param newReflectionProbe The reflection probe to add
  54332. */
  54333. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  54334. }
  54335. }
  54336. /**
  54337. * Class used to generate realtime reflection / refraction cube textures
  54338. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  54339. */
  54340. export class ReflectionProbe {
  54341. /** defines the name of the probe */
  54342. name: string;
  54343. private _scene;
  54344. private _renderTargetTexture;
  54345. private _projectionMatrix;
  54346. private _viewMatrix;
  54347. private _target;
  54348. private _add;
  54349. private _attachedMesh;
  54350. private _invertYAxis;
  54351. /** Gets or sets probe position (center of the cube map) */
  54352. position: Vector3;
  54353. /**
  54354. * Creates a new reflection probe
  54355. * @param name defines the name of the probe
  54356. * @param size defines the texture resolution (for each face)
  54357. * @param scene defines the hosting scene
  54358. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  54359. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  54360. */
  54361. constructor(
  54362. /** defines the name of the probe */
  54363. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  54364. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  54365. samples: number;
  54366. /** Gets or sets the refresh rate to use (on every frame by default) */
  54367. refreshRate: number;
  54368. /**
  54369. * Gets the hosting scene
  54370. * @returns a Scene
  54371. */
  54372. getScene(): Scene;
  54373. /** Gets the internal CubeTexture used to render to */
  54374. readonly cubeTexture: RenderTargetTexture;
  54375. /** Gets the list of meshes to render */
  54376. readonly renderList: Nullable<AbstractMesh[]>;
  54377. /**
  54378. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  54379. * @param mesh defines the mesh to attach to
  54380. */
  54381. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  54382. /**
  54383. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  54384. * @param renderingGroupId The rendering group id corresponding to its index
  54385. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  54386. */
  54387. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  54388. /**
  54389. * Clean all associated resources
  54390. */
  54391. dispose(): void;
  54392. /**
  54393. * Converts the reflection probe information to a readable string for debug purpose.
  54394. * @param fullDetails Supports for multiple levels of logging within scene loading
  54395. * @returns the human readable reflection probe info
  54396. */
  54397. toString(fullDetails?: boolean): string;
  54398. /**
  54399. * Get the class name of the relfection probe.
  54400. * @returns "ReflectionProbe"
  54401. */
  54402. getClassName(): string;
  54403. /**
  54404. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  54405. * @returns The JSON representation of the texture
  54406. */
  54407. serialize(): any;
  54408. /**
  54409. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  54410. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  54411. * @param scene Define the scene the parsed reflection probe should be instantiated in
  54412. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  54413. * @returns The parsed reflection probe if successful
  54414. */
  54415. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  54416. }
  54417. }
  54418. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  54419. /** @hidden */
  54420. export var _BabylonLoaderRegistered: boolean;
  54421. /**
  54422. * Helps setting up some configuration for the babylon file loader.
  54423. */
  54424. export class BabylonFileLoaderConfiguration {
  54425. /**
  54426. * The loader does not allow injecting custom physix engine into the plugins.
  54427. * Unfortunately in ES6, we need to manually inject them into the plugin.
  54428. * So you could set this variable to your engine import to make it work.
  54429. */
  54430. static LoaderInjectedPhysicsEngine: any;
  54431. }
  54432. }
  54433. declare module "babylonjs/Loading/Plugins/index" {
  54434. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  54435. }
  54436. declare module "babylonjs/Loading/index" {
  54437. export * from "babylonjs/Loading/loadingScreen";
  54438. export * from "babylonjs/Loading/Plugins/index";
  54439. export * from "babylonjs/Loading/sceneLoader";
  54440. export * from "babylonjs/Loading/sceneLoaderFlags";
  54441. }
  54442. declare module "babylonjs/Materials/Background/index" {
  54443. export * from "babylonjs/Materials/Background/backgroundMaterial";
  54444. }
  54445. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  54446. import { Scene } from "babylonjs/scene";
  54447. import { Color3 } from "babylonjs/Maths/math.color";
  54448. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  54449. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54450. /**
  54451. * The Physically based simple base material of BJS.
  54452. *
  54453. * This enables better naming and convention enforcements on top of the pbrMaterial.
  54454. * It is used as the base class for both the specGloss and metalRough conventions.
  54455. */
  54456. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  54457. /**
  54458. * Number of Simultaneous lights allowed on the material.
  54459. */
  54460. maxSimultaneousLights: number;
  54461. /**
  54462. * If sets to true, disables all the lights affecting the material.
  54463. */
  54464. disableLighting: boolean;
  54465. /**
  54466. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  54467. */
  54468. environmentTexture: BaseTexture;
  54469. /**
  54470. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  54471. */
  54472. invertNormalMapX: boolean;
  54473. /**
  54474. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  54475. */
  54476. invertNormalMapY: boolean;
  54477. /**
  54478. * Normal map used in the model.
  54479. */
  54480. normalTexture: BaseTexture;
  54481. /**
  54482. * Emissivie color used to self-illuminate the model.
  54483. */
  54484. emissiveColor: Color3;
  54485. /**
  54486. * Emissivie texture used to self-illuminate the model.
  54487. */
  54488. emissiveTexture: BaseTexture;
  54489. /**
  54490. * Occlusion Channel Strenght.
  54491. */
  54492. occlusionStrength: number;
  54493. /**
  54494. * Occlusion Texture of the material (adding extra occlusion effects).
  54495. */
  54496. occlusionTexture: BaseTexture;
  54497. /**
  54498. * Defines the alpha limits in alpha test mode.
  54499. */
  54500. alphaCutOff: number;
  54501. /**
  54502. * Gets the current double sided mode.
  54503. */
  54504. /**
  54505. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  54506. */
  54507. doubleSided: boolean;
  54508. /**
  54509. * Stores the pre-calculated light information of a mesh in a texture.
  54510. */
  54511. lightmapTexture: BaseTexture;
  54512. /**
  54513. * If true, the light map contains occlusion information instead of lighting info.
  54514. */
  54515. useLightmapAsShadowmap: boolean;
  54516. /**
  54517. * Instantiates a new PBRMaterial instance.
  54518. *
  54519. * @param name The material name
  54520. * @param scene The scene the material will be use in.
  54521. */
  54522. constructor(name: string, scene: Scene);
  54523. getClassName(): string;
  54524. }
  54525. }
  54526. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  54527. import { Scene } from "babylonjs/scene";
  54528. import { Color3 } from "babylonjs/Maths/math.color";
  54529. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54530. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54531. /**
  54532. * The PBR material of BJS following the metal roughness convention.
  54533. *
  54534. * This fits to the PBR convention in the GLTF definition:
  54535. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  54536. */
  54537. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  54538. /**
  54539. * The base color has two different interpretations depending on the value of metalness.
  54540. * When the material is a metal, the base color is the specific measured reflectance value
  54541. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  54542. * of the material.
  54543. */
  54544. baseColor: Color3;
  54545. /**
  54546. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  54547. * well as opacity information in the alpha channel.
  54548. */
  54549. baseTexture: BaseTexture;
  54550. /**
  54551. * Specifies the metallic scalar value of the material.
  54552. * Can also be used to scale the metalness values of the metallic texture.
  54553. */
  54554. metallic: number;
  54555. /**
  54556. * Specifies the roughness scalar value of the material.
  54557. * Can also be used to scale the roughness values of the metallic texture.
  54558. */
  54559. roughness: number;
  54560. /**
  54561. * Texture containing both the metallic value in the B channel and the
  54562. * roughness value in the G channel to keep better precision.
  54563. */
  54564. metallicRoughnessTexture: BaseTexture;
  54565. /**
  54566. * Instantiates a new PBRMetalRoughnessMaterial instance.
  54567. *
  54568. * @param name The material name
  54569. * @param scene The scene the material will be use in.
  54570. */
  54571. constructor(name: string, scene: Scene);
  54572. /**
  54573. * Return the currrent class name of the material.
  54574. */
  54575. getClassName(): string;
  54576. /**
  54577. * Makes a duplicate of the current material.
  54578. * @param name - name to use for the new material.
  54579. */
  54580. clone(name: string): PBRMetallicRoughnessMaterial;
  54581. /**
  54582. * Serialize the material to a parsable JSON object.
  54583. */
  54584. serialize(): any;
  54585. /**
  54586. * Parses a JSON object correponding to the serialize function.
  54587. */
  54588. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  54589. }
  54590. }
  54591. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  54592. import { Scene } from "babylonjs/scene";
  54593. import { Color3 } from "babylonjs/Maths/math.color";
  54594. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54595. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54596. /**
  54597. * The PBR material of BJS following the specular glossiness convention.
  54598. *
  54599. * This fits to the PBR convention in the GLTF definition:
  54600. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  54601. */
  54602. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  54603. /**
  54604. * Specifies the diffuse color of the material.
  54605. */
  54606. diffuseColor: Color3;
  54607. /**
  54608. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  54609. * channel.
  54610. */
  54611. diffuseTexture: BaseTexture;
  54612. /**
  54613. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  54614. */
  54615. specularColor: Color3;
  54616. /**
  54617. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  54618. */
  54619. glossiness: number;
  54620. /**
  54621. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  54622. */
  54623. specularGlossinessTexture: BaseTexture;
  54624. /**
  54625. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  54626. *
  54627. * @param name The material name
  54628. * @param scene The scene the material will be use in.
  54629. */
  54630. constructor(name: string, scene: Scene);
  54631. /**
  54632. * Return the currrent class name of the material.
  54633. */
  54634. getClassName(): string;
  54635. /**
  54636. * Makes a duplicate of the current material.
  54637. * @param name - name to use for the new material.
  54638. */
  54639. clone(name: string): PBRSpecularGlossinessMaterial;
  54640. /**
  54641. * Serialize the material to a parsable JSON object.
  54642. */
  54643. serialize(): any;
  54644. /**
  54645. * Parses a JSON object correponding to the serialize function.
  54646. */
  54647. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  54648. }
  54649. }
  54650. declare module "babylonjs/Materials/PBR/index" {
  54651. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  54652. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54653. export * from "babylonjs/Materials/PBR/pbrMaterial";
  54654. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  54655. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  54656. }
  54657. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  54658. import { Nullable } from "babylonjs/types";
  54659. import { Scene } from "babylonjs/scene";
  54660. import { Matrix } from "babylonjs/Maths/math.vector";
  54661. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54662. /**
  54663. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  54664. * It can help converting any input color in a desired output one. This can then be used to create effects
  54665. * from sepia, black and white to sixties or futuristic rendering...
  54666. *
  54667. * The only supported format is currently 3dl.
  54668. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  54669. */
  54670. export class ColorGradingTexture extends BaseTexture {
  54671. /**
  54672. * The current texture matrix. (will always be identity in color grading texture)
  54673. */
  54674. private _textureMatrix;
  54675. /**
  54676. * The texture URL.
  54677. */
  54678. url: string;
  54679. /**
  54680. * Empty line regex stored for GC.
  54681. */
  54682. private static _noneEmptyLineRegex;
  54683. private _engine;
  54684. /**
  54685. * Instantiates a ColorGradingTexture from the following parameters.
  54686. *
  54687. * @param url The location of the color gradind data (currently only supporting 3dl)
  54688. * @param scene The scene the texture will be used in
  54689. */
  54690. constructor(url: string, scene: Scene);
  54691. /**
  54692. * Returns the texture matrix used in most of the material.
  54693. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  54694. */
  54695. getTextureMatrix(): Matrix;
  54696. /**
  54697. * Occurs when the file being loaded is a .3dl LUT file.
  54698. */
  54699. private load3dlTexture;
  54700. /**
  54701. * Starts the loading process of the texture.
  54702. */
  54703. private loadTexture;
  54704. /**
  54705. * Clones the color gradind texture.
  54706. */
  54707. clone(): ColorGradingTexture;
  54708. /**
  54709. * Called during delayed load for textures.
  54710. */
  54711. delayLoad(): void;
  54712. /**
  54713. * Parses a color grading texture serialized by Babylon.
  54714. * @param parsedTexture The texture information being parsedTexture
  54715. * @param scene The scene to load the texture in
  54716. * @param rootUrl The root url of the data assets to load
  54717. * @return A color gradind texture
  54718. */
  54719. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  54720. /**
  54721. * Serializes the LUT texture to json format.
  54722. */
  54723. serialize(): any;
  54724. }
  54725. }
  54726. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  54727. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54728. import { Scene } from "babylonjs/scene";
  54729. import { Nullable } from "babylonjs/types";
  54730. import "babylonjs/Engines/Extensions/engine.rawTexture";
  54731. /**
  54732. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  54733. */
  54734. export class EquiRectangularCubeTexture extends BaseTexture {
  54735. /** The six faces of the cube. */
  54736. private static _FacesMapping;
  54737. private _noMipmap;
  54738. private _onLoad;
  54739. private _onError;
  54740. /** The size of the cubemap. */
  54741. private _size;
  54742. /** The buffer of the image. */
  54743. private _buffer;
  54744. /** The width of the input image. */
  54745. private _width;
  54746. /** The height of the input image. */
  54747. private _height;
  54748. /** The URL to the image. */
  54749. url: string;
  54750. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  54751. coordinatesMode: number;
  54752. /**
  54753. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  54754. * @param url The location of the image
  54755. * @param scene The scene the texture will be used in
  54756. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  54757. * @param noMipmap Forces to not generate the mipmap if true
  54758. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  54759. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  54760. * @param onLoad — defines a callback called when texture is loaded
  54761. * @param onError — defines a callback called if there is an error
  54762. */
  54763. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  54764. /**
  54765. * Load the image data, by putting the image on a canvas and extracting its buffer.
  54766. */
  54767. private loadImage;
  54768. /**
  54769. * Convert the image buffer into a cubemap and create a CubeTexture.
  54770. */
  54771. private loadTexture;
  54772. /**
  54773. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  54774. * @param buffer The ArrayBuffer that should be converted.
  54775. * @returns The buffer as Float32Array.
  54776. */
  54777. private getFloat32ArrayFromArrayBuffer;
  54778. /**
  54779. * Get the current class name of the texture useful for serialization or dynamic coding.
  54780. * @returns "EquiRectangularCubeTexture"
  54781. */
  54782. getClassName(): string;
  54783. /**
  54784. * Create a clone of the current EquiRectangularCubeTexture and return it.
  54785. * @returns A clone of the current EquiRectangularCubeTexture.
  54786. */
  54787. clone(): EquiRectangularCubeTexture;
  54788. }
  54789. }
  54790. declare module "babylonjs/Misc/tga" {
  54791. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54792. /**
  54793. * Based on jsTGALoader - Javascript loader for TGA file
  54794. * By Vincent Thibault
  54795. * @see http://blog.robrowser.com/javascript-tga-loader.html
  54796. */
  54797. export class TGATools {
  54798. private static _TYPE_INDEXED;
  54799. private static _TYPE_RGB;
  54800. private static _TYPE_GREY;
  54801. private static _TYPE_RLE_INDEXED;
  54802. private static _TYPE_RLE_RGB;
  54803. private static _TYPE_RLE_GREY;
  54804. private static _ORIGIN_MASK;
  54805. private static _ORIGIN_SHIFT;
  54806. private static _ORIGIN_BL;
  54807. private static _ORIGIN_BR;
  54808. private static _ORIGIN_UL;
  54809. private static _ORIGIN_UR;
  54810. /**
  54811. * Gets the header of a TGA file
  54812. * @param data defines the TGA data
  54813. * @returns the header
  54814. */
  54815. static GetTGAHeader(data: Uint8Array): any;
  54816. /**
  54817. * Uploads TGA content to a Babylon Texture
  54818. * @hidden
  54819. */
  54820. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  54821. /** @hidden */
  54822. 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;
  54823. /** @hidden */
  54824. 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;
  54825. /** @hidden */
  54826. 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;
  54827. /** @hidden */
  54828. 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;
  54829. /** @hidden */
  54830. 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;
  54831. /** @hidden */
  54832. 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;
  54833. }
  54834. }
  54835. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  54836. import { Nullable } from "babylonjs/types";
  54837. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54838. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  54839. /**
  54840. * Implementation of the TGA Texture Loader.
  54841. * @hidden
  54842. */
  54843. export class _TGATextureLoader implements IInternalTextureLoader {
  54844. /**
  54845. * Defines wether the loader supports cascade loading the different faces.
  54846. */
  54847. readonly supportCascades: boolean;
  54848. /**
  54849. * This returns if the loader support the current file information.
  54850. * @param extension defines the file extension of the file being loaded
  54851. * @param textureFormatInUse defines the current compressed format in use iun the engine
  54852. * @param fallback defines the fallback internal texture if any
  54853. * @param isBase64 defines whether the texture is encoded as a base64
  54854. * @param isBuffer defines whether the texture data are stored as a buffer
  54855. * @returns true if the loader can load the specified file
  54856. */
  54857. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  54858. /**
  54859. * Transform the url before loading if required.
  54860. * @param rootUrl the url of the texture
  54861. * @param textureFormatInUse defines the current compressed format in use iun the engine
  54862. * @returns the transformed texture
  54863. */
  54864. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  54865. /**
  54866. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  54867. * @param rootUrl the url of the texture
  54868. * @param textureFormatInUse defines the current compressed format in use iun the engine
  54869. * @returns the fallback texture
  54870. */
  54871. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  54872. /**
  54873. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  54874. * @param data contains the texture data
  54875. * @param texture defines the BabylonJS internal texture
  54876. * @param createPolynomials will be true if polynomials have been requested
  54877. * @param onLoad defines the callback to trigger once the texture is ready
  54878. * @param onError defines the callback to trigger in case of error
  54879. */
  54880. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  54881. /**
  54882. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  54883. * @param data contains the texture data
  54884. * @param texture defines the BabylonJS internal texture
  54885. * @param callback defines the method to call once ready to upload
  54886. */
  54887. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  54888. }
  54889. }
  54890. declare module "babylonjs/Misc/basis" {
  54891. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54892. /**
  54893. * Info about the .basis files
  54894. */
  54895. class BasisFileInfo {
  54896. /**
  54897. * If the file has alpha
  54898. */
  54899. hasAlpha: boolean;
  54900. /**
  54901. * Info about each image of the basis file
  54902. */
  54903. images: Array<{
  54904. levels: Array<{
  54905. width: number;
  54906. height: number;
  54907. transcodedPixels: ArrayBufferView;
  54908. }>;
  54909. }>;
  54910. }
  54911. /**
  54912. * Result of transcoding a basis file
  54913. */
  54914. class TranscodeResult {
  54915. /**
  54916. * Info about the .basis file
  54917. */
  54918. fileInfo: BasisFileInfo;
  54919. /**
  54920. * Format to use when loading the file
  54921. */
  54922. format: number;
  54923. }
  54924. /**
  54925. * Configuration options for the Basis transcoder
  54926. */
  54927. export class BasisTranscodeConfiguration {
  54928. /**
  54929. * Supported compression formats used to determine the supported output format of the transcoder
  54930. */
  54931. supportedCompressionFormats?: {
  54932. /**
  54933. * etc1 compression format
  54934. */
  54935. etc1?: boolean;
  54936. /**
  54937. * s3tc compression format
  54938. */
  54939. s3tc?: boolean;
  54940. /**
  54941. * pvrtc compression format
  54942. */
  54943. pvrtc?: boolean;
  54944. /**
  54945. * etc2 compression format
  54946. */
  54947. etc2?: boolean;
  54948. };
  54949. /**
  54950. * If mipmap levels should be loaded for transcoded images (Default: true)
  54951. */
  54952. loadMipmapLevels?: boolean;
  54953. /**
  54954. * Index of a single image to load (Default: all images)
  54955. */
  54956. loadSingleImage?: number;
  54957. }
  54958. /**
  54959. * Used to load .Basis files
  54960. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  54961. */
  54962. export class BasisTools {
  54963. private static _IgnoreSupportedFormats;
  54964. /**
  54965. * URL to use when loading the basis transcoder
  54966. */
  54967. static JSModuleURL: string;
  54968. /**
  54969. * URL to use when loading the wasm module for the transcoder
  54970. */
  54971. static WasmModuleURL: string;
  54972. /**
  54973. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  54974. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  54975. * @returns internal format corresponding to the Basis format
  54976. */
  54977. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  54978. private static _WorkerPromise;
  54979. private static _Worker;
  54980. private static _actionId;
  54981. private static _CreateWorkerAsync;
  54982. /**
  54983. * Transcodes a loaded image file to compressed pixel data
  54984. * @param imageData image data to transcode
  54985. * @param config configuration options for the transcoding
  54986. * @returns a promise resulting in the transcoded image
  54987. */
  54988. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  54989. /**
  54990. * Loads a texture from the transcode result
  54991. * @param texture texture load to
  54992. * @param transcodeResult the result of transcoding the basis file to load from
  54993. */
  54994. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  54995. }
  54996. }
  54997. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  54998. import { Nullable } from "babylonjs/types";
  54999. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55000. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  55001. /**
  55002. * Loader for .basis file format
  55003. */
  55004. export class _BasisTextureLoader implements IInternalTextureLoader {
  55005. /**
  55006. * Defines whether the loader supports cascade loading the different faces.
  55007. */
  55008. readonly supportCascades: boolean;
  55009. /**
  55010. * This returns if the loader support the current file information.
  55011. * @param extension defines the file extension of the file being loaded
  55012. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55013. * @param fallback defines the fallback internal texture if any
  55014. * @param isBase64 defines whether the texture is encoded as a base64
  55015. * @param isBuffer defines whether the texture data are stored as a buffer
  55016. * @returns true if the loader can load the specified file
  55017. */
  55018. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  55019. /**
  55020. * Transform the url before loading if required.
  55021. * @param rootUrl the url of the texture
  55022. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55023. * @returns the transformed texture
  55024. */
  55025. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  55026. /**
  55027. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  55028. * @param rootUrl the url of the texture
  55029. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55030. * @returns the fallback texture
  55031. */
  55032. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  55033. /**
  55034. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  55035. * @param data contains the texture data
  55036. * @param texture defines the BabylonJS internal texture
  55037. * @param createPolynomials will be true if polynomials have been requested
  55038. * @param onLoad defines the callback to trigger once the texture is ready
  55039. * @param onError defines the callback to trigger in case of error
  55040. */
  55041. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  55042. /**
  55043. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  55044. * @param data contains the texture data
  55045. * @param texture defines the BabylonJS internal texture
  55046. * @param callback defines the method to call once ready to upload
  55047. */
  55048. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  55049. }
  55050. }
  55051. declare module "babylonjs/Materials/Textures/Loaders/index" {
  55052. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  55053. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  55054. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  55055. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  55056. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  55057. }
  55058. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  55059. import { Scene } from "babylonjs/scene";
  55060. import { Texture } from "babylonjs/Materials/Textures/texture";
  55061. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55062. /**
  55063. * 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.
  55064. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  55065. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  55066. */
  55067. export class CustomProceduralTexture extends ProceduralTexture {
  55068. private _animate;
  55069. private _time;
  55070. private _config;
  55071. private _texturePath;
  55072. /**
  55073. * Instantiates a new Custom Procedural Texture.
  55074. * 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.
  55075. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  55076. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  55077. * @param name Define the name of the texture
  55078. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  55079. * @param size Define the size of the texture to create
  55080. * @param scene Define the scene the texture belongs to
  55081. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  55082. * @param generateMipMaps Define if the texture should creates mip maps or not
  55083. */
  55084. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  55085. private _loadJson;
  55086. /**
  55087. * Is the texture ready to be used ? (rendered at least once)
  55088. * @returns true if ready, otherwise, false.
  55089. */
  55090. isReady(): boolean;
  55091. /**
  55092. * Render the texture to its associated render target.
  55093. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  55094. */
  55095. render(useCameraPostProcess?: boolean): void;
  55096. /**
  55097. * Update the list of dependant textures samplers in the shader.
  55098. */
  55099. updateTextures(): void;
  55100. /**
  55101. * Update the uniform values of the procedural texture in the shader.
  55102. */
  55103. updateShaderUniforms(): void;
  55104. /**
  55105. * Define if the texture animates or not.
  55106. */
  55107. animate: boolean;
  55108. }
  55109. }
  55110. declare module "babylonjs/Shaders/noise.fragment" {
  55111. /** @hidden */
  55112. export var noisePixelShader: {
  55113. name: string;
  55114. shader: string;
  55115. };
  55116. }
  55117. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  55118. import { Nullable } from "babylonjs/types";
  55119. import { Scene } from "babylonjs/scene";
  55120. import { Texture } from "babylonjs/Materials/Textures/texture";
  55121. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55122. import "babylonjs/Shaders/noise.fragment";
  55123. /**
  55124. * Class used to generate noise procedural textures
  55125. */
  55126. export class NoiseProceduralTexture extends ProceduralTexture {
  55127. private _time;
  55128. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  55129. brightness: number;
  55130. /** Defines the number of octaves to process */
  55131. octaves: number;
  55132. /** Defines the level of persistence (0.8 by default) */
  55133. persistence: number;
  55134. /** Gets or sets animation speed factor (default is 1) */
  55135. animationSpeedFactor: number;
  55136. /**
  55137. * Creates a new NoiseProceduralTexture
  55138. * @param name defines the name fo the texture
  55139. * @param size defines the size of the texture (default is 256)
  55140. * @param scene defines the hosting scene
  55141. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  55142. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  55143. */
  55144. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  55145. private _updateShaderUniforms;
  55146. protected _getDefines(): string;
  55147. /** Generate the current state of the procedural texture */
  55148. render(useCameraPostProcess?: boolean): void;
  55149. /**
  55150. * Serializes this noise procedural texture
  55151. * @returns a serialized noise procedural texture object
  55152. */
  55153. serialize(): any;
  55154. /**
  55155. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  55156. * @param parsedTexture defines parsed texture data
  55157. * @param scene defines the current scene
  55158. * @param rootUrl defines the root URL containing noise procedural texture information
  55159. * @returns a parsed NoiseProceduralTexture
  55160. */
  55161. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  55162. }
  55163. }
  55164. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  55165. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  55166. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  55167. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55168. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  55169. }
  55170. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  55171. import { Nullable } from "babylonjs/types";
  55172. import { Scene } from "babylonjs/scene";
  55173. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  55174. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55175. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  55176. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55177. /**
  55178. * Raw cube texture where the raw buffers are passed in
  55179. */
  55180. export class RawCubeTexture extends CubeTexture {
  55181. /**
  55182. * Creates a cube texture where the raw buffers are passed in.
  55183. * @param scene defines the scene the texture is attached to
  55184. * @param data defines the array of data to use to create each face
  55185. * @param size defines the size of the textures
  55186. * @param format defines the format of the data
  55187. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  55188. * @param generateMipMaps defines if the engine should generate the mip levels
  55189. * @param invertY defines if data must be stored with Y axis inverted
  55190. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  55191. * @param compression defines the compression used (null by default)
  55192. */
  55193. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  55194. /**
  55195. * Updates the raw cube texture.
  55196. * @param data defines the data to store
  55197. * @param format defines the data format
  55198. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  55199. * @param invertY defines if data must be stored with Y axis inverted
  55200. * @param compression defines the compression used (null by default)
  55201. * @param level defines which level of the texture to update
  55202. */
  55203. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  55204. /**
  55205. * Updates a raw cube texture with RGBD encoded data.
  55206. * @param data defines the array of data [mipmap][face] to use to create each face
  55207. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  55208. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  55209. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  55210. * @returns a promsie that resolves when the operation is complete
  55211. */
  55212. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  55213. /**
  55214. * Clones the raw cube texture.
  55215. * @return a new cube texture
  55216. */
  55217. clone(): CubeTexture;
  55218. /** @hidden */
  55219. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  55220. }
  55221. }
  55222. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  55223. import { Scene } from "babylonjs/scene";
  55224. import { Texture } from "babylonjs/Materials/Textures/texture";
  55225. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55226. /**
  55227. * Class used to store 3D textures containing user data
  55228. */
  55229. export class RawTexture3D extends Texture {
  55230. /** Gets or sets the texture format to use */
  55231. format: number;
  55232. private _engine;
  55233. /**
  55234. * Create a new RawTexture3D
  55235. * @param data defines the data of the texture
  55236. * @param width defines the width of the texture
  55237. * @param height defines the height of the texture
  55238. * @param depth defines the depth of the texture
  55239. * @param format defines the texture format to use
  55240. * @param scene defines the hosting scene
  55241. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  55242. * @param invertY defines if texture must be stored with Y axis inverted
  55243. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  55244. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  55245. */
  55246. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  55247. /** Gets or sets the texture format to use */
  55248. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  55249. /**
  55250. * Update the texture with new data
  55251. * @param data defines the data to store in the texture
  55252. */
  55253. update(data: ArrayBufferView): void;
  55254. }
  55255. }
  55256. declare module "babylonjs/Materials/Textures/refractionTexture" {
  55257. import { Scene } from "babylonjs/scene";
  55258. import { Plane } from "babylonjs/Maths/math.plane";
  55259. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  55260. /**
  55261. * Creates a refraction texture used by refraction channel of the standard material.
  55262. * It is like a mirror but to see through a material.
  55263. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55264. */
  55265. export class RefractionTexture extends RenderTargetTexture {
  55266. /**
  55267. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  55268. * 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.
  55269. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55270. */
  55271. refractionPlane: Plane;
  55272. /**
  55273. * Define how deep under the surface we should see.
  55274. */
  55275. depth: number;
  55276. /**
  55277. * Creates a refraction texture used by refraction channel of the standard material.
  55278. * It is like a mirror but to see through a material.
  55279. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55280. * @param name Define the texture name
  55281. * @param size Define the size of the underlying texture
  55282. * @param scene Define the scene the refraction belongs to
  55283. * @param generateMipMaps Define if we need to generate mips level for the refraction
  55284. */
  55285. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  55286. /**
  55287. * Clone the refraction texture.
  55288. * @returns the cloned texture
  55289. */
  55290. clone(): RefractionTexture;
  55291. /**
  55292. * Serialize the texture to a JSON representation you could use in Parse later on
  55293. * @returns the serialized JSON representation
  55294. */
  55295. serialize(): any;
  55296. }
  55297. }
  55298. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  55299. import { Nullable } from "babylonjs/types";
  55300. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55301. import { Matrix } from "babylonjs/Maths/math.vector";
  55302. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  55303. import "babylonjs/Engines/Extensions/engine.videoTexture";
  55304. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  55305. import { Scene } from "babylonjs/scene";
  55306. /**
  55307. * Defines the options related to the creation of an HtmlElementTexture
  55308. */
  55309. export interface IHtmlElementTextureOptions {
  55310. /**
  55311. * Defines wether mip maps should be created or not.
  55312. */
  55313. generateMipMaps?: boolean;
  55314. /**
  55315. * Defines the sampling mode of the texture.
  55316. */
  55317. samplingMode?: number;
  55318. /**
  55319. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  55320. */
  55321. engine: Nullable<ThinEngine>;
  55322. /**
  55323. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  55324. */
  55325. scene: Nullable<Scene>;
  55326. }
  55327. /**
  55328. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  55329. * To be as efficient as possible depending on your constraints nothing aside the first upload
  55330. * is automatically managed.
  55331. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  55332. * in your application.
  55333. *
  55334. * As the update is not automatic, you need to call them manually.
  55335. */
  55336. export class HtmlElementTexture extends BaseTexture {
  55337. /**
  55338. * The texture URL.
  55339. */
  55340. element: HTMLVideoElement | HTMLCanvasElement;
  55341. private static readonly DefaultOptions;
  55342. private _textureMatrix;
  55343. private _engine;
  55344. private _isVideo;
  55345. private _generateMipMaps;
  55346. private _samplingMode;
  55347. /**
  55348. * Instantiates a HtmlElementTexture from the following parameters.
  55349. *
  55350. * @param name Defines the name of the texture
  55351. * @param element Defines the video or canvas the texture is filled with
  55352. * @param options Defines the other none mandatory texture creation options
  55353. */
  55354. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  55355. private _createInternalTexture;
  55356. /**
  55357. * Returns the texture matrix used in most of the material.
  55358. */
  55359. getTextureMatrix(): Matrix;
  55360. /**
  55361. * Updates the content of the texture.
  55362. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  55363. */
  55364. update(invertY?: Nullable<boolean>): void;
  55365. }
  55366. }
  55367. declare module "babylonjs/Materials/Textures/index" {
  55368. export * from "babylonjs/Materials/Textures/baseTexture";
  55369. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  55370. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  55371. export * from "babylonjs/Materials/Textures/cubeTexture";
  55372. export * from "babylonjs/Materials/Textures/dynamicTexture";
  55373. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  55374. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  55375. export * from "babylonjs/Materials/Textures/internalTexture";
  55376. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  55377. export * from "babylonjs/Materials/Textures/Loaders/index";
  55378. export * from "babylonjs/Materials/Textures/mirrorTexture";
  55379. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  55380. export * from "babylonjs/Materials/Textures/Procedurals/index";
  55381. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  55382. export * from "babylonjs/Materials/Textures/rawTexture";
  55383. export * from "babylonjs/Materials/Textures/rawTexture3D";
  55384. export * from "babylonjs/Materials/Textures/refractionTexture";
  55385. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  55386. export * from "babylonjs/Materials/Textures/texture";
  55387. export * from "babylonjs/Materials/Textures/videoTexture";
  55388. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  55389. }
  55390. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  55391. /**
  55392. * Enum used to define the target of a block
  55393. */
  55394. export enum NodeMaterialBlockTargets {
  55395. /** Vertex shader */
  55396. Vertex = 1,
  55397. /** Fragment shader */
  55398. Fragment = 2,
  55399. /** Neutral */
  55400. Neutral = 4,
  55401. /** Vertex and Fragment */
  55402. VertexAndFragment = 3
  55403. }
  55404. }
  55405. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  55406. /**
  55407. * Defines the kind of connection point for node based material
  55408. */
  55409. export enum NodeMaterialBlockConnectionPointTypes {
  55410. /** Float */
  55411. Float = 1,
  55412. /** Int */
  55413. Int = 2,
  55414. /** Vector2 */
  55415. Vector2 = 4,
  55416. /** Vector3 */
  55417. Vector3 = 8,
  55418. /** Vector4 */
  55419. Vector4 = 16,
  55420. /** Color3 */
  55421. Color3 = 32,
  55422. /** Color4 */
  55423. Color4 = 64,
  55424. /** Matrix */
  55425. Matrix = 128,
  55426. /** Detect type based on connection */
  55427. AutoDetect = 1024,
  55428. /** Output type that will be defined by input type */
  55429. BasedOnInput = 2048
  55430. }
  55431. }
  55432. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  55433. /**
  55434. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  55435. */
  55436. export enum NodeMaterialBlockConnectionPointMode {
  55437. /** Value is an uniform */
  55438. Uniform = 0,
  55439. /** Value is a mesh attribute */
  55440. Attribute = 1,
  55441. /** Value is a varying between vertex and fragment shaders */
  55442. Varying = 2,
  55443. /** Mode is undefined */
  55444. Undefined = 3
  55445. }
  55446. }
  55447. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  55448. /**
  55449. * Enum used to define system values e.g. values automatically provided by the system
  55450. */
  55451. export enum NodeMaterialSystemValues {
  55452. /** World */
  55453. World = 1,
  55454. /** View */
  55455. View = 2,
  55456. /** Projection */
  55457. Projection = 3,
  55458. /** ViewProjection */
  55459. ViewProjection = 4,
  55460. /** WorldView */
  55461. WorldView = 5,
  55462. /** WorldViewProjection */
  55463. WorldViewProjection = 6,
  55464. /** CameraPosition */
  55465. CameraPosition = 7,
  55466. /** Fog Color */
  55467. FogColor = 8,
  55468. /** Delta time */
  55469. DeltaTime = 9
  55470. }
  55471. }
  55472. declare module "babylonjs/Materials/Node/Enums/index" {
  55473. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  55474. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  55475. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  55476. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  55477. }
  55478. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  55479. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55480. /**
  55481. * Root class for all node material optimizers
  55482. */
  55483. export class NodeMaterialOptimizer {
  55484. /**
  55485. * Function used to optimize a NodeMaterial graph
  55486. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  55487. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  55488. */
  55489. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  55490. }
  55491. }
  55492. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  55493. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55494. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55495. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55496. import { Scene } from "babylonjs/scene";
  55497. /**
  55498. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  55499. */
  55500. export class TransformBlock extends NodeMaterialBlock {
  55501. /**
  55502. * Defines the value to use to complement W value to transform it to a Vector4
  55503. */
  55504. complementW: number;
  55505. /**
  55506. * Defines the value to use to complement z value to transform it to a Vector4
  55507. */
  55508. complementZ: number;
  55509. /**
  55510. * Creates a new TransformBlock
  55511. * @param name defines the block name
  55512. */
  55513. constructor(name: string);
  55514. /**
  55515. * Gets the current class name
  55516. * @returns the class name
  55517. */
  55518. getClassName(): string;
  55519. /**
  55520. * Gets the vector input
  55521. */
  55522. readonly vector: NodeMaterialConnectionPoint;
  55523. /**
  55524. * Gets the output component
  55525. */
  55526. readonly output: NodeMaterialConnectionPoint;
  55527. /**
  55528. * Gets the matrix transform input
  55529. */
  55530. readonly transform: NodeMaterialConnectionPoint;
  55531. protected _buildBlock(state: NodeMaterialBuildState): this;
  55532. serialize(): any;
  55533. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55534. protected _dumpPropertiesCode(): string;
  55535. }
  55536. }
  55537. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  55538. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55539. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55540. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55541. /**
  55542. * Block used to output the vertex position
  55543. */
  55544. export class VertexOutputBlock extends NodeMaterialBlock {
  55545. /**
  55546. * Creates a new VertexOutputBlock
  55547. * @param name defines the block name
  55548. */
  55549. constructor(name: string);
  55550. /**
  55551. * Gets the current class name
  55552. * @returns the class name
  55553. */
  55554. getClassName(): string;
  55555. /**
  55556. * Gets the vector input component
  55557. */
  55558. readonly vector: NodeMaterialConnectionPoint;
  55559. protected _buildBlock(state: NodeMaterialBuildState): this;
  55560. }
  55561. }
  55562. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  55563. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55564. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55565. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55566. /**
  55567. * Block used to output the final color
  55568. */
  55569. export class FragmentOutputBlock extends NodeMaterialBlock {
  55570. /**
  55571. * Create a new FragmentOutputBlock
  55572. * @param name defines the block name
  55573. */
  55574. constructor(name: string);
  55575. /**
  55576. * Gets the current class name
  55577. * @returns the class name
  55578. */
  55579. getClassName(): string;
  55580. /**
  55581. * Gets the rgba input component
  55582. */
  55583. readonly rgba: NodeMaterialConnectionPoint;
  55584. /**
  55585. * Gets the rgb input component
  55586. */
  55587. readonly rgb: NodeMaterialConnectionPoint;
  55588. /**
  55589. * Gets the a input component
  55590. */
  55591. readonly a: NodeMaterialConnectionPoint;
  55592. protected _buildBlock(state: NodeMaterialBuildState): this;
  55593. }
  55594. }
  55595. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  55596. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55597. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55598. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55599. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55600. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55601. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55602. import { Effect } from "babylonjs/Materials/effect";
  55603. import { Mesh } from "babylonjs/Meshes/mesh";
  55604. import { Nullable } from "babylonjs/types";
  55605. import { Scene } from "babylonjs/scene";
  55606. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  55607. /**
  55608. * Block used to read a reflection texture from a sampler
  55609. */
  55610. export class ReflectionTextureBlock extends NodeMaterialBlock {
  55611. private _define3DName;
  55612. private _defineCubicName;
  55613. private _defineExplicitName;
  55614. private _defineProjectionName;
  55615. private _defineLocalCubicName;
  55616. private _defineSphericalName;
  55617. private _definePlanarName;
  55618. private _defineEquirectangularName;
  55619. private _defineMirroredEquirectangularFixedName;
  55620. private _defineEquirectangularFixedName;
  55621. private _defineSkyboxName;
  55622. private _cubeSamplerName;
  55623. private _2DSamplerName;
  55624. private _positionUVWName;
  55625. private _directionWName;
  55626. private _reflectionCoordsName;
  55627. private _reflection2DCoordsName;
  55628. private _reflectionColorName;
  55629. private _reflectionMatrixName;
  55630. /**
  55631. * Gets or sets the texture associated with the node
  55632. */
  55633. texture: Nullable<BaseTexture>;
  55634. /**
  55635. * Create a new TextureBlock
  55636. * @param name defines the block name
  55637. */
  55638. constructor(name: string);
  55639. /**
  55640. * Gets the current class name
  55641. * @returns the class name
  55642. */
  55643. getClassName(): string;
  55644. /**
  55645. * Gets the world position input component
  55646. */
  55647. readonly position: NodeMaterialConnectionPoint;
  55648. /**
  55649. * Gets the world position input component
  55650. */
  55651. readonly worldPosition: NodeMaterialConnectionPoint;
  55652. /**
  55653. * Gets the world normal input component
  55654. */
  55655. readonly worldNormal: NodeMaterialConnectionPoint;
  55656. /**
  55657. * Gets the world input component
  55658. */
  55659. readonly world: NodeMaterialConnectionPoint;
  55660. /**
  55661. * Gets the camera (or eye) position component
  55662. */
  55663. readonly cameraPosition: NodeMaterialConnectionPoint;
  55664. /**
  55665. * Gets the view input component
  55666. */
  55667. readonly view: NodeMaterialConnectionPoint;
  55668. /**
  55669. * Gets the rgb output component
  55670. */
  55671. readonly rgb: NodeMaterialConnectionPoint;
  55672. /**
  55673. * Gets the r output component
  55674. */
  55675. readonly r: NodeMaterialConnectionPoint;
  55676. /**
  55677. * Gets the g output component
  55678. */
  55679. readonly g: NodeMaterialConnectionPoint;
  55680. /**
  55681. * Gets the b output component
  55682. */
  55683. readonly b: NodeMaterialConnectionPoint;
  55684. autoConfigure(material: NodeMaterial): void;
  55685. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55686. isReady(): boolean;
  55687. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55688. private _injectVertexCode;
  55689. private _writeOutput;
  55690. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  55691. protected _dumpPropertiesCode(): string;
  55692. serialize(): any;
  55693. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55694. }
  55695. }
  55696. declare module "babylonjs/Materials/Node/nodeMaterial" {
  55697. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55698. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  55699. import { Scene } from "babylonjs/scene";
  55700. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55701. import { Matrix } from "babylonjs/Maths/math.vector";
  55702. import { Mesh } from "babylonjs/Meshes/mesh";
  55703. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55704. import { Observable } from "babylonjs/Misc/observable";
  55705. import { SubMesh } from "babylonjs/Meshes/subMesh";
  55706. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  55707. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  55708. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  55709. import { Nullable } from "babylonjs/types";
  55710. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  55711. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  55712. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  55713. /**
  55714. * Interface used to configure the node material editor
  55715. */
  55716. export interface INodeMaterialEditorOptions {
  55717. /** Define the URl to load node editor script */
  55718. editorURL?: string;
  55719. }
  55720. /** @hidden */
  55721. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  55722. /** BONES */
  55723. NUM_BONE_INFLUENCERS: number;
  55724. BonesPerMesh: number;
  55725. BONETEXTURE: boolean;
  55726. /** MORPH TARGETS */
  55727. MORPHTARGETS: boolean;
  55728. MORPHTARGETS_NORMAL: boolean;
  55729. MORPHTARGETS_TANGENT: boolean;
  55730. MORPHTARGETS_UV: boolean;
  55731. NUM_MORPH_INFLUENCERS: number;
  55732. /** IMAGE PROCESSING */
  55733. IMAGEPROCESSING: boolean;
  55734. VIGNETTE: boolean;
  55735. VIGNETTEBLENDMODEMULTIPLY: boolean;
  55736. VIGNETTEBLENDMODEOPAQUE: boolean;
  55737. TONEMAPPING: boolean;
  55738. TONEMAPPING_ACES: boolean;
  55739. CONTRAST: boolean;
  55740. EXPOSURE: boolean;
  55741. COLORCURVES: boolean;
  55742. COLORGRADING: boolean;
  55743. COLORGRADING3D: boolean;
  55744. SAMPLER3DGREENDEPTH: boolean;
  55745. SAMPLER3DBGRMAP: boolean;
  55746. IMAGEPROCESSINGPOSTPROCESS: boolean;
  55747. /** MISC. */
  55748. BUMPDIRECTUV: number;
  55749. constructor();
  55750. setValue(name: string, value: boolean): void;
  55751. }
  55752. /**
  55753. * Class used to configure NodeMaterial
  55754. */
  55755. export interface INodeMaterialOptions {
  55756. /**
  55757. * Defines if blocks should emit comments
  55758. */
  55759. emitComments: boolean;
  55760. }
  55761. /**
  55762. * Class used to create a node based material built by assembling shader blocks
  55763. */
  55764. export class NodeMaterial extends PushMaterial {
  55765. private static _BuildIdGenerator;
  55766. private _options;
  55767. private _vertexCompilationState;
  55768. private _fragmentCompilationState;
  55769. private _sharedData;
  55770. private _buildId;
  55771. private _buildWasSuccessful;
  55772. private _cachedWorldViewMatrix;
  55773. private _cachedWorldViewProjectionMatrix;
  55774. private _optimizers;
  55775. private _animationFrame;
  55776. /** Define the URl to load node editor script */
  55777. static EditorURL: string;
  55778. private BJSNODEMATERIALEDITOR;
  55779. /** Get the inspector from bundle or global */
  55780. private _getGlobalNodeMaterialEditor;
  55781. /**
  55782. * 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)
  55783. */
  55784. ignoreAlpha: boolean;
  55785. /**
  55786. * Defines the maximum number of lights that can be used in the material
  55787. */
  55788. maxSimultaneousLights: number;
  55789. /**
  55790. * Observable raised when the material is built
  55791. */
  55792. onBuildObservable: Observable<NodeMaterial>;
  55793. /**
  55794. * Gets or sets the root nodes of the material vertex shader
  55795. */
  55796. _vertexOutputNodes: NodeMaterialBlock[];
  55797. /**
  55798. * Gets or sets the root nodes of the material fragment (pixel) shader
  55799. */
  55800. _fragmentOutputNodes: NodeMaterialBlock[];
  55801. /** Gets or sets options to control the node material overall behavior */
  55802. options: INodeMaterialOptions;
  55803. /**
  55804. * Default configuration related to image processing available in the standard Material.
  55805. */
  55806. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  55807. /**
  55808. * Gets the image processing configuration used either in this material.
  55809. */
  55810. /**
  55811. * Sets the Default image processing configuration used either in the this material.
  55812. *
  55813. * If sets to null, the scene one is in use.
  55814. */
  55815. imageProcessingConfiguration: ImageProcessingConfiguration;
  55816. /**
  55817. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  55818. */
  55819. attachedBlocks: NodeMaterialBlock[];
  55820. /**
  55821. * Create a new node based material
  55822. * @param name defines the material name
  55823. * @param scene defines the hosting scene
  55824. * @param options defines creation option
  55825. */
  55826. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  55827. /**
  55828. * Gets the current class name of the material e.g. "NodeMaterial"
  55829. * @returns the class name
  55830. */
  55831. getClassName(): string;
  55832. /**
  55833. * Keep track of the image processing observer to allow dispose and replace.
  55834. */
  55835. private _imageProcessingObserver;
  55836. /**
  55837. * Attaches a new image processing configuration to the Standard Material.
  55838. * @param configuration
  55839. */
  55840. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  55841. /**
  55842. * Get a block by its name
  55843. * @param name defines the name of the block to retrieve
  55844. * @returns the required block or null if not found
  55845. */
  55846. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  55847. /**
  55848. * Get a block by its name
  55849. * @param predicate defines the predicate used to find the good candidate
  55850. * @returns the required block or null if not found
  55851. */
  55852. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  55853. /**
  55854. * Get an input block by its name
  55855. * @param predicate defines the predicate used to find the good candidate
  55856. * @returns the required input block or null if not found
  55857. */
  55858. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  55859. /**
  55860. * Gets the list of input blocks attached to this material
  55861. * @returns an array of InputBlocks
  55862. */
  55863. getInputBlocks(): InputBlock[];
  55864. /**
  55865. * Adds a new optimizer to the list of optimizers
  55866. * @param optimizer defines the optimizers to add
  55867. * @returns the current material
  55868. */
  55869. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  55870. /**
  55871. * Remove an optimizer from the list of optimizers
  55872. * @param optimizer defines the optimizers to remove
  55873. * @returns the current material
  55874. */
  55875. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  55876. /**
  55877. * Add a new block to the list of output nodes
  55878. * @param node defines the node to add
  55879. * @returns the current material
  55880. */
  55881. addOutputNode(node: NodeMaterialBlock): this;
  55882. /**
  55883. * Remove a block from the list of root nodes
  55884. * @param node defines the node to remove
  55885. * @returns the current material
  55886. */
  55887. removeOutputNode(node: NodeMaterialBlock): this;
  55888. private _addVertexOutputNode;
  55889. private _removeVertexOutputNode;
  55890. private _addFragmentOutputNode;
  55891. private _removeFragmentOutputNode;
  55892. /**
  55893. * Specifies if the material will require alpha blending
  55894. * @returns a boolean specifying if alpha blending is needed
  55895. */
  55896. needAlphaBlending(): boolean;
  55897. /**
  55898. * Specifies if this material should be rendered in alpha test mode
  55899. * @returns a boolean specifying if an alpha test is needed.
  55900. */
  55901. needAlphaTesting(): boolean;
  55902. private _initializeBlock;
  55903. private _resetDualBlocks;
  55904. /**
  55905. * Build the material and generates the inner effect
  55906. * @param verbose defines if the build should log activity
  55907. */
  55908. build(verbose?: boolean): void;
  55909. /**
  55910. * Runs an otpimization phase to try to improve the shader code
  55911. */
  55912. optimize(): void;
  55913. private _prepareDefinesForAttributes;
  55914. /**
  55915. * Get if the submesh is ready to be used and all its information available.
  55916. * Child classes can use it to update shaders
  55917. * @param mesh defines the mesh to check
  55918. * @param subMesh defines which submesh to check
  55919. * @param useInstances specifies that instances should be used
  55920. * @returns a boolean indicating that the submesh is ready or not
  55921. */
  55922. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  55923. /**
  55924. * Get a string representing the shaders built by the current node graph
  55925. */
  55926. readonly compiledShaders: string;
  55927. /**
  55928. * Binds the world matrix to the material
  55929. * @param world defines the world transformation matrix
  55930. */
  55931. bindOnlyWorldMatrix(world: Matrix): void;
  55932. /**
  55933. * Binds the submesh to this material by preparing the effect and shader to draw
  55934. * @param world defines the world transformation matrix
  55935. * @param mesh defines the mesh containing the submesh
  55936. * @param subMesh defines the submesh to bind the material to
  55937. */
  55938. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  55939. /**
  55940. * Gets the active textures from the material
  55941. * @returns an array of textures
  55942. */
  55943. getActiveTextures(): BaseTexture[];
  55944. /**
  55945. * Gets the list of texture blocks
  55946. * @returns an array of texture blocks
  55947. */
  55948. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  55949. /**
  55950. * Specifies if the material uses a texture
  55951. * @param texture defines the texture to check against the material
  55952. * @returns a boolean specifying if the material uses the texture
  55953. */
  55954. hasTexture(texture: BaseTexture): boolean;
  55955. /**
  55956. * Disposes the material
  55957. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  55958. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  55959. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  55960. */
  55961. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  55962. /** Creates the node editor window. */
  55963. private _createNodeEditor;
  55964. /**
  55965. * Launch the node material editor
  55966. * @param config Define the configuration of the editor
  55967. * @return a promise fulfilled when the node editor is visible
  55968. */
  55969. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  55970. /**
  55971. * Clear the current material
  55972. */
  55973. clear(): void;
  55974. /**
  55975. * Clear the current material and set it to a default state
  55976. */
  55977. setToDefault(): void;
  55978. /**
  55979. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  55980. * @param url defines the url to load from
  55981. * @returns a promise that will fullfil when the material is fully loaded
  55982. */
  55983. loadAsync(url: string): Promise<void>;
  55984. private _gatherBlocks;
  55985. /**
  55986. * Generate a string containing the code declaration required to create an equivalent of this material
  55987. * @returns a string
  55988. */
  55989. generateCode(): string;
  55990. /**
  55991. * Serializes this material in a JSON representation
  55992. * @returns the serialized material object
  55993. */
  55994. serialize(): any;
  55995. private _restoreConnections;
  55996. /**
  55997. * Clear the current graph and load a new one from a serialization object
  55998. * @param source defines the JSON representation of the material
  55999. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56000. */
  56001. loadFromSerialization(source: any, rootUrl?: string): void;
  56002. /**
  56003. * Creates a node material from parsed material data
  56004. * @param source defines the JSON representation of the material
  56005. * @param scene defines the hosting scene
  56006. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56007. * @returns a new node material
  56008. */
  56009. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  56010. /**
  56011. * Creates a new node material set to default basic configuration
  56012. * @param name defines the name of the material
  56013. * @param scene defines the hosting scene
  56014. * @returns a new NodeMaterial
  56015. */
  56016. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  56017. }
  56018. }
  56019. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  56020. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56021. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56022. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56023. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56024. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56025. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56026. import { Effect } from "babylonjs/Materials/effect";
  56027. import { Mesh } from "babylonjs/Meshes/mesh";
  56028. import { Nullable } from "babylonjs/types";
  56029. import { Texture } from "babylonjs/Materials/Textures/texture";
  56030. import { Scene } from "babylonjs/scene";
  56031. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56032. /**
  56033. * Block used to read a texture from a sampler
  56034. */
  56035. export class TextureBlock extends NodeMaterialBlock {
  56036. private _defineName;
  56037. private _linearDefineName;
  56038. private _samplerName;
  56039. private _transformedUVName;
  56040. private _textureTransformName;
  56041. private _textureInfoName;
  56042. private _mainUVName;
  56043. private _mainUVDefineName;
  56044. /**
  56045. * Gets or sets the texture associated with the node
  56046. */
  56047. texture: Nullable<Texture>;
  56048. /**
  56049. * Create a new TextureBlock
  56050. * @param name defines the block name
  56051. */
  56052. constructor(name: string);
  56053. /**
  56054. * Gets the current class name
  56055. * @returns the class name
  56056. */
  56057. getClassName(): string;
  56058. /**
  56059. * Gets the uv input component
  56060. */
  56061. readonly uv: NodeMaterialConnectionPoint;
  56062. /**
  56063. * Gets the rgba output component
  56064. */
  56065. readonly rgba: NodeMaterialConnectionPoint;
  56066. /**
  56067. * Gets the rgb output component
  56068. */
  56069. readonly rgb: NodeMaterialConnectionPoint;
  56070. /**
  56071. * Gets the r output component
  56072. */
  56073. readonly r: NodeMaterialConnectionPoint;
  56074. /**
  56075. * Gets the g output component
  56076. */
  56077. readonly g: NodeMaterialConnectionPoint;
  56078. /**
  56079. * Gets the b output component
  56080. */
  56081. readonly b: NodeMaterialConnectionPoint;
  56082. /**
  56083. * Gets the a output component
  56084. */
  56085. readonly a: NodeMaterialConnectionPoint;
  56086. readonly target: NodeMaterialBlockTargets;
  56087. autoConfigure(material: NodeMaterial): void;
  56088. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56089. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56090. isReady(): boolean;
  56091. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56092. private readonly _isMixed;
  56093. private _injectVertexCode;
  56094. private _writeOutput;
  56095. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  56096. protected _dumpPropertiesCode(): string;
  56097. serialize(): any;
  56098. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56099. }
  56100. }
  56101. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  56102. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56103. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56104. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  56105. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  56106. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  56107. import { Scene } from "babylonjs/scene";
  56108. /**
  56109. * Class used to store shared data between 2 NodeMaterialBuildState
  56110. */
  56111. export class NodeMaterialBuildStateSharedData {
  56112. /**
  56113. * Gets the list of emitted varyings
  56114. */
  56115. temps: string[];
  56116. /**
  56117. * Gets the list of emitted varyings
  56118. */
  56119. varyings: string[];
  56120. /**
  56121. * Gets the varying declaration string
  56122. */
  56123. varyingDeclaration: string;
  56124. /**
  56125. * Input blocks
  56126. */
  56127. inputBlocks: InputBlock[];
  56128. /**
  56129. * Input blocks
  56130. */
  56131. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  56132. /**
  56133. * Bindable blocks (Blocks that need to set data to the effect)
  56134. */
  56135. bindableBlocks: NodeMaterialBlock[];
  56136. /**
  56137. * List of blocks that can provide a compilation fallback
  56138. */
  56139. blocksWithFallbacks: NodeMaterialBlock[];
  56140. /**
  56141. * List of blocks that can provide a define update
  56142. */
  56143. blocksWithDefines: NodeMaterialBlock[];
  56144. /**
  56145. * List of blocks that can provide a repeatable content
  56146. */
  56147. repeatableContentBlocks: NodeMaterialBlock[];
  56148. /**
  56149. * List of blocks that can provide a dynamic list of uniforms
  56150. */
  56151. dynamicUniformBlocks: NodeMaterialBlock[];
  56152. /**
  56153. * List of blocks that can block the isReady function for the material
  56154. */
  56155. blockingBlocks: NodeMaterialBlock[];
  56156. /**
  56157. * Gets the list of animated inputs
  56158. */
  56159. animatedInputs: InputBlock[];
  56160. /**
  56161. * Build Id used to avoid multiple recompilations
  56162. */
  56163. buildId: number;
  56164. /** List of emitted variables */
  56165. variableNames: {
  56166. [key: string]: number;
  56167. };
  56168. /** List of emitted defines */
  56169. defineNames: {
  56170. [key: string]: number;
  56171. };
  56172. /** Should emit comments? */
  56173. emitComments: boolean;
  56174. /** Emit build activity */
  56175. verbose: boolean;
  56176. /** Gets or sets the hosting scene */
  56177. scene: Scene;
  56178. /**
  56179. * Gets the compilation hints emitted at compilation time
  56180. */
  56181. hints: {
  56182. needWorldViewMatrix: boolean;
  56183. needWorldViewProjectionMatrix: boolean;
  56184. needAlphaBlending: boolean;
  56185. needAlphaTesting: boolean;
  56186. };
  56187. /**
  56188. * List of compilation checks
  56189. */
  56190. checks: {
  56191. emitVertex: boolean;
  56192. emitFragment: boolean;
  56193. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  56194. };
  56195. /** Creates a new shared data */
  56196. constructor();
  56197. /**
  56198. * Emits console errors and exceptions if there is a failing check
  56199. */
  56200. emitErrors(): void;
  56201. }
  56202. }
  56203. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  56204. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56205. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56206. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  56207. /**
  56208. * Class used to store node based material build state
  56209. */
  56210. export class NodeMaterialBuildState {
  56211. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  56212. supportUniformBuffers: boolean;
  56213. /**
  56214. * Gets the list of emitted attributes
  56215. */
  56216. attributes: string[];
  56217. /**
  56218. * Gets the list of emitted uniforms
  56219. */
  56220. uniforms: string[];
  56221. /**
  56222. * Gets the list of emitted constants
  56223. */
  56224. constants: string[];
  56225. /**
  56226. * Gets the list of emitted samplers
  56227. */
  56228. samplers: string[];
  56229. /**
  56230. * Gets the list of emitted functions
  56231. */
  56232. functions: {
  56233. [key: string]: string;
  56234. };
  56235. /**
  56236. * Gets the list of emitted extensions
  56237. */
  56238. extensions: {
  56239. [key: string]: string;
  56240. };
  56241. /**
  56242. * Gets the target of the compilation state
  56243. */
  56244. target: NodeMaterialBlockTargets;
  56245. /**
  56246. * Gets the list of emitted counters
  56247. */
  56248. counters: {
  56249. [key: string]: number;
  56250. };
  56251. /**
  56252. * Shared data between multiple NodeMaterialBuildState instances
  56253. */
  56254. sharedData: NodeMaterialBuildStateSharedData;
  56255. /** @hidden */
  56256. _vertexState: NodeMaterialBuildState;
  56257. /** @hidden */
  56258. _attributeDeclaration: string;
  56259. /** @hidden */
  56260. _uniformDeclaration: string;
  56261. /** @hidden */
  56262. _constantDeclaration: string;
  56263. /** @hidden */
  56264. _samplerDeclaration: string;
  56265. /** @hidden */
  56266. _varyingTransfer: string;
  56267. private _repeatableContentAnchorIndex;
  56268. /** @hidden */
  56269. _builtCompilationString: string;
  56270. /**
  56271. * Gets the emitted compilation strings
  56272. */
  56273. compilationString: string;
  56274. /**
  56275. * Finalize the compilation strings
  56276. * @param state defines the current compilation state
  56277. */
  56278. finalize(state: NodeMaterialBuildState): void;
  56279. /** @hidden */
  56280. readonly _repeatableContentAnchor: string;
  56281. /** @hidden */
  56282. _getFreeVariableName(prefix: string): string;
  56283. /** @hidden */
  56284. _getFreeDefineName(prefix: string): string;
  56285. /** @hidden */
  56286. _excludeVariableName(name: string): void;
  56287. /** @hidden */
  56288. _emit2DSampler(name: string): void;
  56289. /** @hidden */
  56290. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  56291. /** @hidden */
  56292. _emitExtension(name: string, extension: string): void;
  56293. /** @hidden */
  56294. _emitFunction(name: string, code: string, comments: string): void;
  56295. /** @hidden */
  56296. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  56297. replaceStrings?: {
  56298. search: RegExp;
  56299. replace: string;
  56300. }[];
  56301. repeatKey?: string;
  56302. }): string;
  56303. /** @hidden */
  56304. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  56305. repeatKey?: string;
  56306. removeAttributes?: boolean;
  56307. removeUniforms?: boolean;
  56308. removeVaryings?: boolean;
  56309. removeIfDef?: boolean;
  56310. replaceStrings?: {
  56311. search: RegExp;
  56312. replace: string;
  56313. }[];
  56314. }, storeKey?: string): void;
  56315. /** @hidden */
  56316. _registerTempVariable(name: string): boolean;
  56317. /** @hidden */
  56318. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  56319. /** @hidden */
  56320. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  56321. /** @hidden */
  56322. _emitFloat(value: number): string;
  56323. }
  56324. }
  56325. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  56326. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56327. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56328. import { Nullable } from "babylonjs/types";
  56329. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56330. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56331. import { Effect } from "babylonjs/Materials/effect";
  56332. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56333. import { Mesh } from "babylonjs/Meshes/mesh";
  56334. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56335. import { Scene } from "babylonjs/scene";
  56336. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56337. /**
  56338. * Defines a block that can be used inside a node based material
  56339. */
  56340. export class NodeMaterialBlock {
  56341. private _buildId;
  56342. private _buildTarget;
  56343. private _target;
  56344. private _isFinalMerger;
  56345. private _isInput;
  56346. /** @hidden */
  56347. _codeVariableName: string;
  56348. /** @hidden */
  56349. _inputs: NodeMaterialConnectionPoint[];
  56350. /** @hidden */
  56351. _outputs: NodeMaterialConnectionPoint[];
  56352. /** @hidden */
  56353. _preparationId: number;
  56354. /**
  56355. * Gets or sets the name of the block
  56356. */
  56357. name: string;
  56358. /**
  56359. * Gets or sets the unique id of the node
  56360. */
  56361. uniqueId: number;
  56362. /**
  56363. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  56364. */
  56365. readonly isFinalMerger: boolean;
  56366. /**
  56367. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  56368. */
  56369. readonly isInput: boolean;
  56370. /**
  56371. * Gets or sets the build Id
  56372. */
  56373. buildId: number;
  56374. /**
  56375. * Gets or sets the target of the block
  56376. */
  56377. target: NodeMaterialBlockTargets;
  56378. /**
  56379. * Gets the list of input points
  56380. */
  56381. readonly inputs: NodeMaterialConnectionPoint[];
  56382. /** Gets the list of output points */
  56383. readonly outputs: NodeMaterialConnectionPoint[];
  56384. /**
  56385. * Find an input by its name
  56386. * @param name defines the name of the input to look for
  56387. * @returns the input or null if not found
  56388. */
  56389. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  56390. /**
  56391. * Find an output by its name
  56392. * @param name defines the name of the outputto look for
  56393. * @returns the output or null if not found
  56394. */
  56395. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  56396. /**
  56397. * Creates a new NodeMaterialBlock
  56398. * @param name defines the block name
  56399. * @param target defines the target of that block (Vertex by default)
  56400. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  56401. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  56402. */
  56403. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  56404. /**
  56405. * Initialize the block and prepare the context for build
  56406. * @param state defines the state that will be used for the build
  56407. */
  56408. initialize(state: NodeMaterialBuildState): void;
  56409. /**
  56410. * Bind data to effect. Will only be called for blocks with isBindable === true
  56411. * @param effect defines the effect to bind data to
  56412. * @param nodeMaterial defines the hosting NodeMaterial
  56413. * @param mesh defines the mesh that will be rendered
  56414. */
  56415. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56416. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  56417. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  56418. protected _writeFloat(value: number): string;
  56419. /**
  56420. * Gets the current class name e.g. "NodeMaterialBlock"
  56421. * @returns the class name
  56422. */
  56423. getClassName(): string;
  56424. /**
  56425. * Register a new input. Must be called inside a block constructor
  56426. * @param name defines the connection point name
  56427. * @param type defines the connection point type
  56428. * @param isOptional defines a boolean indicating that this input can be omitted
  56429. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  56430. * @returns the current block
  56431. */
  56432. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  56433. /**
  56434. * Register a new output. Must be called inside a block constructor
  56435. * @param name defines the connection point name
  56436. * @param type defines the connection point type
  56437. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  56438. * @returns the current block
  56439. */
  56440. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  56441. /**
  56442. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  56443. * @param forOutput defines an optional connection point to check compatibility with
  56444. * @returns the first available input or null
  56445. */
  56446. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  56447. /**
  56448. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  56449. * @param forBlock defines an optional block to check compatibility with
  56450. * @returns the first available input or null
  56451. */
  56452. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  56453. /**
  56454. * Gets the sibling of the given output
  56455. * @param current defines the current output
  56456. * @returns the next output in the list or null
  56457. */
  56458. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  56459. /**
  56460. * Connect current block with another block
  56461. * @param other defines the block to connect with
  56462. * @param options define the various options to help pick the right connections
  56463. * @returns the current block
  56464. */
  56465. connectTo(other: NodeMaterialBlock, options?: {
  56466. input?: string;
  56467. output?: string;
  56468. outputSwizzle?: string;
  56469. }): this | undefined;
  56470. protected _buildBlock(state: NodeMaterialBuildState): void;
  56471. /**
  56472. * Add uniforms, samplers and uniform buffers at compilation time
  56473. * @param state defines the state to update
  56474. * @param nodeMaterial defines the node material requesting the update
  56475. * @param defines defines the material defines to update
  56476. * @param uniformBuffers defines the list of uniform buffer names
  56477. */
  56478. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  56479. /**
  56480. * Add potential fallbacks if shader compilation fails
  56481. * @param mesh defines the mesh to be rendered
  56482. * @param fallbacks defines the current prioritized list of fallbacks
  56483. */
  56484. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  56485. /**
  56486. * Initialize defines for shader compilation
  56487. * @param mesh defines the mesh to be rendered
  56488. * @param nodeMaterial defines the node material requesting the update
  56489. * @param defines defines the material defines to update
  56490. * @param useInstances specifies that instances should be used
  56491. */
  56492. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56493. /**
  56494. * Update defines for shader compilation
  56495. * @param mesh defines the mesh to be rendered
  56496. * @param nodeMaterial defines the node material requesting the update
  56497. * @param defines defines the material defines to update
  56498. * @param useInstances specifies that instances should be used
  56499. */
  56500. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56501. /**
  56502. * Lets the block try to connect some inputs automatically
  56503. * @param material defines the hosting NodeMaterial
  56504. */
  56505. autoConfigure(material: NodeMaterial): void;
  56506. /**
  56507. * Function called when a block is declared as repeatable content generator
  56508. * @param vertexShaderState defines the current compilation state for the vertex shader
  56509. * @param fragmentShaderState defines the current compilation state for the fragment shader
  56510. * @param mesh defines the mesh to be rendered
  56511. * @param defines defines the material defines to update
  56512. */
  56513. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  56514. /**
  56515. * Checks if the block is ready
  56516. * @param mesh defines the mesh to be rendered
  56517. * @param nodeMaterial defines the node material requesting the update
  56518. * @param defines defines the material defines to update
  56519. * @param useInstances specifies that instances should be used
  56520. * @returns true if the block is ready
  56521. */
  56522. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  56523. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  56524. private _processBuild;
  56525. /**
  56526. * Compile the current node and generate the shader code
  56527. * @param state defines the current compilation state (uniforms, samplers, current string)
  56528. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  56529. * @returns true if already built
  56530. */
  56531. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  56532. protected _inputRename(name: string): string;
  56533. protected _outputRename(name: string): string;
  56534. protected _dumpPropertiesCode(): string;
  56535. /** @hidden */
  56536. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  56537. /** @hidden */
  56538. _dumpCodeForOutputConnections(): string;
  56539. /**
  56540. * Clone the current block to a new identical block
  56541. * @param scene defines the hosting scene
  56542. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56543. * @returns a copy of the current block
  56544. */
  56545. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  56546. /**
  56547. * Serializes this block in a JSON representation
  56548. * @returns the serialized block object
  56549. */
  56550. serialize(): any;
  56551. /** @hidden */
  56552. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56553. /**
  56554. * Release resources
  56555. */
  56556. dispose(): void;
  56557. }
  56558. }
  56559. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  56560. /**
  56561. * Enum defining the type of animations supported by InputBlock
  56562. */
  56563. export enum AnimatedInputBlockTypes {
  56564. /** No animation */
  56565. None = 0,
  56566. /** Time based animation. Will only work for floats */
  56567. Time = 1
  56568. }
  56569. }
  56570. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  56571. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56572. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56573. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  56574. import { Nullable } from "babylonjs/types";
  56575. import { Effect } from "babylonjs/Materials/effect";
  56576. import { Matrix } from "babylonjs/Maths/math.vector";
  56577. import { Scene } from "babylonjs/scene";
  56578. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56579. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56580. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56581. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  56582. /**
  56583. * Block used to expose an input value
  56584. */
  56585. export class InputBlock extends NodeMaterialBlock {
  56586. private _mode;
  56587. private _associatedVariableName;
  56588. private _storedValue;
  56589. private _valueCallback;
  56590. private _type;
  56591. private _animationType;
  56592. /** Gets or set a value used to limit the range of float values */
  56593. min: number;
  56594. /** Gets or set a value used to limit the range of float values */
  56595. max: number;
  56596. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  56597. matrixMode: number;
  56598. /** @hidden */
  56599. _systemValue: Nullable<NodeMaterialSystemValues>;
  56600. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  56601. visibleInInspector: boolean;
  56602. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  56603. isConstant: boolean;
  56604. /**
  56605. * Gets or sets the connection point type (default is float)
  56606. */
  56607. readonly type: NodeMaterialBlockConnectionPointTypes;
  56608. /**
  56609. * Creates a new InputBlock
  56610. * @param name defines the block name
  56611. * @param target defines the target of that block (Vertex by default)
  56612. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  56613. */
  56614. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  56615. /**
  56616. * Gets the output component
  56617. */
  56618. readonly output: NodeMaterialConnectionPoint;
  56619. /**
  56620. * Set the source of this connection point to a vertex attribute
  56621. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  56622. * @returns the current connection point
  56623. */
  56624. setAsAttribute(attributeName?: string): InputBlock;
  56625. /**
  56626. * Set the source of this connection point to a system value
  56627. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  56628. * @returns the current connection point
  56629. */
  56630. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  56631. /**
  56632. * Gets or sets the value of that point.
  56633. * Please note that this value will be ignored if valueCallback is defined
  56634. */
  56635. value: any;
  56636. /**
  56637. * Gets or sets a callback used to get the value of that point.
  56638. * Please note that setting this value will force the connection point to ignore the value property
  56639. */
  56640. valueCallback: () => any;
  56641. /**
  56642. * Gets or sets the associated variable name in the shader
  56643. */
  56644. associatedVariableName: string;
  56645. /** Gets or sets the type of animation applied to the input */
  56646. animationType: AnimatedInputBlockTypes;
  56647. /**
  56648. * Gets a boolean indicating that this connection point not defined yet
  56649. */
  56650. readonly isUndefined: boolean;
  56651. /**
  56652. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  56653. * In this case the connection point name must be the name of the uniform to use.
  56654. * Can only be set on inputs
  56655. */
  56656. isUniform: boolean;
  56657. /**
  56658. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  56659. * In this case the connection point name must be the name of the attribute to use
  56660. * Can only be set on inputs
  56661. */
  56662. isAttribute: boolean;
  56663. /**
  56664. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  56665. * Can only be set on exit points
  56666. */
  56667. isVarying: boolean;
  56668. /**
  56669. * Gets a boolean indicating that the current connection point is a system value
  56670. */
  56671. readonly isSystemValue: boolean;
  56672. /**
  56673. * Gets or sets the current well known value or null if not defined as a system value
  56674. */
  56675. systemValue: Nullable<NodeMaterialSystemValues>;
  56676. /**
  56677. * Gets the current class name
  56678. * @returns the class name
  56679. */
  56680. getClassName(): string;
  56681. /**
  56682. * Animate the input if animationType !== None
  56683. * @param scene defines the rendering scene
  56684. */
  56685. animate(scene: Scene): void;
  56686. private _emitDefine;
  56687. initialize(state: NodeMaterialBuildState): void;
  56688. /**
  56689. * Set the input block to its default value (based on its type)
  56690. */
  56691. setDefaultValue(): void;
  56692. private _emitConstant;
  56693. private _emit;
  56694. /** @hidden */
  56695. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  56696. /** @hidden */
  56697. _transmit(effect: Effect, scene: Scene): void;
  56698. protected _buildBlock(state: NodeMaterialBuildState): void;
  56699. protected _dumpPropertiesCode(): string;
  56700. serialize(): any;
  56701. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56702. }
  56703. }
  56704. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  56705. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56706. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56707. import { Nullable } from "babylonjs/types";
  56708. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  56709. import { Observable } from "babylonjs/Misc/observable";
  56710. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56711. /**
  56712. * Defines a connection point for a block
  56713. */
  56714. export class NodeMaterialConnectionPoint {
  56715. /** @hidden */
  56716. _ownerBlock: NodeMaterialBlock;
  56717. /** @hidden */
  56718. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  56719. private _endpoints;
  56720. private _associatedVariableName;
  56721. /** @hidden */
  56722. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  56723. /** @hidden */
  56724. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  56725. private _type;
  56726. /** @hidden */
  56727. _enforceAssociatedVariableName: boolean;
  56728. /**
  56729. * Gets or sets the additional types supported by this connection point
  56730. */
  56731. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  56732. /**
  56733. * Gets or sets the additional types excluded by this connection point
  56734. */
  56735. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  56736. /**
  56737. * Observable triggered when this point is connected
  56738. */
  56739. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  56740. /**
  56741. * Gets or sets the associated variable name in the shader
  56742. */
  56743. associatedVariableName: string;
  56744. /**
  56745. * Gets or sets the connection point type (default is float)
  56746. */
  56747. type: NodeMaterialBlockConnectionPointTypes;
  56748. /**
  56749. * Gets or sets the connection point name
  56750. */
  56751. name: string;
  56752. /**
  56753. * Gets or sets a boolean indicating that this connection point can be omitted
  56754. */
  56755. isOptional: boolean;
  56756. /**
  56757. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  56758. */
  56759. define: string;
  56760. /** @hidden */
  56761. _prioritizeVertex: boolean;
  56762. private _target;
  56763. /** Gets or sets the target of that connection point */
  56764. target: NodeMaterialBlockTargets;
  56765. /**
  56766. * Gets a boolean indicating that the current point is connected
  56767. */
  56768. readonly isConnected: boolean;
  56769. /**
  56770. * Gets a boolean indicating that the current point is connected to an input block
  56771. */
  56772. readonly isConnectedToInputBlock: boolean;
  56773. /**
  56774. * Gets a the connected input block (if any)
  56775. */
  56776. readonly connectInputBlock: Nullable<InputBlock>;
  56777. /** Get the other side of the connection (if any) */
  56778. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  56779. /** Get the block that owns this connection point */
  56780. readonly ownerBlock: NodeMaterialBlock;
  56781. /** Get the block connected on the other side of this connection (if any) */
  56782. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  56783. /** Get the block connected on the endpoints of this connection (if any) */
  56784. readonly connectedBlocks: Array<NodeMaterialBlock>;
  56785. /** Gets the list of connected endpoints */
  56786. readonly endpoints: NodeMaterialConnectionPoint[];
  56787. /** Gets a boolean indicating if that output point is connected to at least one input */
  56788. readonly hasEndpoints: boolean;
  56789. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  56790. readonly isConnectedInVertexShader: boolean;
  56791. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  56792. readonly isConnectedInFragmentShader: boolean;
  56793. /**
  56794. * Creates a new connection point
  56795. * @param name defines the connection point name
  56796. * @param ownerBlock defines the block hosting this connection point
  56797. */
  56798. constructor(name: string, ownerBlock: NodeMaterialBlock);
  56799. /**
  56800. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  56801. * @returns the class name
  56802. */
  56803. getClassName(): string;
  56804. /**
  56805. * Gets an boolean indicating if the current point can be connected to another point
  56806. * @param connectionPoint defines the other connection point
  56807. * @returns true if the connection is possible
  56808. */
  56809. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  56810. /**
  56811. * Connect this point to another connection point
  56812. * @param connectionPoint defines the other connection point
  56813. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  56814. * @returns the current connection point
  56815. */
  56816. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  56817. /**
  56818. * Disconnect this point from one of his endpoint
  56819. * @param endpoint defines the other connection point
  56820. * @returns the current connection point
  56821. */
  56822. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  56823. /**
  56824. * Serializes this point in a JSON representation
  56825. * @returns the serialized point object
  56826. */
  56827. serialize(): any;
  56828. /**
  56829. * Release resources
  56830. */
  56831. dispose(): void;
  56832. }
  56833. }
  56834. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  56835. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56836. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56837. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56838. import { Mesh } from "babylonjs/Meshes/mesh";
  56839. import { Effect } from "babylonjs/Materials/effect";
  56840. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56841. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56842. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56843. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56844. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56845. /**
  56846. * Block used to add support for vertex skinning (bones)
  56847. */
  56848. export class BonesBlock extends NodeMaterialBlock {
  56849. /**
  56850. * Creates a new BonesBlock
  56851. * @param name defines the block name
  56852. */
  56853. constructor(name: string);
  56854. /**
  56855. * Initialize the block and prepare the context for build
  56856. * @param state defines the state that will be used for the build
  56857. */
  56858. initialize(state: NodeMaterialBuildState): void;
  56859. /**
  56860. * Gets the current class name
  56861. * @returns the class name
  56862. */
  56863. getClassName(): string;
  56864. /**
  56865. * Gets the matrix indices input component
  56866. */
  56867. readonly matricesIndices: NodeMaterialConnectionPoint;
  56868. /**
  56869. * Gets the matrix weights input component
  56870. */
  56871. readonly matricesWeights: NodeMaterialConnectionPoint;
  56872. /**
  56873. * Gets the extra matrix indices input component
  56874. */
  56875. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  56876. /**
  56877. * Gets the extra matrix weights input component
  56878. */
  56879. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  56880. /**
  56881. * Gets the world input component
  56882. */
  56883. readonly world: NodeMaterialConnectionPoint;
  56884. /**
  56885. * Gets the output component
  56886. */
  56887. readonly output: NodeMaterialConnectionPoint;
  56888. autoConfigure(material: NodeMaterial): void;
  56889. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  56890. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56891. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56892. protected _buildBlock(state: NodeMaterialBuildState): this;
  56893. }
  56894. }
  56895. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  56896. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56897. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56898. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56899. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56900. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56901. /**
  56902. * Block used to add support for instances
  56903. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  56904. */
  56905. export class InstancesBlock extends NodeMaterialBlock {
  56906. /**
  56907. * Creates a new InstancesBlock
  56908. * @param name defines the block name
  56909. */
  56910. constructor(name: string);
  56911. /**
  56912. * Gets the current class name
  56913. * @returns the class name
  56914. */
  56915. getClassName(): string;
  56916. /**
  56917. * Gets the first world row input component
  56918. */
  56919. readonly world0: NodeMaterialConnectionPoint;
  56920. /**
  56921. * Gets the second world row input component
  56922. */
  56923. readonly world1: NodeMaterialConnectionPoint;
  56924. /**
  56925. * Gets the third world row input component
  56926. */
  56927. readonly world2: NodeMaterialConnectionPoint;
  56928. /**
  56929. * Gets the forth world row input component
  56930. */
  56931. readonly world3: NodeMaterialConnectionPoint;
  56932. /**
  56933. * Gets the world input component
  56934. */
  56935. readonly world: NodeMaterialConnectionPoint;
  56936. /**
  56937. * Gets the output component
  56938. */
  56939. readonly output: NodeMaterialConnectionPoint;
  56940. autoConfigure(material: NodeMaterial): void;
  56941. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56942. protected _buildBlock(state: NodeMaterialBuildState): this;
  56943. }
  56944. }
  56945. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  56946. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56947. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56948. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56949. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56950. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56951. import { Effect } from "babylonjs/Materials/effect";
  56952. import { Mesh } from "babylonjs/Meshes/mesh";
  56953. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  56954. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  56955. /**
  56956. * Block used to add morph targets support to vertex shader
  56957. */
  56958. export class MorphTargetsBlock extends NodeMaterialBlock {
  56959. private _repeatableContentAnchor;
  56960. private _repeatebleContentGenerated;
  56961. /**
  56962. * Create a new MorphTargetsBlock
  56963. * @param name defines the block name
  56964. */
  56965. constructor(name: string);
  56966. /**
  56967. * Gets the current class name
  56968. * @returns the class name
  56969. */
  56970. getClassName(): string;
  56971. /**
  56972. * Gets the position input component
  56973. */
  56974. readonly position: NodeMaterialConnectionPoint;
  56975. /**
  56976. * Gets the normal input component
  56977. */
  56978. readonly normal: NodeMaterialConnectionPoint;
  56979. /**
  56980. * Gets the tangent input component
  56981. */
  56982. readonly tangent: NodeMaterialConnectionPoint;
  56983. /**
  56984. * Gets the tangent input component
  56985. */
  56986. readonly uv: NodeMaterialConnectionPoint;
  56987. /**
  56988. * Gets the position output component
  56989. */
  56990. readonly positionOutput: NodeMaterialConnectionPoint;
  56991. /**
  56992. * Gets the normal output component
  56993. */
  56994. readonly normalOutput: NodeMaterialConnectionPoint;
  56995. /**
  56996. * Gets the tangent output component
  56997. */
  56998. readonly tangentOutput: NodeMaterialConnectionPoint;
  56999. /**
  57000. * Gets the tangent output component
  57001. */
  57002. readonly uvOutput: NodeMaterialConnectionPoint;
  57003. initialize(state: NodeMaterialBuildState): void;
  57004. autoConfigure(material: NodeMaterial): void;
  57005. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57006. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57007. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  57008. protected _buildBlock(state: NodeMaterialBuildState): this;
  57009. }
  57010. }
  57011. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  57012. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57013. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57014. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57015. import { Nullable } from "babylonjs/types";
  57016. import { Scene } from "babylonjs/scene";
  57017. import { Effect } from "babylonjs/Materials/effect";
  57018. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57019. import { Mesh } from "babylonjs/Meshes/mesh";
  57020. import { Light } from "babylonjs/Lights/light";
  57021. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57022. /**
  57023. * Block used to get data information from a light
  57024. */
  57025. export class LightInformationBlock extends NodeMaterialBlock {
  57026. private _lightDataUniformName;
  57027. private _lightColorUniformName;
  57028. private _lightTypeDefineName;
  57029. /**
  57030. * Gets or sets the light associated with this block
  57031. */
  57032. light: Nullable<Light>;
  57033. /**
  57034. * Creates a new LightInformationBlock
  57035. * @param name defines the block name
  57036. */
  57037. constructor(name: string);
  57038. /**
  57039. * Gets the current class name
  57040. * @returns the class name
  57041. */
  57042. getClassName(): string;
  57043. /**
  57044. * Gets the world position input component
  57045. */
  57046. readonly worldPosition: NodeMaterialConnectionPoint;
  57047. /**
  57048. * Gets the direction output component
  57049. */
  57050. readonly direction: NodeMaterialConnectionPoint;
  57051. /**
  57052. * Gets the direction output component
  57053. */
  57054. readonly color: NodeMaterialConnectionPoint;
  57055. /**
  57056. * Gets the direction output component
  57057. */
  57058. readonly intensity: NodeMaterialConnectionPoint;
  57059. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57060. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57061. protected _buildBlock(state: NodeMaterialBuildState): this;
  57062. serialize(): any;
  57063. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57064. }
  57065. }
  57066. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  57067. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  57068. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  57069. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  57070. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  57071. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  57072. }
  57073. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  57074. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57075. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57076. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57077. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57078. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57079. import { Effect } from "babylonjs/Materials/effect";
  57080. import { Mesh } from "babylonjs/Meshes/mesh";
  57081. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57082. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  57083. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  57084. /**
  57085. * Block used to add image processing support to fragment shader
  57086. */
  57087. export class ImageProcessingBlock extends NodeMaterialBlock {
  57088. /**
  57089. * Create a new ImageProcessingBlock
  57090. * @param name defines the block name
  57091. */
  57092. constructor(name: string);
  57093. /**
  57094. * Gets the current class name
  57095. * @returns the class name
  57096. */
  57097. getClassName(): string;
  57098. /**
  57099. * Gets the color input component
  57100. */
  57101. readonly color: NodeMaterialConnectionPoint;
  57102. /**
  57103. * Gets the output component
  57104. */
  57105. readonly output: NodeMaterialConnectionPoint;
  57106. /**
  57107. * Initialize the block and prepare the context for build
  57108. * @param state defines the state that will be used for the build
  57109. */
  57110. initialize(state: NodeMaterialBuildState): void;
  57111. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  57112. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57113. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57114. protected _buildBlock(state: NodeMaterialBuildState): this;
  57115. }
  57116. }
  57117. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  57118. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57119. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57120. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57121. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57122. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57123. import { Effect } from "babylonjs/Materials/effect";
  57124. import { Mesh } from "babylonjs/Meshes/mesh";
  57125. import { Scene } from "babylonjs/scene";
  57126. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  57127. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  57128. /**
  57129. * Block used to pertub normals based on a normal map
  57130. */
  57131. export class PerturbNormalBlock extends NodeMaterialBlock {
  57132. private _tangentSpaceParameterName;
  57133. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  57134. invertX: boolean;
  57135. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  57136. invertY: boolean;
  57137. /**
  57138. * Create a new PerturbNormalBlock
  57139. * @param name defines the block name
  57140. */
  57141. constructor(name: string);
  57142. /**
  57143. * Gets the current class name
  57144. * @returns the class name
  57145. */
  57146. getClassName(): string;
  57147. /**
  57148. * Gets the world position input component
  57149. */
  57150. readonly worldPosition: NodeMaterialConnectionPoint;
  57151. /**
  57152. * Gets the world normal input component
  57153. */
  57154. readonly worldNormal: NodeMaterialConnectionPoint;
  57155. /**
  57156. * Gets the uv input component
  57157. */
  57158. readonly uv: NodeMaterialConnectionPoint;
  57159. /**
  57160. * Gets the normal map color input component
  57161. */
  57162. readonly normalMapColor: NodeMaterialConnectionPoint;
  57163. /**
  57164. * Gets the strength input component
  57165. */
  57166. readonly strength: NodeMaterialConnectionPoint;
  57167. /**
  57168. * Gets the output component
  57169. */
  57170. readonly output: NodeMaterialConnectionPoint;
  57171. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57172. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57173. autoConfigure(material: NodeMaterial): void;
  57174. protected _buildBlock(state: NodeMaterialBuildState): this;
  57175. protected _dumpPropertiesCode(): string;
  57176. serialize(): any;
  57177. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57178. }
  57179. }
  57180. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  57181. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57182. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57183. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57184. /**
  57185. * Block used to discard a pixel if a value is smaller than a cutoff
  57186. */
  57187. export class DiscardBlock extends NodeMaterialBlock {
  57188. /**
  57189. * Create a new DiscardBlock
  57190. * @param name defines the block name
  57191. */
  57192. constructor(name: string);
  57193. /**
  57194. * Gets the current class name
  57195. * @returns the class name
  57196. */
  57197. getClassName(): string;
  57198. /**
  57199. * Gets the color input component
  57200. */
  57201. readonly value: NodeMaterialConnectionPoint;
  57202. /**
  57203. * Gets the cutoff input component
  57204. */
  57205. readonly cutoff: NodeMaterialConnectionPoint;
  57206. protected _buildBlock(state: NodeMaterialBuildState): this;
  57207. }
  57208. }
  57209. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  57210. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  57211. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  57212. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  57213. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  57214. }
  57215. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  57216. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57217. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57218. import { Mesh } from "babylonjs/Meshes/mesh";
  57219. import { Effect } from "babylonjs/Materials/effect";
  57220. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57221. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57222. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57223. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  57224. /**
  57225. * Block used to add support for scene fog
  57226. */
  57227. export class FogBlock extends NodeMaterialBlock {
  57228. private _fogDistanceName;
  57229. private _fogParameters;
  57230. /**
  57231. * Create a new FogBlock
  57232. * @param name defines the block name
  57233. */
  57234. constructor(name: string);
  57235. /**
  57236. * Gets the current class name
  57237. * @returns the class name
  57238. */
  57239. getClassName(): string;
  57240. /**
  57241. * Gets the world position input component
  57242. */
  57243. readonly worldPosition: NodeMaterialConnectionPoint;
  57244. /**
  57245. * Gets the view input component
  57246. */
  57247. readonly view: NodeMaterialConnectionPoint;
  57248. /**
  57249. * Gets the color input component
  57250. */
  57251. readonly input: NodeMaterialConnectionPoint;
  57252. /**
  57253. * Gets the fog color input component
  57254. */
  57255. readonly fogColor: NodeMaterialConnectionPoint;
  57256. /**
  57257. * Gets the output component
  57258. */
  57259. readonly output: NodeMaterialConnectionPoint;
  57260. autoConfigure(material: NodeMaterial): void;
  57261. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57262. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57263. protected _buildBlock(state: NodeMaterialBuildState): this;
  57264. }
  57265. }
  57266. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  57267. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57268. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57269. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57270. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57271. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57272. import { Effect } from "babylonjs/Materials/effect";
  57273. import { Mesh } from "babylonjs/Meshes/mesh";
  57274. import { Light } from "babylonjs/Lights/light";
  57275. import { Nullable } from "babylonjs/types";
  57276. import { Scene } from "babylonjs/scene";
  57277. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  57278. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  57279. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  57280. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57281. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  57282. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  57283. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  57284. /**
  57285. * Block used to add light in the fragment shader
  57286. */
  57287. export class LightBlock extends NodeMaterialBlock {
  57288. private _lightId;
  57289. /**
  57290. * Gets or sets the light associated with this block
  57291. */
  57292. light: Nullable<Light>;
  57293. /**
  57294. * Create a new LightBlock
  57295. * @param name defines the block name
  57296. */
  57297. constructor(name: string);
  57298. /**
  57299. * Gets the current class name
  57300. * @returns the class name
  57301. */
  57302. getClassName(): string;
  57303. /**
  57304. * Gets the world position input component
  57305. */
  57306. readonly worldPosition: NodeMaterialConnectionPoint;
  57307. /**
  57308. * Gets the world normal input component
  57309. */
  57310. readonly worldNormal: NodeMaterialConnectionPoint;
  57311. /**
  57312. * Gets the camera (or eye) position component
  57313. */
  57314. readonly cameraPosition: NodeMaterialConnectionPoint;
  57315. /**
  57316. * Gets the glossiness component
  57317. */
  57318. readonly glossiness: NodeMaterialConnectionPoint;
  57319. /**
  57320. * Gets the glossinness power component
  57321. */
  57322. readonly glossPower: NodeMaterialConnectionPoint;
  57323. /**
  57324. * Gets the diffuse color component
  57325. */
  57326. readonly diffuseColor: NodeMaterialConnectionPoint;
  57327. /**
  57328. * Gets the specular color component
  57329. */
  57330. readonly specularColor: NodeMaterialConnectionPoint;
  57331. /**
  57332. * Gets the diffuse output component
  57333. */
  57334. readonly diffuseOutput: NodeMaterialConnectionPoint;
  57335. /**
  57336. * Gets the specular output component
  57337. */
  57338. readonly specularOutput: NodeMaterialConnectionPoint;
  57339. autoConfigure(material: NodeMaterial): void;
  57340. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57341. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  57342. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57343. private _injectVertexCode;
  57344. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  57345. serialize(): any;
  57346. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57347. }
  57348. }
  57349. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  57350. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  57351. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  57352. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  57353. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  57354. }
  57355. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  57356. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  57357. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  57358. }
  57359. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  57360. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57361. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57362. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57363. /**
  57364. * Block used to multiply 2 values
  57365. */
  57366. export class MultiplyBlock extends NodeMaterialBlock {
  57367. /**
  57368. * Creates a new MultiplyBlock
  57369. * @param name defines the block name
  57370. */
  57371. constructor(name: string);
  57372. /**
  57373. * Gets the current class name
  57374. * @returns the class name
  57375. */
  57376. getClassName(): string;
  57377. /**
  57378. * Gets the left operand input component
  57379. */
  57380. readonly left: NodeMaterialConnectionPoint;
  57381. /**
  57382. * Gets the right operand input component
  57383. */
  57384. readonly right: NodeMaterialConnectionPoint;
  57385. /**
  57386. * Gets the output component
  57387. */
  57388. readonly output: NodeMaterialConnectionPoint;
  57389. protected _buildBlock(state: NodeMaterialBuildState): this;
  57390. }
  57391. }
  57392. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  57393. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57394. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57395. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57396. /**
  57397. * Block used to add 2 vectors
  57398. */
  57399. export class AddBlock extends NodeMaterialBlock {
  57400. /**
  57401. * Creates a new AddBlock
  57402. * @param name defines the block name
  57403. */
  57404. constructor(name: string);
  57405. /**
  57406. * Gets the current class name
  57407. * @returns the class name
  57408. */
  57409. getClassName(): string;
  57410. /**
  57411. * Gets the left operand input component
  57412. */
  57413. readonly left: NodeMaterialConnectionPoint;
  57414. /**
  57415. * Gets the right operand input component
  57416. */
  57417. readonly right: NodeMaterialConnectionPoint;
  57418. /**
  57419. * Gets the output component
  57420. */
  57421. readonly output: NodeMaterialConnectionPoint;
  57422. protected _buildBlock(state: NodeMaterialBuildState): this;
  57423. }
  57424. }
  57425. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  57426. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57427. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57428. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57429. /**
  57430. * Block used to scale a vector by a float
  57431. */
  57432. export class ScaleBlock extends NodeMaterialBlock {
  57433. /**
  57434. * Creates a new ScaleBlock
  57435. * @param name defines the block name
  57436. */
  57437. constructor(name: string);
  57438. /**
  57439. * Gets the current class name
  57440. * @returns the class name
  57441. */
  57442. getClassName(): string;
  57443. /**
  57444. * Gets the input component
  57445. */
  57446. readonly input: NodeMaterialConnectionPoint;
  57447. /**
  57448. * Gets the factor input component
  57449. */
  57450. readonly factor: NodeMaterialConnectionPoint;
  57451. /**
  57452. * Gets the output component
  57453. */
  57454. readonly output: NodeMaterialConnectionPoint;
  57455. protected _buildBlock(state: NodeMaterialBuildState): this;
  57456. }
  57457. }
  57458. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  57459. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57460. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57461. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57462. import { Scene } from "babylonjs/scene";
  57463. /**
  57464. * Block used to clamp a float
  57465. */
  57466. export class ClampBlock extends NodeMaterialBlock {
  57467. /** Gets or sets the minimum range */
  57468. minimum: number;
  57469. /** Gets or sets the maximum range */
  57470. maximum: number;
  57471. /**
  57472. * Creates a new ClampBlock
  57473. * @param name defines the block name
  57474. */
  57475. constructor(name: string);
  57476. /**
  57477. * Gets the current class name
  57478. * @returns the class name
  57479. */
  57480. getClassName(): string;
  57481. /**
  57482. * Gets the value input component
  57483. */
  57484. readonly value: NodeMaterialConnectionPoint;
  57485. /**
  57486. * Gets the output component
  57487. */
  57488. readonly output: NodeMaterialConnectionPoint;
  57489. protected _buildBlock(state: NodeMaterialBuildState): this;
  57490. protected _dumpPropertiesCode(): string;
  57491. serialize(): any;
  57492. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57493. }
  57494. }
  57495. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  57496. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57497. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57498. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57499. /**
  57500. * Block used to apply a cross product between 2 vectors
  57501. */
  57502. export class CrossBlock extends NodeMaterialBlock {
  57503. /**
  57504. * Creates a new CrossBlock
  57505. * @param name defines the block name
  57506. */
  57507. constructor(name: string);
  57508. /**
  57509. * Gets the current class name
  57510. * @returns the class name
  57511. */
  57512. getClassName(): string;
  57513. /**
  57514. * Gets the left operand input component
  57515. */
  57516. readonly left: NodeMaterialConnectionPoint;
  57517. /**
  57518. * Gets the right operand input component
  57519. */
  57520. readonly right: NodeMaterialConnectionPoint;
  57521. /**
  57522. * Gets the output component
  57523. */
  57524. readonly output: NodeMaterialConnectionPoint;
  57525. protected _buildBlock(state: NodeMaterialBuildState): this;
  57526. }
  57527. }
  57528. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  57529. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57530. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57531. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57532. /**
  57533. * Block used to apply a dot product between 2 vectors
  57534. */
  57535. export class DotBlock extends NodeMaterialBlock {
  57536. /**
  57537. * Creates a new DotBlock
  57538. * @param name defines the block name
  57539. */
  57540. constructor(name: string);
  57541. /**
  57542. * Gets the current class name
  57543. * @returns the class name
  57544. */
  57545. getClassName(): string;
  57546. /**
  57547. * Gets the left operand input component
  57548. */
  57549. readonly left: NodeMaterialConnectionPoint;
  57550. /**
  57551. * Gets the right operand input component
  57552. */
  57553. readonly right: NodeMaterialConnectionPoint;
  57554. /**
  57555. * Gets the output component
  57556. */
  57557. readonly output: NodeMaterialConnectionPoint;
  57558. protected _buildBlock(state: NodeMaterialBuildState): this;
  57559. }
  57560. }
  57561. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  57562. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57563. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57564. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57565. import { Vector2 } from "babylonjs/Maths/math.vector";
  57566. import { Scene } from "babylonjs/scene";
  57567. /**
  57568. * Block used to remap a float from a range to a new one
  57569. */
  57570. export class RemapBlock extends NodeMaterialBlock {
  57571. /**
  57572. * Gets or sets the source range
  57573. */
  57574. sourceRange: Vector2;
  57575. /**
  57576. * Gets or sets the target range
  57577. */
  57578. targetRange: Vector2;
  57579. /**
  57580. * Creates a new RemapBlock
  57581. * @param name defines the block name
  57582. */
  57583. constructor(name: string);
  57584. /**
  57585. * Gets the current class name
  57586. * @returns the class name
  57587. */
  57588. getClassName(): string;
  57589. /**
  57590. * Gets the input component
  57591. */
  57592. readonly input: NodeMaterialConnectionPoint;
  57593. /**
  57594. * Gets the source min input component
  57595. */
  57596. readonly sourceMin: NodeMaterialConnectionPoint;
  57597. /**
  57598. * Gets the source max input component
  57599. */
  57600. readonly sourceMax: NodeMaterialConnectionPoint;
  57601. /**
  57602. * Gets the target min input component
  57603. */
  57604. readonly targetMin: NodeMaterialConnectionPoint;
  57605. /**
  57606. * Gets the target max input component
  57607. */
  57608. readonly targetMax: NodeMaterialConnectionPoint;
  57609. /**
  57610. * Gets the output component
  57611. */
  57612. readonly output: NodeMaterialConnectionPoint;
  57613. protected _buildBlock(state: NodeMaterialBuildState): this;
  57614. protected _dumpPropertiesCode(): string;
  57615. serialize(): any;
  57616. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57617. }
  57618. }
  57619. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  57620. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57621. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57622. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57623. /**
  57624. * Block used to normalize a vector
  57625. */
  57626. export class NormalizeBlock extends NodeMaterialBlock {
  57627. /**
  57628. * Creates a new NormalizeBlock
  57629. * @param name defines the block name
  57630. */
  57631. constructor(name: string);
  57632. /**
  57633. * Gets the current class name
  57634. * @returns the class name
  57635. */
  57636. getClassName(): string;
  57637. /**
  57638. * Gets the input component
  57639. */
  57640. readonly input: NodeMaterialConnectionPoint;
  57641. /**
  57642. * Gets the output component
  57643. */
  57644. readonly output: NodeMaterialConnectionPoint;
  57645. protected _buildBlock(state: NodeMaterialBuildState): this;
  57646. }
  57647. }
  57648. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  57649. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57650. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57651. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57652. import { Scene } from "babylonjs/scene";
  57653. /**
  57654. * Operations supported by the Trigonometry block
  57655. */
  57656. export enum TrigonometryBlockOperations {
  57657. /** Cos */
  57658. Cos = 0,
  57659. /** Sin */
  57660. Sin = 1,
  57661. /** Abs */
  57662. Abs = 2,
  57663. /** Exp */
  57664. Exp = 3,
  57665. /** Exp2 */
  57666. Exp2 = 4,
  57667. /** Round */
  57668. Round = 5,
  57669. /** Floor */
  57670. Floor = 6,
  57671. /** Ceiling */
  57672. Ceiling = 7,
  57673. /** Square root */
  57674. Sqrt = 8,
  57675. /** Log */
  57676. Log = 9,
  57677. /** Tangent */
  57678. Tan = 10,
  57679. /** Arc tangent */
  57680. ArcTan = 11,
  57681. /** Arc cosinus */
  57682. ArcCos = 12,
  57683. /** Arc sinus */
  57684. ArcSin = 13,
  57685. /** Fraction */
  57686. Fract = 14,
  57687. /** Sign */
  57688. Sign = 15,
  57689. /** To radians (from degrees) */
  57690. Radians = 16,
  57691. /** To degrees (from radians) */
  57692. Degrees = 17
  57693. }
  57694. /**
  57695. * Block used to apply trigonometry operation to floats
  57696. */
  57697. export class TrigonometryBlock extends NodeMaterialBlock {
  57698. /**
  57699. * Gets or sets the operation applied by the block
  57700. */
  57701. operation: TrigonometryBlockOperations;
  57702. /**
  57703. * Creates a new TrigonometryBlock
  57704. * @param name defines the block name
  57705. */
  57706. constructor(name: string);
  57707. /**
  57708. * Gets the current class name
  57709. * @returns the class name
  57710. */
  57711. getClassName(): string;
  57712. /**
  57713. * Gets the input component
  57714. */
  57715. readonly input: NodeMaterialConnectionPoint;
  57716. /**
  57717. * Gets the output component
  57718. */
  57719. readonly output: NodeMaterialConnectionPoint;
  57720. protected _buildBlock(state: NodeMaterialBuildState): this;
  57721. serialize(): any;
  57722. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57723. }
  57724. }
  57725. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  57726. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57727. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57728. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57729. /**
  57730. * Block used to create a Color3/4 out of individual inputs (one for each component)
  57731. */
  57732. export class ColorMergerBlock extends NodeMaterialBlock {
  57733. /**
  57734. * Create a new ColorMergerBlock
  57735. * @param name defines the block name
  57736. */
  57737. constructor(name: string);
  57738. /**
  57739. * Gets the current class name
  57740. * @returns the class name
  57741. */
  57742. getClassName(): string;
  57743. /**
  57744. * Gets the r component (input)
  57745. */
  57746. readonly r: NodeMaterialConnectionPoint;
  57747. /**
  57748. * Gets the g component (input)
  57749. */
  57750. readonly g: NodeMaterialConnectionPoint;
  57751. /**
  57752. * Gets the b component (input)
  57753. */
  57754. readonly b: NodeMaterialConnectionPoint;
  57755. /**
  57756. * Gets the a component (input)
  57757. */
  57758. readonly a: NodeMaterialConnectionPoint;
  57759. /**
  57760. * Gets the rgba component (output)
  57761. */
  57762. readonly rgba: NodeMaterialConnectionPoint;
  57763. /**
  57764. * Gets the rgb component (output)
  57765. */
  57766. readonly rgb: NodeMaterialConnectionPoint;
  57767. protected _buildBlock(state: NodeMaterialBuildState): this;
  57768. }
  57769. }
  57770. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  57771. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57772. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57773. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57774. /**
  57775. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  57776. */
  57777. export class VectorMergerBlock extends NodeMaterialBlock {
  57778. /**
  57779. * Create a new VectorMergerBlock
  57780. * @param name defines the block name
  57781. */
  57782. constructor(name: string);
  57783. /**
  57784. * Gets the current class name
  57785. * @returns the class name
  57786. */
  57787. getClassName(): string;
  57788. /**
  57789. * Gets the x component (input)
  57790. */
  57791. readonly x: NodeMaterialConnectionPoint;
  57792. /**
  57793. * Gets the y component (input)
  57794. */
  57795. readonly y: NodeMaterialConnectionPoint;
  57796. /**
  57797. * Gets the z component (input)
  57798. */
  57799. readonly z: NodeMaterialConnectionPoint;
  57800. /**
  57801. * Gets the w component (input)
  57802. */
  57803. readonly w: NodeMaterialConnectionPoint;
  57804. /**
  57805. * Gets the xyzw component (output)
  57806. */
  57807. readonly xyzw: NodeMaterialConnectionPoint;
  57808. /**
  57809. * Gets the xyz component (output)
  57810. */
  57811. readonly xyz: NodeMaterialConnectionPoint;
  57812. /**
  57813. * Gets the xy component (output)
  57814. */
  57815. readonly xy: NodeMaterialConnectionPoint;
  57816. protected _buildBlock(state: NodeMaterialBuildState): this;
  57817. }
  57818. }
  57819. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  57820. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57821. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57822. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57823. /**
  57824. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  57825. */
  57826. export class ColorSplitterBlock extends NodeMaterialBlock {
  57827. /**
  57828. * Create a new ColorSplitterBlock
  57829. * @param name defines the block name
  57830. */
  57831. constructor(name: string);
  57832. /**
  57833. * Gets the current class name
  57834. * @returns the class name
  57835. */
  57836. getClassName(): string;
  57837. /**
  57838. * Gets the rgba component (input)
  57839. */
  57840. readonly rgba: NodeMaterialConnectionPoint;
  57841. /**
  57842. * Gets the rgb component (input)
  57843. */
  57844. readonly rgbIn: NodeMaterialConnectionPoint;
  57845. /**
  57846. * Gets the rgb component (output)
  57847. */
  57848. readonly rgbOut: NodeMaterialConnectionPoint;
  57849. /**
  57850. * Gets the r component (output)
  57851. */
  57852. readonly r: NodeMaterialConnectionPoint;
  57853. /**
  57854. * Gets the g component (output)
  57855. */
  57856. readonly g: NodeMaterialConnectionPoint;
  57857. /**
  57858. * Gets the b component (output)
  57859. */
  57860. readonly b: NodeMaterialConnectionPoint;
  57861. /**
  57862. * Gets the a component (output)
  57863. */
  57864. readonly a: NodeMaterialConnectionPoint;
  57865. protected _inputRename(name: string): string;
  57866. protected _outputRename(name: string): string;
  57867. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  57868. }
  57869. }
  57870. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  57871. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57872. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57873. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57874. /**
  57875. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  57876. */
  57877. export class VectorSplitterBlock extends NodeMaterialBlock {
  57878. /**
  57879. * Create a new VectorSplitterBlock
  57880. * @param name defines the block name
  57881. */
  57882. constructor(name: string);
  57883. /**
  57884. * Gets the current class name
  57885. * @returns the class name
  57886. */
  57887. getClassName(): string;
  57888. /**
  57889. * Gets the xyzw component (input)
  57890. */
  57891. readonly xyzw: NodeMaterialConnectionPoint;
  57892. /**
  57893. * Gets the xyz component (input)
  57894. */
  57895. readonly xyzIn: NodeMaterialConnectionPoint;
  57896. /**
  57897. * Gets the xy component (input)
  57898. */
  57899. readonly xyIn: NodeMaterialConnectionPoint;
  57900. /**
  57901. * Gets the xyz component (output)
  57902. */
  57903. readonly xyzOut: NodeMaterialConnectionPoint;
  57904. /**
  57905. * Gets the xy component (output)
  57906. */
  57907. readonly xyOut: NodeMaterialConnectionPoint;
  57908. /**
  57909. * Gets the x component (output)
  57910. */
  57911. readonly x: NodeMaterialConnectionPoint;
  57912. /**
  57913. * Gets the y component (output)
  57914. */
  57915. readonly y: NodeMaterialConnectionPoint;
  57916. /**
  57917. * Gets the z component (output)
  57918. */
  57919. readonly z: NodeMaterialConnectionPoint;
  57920. /**
  57921. * Gets the w component (output)
  57922. */
  57923. readonly w: NodeMaterialConnectionPoint;
  57924. protected _inputRename(name: string): string;
  57925. protected _outputRename(name: string): string;
  57926. protected _buildBlock(state: NodeMaterialBuildState): this;
  57927. }
  57928. }
  57929. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  57930. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57931. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57932. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57933. /**
  57934. * Block used to lerp between 2 values
  57935. */
  57936. export class LerpBlock extends NodeMaterialBlock {
  57937. /**
  57938. * Creates a new LerpBlock
  57939. * @param name defines the block name
  57940. */
  57941. constructor(name: string);
  57942. /**
  57943. * Gets the current class name
  57944. * @returns the class name
  57945. */
  57946. getClassName(): string;
  57947. /**
  57948. * Gets the left operand input component
  57949. */
  57950. readonly left: NodeMaterialConnectionPoint;
  57951. /**
  57952. * Gets the right operand input component
  57953. */
  57954. readonly right: NodeMaterialConnectionPoint;
  57955. /**
  57956. * Gets the gradient operand input component
  57957. */
  57958. readonly gradient: NodeMaterialConnectionPoint;
  57959. /**
  57960. * Gets the output component
  57961. */
  57962. readonly output: NodeMaterialConnectionPoint;
  57963. protected _buildBlock(state: NodeMaterialBuildState): this;
  57964. }
  57965. }
  57966. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  57967. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57968. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57969. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57970. /**
  57971. * Block used to divide 2 vectors
  57972. */
  57973. export class DivideBlock extends NodeMaterialBlock {
  57974. /**
  57975. * Creates a new DivideBlock
  57976. * @param name defines the block name
  57977. */
  57978. constructor(name: string);
  57979. /**
  57980. * Gets the current class name
  57981. * @returns the class name
  57982. */
  57983. getClassName(): string;
  57984. /**
  57985. * Gets the left operand input component
  57986. */
  57987. readonly left: NodeMaterialConnectionPoint;
  57988. /**
  57989. * Gets the right operand input component
  57990. */
  57991. readonly right: NodeMaterialConnectionPoint;
  57992. /**
  57993. * Gets the output component
  57994. */
  57995. readonly output: NodeMaterialConnectionPoint;
  57996. protected _buildBlock(state: NodeMaterialBuildState): this;
  57997. }
  57998. }
  57999. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  58000. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58001. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58002. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58003. /**
  58004. * Block used to subtract 2 vectors
  58005. */
  58006. export class SubtractBlock extends NodeMaterialBlock {
  58007. /**
  58008. * Creates a new SubtractBlock
  58009. * @param name defines the block name
  58010. */
  58011. constructor(name: string);
  58012. /**
  58013. * Gets the current class name
  58014. * @returns the class name
  58015. */
  58016. getClassName(): string;
  58017. /**
  58018. * Gets the left operand input component
  58019. */
  58020. readonly left: NodeMaterialConnectionPoint;
  58021. /**
  58022. * Gets the right operand input component
  58023. */
  58024. readonly right: NodeMaterialConnectionPoint;
  58025. /**
  58026. * Gets the output component
  58027. */
  58028. readonly output: NodeMaterialConnectionPoint;
  58029. protected _buildBlock(state: NodeMaterialBuildState): this;
  58030. }
  58031. }
  58032. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  58033. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58034. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58035. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58036. /**
  58037. * Block used to step a value
  58038. */
  58039. export class StepBlock extends NodeMaterialBlock {
  58040. /**
  58041. * Creates a new StepBlock
  58042. * @param name defines the block name
  58043. */
  58044. constructor(name: string);
  58045. /**
  58046. * Gets the current class name
  58047. * @returns the class name
  58048. */
  58049. getClassName(): string;
  58050. /**
  58051. * Gets the value operand input component
  58052. */
  58053. readonly value: NodeMaterialConnectionPoint;
  58054. /**
  58055. * Gets the edge operand input component
  58056. */
  58057. readonly edge: NodeMaterialConnectionPoint;
  58058. /**
  58059. * Gets the output component
  58060. */
  58061. readonly output: NodeMaterialConnectionPoint;
  58062. protected _buildBlock(state: NodeMaterialBuildState): this;
  58063. }
  58064. }
  58065. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  58066. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58067. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58068. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58069. /**
  58070. * Block used to get the opposite (1 - x) of a value
  58071. */
  58072. export class OneMinusBlock extends NodeMaterialBlock {
  58073. /**
  58074. * Creates a new OneMinusBlock
  58075. * @param name defines the block name
  58076. */
  58077. constructor(name: string);
  58078. /**
  58079. * Gets the current class name
  58080. * @returns the class name
  58081. */
  58082. getClassName(): string;
  58083. /**
  58084. * Gets the input component
  58085. */
  58086. readonly input: NodeMaterialConnectionPoint;
  58087. /**
  58088. * Gets the output component
  58089. */
  58090. readonly output: NodeMaterialConnectionPoint;
  58091. protected _buildBlock(state: NodeMaterialBuildState): this;
  58092. }
  58093. }
  58094. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  58095. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58096. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58097. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58098. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58099. /**
  58100. * Block used to get the view direction
  58101. */
  58102. export class ViewDirectionBlock extends NodeMaterialBlock {
  58103. /**
  58104. * Creates a new ViewDirectionBlock
  58105. * @param name defines the block name
  58106. */
  58107. constructor(name: string);
  58108. /**
  58109. * Gets the current class name
  58110. * @returns the class name
  58111. */
  58112. getClassName(): string;
  58113. /**
  58114. * Gets the world position component
  58115. */
  58116. readonly worldPosition: NodeMaterialConnectionPoint;
  58117. /**
  58118. * Gets the camera position component
  58119. */
  58120. readonly cameraPosition: NodeMaterialConnectionPoint;
  58121. /**
  58122. * Gets the output component
  58123. */
  58124. readonly output: NodeMaterialConnectionPoint;
  58125. autoConfigure(material: NodeMaterial): void;
  58126. protected _buildBlock(state: NodeMaterialBuildState): this;
  58127. }
  58128. }
  58129. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  58130. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58131. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58132. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58133. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58134. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  58135. /**
  58136. * Block used to compute fresnel value
  58137. */
  58138. export class FresnelBlock extends NodeMaterialBlock {
  58139. /**
  58140. * Create a new FresnelBlock
  58141. * @param name defines the block name
  58142. */
  58143. constructor(name: string);
  58144. /**
  58145. * Gets the current class name
  58146. * @returns the class name
  58147. */
  58148. getClassName(): string;
  58149. /**
  58150. * Gets the world normal input component
  58151. */
  58152. readonly worldNormal: NodeMaterialConnectionPoint;
  58153. /**
  58154. * Gets the view direction input component
  58155. */
  58156. readonly viewDirection: NodeMaterialConnectionPoint;
  58157. /**
  58158. * Gets the bias input component
  58159. */
  58160. readonly bias: NodeMaterialConnectionPoint;
  58161. /**
  58162. * Gets the camera (or eye) position component
  58163. */
  58164. readonly power: NodeMaterialConnectionPoint;
  58165. /**
  58166. * Gets the fresnel output component
  58167. */
  58168. readonly fresnel: NodeMaterialConnectionPoint;
  58169. autoConfigure(material: NodeMaterial): void;
  58170. protected _buildBlock(state: NodeMaterialBuildState): this;
  58171. }
  58172. }
  58173. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  58174. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58175. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58176. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58177. /**
  58178. * Block used to get the max of 2 values
  58179. */
  58180. export class MaxBlock extends NodeMaterialBlock {
  58181. /**
  58182. * Creates a new MaxBlock
  58183. * @param name defines the block name
  58184. */
  58185. constructor(name: string);
  58186. /**
  58187. * Gets the current class name
  58188. * @returns the class name
  58189. */
  58190. getClassName(): string;
  58191. /**
  58192. * Gets the left operand input component
  58193. */
  58194. readonly left: NodeMaterialConnectionPoint;
  58195. /**
  58196. * Gets the right operand input component
  58197. */
  58198. readonly right: NodeMaterialConnectionPoint;
  58199. /**
  58200. * Gets the output component
  58201. */
  58202. readonly output: NodeMaterialConnectionPoint;
  58203. protected _buildBlock(state: NodeMaterialBuildState): this;
  58204. }
  58205. }
  58206. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  58207. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58208. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58209. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58210. /**
  58211. * Block used to get the min of 2 values
  58212. */
  58213. export class MinBlock extends NodeMaterialBlock {
  58214. /**
  58215. * Creates a new MinBlock
  58216. * @param name defines the block name
  58217. */
  58218. constructor(name: string);
  58219. /**
  58220. * Gets the current class name
  58221. * @returns the class name
  58222. */
  58223. getClassName(): string;
  58224. /**
  58225. * Gets the left operand input component
  58226. */
  58227. readonly left: NodeMaterialConnectionPoint;
  58228. /**
  58229. * Gets the right operand input component
  58230. */
  58231. readonly right: NodeMaterialConnectionPoint;
  58232. /**
  58233. * Gets the output component
  58234. */
  58235. readonly output: NodeMaterialConnectionPoint;
  58236. protected _buildBlock(state: NodeMaterialBuildState): this;
  58237. }
  58238. }
  58239. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  58240. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58241. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58242. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58243. /**
  58244. * Block used to get the distance between 2 values
  58245. */
  58246. export class DistanceBlock extends NodeMaterialBlock {
  58247. /**
  58248. * Creates a new DistanceBlock
  58249. * @param name defines the block name
  58250. */
  58251. constructor(name: string);
  58252. /**
  58253. * Gets the current class name
  58254. * @returns the class name
  58255. */
  58256. getClassName(): string;
  58257. /**
  58258. * Gets the left operand input component
  58259. */
  58260. readonly left: NodeMaterialConnectionPoint;
  58261. /**
  58262. * Gets the right operand input component
  58263. */
  58264. readonly right: NodeMaterialConnectionPoint;
  58265. /**
  58266. * Gets the output component
  58267. */
  58268. readonly output: NodeMaterialConnectionPoint;
  58269. protected _buildBlock(state: NodeMaterialBuildState): this;
  58270. }
  58271. }
  58272. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  58273. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58274. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58275. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58276. /**
  58277. * Block used to get the length of a vector
  58278. */
  58279. export class LengthBlock extends NodeMaterialBlock {
  58280. /**
  58281. * Creates a new LengthBlock
  58282. * @param name defines the block name
  58283. */
  58284. constructor(name: string);
  58285. /**
  58286. * Gets the current class name
  58287. * @returns the class name
  58288. */
  58289. getClassName(): string;
  58290. /**
  58291. * Gets the value input component
  58292. */
  58293. readonly value: NodeMaterialConnectionPoint;
  58294. /**
  58295. * Gets the output component
  58296. */
  58297. readonly output: NodeMaterialConnectionPoint;
  58298. protected _buildBlock(state: NodeMaterialBuildState): this;
  58299. }
  58300. }
  58301. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  58302. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58303. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58304. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58305. /**
  58306. * Block used to get negative version of a value (i.e. x * -1)
  58307. */
  58308. export class NegateBlock extends NodeMaterialBlock {
  58309. /**
  58310. * Creates a new NegateBlock
  58311. * @param name defines the block name
  58312. */
  58313. constructor(name: string);
  58314. /**
  58315. * Gets the current class name
  58316. * @returns the class name
  58317. */
  58318. getClassName(): string;
  58319. /**
  58320. * Gets the value input component
  58321. */
  58322. readonly value: NodeMaterialConnectionPoint;
  58323. /**
  58324. * Gets the output component
  58325. */
  58326. readonly output: NodeMaterialConnectionPoint;
  58327. protected _buildBlock(state: NodeMaterialBuildState): this;
  58328. }
  58329. }
  58330. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  58331. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58332. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58333. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58334. /**
  58335. * Block used to get the value of the first parameter raised to the power of the second
  58336. */
  58337. export class PowBlock extends NodeMaterialBlock {
  58338. /**
  58339. * Creates a new PowBlock
  58340. * @param name defines the block name
  58341. */
  58342. constructor(name: string);
  58343. /**
  58344. * Gets the current class name
  58345. * @returns the class name
  58346. */
  58347. getClassName(): string;
  58348. /**
  58349. * Gets the value operand input component
  58350. */
  58351. readonly value: NodeMaterialConnectionPoint;
  58352. /**
  58353. * Gets the power operand input component
  58354. */
  58355. readonly power: NodeMaterialConnectionPoint;
  58356. /**
  58357. * Gets the output component
  58358. */
  58359. readonly output: NodeMaterialConnectionPoint;
  58360. protected _buildBlock(state: NodeMaterialBuildState): this;
  58361. }
  58362. }
  58363. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  58364. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58365. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58366. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58367. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58368. /**
  58369. * Block used to get a random number
  58370. */
  58371. export class RandomNumberBlock extends NodeMaterialBlock {
  58372. /**
  58373. * Creates a new RandomNumberBlock
  58374. * @param name defines the block name
  58375. */
  58376. constructor(name: string);
  58377. /**
  58378. * Gets the current class name
  58379. * @returns the class name
  58380. */
  58381. getClassName(): string;
  58382. /**
  58383. * Gets the seed input component
  58384. */
  58385. readonly seed: NodeMaterialConnectionPoint;
  58386. /**
  58387. * Gets the output component
  58388. */
  58389. readonly output: NodeMaterialConnectionPoint;
  58390. protected _buildBlock(state: NodeMaterialBuildState): this;
  58391. }
  58392. }
  58393. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  58394. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58395. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58396. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58397. /**
  58398. * Block used to compute arc tangent of 2 values
  58399. */
  58400. export class ArcTan2Block extends NodeMaterialBlock {
  58401. /**
  58402. * Creates a new ArcTan2Block
  58403. * @param name defines the block name
  58404. */
  58405. constructor(name: string);
  58406. /**
  58407. * Gets the current class name
  58408. * @returns the class name
  58409. */
  58410. getClassName(): string;
  58411. /**
  58412. * Gets the x operand input component
  58413. */
  58414. readonly x: NodeMaterialConnectionPoint;
  58415. /**
  58416. * Gets the y operand input component
  58417. */
  58418. readonly y: NodeMaterialConnectionPoint;
  58419. /**
  58420. * Gets the output component
  58421. */
  58422. readonly output: NodeMaterialConnectionPoint;
  58423. protected _buildBlock(state: NodeMaterialBuildState): this;
  58424. }
  58425. }
  58426. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  58427. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58428. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58429. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58430. /**
  58431. * Block used to smooth step a value
  58432. */
  58433. export class SmoothStepBlock extends NodeMaterialBlock {
  58434. /**
  58435. * Creates a new SmoothStepBlock
  58436. * @param name defines the block name
  58437. */
  58438. constructor(name: string);
  58439. /**
  58440. * Gets the current class name
  58441. * @returns the class name
  58442. */
  58443. getClassName(): string;
  58444. /**
  58445. * Gets the value operand input component
  58446. */
  58447. readonly value: NodeMaterialConnectionPoint;
  58448. /**
  58449. * Gets the first edge operand input component
  58450. */
  58451. readonly edge0: NodeMaterialConnectionPoint;
  58452. /**
  58453. * Gets the second edge operand input component
  58454. */
  58455. readonly edge1: NodeMaterialConnectionPoint;
  58456. /**
  58457. * Gets the output component
  58458. */
  58459. readonly output: NodeMaterialConnectionPoint;
  58460. protected _buildBlock(state: NodeMaterialBuildState): this;
  58461. }
  58462. }
  58463. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  58464. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58465. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58466. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58467. /**
  58468. * Block used to get the reciprocal (1 / x) of a value
  58469. */
  58470. export class ReciprocalBlock extends NodeMaterialBlock {
  58471. /**
  58472. * Creates a new ReciprocalBlock
  58473. * @param name defines the block name
  58474. */
  58475. constructor(name: string);
  58476. /**
  58477. * Gets the current class name
  58478. * @returns the class name
  58479. */
  58480. getClassName(): string;
  58481. /**
  58482. * Gets the input component
  58483. */
  58484. readonly input: NodeMaterialConnectionPoint;
  58485. /**
  58486. * Gets the output component
  58487. */
  58488. readonly output: NodeMaterialConnectionPoint;
  58489. protected _buildBlock(state: NodeMaterialBuildState): this;
  58490. }
  58491. }
  58492. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  58493. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58494. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58495. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58496. /**
  58497. * Block used to replace a color by another one
  58498. */
  58499. export class ReplaceColorBlock extends NodeMaterialBlock {
  58500. /**
  58501. * Creates a new ReplaceColorBlock
  58502. * @param name defines the block name
  58503. */
  58504. constructor(name: string);
  58505. /**
  58506. * Gets the current class name
  58507. * @returns the class name
  58508. */
  58509. getClassName(): string;
  58510. /**
  58511. * Gets the value input component
  58512. */
  58513. readonly value: NodeMaterialConnectionPoint;
  58514. /**
  58515. * Gets the reference input component
  58516. */
  58517. readonly reference: NodeMaterialConnectionPoint;
  58518. /**
  58519. * Gets the distance input component
  58520. */
  58521. readonly distance: NodeMaterialConnectionPoint;
  58522. /**
  58523. * Gets the replacement input component
  58524. */
  58525. readonly replacement: NodeMaterialConnectionPoint;
  58526. /**
  58527. * Gets the output component
  58528. */
  58529. readonly output: NodeMaterialConnectionPoint;
  58530. protected _buildBlock(state: NodeMaterialBuildState): this;
  58531. }
  58532. }
  58533. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  58534. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58535. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58536. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58537. /**
  58538. * Block used to posterize a value
  58539. * @see https://en.wikipedia.org/wiki/Posterization
  58540. */
  58541. export class PosterizeBlock extends NodeMaterialBlock {
  58542. /**
  58543. * Creates a new PosterizeBlock
  58544. * @param name defines the block name
  58545. */
  58546. constructor(name: string);
  58547. /**
  58548. * Gets the current class name
  58549. * @returns the class name
  58550. */
  58551. getClassName(): string;
  58552. /**
  58553. * Gets the value input component
  58554. */
  58555. readonly value: NodeMaterialConnectionPoint;
  58556. /**
  58557. * Gets the steps input component
  58558. */
  58559. readonly steps: NodeMaterialConnectionPoint;
  58560. /**
  58561. * Gets the output component
  58562. */
  58563. readonly output: NodeMaterialConnectionPoint;
  58564. protected _buildBlock(state: NodeMaterialBuildState): this;
  58565. }
  58566. }
  58567. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  58568. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58569. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58570. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58571. import { Scene } from "babylonjs/scene";
  58572. /**
  58573. * Operations supported by the Wave block
  58574. */
  58575. export enum WaveBlockKind {
  58576. /** SawTooth */
  58577. SawTooth = 0,
  58578. /** Square */
  58579. Square = 1,
  58580. /** Triangle */
  58581. Triangle = 2
  58582. }
  58583. /**
  58584. * Block used to apply wave operation to floats
  58585. */
  58586. export class WaveBlock extends NodeMaterialBlock {
  58587. /**
  58588. * Gets or sets the kibnd of wave to be applied by the block
  58589. */
  58590. kind: WaveBlockKind;
  58591. /**
  58592. * Creates a new WaveBlock
  58593. * @param name defines the block name
  58594. */
  58595. constructor(name: string);
  58596. /**
  58597. * Gets the current class name
  58598. * @returns the class name
  58599. */
  58600. getClassName(): string;
  58601. /**
  58602. * Gets the input component
  58603. */
  58604. readonly input: NodeMaterialConnectionPoint;
  58605. /**
  58606. * Gets the output component
  58607. */
  58608. readonly output: NodeMaterialConnectionPoint;
  58609. protected _buildBlock(state: NodeMaterialBuildState): this;
  58610. serialize(): any;
  58611. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  58612. }
  58613. }
  58614. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  58615. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58616. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58617. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58618. import { Color3 } from "babylonjs/Maths/math.color";
  58619. import { Scene } from "babylonjs/scene";
  58620. /**
  58621. * Class used to store a color step for the GradientBlock
  58622. */
  58623. export class GradientBlockColorStep {
  58624. /**
  58625. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  58626. */
  58627. step: number;
  58628. /**
  58629. * Gets or sets the color associated with this step
  58630. */
  58631. color: Color3;
  58632. /**
  58633. * Creates a new GradientBlockColorStep
  58634. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  58635. * @param color defines the color associated with this step
  58636. */
  58637. constructor(
  58638. /**
  58639. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  58640. */
  58641. step: number,
  58642. /**
  58643. * Gets or sets the color associated with this step
  58644. */
  58645. color: Color3);
  58646. }
  58647. /**
  58648. * Block used to return a color from a gradient based on an input value between 0 and 1
  58649. */
  58650. export class GradientBlock extends NodeMaterialBlock {
  58651. /**
  58652. * Gets or sets the list of color steps
  58653. */
  58654. colorSteps: GradientBlockColorStep[];
  58655. /**
  58656. * Creates a new GradientBlock
  58657. * @param name defines the block name
  58658. */
  58659. constructor(name: string);
  58660. /**
  58661. * Gets the current class name
  58662. * @returns the class name
  58663. */
  58664. getClassName(): string;
  58665. /**
  58666. * Gets the gradient input component
  58667. */
  58668. readonly gradient: NodeMaterialConnectionPoint;
  58669. /**
  58670. * Gets the output component
  58671. */
  58672. readonly output: NodeMaterialConnectionPoint;
  58673. private _writeColorConstant;
  58674. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  58675. serialize(): any;
  58676. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  58677. protected _dumpPropertiesCode(): string;
  58678. }
  58679. }
  58680. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  58681. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58682. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58683. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58684. /**
  58685. * Block used to normalize lerp between 2 values
  58686. */
  58687. export class NLerpBlock extends NodeMaterialBlock {
  58688. /**
  58689. * Creates a new NLerpBlock
  58690. * @param name defines the block name
  58691. */
  58692. constructor(name: string);
  58693. /**
  58694. * Gets the current class name
  58695. * @returns the class name
  58696. */
  58697. getClassName(): string;
  58698. /**
  58699. * Gets the left operand input component
  58700. */
  58701. readonly left: NodeMaterialConnectionPoint;
  58702. /**
  58703. * Gets the right operand input component
  58704. */
  58705. readonly right: NodeMaterialConnectionPoint;
  58706. /**
  58707. * Gets the gradient operand input component
  58708. */
  58709. readonly gradient: NodeMaterialConnectionPoint;
  58710. /**
  58711. * Gets the output component
  58712. */
  58713. readonly output: NodeMaterialConnectionPoint;
  58714. protected _buildBlock(state: NodeMaterialBuildState): this;
  58715. }
  58716. }
  58717. declare module "babylonjs/Materials/Node/Blocks/frontFacingBlock" {
  58718. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58719. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58720. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58721. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58722. /**
  58723. * Block used to test if the fragment shader is front facing
  58724. */
  58725. export class FrontFacingBlock extends NodeMaterialBlock {
  58726. /**
  58727. * Creates a new FrontFacingBlock
  58728. * @param name defines the block name
  58729. */
  58730. constructor(name: string);
  58731. /**
  58732. * Gets the current class name
  58733. * @returns the class name
  58734. */
  58735. getClassName(): string;
  58736. /**
  58737. * Gets the world normal component
  58738. */
  58739. readonly worldNormal: NodeMaterialConnectionPoint;
  58740. /**
  58741. * Gets the view direction input component
  58742. */
  58743. readonly viewDirection: NodeMaterialConnectionPoint;
  58744. /**
  58745. * Gets the output component
  58746. */
  58747. readonly output: NodeMaterialConnectionPoint;
  58748. autoConfigure(material: NodeMaterial): void;
  58749. protected _buildBlock(state: NodeMaterialBuildState): this;
  58750. }
  58751. }
  58752. declare module "babylonjs/Materials/Node/Blocks/index" {
  58753. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  58754. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  58755. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  58756. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  58757. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  58758. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  58759. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  58760. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  58761. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  58762. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  58763. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  58764. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  58765. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  58766. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  58767. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  58768. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  58769. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  58770. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  58771. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  58772. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  58773. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  58774. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  58775. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  58776. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  58777. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  58778. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  58779. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  58780. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  58781. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  58782. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  58783. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  58784. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  58785. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  58786. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  58787. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  58788. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  58789. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  58790. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  58791. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  58792. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  58793. export * from "babylonjs/Materials/Node/Blocks/frontFacingBlock";
  58794. }
  58795. declare module "babylonjs/Materials/Node/Optimizers/index" {
  58796. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  58797. }
  58798. declare module "babylonjs/Materials/Node/index" {
  58799. export * from "babylonjs/Materials/Node/Enums/index";
  58800. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58801. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  58802. export * from "babylonjs/Materials/Node/nodeMaterial";
  58803. export * from "babylonjs/Materials/Node/Blocks/index";
  58804. export * from "babylonjs/Materials/Node/Optimizers/index";
  58805. }
  58806. declare module "babylonjs/Materials/effectRenderer" {
  58807. import { Nullable } from "babylonjs/types";
  58808. import { Texture } from "babylonjs/Materials/Textures/texture";
  58809. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  58810. import { Viewport } from "babylonjs/Maths/math.viewport";
  58811. import { Observable } from "babylonjs/Misc/observable";
  58812. import { Effect } from "babylonjs/Materials/effect";
  58813. import "babylonjs/Engines/Extensions/engine.renderTarget";
  58814. import "babylonjs/Shaders/postprocess.vertex";
  58815. /**
  58816. * Effect Render Options
  58817. */
  58818. export interface IEffectRendererOptions {
  58819. /**
  58820. * Defines the vertices positions.
  58821. */
  58822. positions?: number[];
  58823. /**
  58824. * Defines the indices.
  58825. */
  58826. indices?: number[];
  58827. }
  58828. /**
  58829. * Helper class to render one or more effects
  58830. */
  58831. export class EffectRenderer {
  58832. private engine;
  58833. private static _DefaultOptions;
  58834. private _vertexBuffers;
  58835. private _indexBuffer;
  58836. private _ringBufferIndex;
  58837. private _ringScreenBuffer;
  58838. private _fullscreenViewport;
  58839. private _getNextFrameBuffer;
  58840. /**
  58841. * Creates an effect renderer
  58842. * @param engine the engine to use for rendering
  58843. * @param options defines the options of the effect renderer
  58844. */
  58845. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  58846. /**
  58847. * Sets the current viewport in normalized coordinates 0-1
  58848. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  58849. */
  58850. setViewport(viewport?: Viewport): void;
  58851. /**
  58852. * Binds the embedded attributes buffer to the effect.
  58853. * @param effect Defines the effect to bind the attributes for
  58854. */
  58855. bindBuffers(effect: Effect): void;
  58856. /**
  58857. * Sets the current effect wrapper to use during draw.
  58858. * The effect needs to be ready before calling this api.
  58859. * This also sets the default full screen position attribute.
  58860. * @param effectWrapper Defines the effect to draw with
  58861. */
  58862. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  58863. /**
  58864. * Draws a full screen quad.
  58865. */
  58866. draw(): void;
  58867. /**
  58868. * renders one or more effects to a specified texture
  58869. * @param effectWrappers list of effects to renderer
  58870. * @param outputTexture texture to draw to, if null it will render to the screen
  58871. */
  58872. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  58873. /**
  58874. * Disposes of the effect renderer
  58875. */
  58876. dispose(): void;
  58877. }
  58878. /**
  58879. * Options to create an EffectWrapper
  58880. */
  58881. interface EffectWrapperCreationOptions {
  58882. /**
  58883. * Engine to use to create the effect
  58884. */
  58885. engine: ThinEngine;
  58886. /**
  58887. * Fragment shader for the effect
  58888. */
  58889. fragmentShader: string;
  58890. /**
  58891. * Vertex shader for the effect
  58892. */
  58893. vertexShader?: string;
  58894. /**
  58895. * Attributes to use in the shader
  58896. */
  58897. attributeNames?: Array<string>;
  58898. /**
  58899. * Uniforms to use in the shader
  58900. */
  58901. uniformNames?: Array<string>;
  58902. /**
  58903. * Texture sampler names to use in the shader
  58904. */
  58905. samplerNames?: Array<string>;
  58906. /**
  58907. * The friendly name of the effect displayed in Spector.
  58908. */
  58909. name?: string;
  58910. }
  58911. /**
  58912. * Wraps an effect to be used for rendering
  58913. */
  58914. export class EffectWrapper {
  58915. /**
  58916. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  58917. */
  58918. onApplyObservable: Observable<{}>;
  58919. /**
  58920. * The underlying effect
  58921. */
  58922. effect: Effect;
  58923. /**
  58924. * Creates an effect to be renderer
  58925. * @param creationOptions options to create the effect
  58926. */
  58927. constructor(creationOptions: EffectWrapperCreationOptions);
  58928. /**
  58929. * Disposes of the effect wrapper
  58930. */
  58931. dispose(): void;
  58932. }
  58933. }
  58934. declare module "babylonjs/Materials/index" {
  58935. export * from "babylonjs/Materials/Background/index";
  58936. export * from "babylonjs/Materials/colorCurves";
  58937. export * from "babylonjs/Materials/iEffectFallbacks";
  58938. export * from "babylonjs/Materials/effectFallbacks";
  58939. export * from "babylonjs/Materials/effect";
  58940. export * from "babylonjs/Materials/fresnelParameters";
  58941. export * from "babylonjs/Materials/imageProcessingConfiguration";
  58942. export * from "babylonjs/Materials/material";
  58943. export * from "babylonjs/Materials/materialDefines";
  58944. export * from "babylonjs/Materials/materialHelper";
  58945. export * from "babylonjs/Materials/multiMaterial";
  58946. export * from "babylonjs/Materials/PBR/index";
  58947. export * from "babylonjs/Materials/pushMaterial";
  58948. export * from "babylonjs/Materials/shaderMaterial";
  58949. export * from "babylonjs/Materials/standardMaterial";
  58950. export * from "babylonjs/Materials/Textures/index";
  58951. export * from "babylonjs/Materials/uniformBuffer";
  58952. export * from "babylonjs/Materials/materialFlags";
  58953. export * from "babylonjs/Materials/Node/index";
  58954. export * from "babylonjs/Materials/effectRenderer";
  58955. }
  58956. declare module "babylonjs/Maths/index" {
  58957. export * from "babylonjs/Maths/math.scalar";
  58958. export * from "babylonjs/Maths/math";
  58959. export * from "babylonjs/Maths/sphericalPolynomial";
  58960. }
  58961. declare module "babylonjs/Misc/workerPool" {
  58962. import { IDisposable } from "babylonjs/scene";
  58963. /**
  58964. * Helper class to push actions to a pool of workers.
  58965. */
  58966. export class WorkerPool implements IDisposable {
  58967. private _workerInfos;
  58968. private _pendingActions;
  58969. /**
  58970. * Constructor
  58971. * @param workers Array of workers to use for actions
  58972. */
  58973. constructor(workers: Array<Worker>);
  58974. /**
  58975. * Terminates all workers and clears any pending actions.
  58976. */
  58977. dispose(): void;
  58978. /**
  58979. * Pushes an action to the worker pool. If all the workers are active, the action will be
  58980. * pended until a worker has completed its action.
  58981. * @param action The action to perform. Call onComplete when the action is complete.
  58982. */
  58983. push(action: (worker: Worker, onComplete: () => void) => void): void;
  58984. private _execute;
  58985. }
  58986. }
  58987. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  58988. import { IDisposable } from "babylonjs/scene";
  58989. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  58990. /**
  58991. * Configuration for Draco compression
  58992. */
  58993. export interface IDracoCompressionConfiguration {
  58994. /**
  58995. * Configuration for the decoder.
  58996. */
  58997. decoder: {
  58998. /**
  58999. * The url to the WebAssembly module.
  59000. */
  59001. wasmUrl?: string;
  59002. /**
  59003. * The url to the WebAssembly binary.
  59004. */
  59005. wasmBinaryUrl?: string;
  59006. /**
  59007. * The url to the fallback JavaScript module.
  59008. */
  59009. fallbackUrl?: string;
  59010. };
  59011. }
  59012. /**
  59013. * Draco compression (https://google.github.io/draco/)
  59014. *
  59015. * This class wraps the Draco module.
  59016. *
  59017. * **Encoder**
  59018. *
  59019. * The encoder is not currently implemented.
  59020. *
  59021. * **Decoder**
  59022. *
  59023. * 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.
  59024. *
  59025. * To update the configuration, use the following code:
  59026. * ```javascript
  59027. * DracoCompression.Configuration = {
  59028. * decoder: {
  59029. * wasmUrl: "<url to the WebAssembly library>",
  59030. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  59031. * fallbackUrl: "<url to the fallback JavaScript library>",
  59032. * }
  59033. * };
  59034. * ```
  59035. *
  59036. * 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.
  59037. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  59038. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  59039. *
  59040. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  59041. * ```javascript
  59042. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  59043. * ```
  59044. *
  59045. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  59046. */
  59047. export class DracoCompression implements IDisposable {
  59048. private _workerPoolPromise?;
  59049. private _decoderModulePromise?;
  59050. /**
  59051. * The configuration. Defaults to the following urls:
  59052. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  59053. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  59054. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  59055. */
  59056. static Configuration: IDracoCompressionConfiguration;
  59057. /**
  59058. * Returns true if the decoder configuration is available.
  59059. */
  59060. static readonly DecoderAvailable: boolean;
  59061. /**
  59062. * Default number of workers to create when creating the draco compression object.
  59063. */
  59064. static DefaultNumWorkers: number;
  59065. private static GetDefaultNumWorkers;
  59066. private static _Default;
  59067. /**
  59068. * Default instance for the draco compression object.
  59069. */
  59070. static readonly Default: DracoCompression;
  59071. /**
  59072. * Constructor
  59073. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  59074. */
  59075. constructor(numWorkers?: number);
  59076. /**
  59077. * Stop all async operations and release resources.
  59078. */
  59079. dispose(): void;
  59080. /**
  59081. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  59082. * @returns a promise that resolves when ready
  59083. */
  59084. whenReadyAsync(): Promise<void>;
  59085. /**
  59086. * Decode Draco compressed mesh data to vertex data.
  59087. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  59088. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  59089. * @returns A promise that resolves with the decoded vertex data
  59090. */
  59091. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  59092. [kind: string]: number;
  59093. }): Promise<VertexData>;
  59094. }
  59095. }
  59096. declare module "babylonjs/Meshes/Compression/index" {
  59097. export * from "babylonjs/Meshes/Compression/dracoCompression";
  59098. }
  59099. declare module "babylonjs/Meshes/csg" {
  59100. import { Nullable } from "babylonjs/types";
  59101. import { Scene } from "babylonjs/scene";
  59102. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  59103. import { Mesh } from "babylonjs/Meshes/mesh";
  59104. import { Material } from "babylonjs/Materials/material";
  59105. /**
  59106. * Class for building Constructive Solid Geometry
  59107. */
  59108. export class CSG {
  59109. private polygons;
  59110. /**
  59111. * The world matrix
  59112. */
  59113. matrix: Matrix;
  59114. /**
  59115. * Stores the position
  59116. */
  59117. position: Vector3;
  59118. /**
  59119. * Stores the rotation
  59120. */
  59121. rotation: Vector3;
  59122. /**
  59123. * Stores the rotation quaternion
  59124. */
  59125. rotationQuaternion: Nullable<Quaternion>;
  59126. /**
  59127. * Stores the scaling vector
  59128. */
  59129. scaling: Vector3;
  59130. /**
  59131. * Convert the Mesh to CSG
  59132. * @param mesh The Mesh to convert to CSG
  59133. * @returns A new CSG from the Mesh
  59134. */
  59135. static FromMesh(mesh: Mesh): CSG;
  59136. /**
  59137. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  59138. * @param polygons Polygons used to construct a CSG solid
  59139. */
  59140. private static FromPolygons;
  59141. /**
  59142. * Clones, or makes a deep copy, of the CSG
  59143. * @returns A new CSG
  59144. */
  59145. clone(): CSG;
  59146. /**
  59147. * Unions this CSG with another CSG
  59148. * @param csg The CSG to union against this CSG
  59149. * @returns The unioned CSG
  59150. */
  59151. union(csg: CSG): CSG;
  59152. /**
  59153. * Unions this CSG with another CSG in place
  59154. * @param csg The CSG to union against this CSG
  59155. */
  59156. unionInPlace(csg: CSG): void;
  59157. /**
  59158. * Subtracts this CSG with another CSG
  59159. * @param csg The CSG to subtract against this CSG
  59160. * @returns A new CSG
  59161. */
  59162. subtract(csg: CSG): CSG;
  59163. /**
  59164. * Subtracts this CSG with another CSG in place
  59165. * @param csg The CSG to subtact against this CSG
  59166. */
  59167. subtractInPlace(csg: CSG): void;
  59168. /**
  59169. * Intersect this CSG with another CSG
  59170. * @param csg The CSG to intersect against this CSG
  59171. * @returns A new CSG
  59172. */
  59173. intersect(csg: CSG): CSG;
  59174. /**
  59175. * Intersects this CSG with another CSG in place
  59176. * @param csg The CSG to intersect against this CSG
  59177. */
  59178. intersectInPlace(csg: CSG): void;
  59179. /**
  59180. * Return a new CSG solid with solid and empty space switched. This solid is
  59181. * not modified.
  59182. * @returns A new CSG solid with solid and empty space switched
  59183. */
  59184. inverse(): CSG;
  59185. /**
  59186. * Inverses the CSG in place
  59187. */
  59188. inverseInPlace(): void;
  59189. /**
  59190. * This is used to keep meshes transformations so they can be restored
  59191. * when we build back a Babylon Mesh
  59192. * NB : All CSG operations are performed in world coordinates
  59193. * @param csg The CSG to copy the transform attributes from
  59194. * @returns This CSG
  59195. */
  59196. copyTransformAttributes(csg: CSG): CSG;
  59197. /**
  59198. * Build Raw mesh from CSG
  59199. * Coordinates here are in world space
  59200. * @param name The name of the mesh geometry
  59201. * @param scene The Scene
  59202. * @param keepSubMeshes Specifies if the submeshes should be kept
  59203. * @returns A new Mesh
  59204. */
  59205. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  59206. /**
  59207. * Build Mesh from CSG taking material and transforms into account
  59208. * @param name The name of the Mesh
  59209. * @param material The material of the Mesh
  59210. * @param scene The Scene
  59211. * @param keepSubMeshes Specifies if submeshes should be kept
  59212. * @returns The new Mesh
  59213. */
  59214. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  59215. }
  59216. }
  59217. declare module "babylonjs/Meshes/trailMesh" {
  59218. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59219. import { Mesh } from "babylonjs/Meshes/mesh";
  59220. import { Scene } from "babylonjs/scene";
  59221. /**
  59222. * Class used to create a trail following a mesh
  59223. */
  59224. export class TrailMesh extends Mesh {
  59225. private _generator;
  59226. private _autoStart;
  59227. private _running;
  59228. private _diameter;
  59229. private _length;
  59230. private _sectionPolygonPointsCount;
  59231. private _sectionVectors;
  59232. private _sectionNormalVectors;
  59233. private _beforeRenderObserver;
  59234. /**
  59235. * @constructor
  59236. * @param name The value used by scene.getMeshByName() to do a lookup.
  59237. * @param generator The mesh to generate a trail.
  59238. * @param scene The scene to add this mesh to.
  59239. * @param diameter Diameter of trailing mesh. Default is 1.
  59240. * @param length Length of trailing mesh. Default is 60.
  59241. * @param autoStart Automatically start trailing mesh. Default true.
  59242. */
  59243. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  59244. /**
  59245. * "TrailMesh"
  59246. * @returns "TrailMesh"
  59247. */
  59248. getClassName(): string;
  59249. private _createMesh;
  59250. /**
  59251. * Start trailing mesh.
  59252. */
  59253. start(): void;
  59254. /**
  59255. * Stop trailing mesh.
  59256. */
  59257. stop(): void;
  59258. /**
  59259. * Update trailing mesh geometry.
  59260. */
  59261. update(): void;
  59262. /**
  59263. * Returns a new TrailMesh object.
  59264. * @param name is a string, the name given to the new mesh
  59265. * @param newGenerator use new generator object for cloned trail mesh
  59266. * @returns a new mesh
  59267. */
  59268. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  59269. /**
  59270. * Serializes this trail mesh
  59271. * @param serializationObject object to write serialization to
  59272. */
  59273. serialize(serializationObject: any): void;
  59274. /**
  59275. * Parses a serialized trail mesh
  59276. * @param parsedMesh the serialized mesh
  59277. * @param scene the scene to create the trail mesh in
  59278. * @returns the created trail mesh
  59279. */
  59280. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  59281. }
  59282. }
  59283. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  59284. import { Nullable } from "babylonjs/types";
  59285. import { Scene } from "babylonjs/scene";
  59286. import { Vector4 } from "babylonjs/Maths/math.vector";
  59287. import { Color4 } from "babylonjs/Maths/math.color";
  59288. import { Mesh } from "babylonjs/Meshes/mesh";
  59289. /**
  59290. * Class containing static functions to help procedurally build meshes
  59291. */
  59292. export class TiledBoxBuilder {
  59293. /**
  59294. * Creates a box mesh
  59295. * 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)
  59296. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  59297. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59298. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59299. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59300. * @param name defines the name of the mesh
  59301. * @param options defines the options used to create the mesh
  59302. * @param scene defines the hosting scene
  59303. * @returns the box mesh
  59304. */
  59305. static CreateTiledBox(name: string, options: {
  59306. pattern?: number;
  59307. width?: number;
  59308. height?: number;
  59309. depth?: number;
  59310. tileSize?: number;
  59311. tileWidth?: number;
  59312. tileHeight?: number;
  59313. alignHorizontal?: number;
  59314. alignVertical?: number;
  59315. faceUV?: Vector4[];
  59316. faceColors?: Color4[];
  59317. sideOrientation?: number;
  59318. updatable?: boolean;
  59319. }, scene?: Nullable<Scene>): Mesh;
  59320. }
  59321. }
  59322. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  59323. import { Vector4 } from "babylonjs/Maths/math.vector";
  59324. import { Mesh } from "babylonjs/Meshes/mesh";
  59325. /**
  59326. * Class containing static functions to help procedurally build meshes
  59327. */
  59328. export class TorusKnotBuilder {
  59329. /**
  59330. * Creates a torus knot mesh
  59331. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  59332. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  59333. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  59334. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  59335. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59336. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59337. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  59338. * @param name defines the name of the mesh
  59339. * @param options defines the options used to create the mesh
  59340. * @param scene defines the hosting scene
  59341. * @returns the torus knot mesh
  59342. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  59343. */
  59344. static CreateTorusKnot(name: string, options: {
  59345. radius?: number;
  59346. tube?: number;
  59347. radialSegments?: number;
  59348. tubularSegments?: number;
  59349. p?: number;
  59350. q?: number;
  59351. updatable?: boolean;
  59352. sideOrientation?: number;
  59353. frontUVs?: Vector4;
  59354. backUVs?: Vector4;
  59355. }, scene: any): Mesh;
  59356. }
  59357. }
  59358. declare module "babylonjs/Meshes/polygonMesh" {
  59359. import { Scene } from "babylonjs/scene";
  59360. import { Vector2 } from "babylonjs/Maths/math.vector";
  59361. import { Mesh } from "babylonjs/Meshes/mesh";
  59362. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  59363. import { Path2 } from "babylonjs/Maths/math.path";
  59364. /**
  59365. * Polygon
  59366. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  59367. */
  59368. export class Polygon {
  59369. /**
  59370. * Creates a rectangle
  59371. * @param xmin bottom X coord
  59372. * @param ymin bottom Y coord
  59373. * @param xmax top X coord
  59374. * @param ymax top Y coord
  59375. * @returns points that make the resulting rectation
  59376. */
  59377. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  59378. /**
  59379. * Creates a circle
  59380. * @param radius radius of circle
  59381. * @param cx scale in x
  59382. * @param cy scale in y
  59383. * @param numberOfSides number of sides that make up the circle
  59384. * @returns points that make the resulting circle
  59385. */
  59386. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  59387. /**
  59388. * Creates a polygon from input string
  59389. * @param input Input polygon data
  59390. * @returns the parsed points
  59391. */
  59392. static Parse(input: string): Vector2[];
  59393. /**
  59394. * Starts building a polygon from x and y coordinates
  59395. * @param x x coordinate
  59396. * @param y y coordinate
  59397. * @returns the started path2
  59398. */
  59399. static StartingAt(x: number, y: number): Path2;
  59400. }
  59401. /**
  59402. * Builds a polygon
  59403. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  59404. */
  59405. export class PolygonMeshBuilder {
  59406. private _points;
  59407. private _outlinepoints;
  59408. private _holes;
  59409. private _name;
  59410. private _scene;
  59411. private _epoints;
  59412. private _eholes;
  59413. private _addToepoint;
  59414. /**
  59415. * Babylon reference to the earcut plugin.
  59416. */
  59417. bjsEarcut: any;
  59418. /**
  59419. * Creates a PolygonMeshBuilder
  59420. * @param name name of the builder
  59421. * @param contours Path of the polygon
  59422. * @param scene scene to add to when creating the mesh
  59423. * @param earcutInjection can be used to inject your own earcut reference
  59424. */
  59425. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  59426. /**
  59427. * Adds a whole within the polygon
  59428. * @param hole Array of points defining the hole
  59429. * @returns this
  59430. */
  59431. addHole(hole: Vector2[]): PolygonMeshBuilder;
  59432. /**
  59433. * Creates the polygon
  59434. * @param updatable If the mesh should be updatable
  59435. * @param depth The depth of the mesh created
  59436. * @returns the created mesh
  59437. */
  59438. build(updatable?: boolean, depth?: number): Mesh;
  59439. /**
  59440. * Creates the polygon
  59441. * @param depth The depth of the mesh created
  59442. * @returns the created VertexData
  59443. */
  59444. buildVertexData(depth?: number): VertexData;
  59445. /**
  59446. * Adds a side to the polygon
  59447. * @param positions points that make the polygon
  59448. * @param normals normals of the polygon
  59449. * @param uvs uvs of the polygon
  59450. * @param indices indices of the polygon
  59451. * @param bounds bounds of the polygon
  59452. * @param points points of the polygon
  59453. * @param depth depth of the polygon
  59454. * @param flip flip of the polygon
  59455. */
  59456. private addSide;
  59457. }
  59458. }
  59459. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  59460. import { Scene } from "babylonjs/scene";
  59461. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  59462. import { Color4 } from "babylonjs/Maths/math.color";
  59463. import { Mesh } from "babylonjs/Meshes/mesh";
  59464. import { Nullable } from "babylonjs/types";
  59465. /**
  59466. * Class containing static functions to help procedurally build meshes
  59467. */
  59468. export class PolygonBuilder {
  59469. /**
  59470. * Creates a polygon mesh
  59471. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  59472. * * 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
  59473. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  59474. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59475. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  59476. * * Remember you can only change the shape positions, not their number when updating a polygon
  59477. * @param name defines the name of the mesh
  59478. * @param options defines the options used to create the mesh
  59479. * @param scene defines the hosting scene
  59480. * @param earcutInjection can be used to inject your own earcut reference
  59481. * @returns the polygon mesh
  59482. */
  59483. static CreatePolygon(name: string, options: {
  59484. shape: Vector3[];
  59485. holes?: Vector3[][];
  59486. depth?: number;
  59487. faceUV?: Vector4[];
  59488. faceColors?: Color4[];
  59489. updatable?: boolean;
  59490. sideOrientation?: number;
  59491. frontUVs?: Vector4;
  59492. backUVs?: Vector4;
  59493. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  59494. /**
  59495. * Creates an extruded polygon mesh, with depth in the Y direction.
  59496. * * 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)
  59497. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  59498. * @param name defines the name of the mesh
  59499. * @param options defines the options used to create the mesh
  59500. * @param scene defines the hosting scene
  59501. * @param earcutInjection can be used to inject your own earcut reference
  59502. * @returns the polygon mesh
  59503. */
  59504. static ExtrudePolygon(name: string, options: {
  59505. shape: Vector3[];
  59506. holes?: Vector3[][];
  59507. depth?: number;
  59508. faceUV?: Vector4[];
  59509. faceColors?: Color4[];
  59510. updatable?: boolean;
  59511. sideOrientation?: number;
  59512. frontUVs?: Vector4;
  59513. backUVs?: Vector4;
  59514. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  59515. }
  59516. }
  59517. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  59518. import { Scene } from "babylonjs/scene";
  59519. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  59520. import { Mesh } from "babylonjs/Meshes/mesh";
  59521. import { Nullable } from "babylonjs/types";
  59522. /**
  59523. * Class containing static functions to help procedurally build meshes
  59524. */
  59525. export class LatheBuilder {
  59526. /**
  59527. * Creates lathe mesh.
  59528. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  59529. * * 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
  59530. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  59531. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  59532. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  59533. * * 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
  59534. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  59535. * * 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
  59536. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59537. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59538. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  59539. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59540. * @param name defines the name of the mesh
  59541. * @param options defines the options used to create the mesh
  59542. * @param scene defines the hosting scene
  59543. * @returns the lathe mesh
  59544. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  59545. */
  59546. static CreateLathe(name: string, options: {
  59547. shape: Vector3[];
  59548. radius?: number;
  59549. tessellation?: number;
  59550. clip?: number;
  59551. arc?: number;
  59552. closed?: boolean;
  59553. updatable?: boolean;
  59554. sideOrientation?: number;
  59555. frontUVs?: Vector4;
  59556. backUVs?: Vector4;
  59557. cap?: number;
  59558. invertUV?: boolean;
  59559. }, scene?: Nullable<Scene>): Mesh;
  59560. }
  59561. }
  59562. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  59563. import { Nullable } from "babylonjs/types";
  59564. import { Scene } from "babylonjs/scene";
  59565. import { Vector4 } from "babylonjs/Maths/math.vector";
  59566. import { Mesh } from "babylonjs/Meshes/mesh";
  59567. /**
  59568. * Class containing static functions to help procedurally build meshes
  59569. */
  59570. export class TiledPlaneBuilder {
  59571. /**
  59572. * Creates a tiled plane mesh
  59573. * * The parameter `pattern` will, depending on value, do nothing or
  59574. * * * flip (reflect about central vertical) alternate tiles across and up
  59575. * * * flip every tile on alternate rows
  59576. * * * rotate (180 degs) alternate tiles across and up
  59577. * * * rotate every tile on alternate rows
  59578. * * * flip and rotate alternate tiles across and up
  59579. * * * flip and rotate every tile on alternate rows
  59580. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  59581. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  59582. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59583. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  59584. * * 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)
  59585. * * 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)
  59586. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  59587. * @param name defines the name of the mesh
  59588. * @param options defines the options used to create the mesh
  59589. * @param scene defines the hosting scene
  59590. * @returns the box mesh
  59591. */
  59592. static CreateTiledPlane(name: string, options: {
  59593. pattern?: number;
  59594. tileSize?: number;
  59595. tileWidth?: number;
  59596. tileHeight?: number;
  59597. size?: number;
  59598. width?: number;
  59599. height?: number;
  59600. alignHorizontal?: number;
  59601. alignVertical?: number;
  59602. sideOrientation?: number;
  59603. frontUVs?: Vector4;
  59604. backUVs?: Vector4;
  59605. updatable?: boolean;
  59606. }, scene?: Nullable<Scene>): Mesh;
  59607. }
  59608. }
  59609. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  59610. import { Nullable } from "babylonjs/types";
  59611. import { Scene } from "babylonjs/scene";
  59612. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  59613. import { Mesh } from "babylonjs/Meshes/mesh";
  59614. /**
  59615. * Class containing static functions to help procedurally build meshes
  59616. */
  59617. export class TubeBuilder {
  59618. /**
  59619. * Creates a tube mesh.
  59620. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  59621. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  59622. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  59623. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  59624. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  59625. * * 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)
  59626. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  59627. * * 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
  59628. * * 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
  59629. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59630. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59631. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  59632. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59633. * @param name defines the name of the mesh
  59634. * @param options defines the options used to create the mesh
  59635. * @param scene defines the hosting scene
  59636. * @returns the tube mesh
  59637. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  59638. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  59639. */
  59640. static CreateTube(name: string, options: {
  59641. path: Vector3[];
  59642. radius?: number;
  59643. tessellation?: number;
  59644. radiusFunction?: {
  59645. (i: number, distance: number): number;
  59646. };
  59647. cap?: number;
  59648. arc?: number;
  59649. updatable?: boolean;
  59650. sideOrientation?: number;
  59651. frontUVs?: Vector4;
  59652. backUVs?: Vector4;
  59653. instance?: Mesh;
  59654. invertUV?: boolean;
  59655. }, scene?: Nullable<Scene>): Mesh;
  59656. }
  59657. }
  59658. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  59659. import { Scene } from "babylonjs/scene";
  59660. import { Vector4 } from "babylonjs/Maths/math.vector";
  59661. import { Mesh } from "babylonjs/Meshes/mesh";
  59662. import { Nullable } from "babylonjs/types";
  59663. /**
  59664. * Class containing static functions to help procedurally build meshes
  59665. */
  59666. export class IcoSphereBuilder {
  59667. /**
  59668. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  59669. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  59670. * * 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`)
  59671. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  59672. * * 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
  59673. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59674. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59675. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59676. * @param name defines the name of the mesh
  59677. * @param options defines the options used to create the mesh
  59678. * @param scene defines the hosting scene
  59679. * @returns the icosahedron mesh
  59680. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  59681. */
  59682. static CreateIcoSphere(name: string, options: {
  59683. radius?: number;
  59684. radiusX?: number;
  59685. radiusY?: number;
  59686. radiusZ?: number;
  59687. flat?: boolean;
  59688. subdivisions?: number;
  59689. sideOrientation?: number;
  59690. frontUVs?: Vector4;
  59691. backUVs?: Vector4;
  59692. updatable?: boolean;
  59693. }, scene?: Nullable<Scene>): Mesh;
  59694. }
  59695. }
  59696. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  59697. import { Vector3 } from "babylonjs/Maths/math.vector";
  59698. import { Mesh } from "babylonjs/Meshes/mesh";
  59699. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59700. /**
  59701. * Class containing static functions to help procedurally build meshes
  59702. */
  59703. export class DecalBuilder {
  59704. /**
  59705. * Creates a decal mesh.
  59706. * 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
  59707. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  59708. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  59709. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  59710. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  59711. * @param name defines the name of the mesh
  59712. * @param sourceMesh defines the mesh where the decal must be applied
  59713. * @param options defines the options used to create the mesh
  59714. * @param scene defines the hosting scene
  59715. * @returns the decal mesh
  59716. * @see https://doc.babylonjs.com/how_to/decals
  59717. */
  59718. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  59719. position?: Vector3;
  59720. normal?: Vector3;
  59721. size?: Vector3;
  59722. angle?: number;
  59723. }): Mesh;
  59724. }
  59725. }
  59726. declare module "babylonjs/Meshes/meshBuilder" {
  59727. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  59728. import { Nullable } from "babylonjs/types";
  59729. import { Scene } from "babylonjs/scene";
  59730. import { Mesh } from "babylonjs/Meshes/mesh";
  59731. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  59732. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  59733. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59734. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  59735. import { Plane } from "babylonjs/Maths/math.plane";
  59736. /**
  59737. * Class containing static functions to help procedurally build meshes
  59738. */
  59739. export class MeshBuilder {
  59740. /**
  59741. * Creates a box mesh
  59742. * * The parameter `size` sets the size (float) of each box side (default 1)
  59743. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  59744. * * 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)
  59745. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  59746. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59747. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59748. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59749. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  59750. * @param name defines the name of the mesh
  59751. * @param options defines the options used to create the mesh
  59752. * @param scene defines the hosting scene
  59753. * @returns the box mesh
  59754. */
  59755. static CreateBox(name: string, options: {
  59756. size?: number;
  59757. width?: number;
  59758. height?: number;
  59759. depth?: number;
  59760. faceUV?: Vector4[];
  59761. faceColors?: Color4[];
  59762. sideOrientation?: number;
  59763. frontUVs?: Vector4;
  59764. backUVs?: Vector4;
  59765. updatable?: boolean;
  59766. }, scene?: Nullable<Scene>): Mesh;
  59767. /**
  59768. * Creates a tiled box mesh
  59769. * * faceTiles sets the pattern, tile size and number of tiles for a face
  59770. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59771. * @param name defines the name of the mesh
  59772. * @param options defines the options used to create the mesh
  59773. * @param scene defines the hosting scene
  59774. * @returns the tiled box mesh
  59775. */
  59776. static CreateTiledBox(name: string, options: {
  59777. pattern?: number;
  59778. size?: number;
  59779. width?: number;
  59780. height?: number;
  59781. depth: number;
  59782. tileSize?: number;
  59783. tileWidth?: number;
  59784. tileHeight?: number;
  59785. faceUV?: Vector4[];
  59786. faceColors?: Color4[];
  59787. alignHorizontal?: number;
  59788. alignVertical?: number;
  59789. sideOrientation?: number;
  59790. updatable?: boolean;
  59791. }, scene?: Nullable<Scene>): Mesh;
  59792. /**
  59793. * Creates a sphere mesh
  59794. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  59795. * * 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`)
  59796. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  59797. * * 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
  59798. * * 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)
  59799. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59800. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59801. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59802. * @param name defines the name of the mesh
  59803. * @param options defines the options used to create the mesh
  59804. * @param scene defines the hosting scene
  59805. * @returns the sphere mesh
  59806. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  59807. */
  59808. static CreateSphere(name: string, options: {
  59809. segments?: number;
  59810. diameter?: number;
  59811. diameterX?: number;
  59812. diameterY?: number;
  59813. diameterZ?: number;
  59814. arc?: number;
  59815. slice?: number;
  59816. sideOrientation?: number;
  59817. frontUVs?: Vector4;
  59818. backUVs?: Vector4;
  59819. updatable?: boolean;
  59820. }, scene?: Nullable<Scene>): Mesh;
  59821. /**
  59822. * Creates a plane polygonal mesh. By default, this is a disc
  59823. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  59824. * * 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
  59825. * * 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
  59826. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59827. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59828. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59829. * @param name defines the name of the mesh
  59830. * @param options defines the options used to create the mesh
  59831. * @param scene defines the hosting scene
  59832. * @returns the plane polygonal mesh
  59833. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  59834. */
  59835. static CreateDisc(name: string, options: {
  59836. radius?: number;
  59837. tessellation?: number;
  59838. arc?: number;
  59839. updatable?: boolean;
  59840. sideOrientation?: number;
  59841. frontUVs?: Vector4;
  59842. backUVs?: Vector4;
  59843. }, scene?: Nullable<Scene>): Mesh;
  59844. /**
  59845. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  59846. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  59847. * * 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`)
  59848. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  59849. * * 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
  59850. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59851. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59852. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59853. * @param name defines the name of the mesh
  59854. * @param options defines the options used to create the mesh
  59855. * @param scene defines the hosting scene
  59856. * @returns the icosahedron mesh
  59857. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  59858. */
  59859. static CreateIcoSphere(name: string, options: {
  59860. radius?: number;
  59861. radiusX?: number;
  59862. radiusY?: number;
  59863. radiusZ?: number;
  59864. flat?: boolean;
  59865. subdivisions?: number;
  59866. sideOrientation?: number;
  59867. frontUVs?: Vector4;
  59868. backUVs?: Vector4;
  59869. updatable?: boolean;
  59870. }, scene?: Nullable<Scene>): Mesh;
  59871. /**
  59872. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  59873. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  59874. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  59875. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  59876. * * 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
  59877. * * 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
  59878. * * 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
  59879. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59880. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59881. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  59882. * * 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
  59883. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  59884. * * 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
  59885. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  59886. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59887. * @param name defines the name of the mesh
  59888. * @param options defines the options used to create the mesh
  59889. * @param scene defines the hosting scene
  59890. * @returns the ribbon mesh
  59891. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  59892. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  59893. */
  59894. static CreateRibbon(name: string, options: {
  59895. pathArray: Vector3[][];
  59896. closeArray?: boolean;
  59897. closePath?: boolean;
  59898. offset?: number;
  59899. updatable?: boolean;
  59900. sideOrientation?: number;
  59901. frontUVs?: Vector4;
  59902. backUVs?: Vector4;
  59903. instance?: Mesh;
  59904. invertUV?: boolean;
  59905. uvs?: Vector2[];
  59906. colors?: Color4[];
  59907. }, scene?: Nullable<Scene>): Mesh;
  59908. /**
  59909. * Creates a cylinder or a cone mesh
  59910. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  59911. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  59912. * * 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.
  59913. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  59914. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  59915. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  59916. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  59917. * * 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).
  59918. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  59919. * * 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).
  59920. * * 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
  59921. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  59922. * * 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
  59923. * * 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.
  59924. * * If `enclose` is false, a ring surface is one element.
  59925. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  59926. * * 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
  59927. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59928. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59929. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  59930. * @param name defines the name of the mesh
  59931. * @param options defines the options used to create the mesh
  59932. * @param scene defines the hosting scene
  59933. * @returns the cylinder mesh
  59934. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  59935. */
  59936. static CreateCylinder(name: string, options: {
  59937. height?: number;
  59938. diameterTop?: number;
  59939. diameterBottom?: number;
  59940. diameter?: number;
  59941. tessellation?: number;
  59942. subdivisions?: number;
  59943. arc?: number;
  59944. faceColors?: Color4[];
  59945. faceUV?: Vector4[];
  59946. updatable?: boolean;
  59947. hasRings?: boolean;
  59948. enclose?: boolean;
  59949. cap?: number;
  59950. sideOrientation?: number;
  59951. frontUVs?: Vector4;
  59952. backUVs?: Vector4;
  59953. }, scene?: Nullable<Scene>): Mesh;
  59954. /**
  59955. * Creates a torus mesh
  59956. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  59957. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  59958. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  59959. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59960. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59961. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  59962. * @param name defines the name of the mesh
  59963. * @param options defines the options used to create the mesh
  59964. * @param scene defines the hosting scene
  59965. * @returns the torus mesh
  59966. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  59967. */
  59968. static CreateTorus(name: string, options: {
  59969. diameter?: number;
  59970. thickness?: number;
  59971. tessellation?: number;
  59972. updatable?: boolean;
  59973. sideOrientation?: number;
  59974. frontUVs?: Vector4;
  59975. backUVs?: Vector4;
  59976. }, scene?: Nullable<Scene>): Mesh;
  59977. /**
  59978. * Creates a torus knot mesh
  59979. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  59980. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  59981. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  59982. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  59983. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59984. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59985. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  59986. * @param name defines the name of the mesh
  59987. * @param options defines the options used to create the mesh
  59988. * @param scene defines the hosting scene
  59989. * @returns the torus knot mesh
  59990. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  59991. */
  59992. static CreateTorusKnot(name: string, options: {
  59993. radius?: number;
  59994. tube?: number;
  59995. radialSegments?: number;
  59996. tubularSegments?: number;
  59997. p?: number;
  59998. q?: number;
  59999. updatable?: boolean;
  60000. sideOrientation?: number;
  60001. frontUVs?: Vector4;
  60002. backUVs?: Vector4;
  60003. }, scene?: Nullable<Scene>): Mesh;
  60004. /**
  60005. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  60006. * * 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
  60007. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  60008. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  60009. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  60010. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  60011. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  60012. * * 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
  60013. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  60014. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60015. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  60016. * @param name defines the name of the new line system
  60017. * @param options defines the options used to create the line system
  60018. * @param scene defines the hosting scene
  60019. * @returns a new line system mesh
  60020. */
  60021. static CreateLineSystem(name: string, options: {
  60022. lines: Vector3[][];
  60023. updatable?: boolean;
  60024. instance?: Nullable<LinesMesh>;
  60025. colors?: Nullable<Color4[][]>;
  60026. useVertexAlpha?: boolean;
  60027. }, scene: Nullable<Scene>): LinesMesh;
  60028. /**
  60029. * Creates a line mesh
  60030. * 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
  60031. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  60032. * * The parameter `points` is an array successive Vector3
  60033. * * 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
  60034. * * The optional parameter `colors` is an array of successive Color4, one per line point
  60035. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  60036. * * When updating an instance, remember that only point positions can change, not the number of points
  60037. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60038. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  60039. * @param name defines the name of the new line system
  60040. * @param options defines the options used to create the line system
  60041. * @param scene defines the hosting scene
  60042. * @returns a new line mesh
  60043. */
  60044. static CreateLines(name: string, options: {
  60045. points: Vector3[];
  60046. updatable?: boolean;
  60047. instance?: Nullable<LinesMesh>;
  60048. colors?: Color4[];
  60049. useVertexAlpha?: boolean;
  60050. }, scene?: Nullable<Scene>): LinesMesh;
  60051. /**
  60052. * Creates a dashed line mesh
  60053. * * 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
  60054. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  60055. * * The parameter `points` is an array successive Vector3
  60056. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  60057. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  60058. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  60059. * * 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
  60060. * * When updating an instance, remember that only point positions can change, not the number of points
  60061. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60062. * @param name defines the name of the mesh
  60063. * @param options defines the options used to create the mesh
  60064. * @param scene defines the hosting scene
  60065. * @returns the dashed line mesh
  60066. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  60067. */
  60068. static CreateDashedLines(name: string, options: {
  60069. points: Vector3[];
  60070. dashSize?: number;
  60071. gapSize?: number;
  60072. dashNb?: number;
  60073. updatable?: boolean;
  60074. instance?: LinesMesh;
  60075. }, scene?: Nullable<Scene>): LinesMesh;
  60076. /**
  60077. * 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.
  60078. * * 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.
  60079. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  60080. * * 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.
  60081. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  60082. * * 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
  60083. * * 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
  60084. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  60085. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60086. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60087. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  60088. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60089. * @param name defines the name of the mesh
  60090. * @param options defines the options used to create the mesh
  60091. * @param scene defines the hosting scene
  60092. * @returns the extruded shape mesh
  60093. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60094. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  60095. */
  60096. static ExtrudeShape(name: string, options: {
  60097. shape: Vector3[];
  60098. path: Vector3[];
  60099. scale?: number;
  60100. rotation?: number;
  60101. cap?: number;
  60102. updatable?: boolean;
  60103. sideOrientation?: number;
  60104. frontUVs?: Vector4;
  60105. backUVs?: Vector4;
  60106. instance?: Mesh;
  60107. invertUV?: boolean;
  60108. }, scene?: Nullable<Scene>): Mesh;
  60109. /**
  60110. * Creates an custom extruded shape mesh.
  60111. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  60112. * * 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.
  60113. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  60114. * * 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
  60115. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  60116. * * 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
  60117. * * It must returns a float value that will be the scale value applied to the shape on each path point
  60118. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  60119. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  60120. * * 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
  60121. * * 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
  60122. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  60123. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60124. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60125. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60126. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60127. * @param name defines the name of the mesh
  60128. * @param options defines the options used to create the mesh
  60129. * @param scene defines the hosting scene
  60130. * @returns the custom extruded shape mesh
  60131. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  60132. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60133. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  60134. */
  60135. static ExtrudeShapeCustom(name: string, options: {
  60136. shape: Vector3[];
  60137. path: Vector3[];
  60138. scaleFunction?: any;
  60139. rotationFunction?: any;
  60140. ribbonCloseArray?: boolean;
  60141. ribbonClosePath?: boolean;
  60142. cap?: number;
  60143. updatable?: boolean;
  60144. sideOrientation?: number;
  60145. frontUVs?: Vector4;
  60146. backUVs?: Vector4;
  60147. instance?: Mesh;
  60148. invertUV?: boolean;
  60149. }, scene?: Nullable<Scene>): Mesh;
  60150. /**
  60151. * Creates lathe mesh.
  60152. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  60153. * * 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
  60154. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  60155. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  60156. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  60157. * * 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
  60158. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  60159. * * 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
  60160. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60161. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60162. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60163. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60164. * @param name defines the name of the mesh
  60165. * @param options defines the options used to create the mesh
  60166. * @param scene defines the hosting scene
  60167. * @returns the lathe mesh
  60168. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  60169. */
  60170. static CreateLathe(name: string, options: {
  60171. shape: Vector3[];
  60172. radius?: number;
  60173. tessellation?: number;
  60174. clip?: number;
  60175. arc?: number;
  60176. closed?: boolean;
  60177. updatable?: boolean;
  60178. sideOrientation?: number;
  60179. frontUVs?: Vector4;
  60180. backUVs?: Vector4;
  60181. cap?: number;
  60182. invertUV?: boolean;
  60183. }, scene?: Nullable<Scene>): Mesh;
  60184. /**
  60185. * Creates a tiled plane mesh
  60186. * * You can set a limited pattern arrangement with the tiles
  60187. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60188. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60189. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60190. * @param name defines the name of the mesh
  60191. * @param options defines the options used to create the mesh
  60192. * @param scene defines the hosting scene
  60193. * @returns the plane mesh
  60194. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  60195. */
  60196. static CreateTiledPlane(name: string, options: {
  60197. pattern?: number;
  60198. tileSize?: number;
  60199. tileWidth?: number;
  60200. tileHeight?: number;
  60201. size?: number;
  60202. width?: number;
  60203. height?: number;
  60204. alignHorizontal?: number;
  60205. alignVertical?: number;
  60206. sideOrientation?: number;
  60207. frontUVs?: Vector4;
  60208. backUVs?: Vector4;
  60209. updatable?: boolean;
  60210. }, scene?: Nullable<Scene>): Mesh;
  60211. /**
  60212. * Creates a plane mesh
  60213. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  60214. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  60215. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  60216. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60217. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60218. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60219. * @param name defines the name of the mesh
  60220. * @param options defines the options used to create the mesh
  60221. * @param scene defines the hosting scene
  60222. * @returns the plane mesh
  60223. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  60224. */
  60225. static CreatePlane(name: string, options: {
  60226. size?: number;
  60227. width?: number;
  60228. height?: number;
  60229. sideOrientation?: number;
  60230. frontUVs?: Vector4;
  60231. backUVs?: Vector4;
  60232. updatable?: boolean;
  60233. sourcePlane?: Plane;
  60234. }, scene?: Nullable<Scene>): Mesh;
  60235. /**
  60236. * Creates a ground mesh
  60237. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  60238. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  60239. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60240. * @param name defines the name of the mesh
  60241. * @param options defines the options used to create the mesh
  60242. * @param scene defines the hosting scene
  60243. * @returns the ground mesh
  60244. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  60245. */
  60246. static CreateGround(name: string, options: {
  60247. width?: number;
  60248. height?: number;
  60249. subdivisions?: number;
  60250. subdivisionsX?: number;
  60251. subdivisionsY?: number;
  60252. updatable?: boolean;
  60253. }, scene?: Nullable<Scene>): Mesh;
  60254. /**
  60255. * Creates a tiled ground mesh
  60256. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  60257. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  60258. * * 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
  60259. * * 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
  60260. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60261. * @param name defines the name of the mesh
  60262. * @param options defines the options used to create the mesh
  60263. * @param scene defines the hosting scene
  60264. * @returns the tiled ground mesh
  60265. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  60266. */
  60267. static CreateTiledGround(name: string, options: {
  60268. xmin: number;
  60269. zmin: number;
  60270. xmax: number;
  60271. zmax: number;
  60272. subdivisions?: {
  60273. w: number;
  60274. h: number;
  60275. };
  60276. precision?: {
  60277. w: number;
  60278. h: number;
  60279. };
  60280. updatable?: boolean;
  60281. }, scene?: Nullable<Scene>): Mesh;
  60282. /**
  60283. * Creates a ground mesh from a height map
  60284. * * The parameter `url` sets the URL of the height map image resource.
  60285. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  60286. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  60287. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  60288. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  60289. * * 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.
  60290. * * 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).
  60291. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  60292. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60293. * @param name defines the name of the mesh
  60294. * @param url defines the url to the height map
  60295. * @param options defines the options used to create the mesh
  60296. * @param scene defines the hosting scene
  60297. * @returns the ground mesh
  60298. * @see https://doc.babylonjs.com/babylon101/height_map
  60299. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  60300. */
  60301. static CreateGroundFromHeightMap(name: string, url: string, options: {
  60302. width?: number;
  60303. height?: number;
  60304. subdivisions?: number;
  60305. minHeight?: number;
  60306. maxHeight?: number;
  60307. colorFilter?: Color3;
  60308. alphaFilter?: number;
  60309. updatable?: boolean;
  60310. onReady?: (mesh: GroundMesh) => void;
  60311. }, scene?: Nullable<Scene>): GroundMesh;
  60312. /**
  60313. * Creates a polygon mesh
  60314. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  60315. * * 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
  60316. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  60317. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60318. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  60319. * * Remember you can only change the shape positions, not their number when updating a polygon
  60320. * @param name defines the name of the mesh
  60321. * @param options defines the options used to create the mesh
  60322. * @param scene defines the hosting scene
  60323. * @param earcutInjection can be used to inject your own earcut reference
  60324. * @returns the polygon mesh
  60325. */
  60326. static CreatePolygon(name: string, options: {
  60327. shape: Vector3[];
  60328. holes?: Vector3[][];
  60329. depth?: number;
  60330. faceUV?: Vector4[];
  60331. faceColors?: Color4[];
  60332. updatable?: boolean;
  60333. sideOrientation?: number;
  60334. frontUVs?: Vector4;
  60335. backUVs?: Vector4;
  60336. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60337. /**
  60338. * Creates an extruded polygon mesh, with depth in the Y direction.
  60339. * * 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)
  60340. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  60341. * @param name defines the name of the mesh
  60342. * @param options defines the options used to create the mesh
  60343. * @param scene defines the hosting scene
  60344. * @param earcutInjection can be used to inject your own earcut reference
  60345. * @returns the polygon mesh
  60346. */
  60347. static ExtrudePolygon(name: string, options: {
  60348. shape: Vector3[];
  60349. holes?: Vector3[][];
  60350. depth?: number;
  60351. faceUV?: Vector4[];
  60352. faceColors?: Color4[];
  60353. updatable?: boolean;
  60354. sideOrientation?: number;
  60355. frontUVs?: Vector4;
  60356. backUVs?: Vector4;
  60357. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60358. /**
  60359. * Creates a tube mesh.
  60360. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  60361. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  60362. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  60363. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  60364. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  60365. * * 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)
  60366. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  60367. * * 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
  60368. * * 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
  60369. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60370. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60371. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60372. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60373. * @param name defines the name of the mesh
  60374. * @param options defines the options used to create the mesh
  60375. * @param scene defines the hosting scene
  60376. * @returns the tube mesh
  60377. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60378. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  60379. */
  60380. static CreateTube(name: string, options: {
  60381. path: Vector3[];
  60382. radius?: number;
  60383. tessellation?: number;
  60384. radiusFunction?: {
  60385. (i: number, distance: number): number;
  60386. };
  60387. cap?: number;
  60388. arc?: number;
  60389. updatable?: boolean;
  60390. sideOrientation?: number;
  60391. frontUVs?: Vector4;
  60392. backUVs?: Vector4;
  60393. instance?: Mesh;
  60394. invertUV?: boolean;
  60395. }, scene?: Nullable<Scene>): Mesh;
  60396. /**
  60397. * Creates a polyhedron mesh
  60398. * * 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
  60399. * * The parameter `size` (positive float, default 1) sets the polygon size
  60400. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  60401. * * 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`
  60402. * * 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
  60403. * * 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)`)
  60404. * * 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
  60405. * * 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
  60406. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60407. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60408. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60409. * @param name defines the name of the mesh
  60410. * @param options defines the options used to create the mesh
  60411. * @param scene defines the hosting scene
  60412. * @returns the polyhedron mesh
  60413. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  60414. */
  60415. static CreatePolyhedron(name: string, options: {
  60416. type?: number;
  60417. size?: number;
  60418. sizeX?: number;
  60419. sizeY?: number;
  60420. sizeZ?: number;
  60421. custom?: any;
  60422. faceUV?: Vector4[];
  60423. faceColors?: Color4[];
  60424. flat?: boolean;
  60425. updatable?: boolean;
  60426. sideOrientation?: number;
  60427. frontUVs?: Vector4;
  60428. backUVs?: Vector4;
  60429. }, scene?: Nullable<Scene>): Mesh;
  60430. /**
  60431. * Creates a decal mesh.
  60432. * 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
  60433. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  60434. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  60435. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  60436. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  60437. * @param name defines the name of the mesh
  60438. * @param sourceMesh defines the mesh where the decal must be applied
  60439. * @param options defines the options used to create the mesh
  60440. * @param scene defines the hosting scene
  60441. * @returns the decal mesh
  60442. * @see https://doc.babylonjs.com/how_to/decals
  60443. */
  60444. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  60445. position?: Vector3;
  60446. normal?: Vector3;
  60447. size?: Vector3;
  60448. angle?: number;
  60449. }): Mesh;
  60450. }
  60451. }
  60452. declare module "babylonjs/Meshes/meshSimplification" {
  60453. import { Mesh } from "babylonjs/Meshes/mesh";
  60454. /**
  60455. * A simplifier interface for future simplification implementations
  60456. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60457. */
  60458. export interface ISimplifier {
  60459. /**
  60460. * Simplification of a given mesh according to the given settings.
  60461. * Since this requires computation, it is assumed that the function runs async.
  60462. * @param settings The settings of the simplification, including quality and distance
  60463. * @param successCallback A callback that will be called after the mesh was simplified.
  60464. * @param errorCallback in case of an error, this callback will be called. optional.
  60465. */
  60466. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  60467. }
  60468. /**
  60469. * Expected simplification settings.
  60470. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  60471. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60472. */
  60473. export interface ISimplificationSettings {
  60474. /**
  60475. * Gets or sets the expected quality
  60476. */
  60477. quality: number;
  60478. /**
  60479. * Gets or sets the distance when this optimized version should be used
  60480. */
  60481. distance: number;
  60482. /**
  60483. * Gets an already optimized mesh
  60484. */
  60485. optimizeMesh?: boolean;
  60486. }
  60487. /**
  60488. * Class used to specify simplification options
  60489. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60490. */
  60491. export class SimplificationSettings implements ISimplificationSettings {
  60492. /** expected quality */
  60493. quality: number;
  60494. /** distance when this optimized version should be used */
  60495. distance: number;
  60496. /** already optimized mesh */
  60497. optimizeMesh?: boolean | undefined;
  60498. /**
  60499. * Creates a SimplificationSettings
  60500. * @param quality expected quality
  60501. * @param distance distance when this optimized version should be used
  60502. * @param optimizeMesh already optimized mesh
  60503. */
  60504. constructor(
  60505. /** expected quality */
  60506. quality: number,
  60507. /** distance when this optimized version should be used */
  60508. distance: number,
  60509. /** already optimized mesh */
  60510. optimizeMesh?: boolean | undefined);
  60511. }
  60512. /**
  60513. * Interface used to define a simplification task
  60514. */
  60515. export interface ISimplificationTask {
  60516. /**
  60517. * Array of settings
  60518. */
  60519. settings: Array<ISimplificationSettings>;
  60520. /**
  60521. * Simplification type
  60522. */
  60523. simplificationType: SimplificationType;
  60524. /**
  60525. * Mesh to simplify
  60526. */
  60527. mesh: Mesh;
  60528. /**
  60529. * Callback called on success
  60530. */
  60531. successCallback?: () => void;
  60532. /**
  60533. * Defines if parallel processing can be used
  60534. */
  60535. parallelProcessing: boolean;
  60536. }
  60537. /**
  60538. * Queue used to order the simplification tasks
  60539. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60540. */
  60541. export class SimplificationQueue {
  60542. private _simplificationArray;
  60543. /**
  60544. * Gets a boolean indicating that the process is still running
  60545. */
  60546. running: boolean;
  60547. /**
  60548. * Creates a new queue
  60549. */
  60550. constructor();
  60551. /**
  60552. * Adds a new simplification task
  60553. * @param task defines a task to add
  60554. */
  60555. addTask(task: ISimplificationTask): void;
  60556. /**
  60557. * Execute next task
  60558. */
  60559. executeNext(): void;
  60560. /**
  60561. * Execute a simplification task
  60562. * @param task defines the task to run
  60563. */
  60564. runSimplification(task: ISimplificationTask): void;
  60565. private getSimplifier;
  60566. }
  60567. /**
  60568. * The implemented types of simplification
  60569. * At the moment only Quadratic Error Decimation is implemented
  60570. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60571. */
  60572. export enum SimplificationType {
  60573. /** Quadratic error decimation */
  60574. QUADRATIC = 0
  60575. }
  60576. }
  60577. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  60578. import { Scene } from "babylonjs/scene";
  60579. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  60580. import { ISceneComponent } from "babylonjs/sceneComponent";
  60581. module "babylonjs/scene" {
  60582. interface Scene {
  60583. /** @hidden (Backing field) */
  60584. _simplificationQueue: SimplificationQueue;
  60585. /**
  60586. * Gets or sets the simplification queue attached to the scene
  60587. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60588. */
  60589. simplificationQueue: SimplificationQueue;
  60590. }
  60591. }
  60592. module "babylonjs/Meshes/mesh" {
  60593. interface Mesh {
  60594. /**
  60595. * Simplify the mesh according to the given array of settings.
  60596. * Function will return immediately and will simplify async
  60597. * @param settings a collection of simplification settings
  60598. * @param parallelProcessing should all levels calculate parallel or one after the other
  60599. * @param simplificationType the type of simplification to run
  60600. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  60601. * @returns the current mesh
  60602. */
  60603. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  60604. }
  60605. }
  60606. /**
  60607. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  60608. * created in a scene
  60609. */
  60610. export class SimplicationQueueSceneComponent implements ISceneComponent {
  60611. /**
  60612. * The component name helpfull to identify the component in the list of scene components.
  60613. */
  60614. readonly name: string;
  60615. /**
  60616. * The scene the component belongs to.
  60617. */
  60618. scene: Scene;
  60619. /**
  60620. * Creates a new instance of the component for the given scene
  60621. * @param scene Defines the scene to register the component in
  60622. */
  60623. constructor(scene: Scene);
  60624. /**
  60625. * Registers the component in a given scene
  60626. */
  60627. register(): void;
  60628. /**
  60629. * Rebuilds the elements related to this component in case of
  60630. * context lost for instance.
  60631. */
  60632. rebuild(): void;
  60633. /**
  60634. * Disposes the component and the associated ressources
  60635. */
  60636. dispose(): void;
  60637. private _beforeCameraUpdate;
  60638. }
  60639. }
  60640. declare module "babylonjs/Meshes/Builders/index" {
  60641. export * from "babylonjs/Meshes/Builders/boxBuilder";
  60642. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  60643. export * from "babylonjs/Meshes/Builders/discBuilder";
  60644. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  60645. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  60646. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  60647. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  60648. export * from "babylonjs/Meshes/Builders/torusBuilder";
  60649. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  60650. export * from "babylonjs/Meshes/Builders/linesBuilder";
  60651. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  60652. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  60653. export * from "babylonjs/Meshes/Builders/latheBuilder";
  60654. export * from "babylonjs/Meshes/Builders/planeBuilder";
  60655. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  60656. export * from "babylonjs/Meshes/Builders/groundBuilder";
  60657. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  60658. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  60659. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  60660. export * from "babylonjs/Meshes/Builders/decalBuilder";
  60661. }
  60662. declare module "babylonjs/Meshes/index" {
  60663. export * from "babylonjs/Meshes/abstractMesh";
  60664. export * from "babylonjs/Meshes/buffer";
  60665. export * from "babylonjs/Meshes/Compression/index";
  60666. export * from "babylonjs/Meshes/csg";
  60667. export * from "babylonjs/Meshes/geometry";
  60668. export * from "babylonjs/Meshes/groundMesh";
  60669. export * from "babylonjs/Meshes/trailMesh";
  60670. export * from "babylonjs/Meshes/instancedMesh";
  60671. export * from "babylonjs/Meshes/linesMesh";
  60672. export * from "babylonjs/Meshes/mesh";
  60673. export * from "babylonjs/Meshes/mesh.vertexData";
  60674. export * from "babylonjs/Meshes/meshBuilder";
  60675. export * from "babylonjs/Meshes/meshSimplification";
  60676. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  60677. export * from "babylonjs/Meshes/polygonMesh";
  60678. export * from "babylonjs/Meshes/subMesh";
  60679. export * from "babylonjs/Meshes/meshLODLevel";
  60680. export * from "babylonjs/Meshes/transformNode";
  60681. export * from "babylonjs/Meshes/Builders/index";
  60682. export * from "babylonjs/Meshes/dataBuffer";
  60683. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  60684. }
  60685. declare module "babylonjs/Morph/index" {
  60686. export * from "babylonjs/Morph/morphTarget";
  60687. export * from "babylonjs/Morph/morphTargetManager";
  60688. }
  60689. declare module "babylonjs/Navigation/INavigationEngine" {
  60690. import { TransformNode } from "babylonjs/Meshes/transformNode";
  60691. import { Vector3 } from "babylonjs/Maths/math";
  60692. import { Mesh } from "babylonjs/Meshes/mesh";
  60693. import { Scene } from "babylonjs/scene";
  60694. /**
  60695. * Navigation plugin interface to add navigation constrained by a navigation mesh
  60696. */
  60697. export interface INavigationEnginePlugin {
  60698. /**
  60699. * plugin name
  60700. */
  60701. name: string;
  60702. /**
  60703. * Creates a navigation mesh
  60704. * @param meshes array of all the geometry used to compute the navigatio mesh
  60705. * @param parameters bunch of parameters used to filter geometry
  60706. */
  60707. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  60708. /**
  60709. * Create a navigation mesh debug mesh
  60710. * @param scene is where the mesh will be added
  60711. * @returns debug display mesh
  60712. */
  60713. createDebugNavMesh(scene: Scene): Mesh;
  60714. /**
  60715. * Get a navigation mesh constrained position, closest to the parameter position
  60716. * @param position world position
  60717. * @returns the closest point to position constrained by the navigation mesh
  60718. */
  60719. getClosestPoint(position: Vector3): Vector3;
  60720. /**
  60721. * Get a navigation mesh constrained position, within a particular radius
  60722. * @param position world position
  60723. * @param maxRadius the maximum distance to the constrained world position
  60724. * @returns the closest point to position constrained by the navigation mesh
  60725. */
  60726. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  60727. /**
  60728. * Compute the final position from a segment made of destination-position
  60729. * @param position world position
  60730. * @param destination world position
  60731. * @returns the resulting point along the navmesh
  60732. */
  60733. moveAlong(position: Vector3, destination: Vector3): Vector3;
  60734. /**
  60735. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  60736. * @param start world position
  60737. * @param end world position
  60738. * @returns array containing world position composing the path
  60739. */
  60740. computePath(start: Vector3, end: Vector3): Vector3[];
  60741. /**
  60742. * If this plugin is supported
  60743. * @returns true if plugin is supported
  60744. */
  60745. isSupported(): boolean;
  60746. /**
  60747. * Create a new Crowd so you can add agents
  60748. * @param maxAgents the maximum agent count in the crowd
  60749. * @param maxAgentRadius the maximum radius an agent can have
  60750. * @param scene to attach the crowd to
  60751. * @returns the crowd you can add agents to
  60752. */
  60753. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  60754. /**
  60755. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  60756. * The queries will try to find a solution within those bounds
  60757. * default is (1,1,1)
  60758. * @param extent x,y,z value that define the extent around the queries point of reference
  60759. */
  60760. setDefaultQueryExtent(extent: Vector3): void;
  60761. /**
  60762. * Get the Bounding box extent specified by setDefaultQueryExtent
  60763. * @returns the box extent values
  60764. */
  60765. getDefaultQueryExtent(): Vector3;
  60766. /**
  60767. * Release all resources
  60768. */
  60769. dispose(): void;
  60770. }
  60771. /**
  60772. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  60773. */
  60774. export interface ICrowd {
  60775. /**
  60776. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  60777. * You can attach anything to that node. The node position is updated in the scene update tick.
  60778. * @param pos world position that will be constrained by the navigation mesh
  60779. * @param parameters agent parameters
  60780. * @param transform hooked to the agent that will be update by the scene
  60781. * @returns agent index
  60782. */
  60783. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  60784. /**
  60785. * Returns the agent position in world space
  60786. * @param index agent index returned by addAgent
  60787. * @returns world space position
  60788. */
  60789. getAgentPosition(index: number): Vector3;
  60790. /**
  60791. * Gets the agent velocity in world space
  60792. * @param index agent index returned by addAgent
  60793. * @returns world space velocity
  60794. */
  60795. getAgentVelocity(index: number): Vector3;
  60796. /**
  60797. * remove a particular agent previously created
  60798. * @param index agent index returned by addAgent
  60799. */
  60800. removeAgent(index: number): void;
  60801. /**
  60802. * get the list of all agents attached to this crowd
  60803. * @returns list of agent indices
  60804. */
  60805. getAgents(): number[];
  60806. /**
  60807. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  60808. * @param deltaTime in seconds
  60809. */
  60810. update(deltaTime: number): void;
  60811. /**
  60812. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  60813. * @param index agent index returned by addAgent
  60814. * @param destination targeted world position
  60815. */
  60816. agentGoto(index: number, destination: Vector3): void;
  60817. /**
  60818. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  60819. * The queries will try to find a solution within those bounds
  60820. * default is (1,1,1)
  60821. * @param extent x,y,z value that define the extent around the queries point of reference
  60822. */
  60823. setDefaultQueryExtent(extent: Vector3): void;
  60824. /**
  60825. * Get the Bounding box extent specified by setDefaultQueryExtent
  60826. * @returns the box extent values
  60827. */
  60828. getDefaultQueryExtent(): Vector3;
  60829. /**
  60830. * Release all resources
  60831. */
  60832. dispose(): void;
  60833. }
  60834. /**
  60835. * Configures an agent
  60836. */
  60837. export interface IAgentParameters {
  60838. /**
  60839. * Agent radius. [Limit: >= 0]
  60840. */
  60841. radius: number;
  60842. /**
  60843. * Agent height. [Limit: > 0]
  60844. */
  60845. height: number;
  60846. /**
  60847. * Maximum allowed acceleration. [Limit: >= 0]
  60848. */
  60849. maxAcceleration: number;
  60850. /**
  60851. * Maximum allowed speed. [Limit: >= 0]
  60852. */
  60853. maxSpeed: number;
  60854. /**
  60855. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  60856. */
  60857. collisionQueryRange: number;
  60858. /**
  60859. * The path visibility optimization range. [Limit: > 0]
  60860. */
  60861. pathOptimizationRange: number;
  60862. /**
  60863. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  60864. */
  60865. separationWeight: number;
  60866. }
  60867. /**
  60868. * Configures the navigation mesh creation
  60869. */
  60870. export interface INavMeshParameters {
  60871. /**
  60872. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  60873. */
  60874. cs: number;
  60875. /**
  60876. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  60877. */
  60878. ch: number;
  60879. /**
  60880. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  60881. */
  60882. walkableSlopeAngle: number;
  60883. /**
  60884. * Minimum floor to 'ceiling' height that will still allow the floor area to
  60885. * be considered walkable. [Limit: >= 3] [Units: vx]
  60886. */
  60887. walkableHeight: number;
  60888. /**
  60889. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  60890. */
  60891. walkableClimb: number;
  60892. /**
  60893. * The distance to erode/shrink the walkable area of the heightfield away from
  60894. * obstructions. [Limit: >=0] [Units: vx]
  60895. */
  60896. walkableRadius: number;
  60897. /**
  60898. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  60899. */
  60900. maxEdgeLen: number;
  60901. /**
  60902. * The maximum distance a simplfied contour's border edges should deviate
  60903. * the original raw contour. [Limit: >=0] [Units: vx]
  60904. */
  60905. maxSimplificationError: number;
  60906. /**
  60907. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  60908. */
  60909. minRegionArea: number;
  60910. /**
  60911. * Any regions with a span count smaller than this value will, if possible,
  60912. * be merged with larger regions. [Limit: >=0] [Units: vx]
  60913. */
  60914. mergeRegionArea: number;
  60915. /**
  60916. * The maximum number of vertices allowed for polygons generated during the
  60917. * contour to polygon conversion process. [Limit: >= 3]
  60918. */
  60919. maxVertsPerPoly: number;
  60920. /**
  60921. * Sets the sampling distance to use when generating the detail mesh.
  60922. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  60923. */
  60924. detailSampleDist: number;
  60925. /**
  60926. * The maximum distance the detail mesh surface should deviate from heightfield
  60927. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  60928. */
  60929. detailSampleMaxError: number;
  60930. }
  60931. }
  60932. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  60933. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  60934. import { Mesh } from "babylonjs/Meshes/mesh";
  60935. import { Scene } from "babylonjs/scene";
  60936. import { Vector3 } from "babylonjs/Maths/math";
  60937. import { TransformNode } from "babylonjs/Meshes/transformNode";
  60938. /**
  60939. * RecastJS navigation plugin
  60940. */
  60941. export class RecastJSPlugin implements INavigationEnginePlugin {
  60942. /**
  60943. * Reference to the Recast library
  60944. */
  60945. bjsRECAST: any;
  60946. /**
  60947. * plugin name
  60948. */
  60949. name: string;
  60950. /**
  60951. * the first navmesh created. We might extend this to support multiple navmeshes
  60952. */
  60953. navMesh: any;
  60954. /**
  60955. * Initializes the recastJS plugin
  60956. * @param recastInjection can be used to inject your own recast reference
  60957. */
  60958. constructor(recastInjection?: any);
  60959. /**
  60960. * Creates a navigation mesh
  60961. * @param meshes array of all the geometry used to compute the navigatio mesh
  60962. * @param parameters bunch of parameters used to filter geometry
  60963. */
  60964. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  60965. /**
  60966. * Create a navigation mesh debug mesh
  60967. * @param scene is where the mesh will be added
  60968. * @returns debug display mesh
  60969. */
  60970. createDebugNavMesh(scene: Scene): Mesh;
  60971. /**
  60972. * Get a navigation mesh constrained position, closest to the parameter position
  60973. * @param position world position
  60974. * @returns the closest point to position constrained by the navigation mesh
  60975. */
  60976. getClosestPoint(position: Vector3): Vector3;
  60977. /**
  60978. * Get a navigation mesh constrained position, within a particular radius
  60979. * @param position world position
  60980. * @param maxRadius the maximum distance to the constrained world position
  60981. * @returns the closest point to position constrained by the navigation mesh
  60982. */
  60983. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  60984. /**
  60985. * Compute the final position from a segment made of destination-position
  60986. * @param position world position
  60987. * @param destination world position
  60988. * @returns the resulting point along the navmesh
  60989. */
  60990. moveAlong(position: Vector3, destination: Vector3): Vector3;
  60991. /**
  60992. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  60993. * @param start world position
  60994. * @param end world position
  60995. * @returns array containing world position composing the path
  60996. */
  60997. computePath(start: Vector3, end: Vector3): Vector3[];
  60998. /**
  60999. * Create a new Crowd so you can add agents
  61000. * @param maxAgents the maximum agent count in the crowd
  61001. * @param maxAgentRadius the maximum radius an agent can have
  61002. * @param scene to attach the crowd to
  61003. * @returns the crowd you can add agents to
  61004. */
  61005. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  61006. /**
  61007. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61008. * The queries will try to find a solution within those bounds
  61009. * default is (1,1,1)
  61010. * @param extent x,y,z value that define the extent around the queries point of reference
  61011. */
  61012. setDefaultQueryExtent(extent: Vector3): void;
  61013. /**
  61014. * Get the Bounding box extent specified by setDefaultQueryExtent
  61015. * @returns the box extent values
  61016. */
  61017. getDefaultQueryExtent(): Vector3;
  61018. /**
  61019. * Disposes
  61020. */
  61021. dispose(): void;
  61022. /**
  61023. * If this plugin is supported
  61024. * @returns true if plugin is supported
  61025. */
  61026. isSupported(): boolean;
  61027. }
  61028. /**
  61029. * Recast detour crowd implementation
  61030. */
  61031. export class RecastJSCrowd implements ICrowd {
  61032. /**
  61033. * Recast/detour plugin
  61034. */
  61035. bjsRECASTPlugin: RecastJSPlugin;
  61036. /**
  61037. * Link to the detour crowd
  61038. */
  61039. recastCrowd: any;
  61040. /**
  61041. * One transform per agent
  61042. */
  61043. transforms: TransformNode[];
  61044. /**
  61045. * All agents created
  61046. */
  61047. agents: number[];
  61048. /**
  61049. * Link to the scene is kept to unregister the crowd from the scene
  61050. */
  61051. private _scene;
  61052. /**
  61053. * Observer for crowd updates
  61054. */
  61055. private _onBeforeAnimationsObserver;
  61056. /**
  61057. * Constructor
  61058. * @param plugin recastJS plugin
  61059. * @param maxAgents the maximum agent count in the crowd
  61060. * @param maxAgentRadius the maximum radius an agent can have
  61061. * @param scene to attach the crowd to
  61062. * @returns the crowd you can add agents to
  61063. */
  61064. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  61065. /**
  61066. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  61067. * You can attach anything to that node. The node position is updated in the scene update tick.
  61068. * @param pos world position that will be constrained by the navigation mesh
  61069. * @param parameters agent parameters
  61070. * @param transform hooked to the agent that will be update by the scene
  61071. * @returns agent index
  61072. */
  61073. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  61074. /**
  61075. * Returns the agent position in world space
  61076. * @param index agent index returned by addAgent
  61077. * @returns world space position
  61078. */
  61079. getAgentPosition(index: number): Vector3;
  61080. /**
  61081. * Returns the agent velocity in world space
  61082. * @param index agent index returned by addAgent
  61083. * @returns world space velocity
  61084. */
  61085. getAgentVelocity(index: number): Vector3;
  61086. /**
  61087. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  61088. * @param index agent index returned by addAgent
  61089. * @param destination targeted world position
  61090. */
  61091. agentGoto(index: number, destination: Vector3): void;
  61092. /**
  61093. * remove a particular agent previously created
  61094. * @param index agent index returned by addAgent
  61095. */
  61096. removeAgent(index: number): void;
  61097. /**
  61098. * get the list of all agents attached to this crowd
  61099. * @returns list of agent indices
  61100. */
  61101. getAgents(): number[];
  61102. /**
  61103. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  61104. * @param deltaTime in seconds
  61105. */
  61106. update(deltaTime: number): void;
  61107. /**
  61108. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61109. * The queries will try to find a solution within those bounds
  61110. * default is (1,1,1)
  61111. * @param extent x,y,z value that define the extent around the queries point of reference
  61112. */
  61113. setDefaultQueryExtent(extent: Vector3): void;
  61114. /**
  61115. * Get the Bounding box extent specified by setDefaultQueryExtent
  61116. * @returns the box extent values
  61117. */
  61118. getDefaultQueryExtent(): Vector3;
  61119. /**
  61120. * Release all resources
  61121. */
  61122. dispose(): void;
  61123. }
  61124. }
  61125. declare module "babylonjs/Navigation/Plugins/index" {
  61126. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  61127. }
  61128. declare module "babylonjs/Navigation/index" {
  61129. export * from "babylonjs/Navigation/INavigationEngine";
  61130. export * from "babylonjs/Navigation/Plugins/index";
  61131. }
  61132. declare module "babylonjs/Offline/database" {
  61133. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  61134. /**
  61135. * Class used to enable access to IndexedDB
  61136. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  61137. */
  61138. export class Database implements IOfflineProvider {
  61139. private _callbackManifestChecked;
  61140. private _currentSceneUrl;
  61141. private _db;
  61142. private _enableSceneOffline;
  61143. private _enableTexturesOffline;
  61144. private _manifestVersionFound;
  61145. private _mustUpdateRessources;
  61146. private _hasReachedQuota;
  61147. private _isSupported;
  61148. private _idbFactory;
  61149. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  61150. private static IsUASupportingBlobStorage;
  61151. /**
  61152. * Gets a boolean indicating if Database storate is enabled (off by default)
  61153. */
  61154. static IDBStorageEnabled: boolean;
  61155. /**
  61156. * Gets a boolean indicating if scene must be saved in the database
  61157. */
  61158. readonly enableSceneOffline: boolean;
  61159. /**
  61160. * Gets a boolean indicating if textures must be saved in the database
  61161. */
  61162. readonly enableTexturesOffline: boolean;
  61163. /**
  61164. * Creates a new Database
  61165. * @param urlToScene defines the url to load the scene
  61166. * @param callbackManifestChecked defines the callback to use when manifest is checked
  61167. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  61168. */
  61169. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  61170. private static _ParseURL;
  61171. private static _ReturnFullUrlLocation;
  61172. private _checkManifestFile;
  61173. /**
  61174. * Open the database and make it available
  61175. * @param successCallback defines the callback to call on success
  61176. * @param errorCallback defines the callback to call on error
  61177. */
  61178. open(successCallback: () => void, errorCallback: () => void): void;
  61179. /**
  61180. * Loads an image from the database
  61181. * @param url defines the url to load from
  61182. * @param image defines the target DOM image
  61183. */
  61184. loadImage(url: string, image: HTMLImageElement): void;
  61185. private _loadImageFromDBAsync;
  61186. private _saveImageIntoDBAsync;
  61187. private _checkVersionFromDB;
  61188. private _loadVersionFromDBAsync;
  61189. private _saveVersionIntoDBAsync;
  61190. /**
  61191. * Loads a file from database
  61192. * @param url defines the URL to load from
  61193. * @param sceneLoaded defines a callback to call on success
  61194. * @param progressCallBack defines a callback to call when progress changed
  61195. * @param errorCallback defines a callback to call on error
  61196. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  61197. */
  61198. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  61199. private _loadFileAsync;
  61200. private _saveFileAsync;
  61201. /**
  61202. * Validates if xhr data is correct
  61203. * @param xhr defines the request to validate
  61204. * @param dataType defines the expected data type
  61205. * @returns true if data is correct
  61206. */
  61207. private static _ValidateXHRData;
  61208. }
  61209. }
  61210. declare module "babylonjs/Offline/index" {
  61211. export * from "babylonjs/Offline/database";
  61212. export * from "babylonjs/Offline/IOfflineProvider";
  61213. }
  61214. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  61215. /** @hidden */
  61216. export var gpuUpdateParticlesPixelShader: {
  61217. name: string;
  61218. shader: string;
  61219. };
  61220. }
  61221. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  61222. /** @hidden */
  61223. export var gpuUpdateParticlesVertexShader: {
  61224. name: string;
  61225. shader: string;
  61226. };
  61227. }
  61228. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  61229. /** @hidden */
  61230. export var clipPlaneFragmentDeclaration2: {
  61231. name: string;
  61232. shader: string;
  61233. };
  61234. }
  61235. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  61236. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  61237. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  61238. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61239. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  61240. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  61241. /** @hidden */
  61242. export var gpuRenderParticlesPixelShader: {
  61243. name: string;
  61244. shader: string;
  61245. };
  61246. }
  61247. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  61248. /** @hidden */
  61249. export var clipPlaneVertexDeclaration2: {
  61250. name: string;
  61251. shader: string;
  61252. };
  61253. }
  61254. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  61255. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  61256. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  61257. /** @hidden */
  61258. export var gpuRenderParticlesVertexShader: {
  61259. name: string;
  61260. shader: string;
  61261. };
  61262. }
  61263. declare module "babylonjs/Particles/gpuParticleSystem" {
  61264. import { Nullable } from "babylonjs/types";
  61265. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  61266. import { Observable } from "babylonjs/Misc/observable";
  61267. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61268. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61269. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  61270. import { Scene, IDisposable } from "babylonjs/scene";
  61271. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  61272. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  61273. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  61274. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  61275. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  61276. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  61277. /**
  61278. * This represents a GPU particle system in Babylon
  61279. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  61280. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  61281. */
  61282. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  61283. /**
  61284. * The layer mask we are rendering the particles through.
  61285. */
  61286. layerMask: number;
  61287. private _capacity;
  61288. private _activeCount;
  61289. private _currentActiveCount;
  61290. private _accumulatedCount;
  61291. private _renderEffect;
  61292. private _updateEffect;
  61293. private _buffer0;
  61294. private _buffer1;
  61295. private _spriteBuffer;
  61296. private _updateVAO;
  61297. private _renderVAO;
  61298. private _targetIndex;
  61299. private _sourceBuffer;
  61300. private _targetBuffer;
  61301. private _engine;
  61302. private _currentRenderId;
  61303. private _started;
  61304. private _stopped;
  61305. private _timeDelta;
  61306. private _randomTexture;
  61307. private _randomTexture2;
  61308. private _attributesStrideSize;
  61309. private _updateEffectOptions;
  61310. private _randomTextureSize;
  61311. private _actualFrame;
  61312. private readonly _rawTextureWidth;
  61313. /**
  61314. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  61315. */
  61316. static readonly IsSupported: boolean;
  61317. /**
  61318. * An event triggered when the system is disposed.
  61319. */
  61320. onDisposeObservable: Observable<GPUParticleSystem>;
  61321. /**
  61322. * Gets the maximum number of particles active at the same time.
  61323. * @returns The max number of active particles.
  61324. */
  61325. getCapacity(): number;
  61326. /**
  61327. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  61328. * to override the particles.
  61329. */
  61330. forceDepthWrite: boolean;
  61331. /**
  61332. * Gets or set the number of active particles
  61333. */
  61334. activeParticleCount: number;
  61335. private _preWarmDone;
  61336. /**
  61337. * Is this system ready to be used/rendered
  61338. * @return true if the system is ready
  61339. */
  61340. isReady(): boolean;
  61341. /**
  61342. * Gets if the system has been started. (Note: this will still be true after stop is called)
  61343. * @returns True if it has been started, otherwise false.
  61344. */
  61345. isStarted(): boolean;
  61346. /**
  61347. * Starts the particle system and begins to emit
  61348. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  61349. */
  61350. start(delay?: number): void;
  61351. /**
  61352. * Stops the particle system.
  61353. */
  61354. stop(): void;
  61355. /**
  61356. * Remove all active particles
  61357. */
  61358. reset(): void;
  61359. /**
  61360. * Returns the string "GPUParticleSystem"
  61361. * @returns a string containing the class name
  61362. */
  61363. getClassName(): string;
  61364. private _colorGradientsTexture;
  61365. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  61366. /**
  61367. * Adds a new color gradient
  61368. * @param gradient defines the gradient to use (between 0 and 1)
  61369. * @param color1 defines the color to affect to the specified gradient
  61370. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  61371. * @returns the current particle system
  61372. */
  61373. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  61374. /**
  61375. * Remove a specific color gradient
  61376. * @param gradient defines the gradient to remove
  61377. * @returns the current particle system
  61378. */
  61379. removeColorGradient(gradient: number): GPUParticleSystem;
  61380. private _angularSpeedGradientsTexture;
  61381. private _sizeGradientsTexture;
  61382. private _velocityGradientsTexture;
  61383. private _limitVelocityGradientsTexture;
  61384. private _dragGradientsTexture;
  61385. private _addFactorGradient;
  61386. /**
  61387. * Adds a new size gradient
  61388. * @param gradient defines the gradient to use (between 0 and 1)
  61389. * @param factor defines the size factor to affect to the specified gradient
  61390. * @returns the current particle system
  61391. */
  61392. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  61393. /**
  61394. * Remove a specific size gradient
  61395. * @param gradient defines the gradient to remove
  61396. * @returns the current particle system
  61397. */
  61398. removeSizeGradient(gradient: number): GPUParticleSystem;
  61399. /**
  61400. * Adds a new angular speed gradient
  61401. * @param gradient defines the gradient to use (between 0 and 1)
  61402. * @param factor defines the angular speed to affect to the specified gradient
  61403. * @returns the current particle system
  61404. */
  61405. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  61406. /**
  61407. * Remove a specific angular speed gradient
  61408. * @param gradient defines the gradient to remove
  61409. * @returns the current particle system
  61410. */
  61411. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  61412. /**
  61413. * Adds a new velocity gradient
  61414. * @param gradient defines the gradient to use (between 0 and 1)
  61415. * @param factor defines the velocity to affect to the specified gradient
  61416. * @returns the current particle system
  61417. */
  61418. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  61419. /**
  61420. * Remove a specific velocity gradient
  61421. * @param gradient defines the gradient to remove
  61422. * @returns the current particle system
  61423. */
  61424. removeVelocityGradient(gradient: number): GPUParticleSystem;
  61425. /**
  61426. * Adds a new limit velocity gradient
  61427. * @param gradient defines the gradient to use (between 0 and 1)
  61428. * @param factor defines the limit velocity value to affect to the specified gradient
  61429. * @returns the current particle system
  61430. */
  61431. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  61432. /**
  61433. * Remove a specific limit velocity gradient
  61434. * @param gradient defines the gradient to remove
  61435. * @returns the current particle system
  61436. */
  61437. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  61438. /**
  61439. * Adds a new drag gradient
  61440. * @param gradient defines the gradient to use (between 0 and 1)
  61441. * @param factor defines the drag value to affect to the specified gradient
  61442. * @returns the current particle system
  61443. */
  61444. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  61445. /**
  61446. * Remove a specific drag gradient
  61447. * @param gradient defines the gradient to remove
  61448. * @returns the current particle system
  61449. */
  61450. removeDragGradient(gradient: number): GPUParticleSystem;
  61451. /**
  61452. * Not supported by GPUParticleSystem
  61453. * @param gradient defines the gradient to use (between 0 and 1)
  61454. * @param factor defines the emit rate value to affect to the specified gradient
  61455. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  61456. * @returns the current particle system
  61457. */
  61458. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  61459. /**
  61460. * Not supported by GPUParticleSystem
  61461. * @param gradient defines the gradient to remove
  61462. * @returns the current particle system
  61463. */
  61464. removeEmitRateGradient(gradient: number): IParticleSystem;
  61465. /**
  61466. * Not supported by GPUParticleSystem
  61467. * @param gradient defines the gradient to use (between 0 and 1)
  61468. * @param factor defines the start size value to affect to the specified gradient
  61469. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  61470. * @returns the current particle system
  61471. */
  61472. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  61473. /**
  61474. * Not supported by GPUParticleSystem
  61475. * @param gradient defines the gradient to remove
  61476. * @returns the current particle system
  61477. */
  61478. removeStartSizeGradient(gradient: number): IParticleSystem;
  61479. /**
  61480. * Not supported by GPUParticleSystem
  61481. * @param gradient defines the gradient to use (between 0 and 1)
  61482. * @param min defines the color remap minimal range
  61483. * @param max defines the color remap maximal range
  61484. * @returns the current particle system
  61485. */
  61486. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  61487. /**
  61488. * Not supported by GPUParticleSystem
  61489. * @param gradient defines the gradient to remove
  61490. * @returns the current particle system
  61491. */
  61492. removeColorRemapGradient(): IParticleSystem;
  61493. /**
  61494. * Not supported by GPUParticleSystem
  61495. * @param gradient defines the gradient to use (between 0 and 1)
  61496. * @param min defines the alpha remap minimal range
  61497. * @param max defines the alpha remap maximal range
  61498. * @returns the current particle system
  61499. */
  61500. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  61501. /**
  61502. * Not supported by GPUParticleSystem
  61503. * @param gradient defines the gradient to remove
  61504. * @returns the current particle system
  61505. */
  61506. removeAlphaRemapGradient(): IParticleSystem;
  61507. /**
  61508. * Not supported by GPUParticleSystem
  61509. * @param gradient defines the gradient to use (between 0 and 1)
  61510. * @param color defines the color to affect to the specified gradient
  61511. * @returns the current particle system
  61512. */
  61513. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  61514. /**
  61515. * Not supported by GPUParticleSystem
  61516. * @param gradient defines the gradient to remove
  61517. * @returns the current particle system
  61518. */
  61519. removeRampGradient(): IParticleSystem;
  61520. /**
  61521. * Not supported by GPUParticleSystem
  61522. * @returns the list of ramp gradients
  61523. */
  61524. getRampGradients(): Nullable<Array<Color3Gradient>>;
  61525. /**
  61526. * Not supported by GPUParticleSystem
  61527. * Gets or sets a boolean indicating that ramp gradients must be used
  61528. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  61529. */
  61530. useRampGradients: boolean;
  61531. /**
  61532. * Not supported by GPUParticleSystem
  61533. * @param gradient defines the gradient to use (between 0 and 1)
  61534. * @param factor defines the life time factor to affect to the specified gradient
  61535. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  61536. * @returns the current particle system
  61537. */
  61538. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  61539. /**
  61540. * Not supported by GPUParticleSystem
  61541. * @param gradient defines the gradient to remove
  61542. * @returns the current particle system
  61543. */
  61544. removeLifeTimeGradient(gradient: number): IParticleSystem;
  61545. /**
  61546. * Instantiates a GPU particle system.
  61547. * 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.
  61548. * @param name The name of the particle system
  61549. * @param options The options used to create the system
  61550. * @param scene The scene the particle system belongs to
  61551. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  61552. */
  61553. constructor(name: string, options: Partial<{
  61554. capacity: number;
  61555. randomTextureSize: number;
  61556. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  61557. protected _reset(): void;
  61558. private _createUpdateVAO;
  61559. private _createRenderVAO;
  61560. private _initialize;
  61561. /** @hidden */
  61562. _recreateUpdateEffect(): void;
  61563. /** @hidden */
  61564. _recreateRenderEffect(): void;
  61565. /**
  61566. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  61567. * @param preWarm defines if we are in the pre-warmimg phase
  61568. */
  61569. animate(preWarm?: boolean): void;
  61570. private _createFactorGradientTexture;
  61571. private _createSizeGradientTexture;
  61572. private _createAngularSpeedGradientTexture;
  61573. private _createVelocityGradientTexture;
  61574. private _createLimitVelocityGradientTexture;
  61575. private _createDragGradientTexture;
  61576. private _createColorGradientTexture;
  61577. /**
  61578. * Renders the particle system in its current state
  61579. * @param preWarm defines if the system should only update the particles but not render them
  61580. * @returns the current number of particles
  61581. */
  61582. render(preWarm?: boolean): number;
  61583. /**
  61584. * Rebuilds the particle system
  61585. */
  61586. rebuild(): void;
  61587. private _releaseBuffers;
  61588. private _releaseVAOs;
  61589. /**
  61590. * Disposes the particle system and free the associated resources
  61591. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  61592. */
  61593. dispose(disposeTexture?: boolean): void;
  61594. /**
  61595. * Clones the particle system.
  61596. * @param name The name of the cloned object
  61597. * @param newEmitter The new emitter to use
  61598. * @returns the cloned particle system
  61599. */
  61600. clone(name: string, newEmitter: any): GPUParticleSystem;
  61601. /**
  61602. * Serializes the particle system to a JSON object.
  61603. * @returns the JSON object
  61604. */
  61605. serialize(): any;
  61606. /**
  61607. * Parses a JSON object to create a GPU particle system.
  61608. * @param parsedParticleSystem The JSON object to parse
  61609. * @param scene The scene to create the particle system in
  61610. * @param rootUrl The root url to use to load external dependencies like texture
  61611. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  61612. * @returns the parsed GPU particle system
  61613. */
  61614. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  61615. }
  61616. }
  61617. declare module "babylonjs/Particles/particleSystemSet" {
  61618. import { Nullable } from "babylonjs/types";
  61619. import { Color3 } from "babylonjs/Maths/math.color";
  61620. import { TransformNode } from "babylonjs/Meshes/transformNode";
  61621. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61622. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61623. import { Scene, IDisposable } from "babylonjs/scene";
  61624. /**
  61625. * Represents a set of particle systems working together to create a specific effect
  61626. */
  61627. export class ParticleSystemSet implements IDisposable {
  61628. /**
  61629. * Gets or sets base Assets URL
  61630. */
  61631. static BaseAssetsUrl: string;
  61632. private _emitterCreationOptions;
  61633. private _emitterNode;
  61634. /**
  61635. * Gets the particle system list
  61636. */
  61637. systems: IParticleSystem[];
  61638. /**
  61639. * Gets the emitter node used with this set
  61640. */
  61641. readonly emitterNode: Nullable<TransformNode>;
  61642. /**
  61643. * Creates a new emitter mesh as a sphere
  61644. * @param options defines the options used to create the sphere
  61645. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  61646. * @param scene defines the hosting scene
  61647. */
  61648. setEmitterAsSphere(options: {
  61649. diameter: number;
  61650. segments: number;
  61651. color: Color3;
  61652. }, renderingGroupId: number, scene: Scene): void;
  61653. /**
  61654. * Starts all particle systems of the set
  61655. * @param emitter defines an optional mesh to use as emitter for the particle systems
  61656. */
  61657. start(emitter?: AbstractMesh): void;
  61658. /**
  61659. * Release all associated resources
  61660. */
  61661. dispose(): void;
  61662. /**
  61663. * Serialize the set into a JSON compatible object
  61664. * @returns a JSON compatible representation of the set
  61665. */
  61666. serialize(): any;
  61667. /**
  61668. * Parse a new ParticleSystemSet from a serialized source
  61669. * @param data defines a JSON compatible representation of the set
  61670. * @param scene defines the hosting scene
  61671. * @param gpu defines if we want GPU particles or CPU particles
  61672. * @returns a new ParticleSystemSet
  61673. */
  61674. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  61675. }
  61676. }
  61677. declare module "babylonjs/Particles/particleHelper" {
  61678. import { Nullable } from "babylonjs/types";
  61679. import { Scene } from "babylonjs/scene";
  61680. import { Vector3 } from "babylonjs/Maths/math.vector";
  61681. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61682. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61683. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  61684. /**
  61685. * This class is made for on one-liner static method to help creating particle system set.
  61686. */
  61687. export class ParticleHelper {
  61688. /**
  61689. * Gets or sets base Assets URL
  61690. */
  61691. static BaseAssetsUrl: string;
  61692. /**
  61693. * Create a default particle system that you can tweak
  61694. * @param emitter defines the emitter to use
  61695. * @param capacity defines the system capacity (default is 500 particles)
  61696. * @param scene defines the hosting scene
  61697. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  61698. * @returns the new Particle system
  61699. */
  61700. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  61701. /**
  61702. * This is the main static method (one-liner) of this helper to create different particle systems
  61703. * @param type This string represents the type to the particle system to create
  61704. * @param scene The scene where the particle system should live
  61705. * @param gpu If the system will use gpu
  61706. * @returns the ParticleSystemSet created
  61707. */
  61708. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  61709. /**
  61710. * Static function used to export a particle system to a ParticleSystemSet variable.
  61711. * Please note that the emitter shape is not exported
  61712. * @param systems defines the particle systems to export
  61713. * @returns the created particle system set
  61714. */
  61715. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  61716. }
  61717. }
  61718. declare module "babylonjs/Particles/particleSystemComponent" {
  61719. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61720. import { Effect } from "babylonjs/Materials/effect";
  61721. import "babylonjs/Shaders/particles.vertex";
  61722. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  61723. module "babylonjs/Engines/engine" {
  61724. interface Engine {
  61725. /**
  61726. * Create an effect to use with particle systems.
  61727. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  61728. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  61729. * @param uniformsNames defines a list of attribute names
  61730. * @param samplers defines an array of string used to represent textures
  61731. * @param defines defines the string containing the defines to use to compile the shaders
  61732. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  61733. * @param onCompiled defines a function to call when the effect creation is successful
  61734. * @param onError defines a function to call when the effect creation has failed
  61735. * @returns the new Effect
  61736. */
  61737. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  61738. }
  61739. }
  61740. module "babylonjs/Meshes/mesh" {
  61741. interface Mesh {
  61742. /**
  61743. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  61744. * @returns an array of IParticleSystem
  61745. */
  61746. getEmittedParticleSystems(): IParticleSystem[];
  61747. /**
  61748. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  61749. * @returns an array of IParticleSystem
  61750. */
  61751. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  61752. }
  61753. }
  61754. /**
  61755. * @hidden
  61756. */
  61757. export var _IDoNeedToBeInTheBuild: number;
  61758. }
  61759. declare module "babylonjs/Particles/pointsCloudSystem" {
  61760. import { Color4 } from "babylonjs/Maths/math";
  61761. import { Mesh } from "babylonjs/Meshes/mesh";
  61762. import { Scene, IDisposable } from "babylonjs/scene";
  61763. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  61764. /** Defines the 4 color options */
  61765. export enum PointColor {
  61766. /** color value */
  61767. Color = 2,
  61768. /** uv value */
  61769. UV = 1,
  61770. /** random value */
  61771. Random = 0,
  61772. /** stated value */
  61773. Stated = 3
  61774. }
  61775. /**
  61776. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  61777. * 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.
  61778. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  61779. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  61780. *
  61781. * Full documentation here : TO BE ENTERED
  61782. */
  61783. export class PointsCloudSystem implements IDisposable {
  61784. /**
  61785. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  61786. * Example : var p = SPS.particles[i];
  61787. */
  61788. particles: CloudPoint[];
  61789. /**
  61790. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  61791. */
  61792. nbParticles: number;
  61793. /**
  61794. * This a counter for your own usage. It's not set by any SPS functions.
  61795. */
  61796. counter: number;
  61797. /**
  61798. * The PCS name. This name is also given to the underlying mesh.
  61799. */
  61800. name: string;
  61801. /**
  61802. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  61803. */
  61804. mesh: Mesh;
  61805. /**
  61806. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  61807. * Please read :
  61808. */
  61809. vars: any;
  61810. /**
  61811. * @hidden
  61812. */
  61813. _size: number;
  61814. private _scene;
  61815. private _promises;
  61816. private _positions;
  61817. private _indices;
  61818. private _normals;
  61819. private _colors;
  61820. private _uvs;
  61821. private _indices32;
  61822. private _positions32;
  61823. private _colors32;
  61824. private _uvs32;
  61825. private _updatable;
  61826. private _isVisibilityBoxLocked;
  61827. private _alwaysVisible;
  61828. private _groups;
  61829. private _groupCounter;
  61830. private _computeParticleColor;
  61831. private _computeParticleTexture;
  61832. private _computeParticleRotation;
  61833. private _computeBoundingBox;
  61834. private _isReady;
  61835. /**
  61836. * Creates a PCS (Points Cloud System) object
  61837. * @param name (String) is the PCS name, this will be the underlying mesh name
  61838. * @param pointSize (number) is the size for each point
  61839. * @param scene (Scene) is the scene in which the PCS is added
  61840. * @param options defines the options of the PCS e.g.
  61841. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  61842. */
  61843. constructor(name: string, pointSize: number, scene: Scene, options?: {
  61844. updatable?: boolean;
  61845. });
  61846. /**
  61847. * Builds the PCS underlying mesh. Returns a standard Mesh.
  61848. * If no points were added to the PCS, the returned mesh is just a single point.
  61849. * @returns a promise for the created mesh
  61850. */
  61851. buildMeshAsync(): Promise<Mesh>;
  61852. /**
  61853. * @hidden
  61854. */
  61855. private _buildMesh;
  61856. private _addParticle;
  61857. private _randomUnitVector;
  61858. private _getColorIndicesForCoord;
  61859. private _setPointsColorOrUV;
  61860. private _colorFromTexture;
  61861. private _calculateDensity;
  61862. /**
  61863. * Adds points to the PCS in random positions within a unit sphere
  61864. * @param nb (positive integer) the number of particles to be created from this model
  61865. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  61866. * @returns the number of groups in the system
  61867. */
  61868. addPoints(nb: number, pointFunction?: any): number;
  61869. /**
  61870. * Adds points to the PCS from the surface of the model shape
  61871. * @param mesh is any Mesh object that will be used as a surface model for the points
  61872. * @param nb (positive integer) the number of particles to be created from this model
  61873. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  61874. * @param color (color3) to be used when colorWith is stated
  61875. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  61876. * @returns the number of groups in the system
  61877. */
  61878. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4, range?: number): number;
  61879. /**
  61880. * Adds points to the PCS inside the model shape
  61881. * @param mesh is any Mesh object that will be used as a surface model for the points
  61882. * @param nb (positive integer) the number of particles to be created from this model
  61883. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible),
  61884. * @param color (color4) to be used when colorWith is stated
  61885. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  61886. * @returns the number of groups in the system
  61887. */
  61888. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4, range?: number): number;
  61889. /**
  61890. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  61891. * This method calls `updateParticle()` for each particle of the SPS.
  61892. * For an animated SPS, it is usually called within the render loop.
  61893. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  61894. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  61895. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  61896. * @returns the PCS.
  61897. */
  61898. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  61899. /**
  61900. * Disposes the PCS.
  61901. */
  61902. dispose(): void;
  61903. /**
  61904. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  61905. * doc :
  61906. * @returns the PCS.
  61907. */
  61908. refreshVisibleSize(): PointsCloudSystem;
  61909. /**
  61910. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  61911. * @param size the size (float) of the visibility box
  61912. * note : this doesn't lock the PCS mesh bounding box.
  61913. * doc :
  61914. */
  61915. setVisibilityBox(size: number): void;
  61916. /**
  61917. * Gets whether the PCS is always visible or not
  61918. * doc :
  61919. */
  61920. /**
  61921. * Sets the PCS as always visible or not
  61922. * doc :
  61923. */
  61924. isAlwaysVisible: boolean;
  61925. /**
  61926. * Tells to `setParticles()` to compute the particle rotations or not
  61927. * Default value : false. The PCS is faster when it's set to false
  61928. * Note : particle rotations are only applied to parent particles
  61929. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  61930. */
  61931. computeParticleRotation: boolean;
  61932. /**
  61933. * Tells to `setParticles()` to compute the particle colors or not.
  61934. * Default value : true. The PCS is faster when it's set to false.
  61935. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  61936. */
  61937. /**
  61938. * Gets if `setParticles()` computes the particle colors or not.
  61939. * Default value : false. The PCS is faster when it's set to false.
  61940. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  61941. */
  61942. computeParticleColor: boolean;
  61943. /**
  61944. * Gets if `setParticles()` computes the particle textures or not.
  61945. * Default value : false. The PCS is faster when it's set to false.
  61946. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  61947. */
  61948. computeParticleTexture: boolean;
  61949. /**
  61950. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  61951. */
  61952. /**
  61953. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  61954. */
  61955. computeBoundingBox: boolean;
  61956. /**
  61957. * This function does nothing. It may be overwritten to set all the particle first values.
  61958. * The PCS doesn't call this function, you may have to call it by your own.
  61959. * doc :
  61960. */
  61961. initParticles(): void;
  61962. /**
  61963. * This function does nothing. It may be overwritten to recycle a particle
  61964. * The PCS doesn't call this function, you can to call it
  61965. * doc :
  61966. * @param particle The particle to recycle
  61967. * @returns the recycled particle
  61968. */
  61969. recycleParticle(particle: CloudPoint): CloudPoint;
  61970. /**
  61971. * Updates a particle : this function should be overwritten by the user.
  61972. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  61973. * doc :
  61974. * @example : just set a particle position or velocity and recycle conditions
  61975. * @param particle The particle to update
  61976. * @returns the updated particle
  61977. */
  61978. updateParticle(particle: CloudPoint): CloudPoint;
  61979. /**
  61980. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  61981. * This does nothing and may be overwritten by the user.
  61982. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  61983. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  61984. * @param update the boolean update value actually passed to setParticles()
  61985. */
  61986. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  61987. /**
  61988. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  61989. * This will be passed three parameters.
  61990. * This does nothing and may be overwritten by the user.
  61991. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  61992. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  61993. * @param update the boolean update value actually passed to setParticles()
  61994. */
  61995. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  61996. }
  61997. }
  61998. declare module "babylonjs/Particles/cloudPoint" {
  61999. import { Nullable } from "babylonjs/types";
  62000. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  62001. import { Mesh } from "babylonjs/Meshes/mesh";
  62002. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62003. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  62004. /**
  62005. * Represents one particle of a points cloud system.
  62006. */
  62007. export class CloudPoint {
  62008. /**
  62009. * particle global index
  62010. */
  62011. idx: number;
  62012. /**
  62013. * The color of the particle
  62014. */
  62015. color: Nullable<Color4>;
  62016. /**
  62017. * The world space position of the particle.
  62018. */
  62019. position: Vector3;
  62020. /**
  62021. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  62022. */
  62023. rotation: Vector3;
  62024. /**
  62025. * The world space rotation quaternion of the particle.
  62026. */
  62027. rotationQuaternion: Nullable<Quaternion>;
  62028. /**
  62029. * The uv of the particle.
  62030. */
  62031. uv: Nullable<Vector2>;
  62032. /**
  62033. * The current speed of the particle.
  62034. */
  62035. velocity: Vector3;
  62036. /**
  62037. * The pivot point in the particle local space.
  62038. */
  62039. pivot: Vector3;
  62040. /**
  62041. * Must the particle be translated from its pivot point in its local space ?
  62042. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  62043. * Default : false
  62044. */
  62045. translateFromPivot: boolean;
  62046. /**
  62047. * Index of this particle in the global "positions" array (Internal use)
  62048. * @hidden
  62049. */
  62050. _pos: number;
  62051. /**
  62052. * @hidden Index of this particle in the global "indices" array (Internal use)
  62053. */
  62054. _ind: number;
  62055. /**
  62056. * Group this particle belongs to
  62057. */
  62058. _group: PointsGroup;
  62059. /**
  62060. * Group id of this particle
  62061. */
  62062. groupId: number;
  62063. /**
  62064. * Index of the particle in its group id (Internal use)
  62065. */
  62066. idxInGroup: number;
  62067. /**
  62068. * @hidden Particle BoundingInfo object (Internal use)
  62069. */
  62070. _boundingInfo: BoundingInfo;
  62071. /**
  62072. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  62073. */
  62074. _pcs: PointsCloudSystem;
  62075. /**
  62076. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  62077. */
  62078. _stillInvisible: boolean;
  62079. /**
  62080. * @hidden Last computed particle rotation matrix
  62081. */
  62082. _rotationMatrix: number[];
  62083. /**
  62084. * Parent particle Id, if any.
  62085. * Default null.
  62086. */
  62087. parentId: Nullable<number>;
  62088. /**
  62089. * @hidden Internal global position in the PCS.
  62090. */
  62091. _globalPosition: Vector3;
  62092. /**
  62093. * Creates a Point Cloud object.
  62094. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  62095. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  62096. * @param group (PointsGroup) is the group the particle belongs to
  62097. * @param groupId (integer) is the group identifier in the PCS.
  62098. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  62099. * @param pcs defines the PCS it is associated to
  62100. */
  62101. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  62102. /**
  62103. * get point size
  62104. */
  62105. /**
  62106. * Set point size
  62107. */
  62108. size: Vector3;
  62109. /**
  62110. * Legacy support, changed quaternion to rotationQuaternion
  62111. */
  62112. /**
  62113. * Legacy support, changed quaternion to rotationQuaternion
  62114. */
  62115. quaternion: Nullable<Quaternion>;
  62116. /**
  62117. * Returns a boolean. True if the particle intersects a mesh, else false
  62118. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  62119. * @param target is the object (point or mesh) what the intersection is computed against
  62120. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  62121. * @returns true if it intersects
  62122. */
  62123. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  62124. /**
  62125. * get the rotation matrix of the particle
  62126. * @hidden
  62127. */
  62128. getRotationMatrix(m: Matrix): void;
  62129. }
  62130. /**
  62131. * Represents a group of points in a points cloud system
  62132. * * PCS internal tool, don't use it manually.
  62133. */
  62134. export class PointsGroup {
  62135. /**
  62136. * The group id
  62137. * @hidden
  62138. */
  62139. groupID: number;
  62140. /**
  62141. * image data for group (internal use)
  62142. * @hidden
  62143. */
  62144. _groupImageData: Nullable<ArrayBufferView>;
  62145. /**
  62146. * Image Width (internal use)
  62147. * @hidden
  62148. */
  62149. _groupImgWidth: number;
  62150. /**
  62151. * Image Height (internal use)
  62152. * @hidden
  62153. */
  62154. _groupImgHeight: number;
  62155. /**
  62156. * Custom position function (internal use)
  62157. * @hidden
  62158. */
  62159. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  62160. /**
  62161. * density per facet for surface points
  62162. * @hidden
  62163. */
  62164. _groupDensity: number[];
  62165. /**
  62166. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  62167. * PCS internal tool, don't use it manually.
  62168. * @hidden
  62169. */
  62170. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  62171. }
  62172. }
  62173. declare module "babylonjs/Particles/index" {
  62174. export * from "babylonjs/Particles/baseParticleSystem";
  62175. export * from "babylonjs/Particles/EmitterTypes/index";
  62176. export * from "babylonjs/Particles/gpuParticleSystem";
  62177. export * from "babylonjs/Particles/IParticleSystem";
  62178. export * from "babylonjs/Particles/particle";
  62179. export * from "babylonjs/Particles/particleHelper";
  62180. export * from "babylonjs/Particles/particleSystem";
  62181. export * from "babylonjs/Particles/particleSystemComponent";
  62182. export * from "babylonjs/Particles/particleSystemSet";
  62183. export * from "babylonjs/Particles/solidParticle";
  62184. export * from "babylonjs/Particles/solidParticleSystem";
  62185. export * from "babylonjs/Particles/cloudPoint";
  62186. export * from "babylonjs/Particles/pointsCloudSystem";
  62187. export * from "babylonjs/Particles/subEmitter";
  62188. }
  62189. declare module "babylonjs/Physics/physicsEngineComponent" {
  62190. import { Nullable } from "babylonjs/types";
  62191. import { Observable, Observer } from "babylonjs/Misc/observable";
  62192. import { Vector3 } from "babylonjs/Maths/math.vector";
  62193. import { Mesh } from "babylonjs/Meshes/mesh";
  62194. import { ISceneComponent } from "babylonjs/sceneComponent";
  62195. import { Scene } from "babylonjs/scene";
  62196. import { Node } from "babylonjs/node";
  62197. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  62198. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62199. module "babylonjs/scene" {
  62200. interface Scene {
  62201. /** @hidden (Backing field) */
  62202. _physicsEngine: Nullable<IPhysicsEngine>;
  62203. /**
  62204. * Gets the current physics engine
  62205. * @returns a IPhysicsEngine or null if none attached
  62206. */
  62207. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  62208. /**
  62209. * Enables physics to the current scene
  62210. * @param gravity defines the scene's gravity for the physics engine
  62211. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  62212. * @return a boolean indicating if the physics engine was initialized
  62213. */
  62214. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  62215. /**
  62216. * Disables and disposes the physics engine associated with the scene
  62217. */
  62218. disablePhysicsEngine(): void;
  62219. /**
  62220. * Gets a boolean indicating if there is an active physics engine
  62221. * @returns a boolean indicating if there is an active physics engine
  62222. */
  62223. isPhysicsEnabled(): boolean;
  62224. /**
  62225. * Deletes a physics compound impostor
  62226. * @param compound defines the compound to delete
  62227. */
  62228. deleteCompoundImpostor(compound: any): void;
  62229. /**
  62230. * An event triggered when physic simulation is about to be run
  62231. */
  62232. onBeforePhysicsObservable: Observable<Scene>;
  62233. /**
  62234. * An event triggered when physic simulation has been done
  62235. */
  62236. onAfterPhysicsObservable: Observable<Scene>;
  62237. }
  62238. }
  62239. module "babylonjs/Meshes/abstractMesh" {
  62240. interface AbstractMesh {
  62241. /** @hidden */
  62242. _physicsImpostor: Nullable<PhysicsImpostor>;
  62243. /**
  62244. * Gets or sets impostor used for physic simulation
  62245. * @see http://doc.babylonjs.com/features/physics_engine
  62246. */
  62247. physicsImpostor: Nullable<PhysicsImpostor>;
  62248. /**
  62249. * Gets the current physics impostor
  62250. * @see http://doc.babylonjs.com/features/physics_engine
  62251. * @returns a physics impostor or null
  62252. */
  62253. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  62254. /** Apply a physic impulse to the mesh
  62255. * @param force defines the force to apply
  62256. * @param contactPoint defines where to apply the force
  62257. * @returns the current mesh
  62258. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  62259. */
  62260. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  62261. /**
  62262. * Creates a physic joint between two meshes
  62263. * @param otherMesh defines the other mesh to use
  62264. * @param pivot1 defines the pivot to use on this mesh
  62265. * @param pivot2 defines the pivot to use on the other mesh
  62266. * @param options defines additional options (can be plugin dependent)
  62267. * @returns the current mesh
  62268. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  62269. */
  62270. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  62271. /** @hidden */
  62272. _disposePhysicsObserver: Nullable<Observer<Node>>;
  62273. }
  62274. }
  62275. /**
  62276. * Defines the physics engine scene component responsible to manage a physics engine
  62277. */
  62278. export class PhysicsEngineSceneComponent implements ISceneComponent {
  62279. /**
  62280. * The component name helpful to identify the component in the list of scene components.
  62281. */
  62282. readonly name: string;
  62283. /**
  62284. * The scene the component belongs to.
  62285. */
  62286. scene: Scene;
  62287. /**
  62288. * Creates a new instance of the component for the given scene
  62289. * @param scene Defines the scene to register the component in
  62290. */
  62291. constructor(scene: Scene);
  62292. /**
  62293. * Registers the component in a given scene
  62294. */
  62295. register(): void;
  62296. /**
  62297. * Rebuilds the elements related to this component in case of
  62298. * context lost for instance.
  62299. */
  62300. rebuild(): void;
  62301. /**
  62302. * Disposes the component and the associated ressources
  62303. */
  62304. dispose(): void;
  62305. }
  62306. }
  62307. declare module "babylonjs/Physics/physicsHelper" {
  62308. import { Nullable } from "babylonjs/types";
  62309. import { Vector3 } from "babylonjs/Maths/math.vector";
  62310. import { Mesh } from "babylonjs/Meshes/mesh";
  62311. import { Scene } from "babylonjs/scene";
  62312. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62313. /**
  62314. * A helper for physics simulations
  62315. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62316. */
  62317. export class PhysicsHelper {
  62318. private _scene;
  62319. private _physicsEngine;
  62320. /**
  62321. * Initializes the Physics helper
  62322. * @param scene Babylon.js scene
  62323. */
  62324. constructor(scene: Scene);
  62325. /**
  62326. * Applies a radial explosion impulse
  62327. * @param origin the origin of the explosion
  62328. * @param radiusOrEventOptions the radius or the options of radial explosion
  62329. * @param strength the explosion strength
  62330. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62331. * @returns A physics radial explosion event, or null
  62332. */
  62333. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  62334. /**
  62335. * Applies a radial explosion force
  62336. * @param origin the origin of the explosion
  62337. * @param radiusOrEventOptions the radius or the options of radial explosion
  62338. * @param strength the explosion strength
  62339. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62340. * @returns A physics radial explosion event, or null
  62341. */
  62342. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  62343. /**
  62344. * Creates a gravitational field
  62345. * @param origin the origin of the explosion
  62346. * @param radiusOrEventOptions the radius or the options of radial explosion
  62347. * @param strength the explosion strength
  62348. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62349. * @returns A physics gravitational field event, or null
  62350. */
  62351. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  62352. /**
  62353. * Creates a physics updraft event
  62354. * @param origin the origin of the updraft
  62355. * @param radiusOrEventOptions the radius or the options of the updraft
  62356. * @param strength the strength of the updraft
  62357. * @param height the height of the updraft
  62358. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  62359. * @returns A physics updraft event, or null
  62360. */
  62361. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  62362. /**
  62363. * Creates a physics vortex event
  62364. * @param origin the of the vortex
  62365. * @param radiusOrEventOptions the radius or the options of the vortex
  62366. * @param strength the strength of the vortex
  62367. * @param height the height of the vortex
  62368. * @returns a Physics vortex event, or null
  62369. * A physics vortex event or null
  62370. */
  62371. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  62372. }
  62373. /**
  62374. * Represents a physics radial explosion event
  62375. */
  62376. class PhysicsRadialExplosionEvent {
  62377. private _scene;
  62378. private _options;
  62379. private _sphere;
  62380. private _dataFetched;
  62381. /**
  62382. * Initializes a radial explosioin event
  62383. * @param _scene BabylonJS scene
  62384. * @param _options The options for the vortex event
  62385. */
  62386. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  62387. /**
  62388. * Returns the data related to the radial explosion event (sphere).
  62389. * @returns The radial explosion event data
  62390. */
  62391. getData(): PhysicsRadialExplosionEventData;
  62392. /**
  62393. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  62394. * @param impostor A physics imposter
  62395. * @param origin the origin of the explosion
  62396. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  62397. */
  62398. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  62399. /**
  62400. * Triggers affecterd impostors callbacks
  62401. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  62402. */
  62403. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  62404. /**
  62405. * Disposes the sphere.
  62406. * @param force Specifies if the sphere should be disposed by force
  62407. */
  62408. dispose(force?: boolean): void;
  62409. /*** Helpers ***/
  62410. private _prepareSphere;
  62411. private _intersectsWithSphere;
  62412. }
  62413. /**
  62414. * Represents a gravitational field event
  62415. */
  62416. class PhysicsGravitationalFieldEvent {
  62417. private _physicsHelper;
  62418. private _scene;
  62419. private _origin;
  62420. private _options;
  62421. private _tickCallback;
  62422. private _sphere;
  62423. private _dataFetched;
  62424. /**
  62425. * Initializes the physics gravitational field event
  62426. * @param _physicsHelper A physics helper
  62427. * @param _scene BabylonJS scene
  62428. * @param _origin The origin position of the gravitational field event
  62429. * @param _options The options for the vortex event
  62430. */
  62431. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  62432. /**
  62433. * Returns the data related to the gravitational field event (sphere).
  62434. * @returns A gravitational field event
  62435. */
  62436. getData(): PhysicsGravitationalFieldEventData;
  62437. /**
  62438. * Enables the gravitational field.
  62439. */
  62440. enable(): void;
  62441. /**
  62442. * Disables the gravitational field.
  62443. */
  62444. disable(): void;
  62445. /**
  62446. * Disposes the sphere.
  62447. * @param force The force to dispose from the gravitational field event
  62448. */
  62449. dispose(force?: boolean): void;
  62450. private _tick;
  62451. }
  62452. /**
  62453. * Represents a physics updraft event
  62454. */
  62455. class PhysicsUpdraftEvent {
  62456. private _scene;
  62457. private _origin;
  62458. private _options;
  62459. private _physicsEngine;
  62460. private _originTop;
  62461. private _originDirection;
  62462. private _tickCallback;
  62463. private _cylinder;
  62464. private _cylinderPosition;
  62465. private _dataFetched;
  62466. /**
  62467. * Initializes the physics updraft event
  62468. * @param _scene BabylonJS scene
  62469. * @param _origin The origin position of the updraft
  62470. * @param _options The options for the updraft event
  62471. */
  62472. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  62473. /**
  62474. * Returns the data related to the updraft event (cylinder).
  62475. * @returns A physics updraft event
  62476. */
  62477. getData(): PhysicsUpdraftEventData;
  62478. /**
  62479. * Enables the updraft.
  62480. */
  62481. enable(): void;
  62482. /**
  62483. * Disables the updraft.
  62484. */
  62485. disable(): void;
  62486. /**
  62487. * Disposes the cylinder.
  62488. * @param force Specifies if the updraft should be disposed by force
  62489. */
  62490. dispose(force?: boolean): void;
  62491. private getImpostorHitData;
  62492. private _tick;
  62493. /*** Helpers ***/
  62494. private _prepareCylinder;
  62495. private _intersectsWithCylinder;
  62496. }
  62497. /**
  62498. * Represents a physics vortex event
  62499. */
  62500. class PhysicsVortexEvent {
  62501. private _scene;
  62502. private _origin;
  62503. private _options;
  62504. private _physicsEngine;
  62505. private _originTop;
  62506. private _tickCallback;
  62507. private _cylinder;
  62508. private _cylinderPosition;
  62509. private _dataFetched;
  62510. /**
  62511. * Initializes the physics vortex event
  62512. * @param _scene The BabylonJS scene
  62513. * @param _origin The origin position of the vortex
  62514. * @param _options The options for the vortex event
  62515. */
  62516. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  62517. /**
  62518. * Returns the data related to the vortex event (cylinder).
  62519. * @returns The physics vortex event data
  62520. */
  62521. getData(): PhysicsVortexEventData;
  62522. /**
  62523. * Enables the vortex.
  62524. */
  62525. enable(): void;
  62526. /**
  62527. * Disables the cortex.
  62528. */
  62529. disable(): void;
  62530. /**
  62531. * Disposes the sphere.
  62532. * @param force
  62533. */
  62534. dispose(force?: boolean): void;
  62535. private getImpostorHitData;
  62536. private _tick;
  62537. /*** Helpers ***/
  62538. private _prepareCylinder;
  62539. private _intersectsWithCylinder;
  62540. }
  62541. /**
  62542. * Options fot the radial explosion event
  62543. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62544. */
  62545. export class PhysicsRadialExplosionEventOptions {
  62546. /**
  62547. * The radius of the sphere for the radial explosion.
  62548. */
  62549. radius: number;
  62550. /**
  62551. * The strenth of the explosion.
  62552. */
  62553. strength: number;
  62554. /**
  62555. * The strenght of the force in correspondence to the distance of the affected object
  62556. */
  62557. falloff: PhysicsRadialImpulseFalloff;
  62558. /**
  62559. * Sphere options for the radial explosion.
  62560. */
  62561. sphere: {
  62562. segments: number;
  62563. diameter: number;
  62564. };
  62565. /**
  62566. * Sphere options for the radial explosion.
  62567. */
  62568. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  62569. }
  62570. /**
  62571. * Options fot the updraft event
  62572. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62573. */
  62574. export class PhysicsUpdraftEventOptions {
  62575. /**
  62576. * The radius of the cylinder for the vortex
  62577. */
  62578. radius: number;
  62579. /**
  62580. * The strenth of the updraft.
  62581. */
  62582. strength: number;
  62583. /**
  62584. * The height of the cylinder for the updraft.
  62585. */
  62586. height: number;
  62587. /**
  62588. * The mode for the the updraft.
  62589. */
  62590. updraftMode: PhysicsUpdraftMode;
  62591. }
  62592. /**
  62593. * Options fot the vortex event
  62594. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62595. */
  62596. export class PhysicsVortexEventOptions {
  62597. /**
  62598. * The radius of the cylinder for the vortex
  62599. */
  62600. radius: number;
  62601. /**
  62602. * The strenth of the vortex.
  62603. */
  62604. strength: number;
  62605. /**
  62606. * The height of the cylinder for the vortex.
  62607. */
  62608. height: number;
  62609. /**
  62610. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  62611. */
  62612. centripetalForceThreshold: number;
  62613. /**
  62614. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  62615. */
  62616. centripetalForceMultiplier: number;
  62617. /**
  62618. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  62619. */
  62620. centrifugalForceMultiplier: number;
  62621. /**
  62622. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  62623. */
  62624. updraftForceMultiplier: number;
  62625. }
  62626. /**
  62627. * The strenght of the force in correspondence to the distance of the affected object
  62628. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62629. */
  62630. export enum PhysicsRadialImpulseFalloff {
  62631. /** Defines that impulse is constant in strength across it's whole radius */
  62632. Constant = 0,
  62633. /** Defines that impulse gets weaker if it's further from the origin */
  62634. Linear = 1
  62635. }
  62636. /**
  62637. * The strength of the force in correspondence to the distance of the affected object
  62638. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62639. */
  62640. export enum PhysicsUpdraftMode {
  62641. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  62642. Center = 0,
  62643. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  62644. Perpendicular = 1
  62645. }
  62646. /**
  62647. * Interface for a physics hit data
  62648. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62649. */
  62650. export interface PhysicsHitData {
  62651. /**
  62652. * The force applied at the contact point
  62653. */
  62654. force: Vector3;
  62655. /**
  62656. * The contact point
  62657. */
  62658. contactPoint: Vector3;
  62659. /**
  62660. * The distance from the origin to the contact point
  62661. */
  62662. distanceFromOrigin: number;
  62663. }
  62664. /**
  62665. * Interface for radial explosion event data
  62666. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62667. */
  62668. export interface PhysicsRadialExplosionEventData {
  62669. /**
  62670. * A sphere used for the radial explosion event
  62671. */
  62672. sphere: Mesh;
  62673. }
  62674. /**
  62675. * Interface for gravitational field event data
  62676. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62677. */
  62678. export interface PhysicsGravitationalFieldEventData {
  62679. /**
  62680. * A sphere mesh used for the gravitational field event
  62681. */
  62682. sphere: Mesh;
  62683. }
  62684. /**
  62685. * Interface for updraft event data
  62686. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62687. */
  62688. export interface PhysicsUpdraftEventData {
  62689. /**
  62690. * A cylinder used for the updraft event
  62691. */
  62692. cylinder: Mesh;
  62693. }
  62694. /**
  62695. * Interface for vortex event data
  62696. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62697. */
  62698. export interface PhysicsVortexEventData {
  62699. /**
  62700. * A cylinder used for the vortex event
  62701. */
  62702. cylinder: Mesh;
  62703. }
  62704. /**
  62705. * Interface for an affected physics impostor
  62706. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62707. */
  62708. export interface PhysicsAffectedImpostorWithData {
  62709. /**
  62710. * The impostor affected by the effect
  62711. */
  62712. impostor: PhysicsImpostor;
  62713. /**
  62714. * The data about the hit/horce from the explosion
  62715. */
  62716. hitData: PhysicsHitData;
  62717. }
  62718. }
  62719. declare module "babylonjs/Physics/Plugins/index" {
  62720. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  62721. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  62722. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  62723. }
  62724. declare module "babylonjs/Physics/index" {
  62725. export * from "babylonjs/Physics/IPhysicsEngine";
  62726. export * from "babylonjs/Physics/physicsEngine";
  62727. export * from "babylonjs/Physics/physicsEngineComponent";
  62728. export * from "babylonjs/Physics/physicsHelper";
  62729. export * from "babylonjs/Physics/physicsImpostor";
  62730. export * from "babylonjs/Physics/physicsJoint";
  62731. export * from "babylonjs/Physics/Plugins/index";
  62732. }
  62733. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  62734. /** @hidden */
  62735. export var blackAndWhitePixelShader: {
  62736. name: string;
  62737. shader: string;
  62738. };
  62739. }
  62740. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  62741. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  62742. import { Camera } from "babylonjs/Cameras/camera";
  62743. import { Engine } from "babylonjs/Engines/engine";
  62744. import "babylonjs/Shaders/blackAndWhite.fragment";
  62745. /**
  62746. * Post process used to render in black and white
  62747. */
  62748. export class BlackAndWhitePostProcess extends PostProcess {
  62749. /**
  62750. * Linear about to convert he result to black and white (default: 1)
  62751. */
  62752. degree: number;
  62753. /**
  62754. * Creates a black and white post process
  62755. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  62756. * @param name The name of the effect.
  62757. * @param options The required width/height ratio to downsize to before computing the render pass.
  62758. * @param camera The camera to apply the render pass to.
  62759. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  62760. * @param engine The engine which the post process will be applied. (default: current engine)
  62761. * @param reusable If the post process can be reused on the same frame. (default: false)
  62762. */
  62763. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  62764. }
  62765. }
  62766. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  62767. import { Nullable } from "babylonjs/types";
  62768. import { Camera } from "babylonjs/Cameras/camera";
  62769. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62770. import { Engine } from "babylonjs/Engines/engine";
  62771. /**
  62772. * This represents a set of one or more post processes in Babylon.
  62773. * A post process can be used to apply a shader to a texture after it is rendered.
  62774. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  62775. */
  62776. export class PostProcessRenderEffect {
  62777. private _postProcesses;
  62778. private _getPostProcesses;
  62779. private _singleInstance;
  62780. private _cameras;
  62781. private _indicesForCamera;
  62782. /**
  62783. * Name of the effect
  62784. * @hidden
  62785. */
  62786. _name: string;
  62787. /**
  62788. * Instantiates a post process render effect.
  62789. * A post process can be used to apply a shader to a texture after it is rendered.
  62790. * @param engine The engine the effect is tied to
  62791. * @param name The name of the effect
  62792. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  62793. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  62794. */
  62795. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  62796. /**
  62797. * Checks if all the post processes in the effect are supported.
  62798. */
  62799. readonly isSupported: boolean;
  62800. /**
  62801. * Updates the current state of the effect
  62802. * @hidden
  62803. */
  62804. _update(): void;
  62805. /**
  62806. * Attaches the effect on cameras
  62807. * @param cameras The camera to attach to.
  62808. * @hidden
  62809. */
  62810. _attachCameras(cameras: Camera): void;
  62811. /**
  62812. * Attaches the effect on cameras
  62813. * @param cameras The camera to attach to.
  62814. * @hidden
  62815. */
  62816. _attachCameras(cameras: Camera[]): void;
  62817. /**
  62818. * Detaches the effect on cameras
  62819. * @param cameras The camera to detatch from.
  62820. * @hidden
  62821. */
  62822. _detachCameras(cameras: Camera): void;
  62823. /**
  62824. * Detatches the effect on cameras
  62825. * @param cameras The camera to detatch from.
  62826. * @hidden
  62827. */
  62828. _detachCameras(cameras: Camera[]): void;
  62829. /**
  62830. * Enables the effect on given cameras
  62831. * @param cameras The camera to enable.
  62832. * @hidden
  62833. */
  62834. _enable(cameras: Camera): void;
  62835. /**
  62836. * Enables the effect on given cameras
  62837. * @param cameras The camera to enable.
  62838. * @hidden
  62839. */
  62840. _enable(cameras: Nullable<Camera[]>): void;
  62841. /**
  62842. * Disables the effect on the given cameras
  62843. * @param cameras The camera to disable.
  62844. * @hidden
  62845. */
  62846. _disable(cameras: Camera): void;
  62847. /**
  62848. * Disables the effect on the given cameras
  62849. * @param cameras The camera to disable.
  62850. * @hidden
  62851. */
  62852. _disable(cameras: Nullable<Camera[]>): void;
  62853. /**
  62854. * Gets a list of the post processes contained in the effect.
  62855. * @param camera The camera to get the post processes on.
  62856. * @returns The list of the post processes in the effect.
  62857. */
  62858. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  62859. }
  62860. }
  62861. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  62862. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62863. /** @hidden */
  62864. export var extractHighlightsPixelShader: {
  62865. name: string;
  62866. shader: string;
  62867. };
  62868. }
  62869. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  62870. import { Nullable } from "babylonjs/types";
  62871. import { Camera } from "babylonjs/Cameras/camera";
  62872. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  62873. import { Engine } from "babylonjs/Engines/engine";
  62874. import "babylonjs/Shaders/extractHighlights.fragment";
  62875. /**
  62876. * 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.
  62877. */
  62878. export class ExtractHighlightsPostProcess extends PostProcess {
  62879. /**
  62880. * The luminance threshold, pixels below this value will be set to black.
  62881. */
  62882. threshold: number;
  62883. /** @hidden */
  62884. _exposure: number;
  62885. /**
  62886. * Post process which has the input texture to be used when performing highlight extraction
  62887. * @hidden
  62888. */
  62889. _inputPostProcess: Nullable<PostProcess>;
  62890. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  62891. }
  62892. }
  62893. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  62894. /** @hidden */
  62895. export var bloomMergePixelShader: {
  62896. name: string;
  62897. shader: string;
  62898. };
  62899. }
  62900. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  62901. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  62902. import { Nullable } from "babylonjs/types";
  62903. import { Engine } from "babylonjs/Engines/engine";
  62904. import { Camera } from "babylonjs/Cameras/camera";
  62905. import "babylonjs/Shaders/bloomMerge.fragment";
  62906. /**
  62907. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  62908. */
  62909. export class BloomMergePostProcess extends PostProcess {
  62910. /** Weight of the bloom to be added to the original input. */
  62911. weight: number;
  62912. /**
  62913. * Creates a new instance of @see BloomMergePostProcess
  62914. * @param name The name of the effect.
  62915. * @param originalFromInput Post process which's input will be used for the merge.
  62916. * @param blurred Blurred highlights post process which's output will be used.
  62917. * @param weight Weight of the bloom to be added to the original input.
  62918. * @param options The required width/height ratio to downsize to before computing the render pass.
  62919. * @param camera The camera to apply the render pass to.
  62920. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  62921. * @param engine The engine which the post process will be applied. (default: current engine)
  62922. * @param reusable If the post process can be reused on the same frame. (default: false)
  62923. * @param textureType Type of textures used when performing the post process. (default: 0)
  62924. * @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)
  62925. */
  62926. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  62927. /** Weight of the bloom to be added to the original input. */
  62928. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  62929. }
  62930. }
  62931. declare module "babylonjs/PostProcesses/bloomEffect" {
  62932. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  62933. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62934. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  62935. import { Camera } from "babylonjs/Cameras/camera";
  62936. import { Scene } from "babylonjs/scene";
  62937. /**
  62938. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  62939. */
  62940. export class BloomEffect extends PostProcessRenderEffect {
  62941. private bloomScale;
  62942. /**
  62943. * @hidden Internal
  62944. */
  62945. _effects: Array<PostProcess>;
  62946. /**
  62947. * @hidden Internal
  62948. */
  62949. _downscale: ExtractHighlightsPostProcess;
  62950. private _blurX;
  62951. private _blurY;
  62952. private _merge;
  62953. /**
  62954. * The luminance threshold to find bright areas of the image to bloom.
  62955. */
  62956. threshold: number;
  62957. /**
  62958. * The strength of the bloom.
  62959. */
  62960. weight: number;
  62961. /**
  62962. * Specifies the size of the bloom blur kernel, relative to the final output size
  62963. */
  62964. kernel: number;
  62965. /**
  62966. * Creates a new instance of @see BloomEffect
  62967. * @param scene The scene the effect belongs to.
  62968. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  62969. * @param bloomKernel The size of the kernel to be used when applying the blur.
  62970. * @param bloomWeight The the strength of bloom.
  62971. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  62972. * @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)
  62973. */
  62974. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  62975. /**
  62976. * Disposes each of the internal effects for a given camera.
  62977. * @param camera The camera to dispose the effect on.
  62978. */
  62979. disposeEffects(camera: Camera): void;
  62980. /**
  62981. * @hidden Internal
  62982. */
  62983. _updateEffects(): void;
  62984. /**
  62985. * Internal
  62986. * @returns if all the contained post processes are ready.
  62987. * @hidden
  62988. */
  62989. _isReady(): boolean;
  62990. }
  62991. }
  62992. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  62993. /** @hidden */
  62994. export var chromaticAberrationPixelShader: {
  62995. name: string;
  62996. shader: string;
  62997. };
  62998. }
  62999. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  63000. import { Vector2 } from "babylonjs/Maths/math.vector";
  63001. import { Nullable } from "babylonjs/types";
  63002. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63003. import { Camera } from "babylonjs/Cameras/camera";
  63004. import { Engine } from "babylonjs/Engines/engine";
  63005. import "babylonjs/Shaders/chromaticAberration.fragment";
  63006. /**
  63007. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  63008. */
  63009. export class ChromaticAberrationPostProcess extends PostProcess {
  63010. /**
  63011. * The amount of seperation of rgb channels (default: 30)
  63012. */
  63013. aberrationAmount: number;
  63014. /**
  63015. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  63016. */
  63017. radialIntensity: number;
  63018. /**
  63019. * 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))
  63020. */
  63021. direction: Vector2;
  63022. /**
  63023. * 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))
  63024. */
  63025. centerPosition: Vector2;
  63026. /**
  63027. * Creates a new instance ChromaticAberrationPostProcess
  63028. * @param name The name of the effect.
  63029. * @param screenWidth The width of the screen to apply the effect on.
  63030. * @param screenHeight The height of the screen to apply the effect on.
  63031. * @param options The required width/height ratio to downsize to before computing the render pass.
  63032. * @param camera The camera to apply the render pass to.
  63033. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63034. * @param engine The engine which the post process will be applied. (default: current engine)
  63035. * @param reusable If the post process can be reused on the same frame. (default: false)
  63036. * @param textureType Type of textures used when performing the post process. (default: 0)
  63037. * @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)
  63038. */
  63039. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63040. }
  63041. }
  63042. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  63043. /** @hidden */
  63044. export var circleOfConfusionPixelShader: {
  63045. name: string;
  63046. shader: string;
  63047. };
  63048. }
  63049. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  63050. import { Nullable } from "babylonjs/types";
  63051. import { Engine } from "babylonjs/Engines/engine";
  63052. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63053. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63054. import { Camera } from "babylonjs/Cameras/camera";
  63055. import "babylonjs/Shaders/circleOfConfusion.fragment";
  63056. /**
  63057. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  63058. */
  63059. export class CircleOfConfusionPostProcess extends PostProcess {
  63060. /**
  63061. * 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.
  63062. */
  63063. lensSize: number;
  63064. /**
  63065. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  63066. */
  63067. fStop: number;
  63068. /**
  63069. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  63070. */
  63071. focusDistance: number;
  63072. /**
  63073. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  63074. */
  63075. focalLength: number;
  63076. private _depthTexture;
  63077. /**
  63078. * Creates a new instance CircleOfConfusionPostProcess
  63079. * @param name The name of the effect.
  63080. * @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.
  63081. * @param options The required width/height ratio to downsize to before computing the render pass.
  63082. * @param camera The camera to apply the render pass to.
  63083. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63084. * @param engine The engine which the post process will be applied. (default: current engine)
  63085. * @param reusable If the post process can be reused on the same frame. (default: false)
  63086. * @param textureType Type of textures used when performing the post process. (default: 0)
  63087. * @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)
  63088. */
  63089. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63090. /**
  63091. * 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.
  63092. */
  63093. depthTexture: RenderTargetTexture;
  63094. }
  63095. }
  63096. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  63097. /** @hidden */
  63098. export var colorCorrectionPixelShader: {
  63099. name: string;
  63100. shader: string;
  63101. };
  63102. }
  63103. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  63104. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63105. import { Engine } from "babylonjs/Engines/engine";
  63106. import { Camera } from "babylonjs/Cameras/camera";
  63107. import "babylonjs/Shaders/colorCorrection.fragment";
  63108. /**
  63109. *
  63110. * This post-process allows the modification of rendered colors by using
  63111. * a 'look-up table' (LUT). This effect is also called Color Grading.
  63112. *
  63113. * The object needs to be provided an url to a texture containing the color
  63114. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  63115. * Use an image editing software to tweak the LUT to match your needs.
  63116. *
  63117. * For an example of a color LUT, see here:
  63118. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  63119. * For explanations on color grading, see here:
  63120. * @see http://udn.epicgames.com/Three/ColorGrading.html
  63121. *
  63122. */
  63123. export class ColorCorrectionPostProcess extends PostProcess {
  63124. private _colorTableTexture;
  63125. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63126. }
  63127. }
  63128. declare module "babylonjs/Shaders/convolution.fragment" {
  63129. /** @hidden */
  63130. export var convolutionPixelShader: {
  63131. name: string;
  63132. shader: string;
  63133. };
  63134. }
  63135. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  63136. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63137. import { Nullable } from "babylonjs/types";
  63138. import { Camera } from "babylonjs/Cameras/camera";
  63139. import { Engine } from "babylonjs/Engines/engine";
  63140. import "babylonjs/Shaders/convolution.fragment";
  63141. /**
  63142. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  63143. * input texture to perform effects such as edge detection or sharpening
  63144. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  63145. */
  63146. export class ConvolutionPostProcess extends PostProcess {
  63147. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  63148. kernel: number[];
  63149. /**
  63150. * Creates a new instance ConvolutionPostProcess
  63151. * @param name The name of the effect.
  63152. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  63153. * @param options The required width/height ratio to downsize to before computing the render pass.
  63154. * @param camera The camera to apply the render pass to.
  63155. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63156. * @param engine The engine which the post process will be applied. (default: current engine)
  63157. * @param reusable If the post process can be reused on the same frame. (default: false)
  63158. * @param textureType Type of textures used when performing the post process. (default: 0)
  63159. */
  63160. constructor(name: string,
  63161. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  63162. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  63163. /**
  63164. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63165. */
  63166. static EdgeDetect0Kernel: number[];
  63167. /**
  63168. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63169. */
  63170. static EdgeDetect1Kernel: number[];
  63171. /**
  63172. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63173. */
  63174. static EdgeDetect2Kernel: number[];
  63175. /**
  63176. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63177. */
  63178. static SharpenKernel: number[];
  63179. /**
  63180. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63181. */
  63182. static EmbossKernel: number[];
  63183. /**
  63184. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63185. */
  63186. static GaussianKernel: number[];
  63187. }
  63188. }
  63189. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  63190. import { Nullable } from "babylonjs/types";
  63191. import { Vector2 } from "babylonjs/Maths/math.vector";
  63192. import { Camera } from "babylonjs/Cameras/camera";
  63193. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63194. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  63195. import { Engine } from "babylonjs/Engines/engine";
  63196. import { Scene } from "babylonjs/scene";
  63197. /**
  63198. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  63199. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  63200. * based on samples that have a large difference in distance than the center pixel.
  63201. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  63202. */
  63203. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  63204. direction: Vector2;
  63205. /**
  63206. * Creates a new instance CircleOfConfusionPostProcess
  63207. * @param name The name of the effect.
  63208. * @param scene The scene the effect belongs to.
  63209. * @param direction The direction the blur should be applied.
  63210. * @param kernel The size of the kernel used to blur.
  63211. * @param options The required width/height ratio to downsize to before computing the render pass.
  63212. * @param camera The camera to apply the render pass to.
  63213. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  63214. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  63215. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63216. * @param engine The engine which the post process will be applied. (default: current engine)
  63217. * @param reusable If the post process can be reused on the same frame. (default: false)
  63218. * @param textureType Type of textures used when performing the post process. (default: 0)
  63219. * @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)
  63220. */
  63221. 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);
  63222. }
  63223. }
  63224. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  63225. /** @hidden */
  63226. export var depthOfFieldMergePixelShader: {
  63227. name: string;
  63228. shader: string;
  63229. };
  63230. }
  63231. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  63232. import { Nullable } from "babylonjs/types";
  63233. import { Camera } from "babylonjs/Cameras/camera";
  63234. import { Effect } from "babylonjs/Materials/effect";
  63235. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63236. import { Engine } from "babylonjs/Engines/engine";
  63237. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  63238. /**
  63239. * Options to be set when merging outputs from the default pipeline.
  63240. */
  63241. export class DepthOfFieldMergePostProcessOptions {
  63242. /**
  63243. * The original image to merge on top of
  63244. */
  63245. originalFromInput: PostProcess;
  63246. /**
  63247. * Parameters to perform the merge of the depth of field effect
  63248. */
  63249. depthOfField?: {
  63250. circleOfConfusion: PostProcess;
  63251. blurSteps: Array<PostProcess>;
  63252. };
  63253. /**
  63254. * Parameters to perform the merge of bloom effect
  63255. */
  63256. bloom?: {
  63257. blurred: PostProcess;
  63258. weight: number;
  63259. };
  63260. }
  63261. /**
  63262. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  63263. */
  63264. export class DepthOfFieldMergePostProcess extends PostProcess {
  63265. private blurSteps;
  63266. /**
  63267. * Creates a new instance of DepthOfFieldMergePostProcess
  63268. * @param name The name of the effect.
  63269. * @param originalFromInput Post process which's input will be used for the merge.
  63270. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  63271. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  63272. * @param options The required width/height ratio to downsize to before computing the render pass.
  63273. * @param camera The camera to apply the render pass to.
  63274. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63275. * @param engine The engine which the post process will be applied. (default: current engine)
  63276. * @param reusable If the post process can be reused on the same frame. (default: false)
  63277. * @param textureType Type of textures used when performing the post process. (default: 0)
  63278. * @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)
  63279. */
  63280. 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);
  63281. /**
  63282. * Updates the effect with the current post process compile time values and recompiles the shader.
  63283. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  63284. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  63285. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  63286. * @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
  63287. * @param onCompiled Called when the shader has been compiled.
  63288. * @param onError Called if there is an error when compiling a shader.
  63289. */
  63290. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  63291. }
  63292. }
  63293. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  63294. import { Nullable } from "babylonjs/types";
  63295. import { Camera } from "babylonjs/Cameras/camera";
  63296. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63297. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63298. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  63299. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  63300. import { Scene } from "babylonjs/scene";
  63301. /**
  63302. * Specifies the level of max blur that should be applied when using the depth of field effect
  63303. */
  63304. export enum DepthOfFieldEffectBlurLevel {
  63305. /**
  63306. * Subtle blur
  63307. */
  63308. Low = 0,
  63309. /**
  63310. * Medium blur
  63311. */
  63312. Medium = 1,
  63313. /**
  63314. * Large blur
  63315. */
  63316. High = 2
  63317. }
  63318. /**
  63319. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  63320. */
  63321. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  63322. private _circleOfConfusion;
  63323. /**
  63324. * @hidden Internal, blurs from high to low
  63325. */
  63326. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  63327. private _depthOfFieldBlurY;
  63328. private _dofMerge;
  63329. /**
  63330. * @hidden Internal post processes in depth of field effect
  63331. */
  63332. _effects: Array<PostProcess>;
  63333. /**
  63334. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  63335. */
  63336. focalLength: number;
  63337. /**
  63338. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  63339. */
  63340. fStop: number;
  63341. /**
  63342. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  63343. */
  63344. focusDistance: number;
  63345. /**
  63346. * 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.
  63347. */
  63348. lensSize: number;
  63349. /**
  63350. * Creates a new instance DepthOfFieldEffect
  63351. * @param scene The scene the effect belongs to.
  63352. * @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.
  63353. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  63354. * @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)
  63355. */
  63356. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  63357. /**
  63358. * Get the current class name of the current effet
  63359. * @returns "DepthOfFieldEffect"
  63360. */
  63361. getClassName(): string;
  63362. /**
  63363. * 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.
  63364. */
  63365. depthTexture: RenderTargetTexture;
  63366. /**
  63367. * Disposes each of the internal effects for a given camera.
  63368. * @param camera The camera to dispose the effect on.
  63369. */
  63370. disposeEffects(camera: Camera): void;
  63371. /**
  63372. * @hidden Internal
  63373. */
  63374. _updateEffects(): void;
  63375. /**
  63376. * Internal
  63377. * @returns if all the contained post processes are ready.
  63378. * @hidden
  63379. */
  63380. _isReady(): boolean;
  63381. }
  63382. }
  63383. declare module "babylonjs/Shaders/displayPass.fragment" {
  63384. /** @hidden */
  63385. export var displayPassPixelShader: {
  63386. name: string;
  63387. shader: string;
  63388. };
  63389. }
  63390. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  63391. import { Nullable } from "babylonjs/types";
  63392. import { Camera } from "babylonjs/Cameras/camera";
  63393. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63394. import { Engine } from "babylonjs/Engines/engine";
  63395. import "babylonjs/Shaders/displayPass.fragment";
  63396. /**
  63397. * DisplayPassPostProcess which produces an output the same as it's input
  63398. */
  63399. export class DisplayPassPostProcess extends PostProcess {
  63400. /**
  63401. * Creates the DisplayPassPostProcess
  63402. * @param name The name of the effect.
  63403. * @param options The required width/height ratio to downsize to before computing the render pass.
  63404. * @param camera The camera to apply the render pass to.
  63405. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63406. * @param engine The engine which the post process will be applied. (default: current engine)
  63407. * @param reusable If the post process can be reused on the same frame. (default: false)
  63408. */
  63409. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63410. }
  63411. }
  63412. declare module "babylonjs/Shaders/filter.fragment" {
  63413. /** @hidden */
  63414. export var filterPixelShader: {
  63415. name: string;
  63416. shader: string;
  63417. };
  63418. }
  63419. declare module "babylonjs/PostProcesses/filterPostProcess" {
  63420. import { Nullable } from "babylonjs/types";
  63421. import { Matrix } from "babylonjs/Maths/math.vector";
  63422. import { Camera } from "babylonjs/Cameras/camera";
  63423. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63424. import { Engine } from "babylonjs/Engines/engine";
  63425. import "babylonjs/Shaders/filter.fragment";
  63426. /**
  63427. * Applies a kernel filter to the image
  63428. */
  63429. export class FilterPostProcess extends PostProcess {
  63430. /** The matrix to be applied to the image */
  63431. kernelMatrix: Matrix;
  63432. /**
  63433. *
  63434. * @param name The name of the effect.
  63435. * @param kernelMatrix The matrix to be applied to the image
  63436. * @param options The required width/height ratio to downsize to before computing the render pass.
  63437. * @param camera The camera to apply the render pass to.
  63438. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63439. * @param engine The engine which the post process will be applied. (default: current engine)
  63440. * @param reusable If the post process can be reused on the same frame. (default: false)
  63441. */
  63442. constructor(name: string,
  63443. /** The matrix to be applied to the image */
  63444. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63445. }
  63446. }
  63447. declare module "babylonjs/Shaders/fxaa.fragment" {
  63448. /** @hidden */
  63449. export var fxaaPixelShader: {
  63450. name: string;
  63451. shader: string;
  63452. };
  63453. }
  63454. declare module "babylonjs/Shaders/fxaa.vertex" {
  63455. /** @hidden */
  63456. export var fxaaVertexShader: {
  63457. name: string;
  63458. shader: string;
  63459. };
  63460. }
  63461. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  63462. import { Nullable } from "babylonjs/types";
  63463. import { Camera } from "babylonjs/Cameras/camera";
  63464. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63465. import { Engine } from "babylonjs/Engines/engine";
  63466. import "babylonjs/Shaders/fxaa.fragment";
  63467. import "babylonjs/Shaders/fxaa.vertex";
  63468. /**
  63469. * Fxaa post process
  63470. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  63471. */
  63472. export class FxaaPostProcess extends PostProcess {
  63473. /** @hidden */
  63474. texelWidth: number;
  63475. /** @hidden */
  63476. texelHeight: number;
  63477. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  63478. private _getDefines;
  63479. }
  63480. }
  63481. declare module "babylonjs/Shaders/grain.fragment" {
  63482. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  63483. /** @hidden */
  63484. export var grainPixelShader: {
  63485. name: string;
  63486. shader: string;
  63487. };
  63488. }
  63489. declare module "babylonjs/PostProcesses/grainPostProcess" {
  63490. import { Nullable } from "babylonjs/types";
  63491. import { Camera } from "babylonjs/Cameras/camera";
  63492. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63493. import { Engine } from "babylonjs/Engines/engine";
  63494. import "babylonjs/Shaders/grain.fragment";
  63495. /**
  63496. * The GrainPostProcess adds noise to the image at mid luminance levels
  63497. */
  63498. export class GrainPostProcess extends PostProcess {
  63499. /**
  63500. * The intensity of the grain added (default: 30)
  63501. */
  63502. intensity: number;
  63503. /**
  63504. * If the grain should be randomized on every frame
  63505. */
  63506. animated: boolean;
  63507. /**
  63508. * Creates a new instance of @see GrainPostProcess
  63509. * @param name The name of the effect.
  63510. * @param options The required width/height ratio to downsize to before computing the render pass.
  63511. * @param camera The camera to apply the render pass to.
  63512. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63513. * @param engine The engine which the post process will be applied. (default: current engine)
  63514. * @param reusable If the post process can be reused on the same frame. (default: false)
  63515. * @param textureType Type of textures used when performing the post process. (default: 0)
  63516. * @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)
  63517. */
  63518. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63519. }
  63520. }
  63521. declare module "babylonjs/Shaders/highlights.fragment" {
  63522. /** @hidden */
  63523. export var highlightsPixelShader: {
  63524. name: string;
  63525. shader: string;
  63526. };
  63527. }
  63528. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  63529. import { Nullable } from "babylonjs/types";
  63530. import { Camera } from "babylonjs/Cameras/camera";
  63531. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63532. import { Engine } from "babylonjs/Engines/engine";
  63533. import "babylonjs/Shaders/highlights.fragment";
  63534. /**
  63535. * Extracts highlights from the image
  63536. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  63537. */
  63538. export class HighlightsPostProcess extends PostProcess {
  63539. /**
  63540. * Extracts highlights from the image
  63541. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  63542. * @param name The name of the effect.
  63543. * @param options The required width/height ratio to downsize to before computing the render pass.
  63544. * @param camera The camera to apply the render pass to.
  63545. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63546. * @param engine The engine which the post process will be applied. (default: current engine)
  63547. * @param reusable If the post process can be reused on the same frame. (default: false)
  63548. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  63549. */
  63550. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  63551. }
  63552. }
  63553. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  63554. /** @hidden */
  63555. export var mrtFragmentDeclaration: {
  63556. name: string;
  63557. shader: string;
  63558. };
  63559. }
  63560. declare module "babylonjs/Shaders/geometry.fragment" {
  63561. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  63562. /** @hidden */
  63563. export var geometryPixelShader: {
  63564. name: string;
  63565. shader: string;
  63566. };
  63567. }
  63568. declare module "babylonjs/Shaders/geometry.vertex" {
  63569. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  63570. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  63571. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  63572. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  63573. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  63574. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  63575. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  63576. /** @hidden */
  63577. export var geometryVertexShader: {
  63578. name: string;
  63579. shader: string;
  63580. };
  63581. }
  63582. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  63583. import { Matrix } from "babylonjs/Maths/math.vector";
  63584. import { SubMesh } from "babylonjs/Meshes/subMesh";
  63585. import { Mesh } from "babylonjs/Meshes/mesh";
  63586. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  63587. import { Effect } from "babylonjs/Materials/effect";
  63588. import { Scene } from "babylonjs/scene";
  63589. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63590. import "babylonjs/Shaders/geometry.fragment";
  63591. import "babylonjs/Shaders/geometry.vertex";
  63592. /** @hidden */
  63593. interface ISavedTransformationMatrix {
  63594. world: Matrix;
  63595. viewProjection: Matrix;
  63596. }
  63597. /**
  63598. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  63599. */
  63600. export class GeometryBufferRenderer {
  63601. /**
  63602. * Constant used to retrieve the position texture index in the G-Buffer textures array
  63603. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  63604. */
  63605. static readonly POSITION_TEXTURE_TYPE: number;
  63606. /**
  63607. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  63608. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  63609. */
  63610. static readonly VELOCITY_TEXTURE_TYPE: number;
  63611. /**
  63612. * Dictionary used to store the previous transformation matrices of each rendered mesh
  63613. * in order to compute objects velocities when enableVelocity is set to "true"
  63614. * @hidden
  63615. */
  63616. _previousTransformationMatrices: {
  63617. [index: number]: ISavedTransformationMatrix;
  63618. };
  63619. /**
  63620. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  63621. * in order to compute objects velocities when enableVelocity is set to "true"
  63622. * @hidden
  63623. */
  63624. _previousBonesTransformationMatrices: {
  63625. [index: number]: Float32Array;
  63626. };
  63627. /**
  63628. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  63629. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  63630. */
  63631. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  63632. private _scene;
  63633. private _multiRenderTarget;
  63634. private _ratio;
  63635. private _enablePosition;
  63636. private _enableVelocity;
  63637. private _positionIndex;
  63638. private _velocityIndex;
  63639. protected _effect: Effect;
  63640. protected _cachedDefines: string;
  63641. /**
  63642. * Set the render list (meshes to be rendered) used in the G buffer.
  63643. */
  63644. renderList: Mesh[];
  63645. /**
  63646. * Gets wether or not G buffer are supported by the running hardware.
  63647. * This requires draw buffer supports
  63648. */
  63649. readonly isSupported: boolean;
  63650. /**
  63651. * Returns the index of the given texture type in the G-Buffer textures array
  63652. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  63653. * @returns the index of the given texture type in the G-Buffer textures array
  63654. */
  63655. getTextureIndex(textureType: number): number;
  63656. /**
  63657. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  63658. */
  63659. /**
  63660. * Sets whether or not objects positions are enabled for the G buffer.
  63661. */
  63662. enablePosition: boolean;
  63663. /**
  63664. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  63665. */
  63666. /**
  63667. * Sets wether or not objects velocities are enabled for the G buffer.
  63668. */
  63669. enableVelocity: boolean;
  63670. /**
  63671. * Gets the scene associated with the buffer.
  63672. */
  63673. readonly scene: Scene;
  63674. /**
  63675. * Gets the ratio used by the buffer during its creation.
  63676. * How big is the buffer related to the main canvas.
  63677. */
  63678. readonly ratio: number;
  63679. /** @hidden */
  63680. static _SceneComponentInitialization: (scene: Scene) => void;
  63681. /**
  63682. * Creates a new G Buffer for the scene
  63683. * @param scene The scene the buffer belongs to
  63684. * @param ratio How big is the buffer related to the main canvas.
  63685. */
  63686. constructor(scene: Scene, ratio?: number);
  63687. /**
  63688. * Checks wether everything is ready to render a submesh to the G buffer.
  63689. * @param subMesh the submesh to check readiness for
  63690. * @param useInstances is the mesh drawn using instance or not
  63691. * @returns true if ready otherwise false
  63692. */
  63693. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  63694. /**
  63695. * Gets the current underlying G Buffer.
  63696. * @returns the buffer
  63697. */
  63698. getGBuffer(): MultiRenderTarget;
  63699. /**
  63700. * Gets the number of samples used to render the buffer (anti aliasing).
  63701. */
  63702. /**
  63703. * Sets the number of samples used to render the buffer (anti aliasing).
  63704. */
  63705. samples: number;
  63706. /**
  63707. * Disposes the renderer and frees up associated resources.
  63708. */
  63709. dispose(): void;
  63710. protected _createRenderTargets(): void;
  63711. private _copyBonesTransformationMatrices;
  63712. }
  63713. }
  63714. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  63715. import { Nullable } from "babylonjs/types";
  63716. import { Scene } from "babylonjs/scene";
  63717. import { ISceneComponent } from "babylonjs/sceneComponent";
  63718. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  63719. module "babylonjs/scene" {
  63720. interface Scene {
  63721. /** @hidden (Backing field) */
  63722. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  63723. /**
  63724. * Gets or Sets the current geometry buffer associated to the scene.
  63725. */
  63726. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  63727. /**
  63728. * Enables a GeometryBufferRender and associates it with the scene
  63729. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  63730. * @returns the GeometryBufferRenderer
  63731. */
  63732. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  63733. /**
  63734. * Disables the GeometryBufferRender associated with the scene
  63735. */
  63736. disableGeometryBufferRenderer(): void;
  63737. }
  63738. }
  63739. /**
  63740. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  63741. * in several rendering techniques.
  63742. */
  63743. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  63744. /**
  63745. * The component name helpful to identify the component in the list of scene components.
  63746. */
  63747. readonly name: string;
  63748. /**
  63749. * The scene the component belongs to.
  63750. */
  63751. scene: Scene;
  63752. /**
  63753. * Creates a new instance of the component for the given scene
  63754. * @param scene Defines the scene to register the component in
  63755. */
  63756. constructor(scene: Scene);
  63757. /**
  63758. * Registers the component in a given scene
  63759. */
  63760. register(): void;
  63761. /**
  63762. * Rebuilds the elements related to this component in case of
  63763. * context lost for instance.
  63764. */
  63765. rebuild(): void;
  63766. /**
  63767. * Disposes the component and the associated ressources
  63768. */
  63769. dispose(): void;
  63770. private _gatherRenderTargets;
  63771. }
  63772. }
  63773. declare module "babylonjs/Shaders/motionBlur.fragment" {
  63774. /** @hidden */
  63775. export var motionBlurPixelShader: {
  63776. name: string;
  63777. shader: string;
  63778. };
  63779. }
  63780. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  63781. import { Nullable } from "babylonjs/types";
  63782. import { Camera } from "babylonjs/Cameras/camera";
  63783. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63784. import { Scene } from "babylonjs/scene";
  63785. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63786. import "babylonjs/Animations/animatable";
  63787. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  63788. import "babylonjs/Shaders/motionBlur.fragment";
  63789. import { Engine } from "babylonjs/Engines/engine";
  63790. /**
  63791. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  63792. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  63793. * As an example, all you have to do is to create the post-process:
  63794. * var mb = new BABYLON.MotionBlurPostProcess(
  63795. * 'mb', // The name of the effect.
  63796. * scene, // The scene containing the objects to blur according to their velocity.
  63797. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  63798. * camera // The camera to apply the render pass to.
  63799. * );
  63800. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  63801. */
  63802. export class MotionBlurPostProcess extends PostProcess {
  63803. /**
  63804. * Defines how much the image is blurred by the movement. Default value is equal to 1
  63805. */
  63806. motionStrength: number;
  63807. /**
  63808. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  63809. */
  63810. /**
  63811. * Sets the number of iterations to be used for motion blur quality
  63812. */
  63813. motionBlurSamples: number;
  63814. private _motionBlurSamples;
  63815. private _geometryBufferRenderer;
  63816. /**
  63817. * Creates a new instance MotionBlurPostProcess
  63818. * @param name The name of the effect.
  63819. * @param scene The scene containing the objects to blur according to their velocity.
  63820. * @param options The required width/height ratio to downsize to before computing the render pass.
  63821. * @param camera The camera to apply the render pass to.
  63822. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63823. * @param engine The engine which the post process will be applied. (default: current engine)
  63824. * @param reusable If the post process can be reused on the same frame. (default: false)
  63825. * @param textureType Type of textures used when performing the post process. (default: 0)
  63826. * @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)
  63827. */
  63828. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63829. /**
  63830. * Excludes the given skinned mesh from computing bones velocities.
  63831. * 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.
  63832. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  63833. */
  63834. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  63835. /**
  63836. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  63837. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  63838. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  63839. */
  63840. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  63841. /**
  63842. * Disposes the post process.
  63843. * @param camera The camera to dispose the post process on.
  63844. */
  63845. dispose(camera?: Camera): void;
  63846. }
  63847. }
  63848. declare module "babylonjs/Shaders/refraction.fragment" {
  63849. /** @hidden */
  63850. export var refractionPixelShader: {
  63851. name: string;
  63852. shader: string;
  63853. };
  63854. }
  63855. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  63856. import { Color3 } from "babylonjs/Maths/math.color";
  63857. import { Camera } from "babylonjs/Cameras/camera";
  63858. import { Texture } from "babylonjs/Materials/Textures/texture";
  63859. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63860. import { Engine } from "babylonjs/Engines/engine";
  63861. import "babylonjs/Shaders/refraction.fragment";
  63862. /**
  63863. * Post process which applies a refractin texture
  63864. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  63865. */
  63866. export class RefractionPostProcess extends PostProcess {
  63867. /** the base color of the refraction (used to taint the rendering) */
  63868. color: Color3;
  63869. /** simulated refraction depth */
  63870. depth: number;
  63871. /** the coefficient of the base color (0 to remove base color tainting) */
  63872. colorLevel: number;
  63873. private _refTexture;
  63874. private _ownRefractionTexture;
  63875. /**
  63876. * Gets or sets the refraction texture
  63877. * Please note that you are responsible for disposing the texture if you set it manually
  63878. */
  63879. refractionTexture: Texture;
  63880. /**
  63881. * Initializes the RefractionPostProcess
  63882. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  63883. * @param name The name of the effect.
  63884. * @param refractionTextureUrl Url of the refraction texture to use
  63885. * @param color the base color of the refraction (used to taint the rendering)
  63886. * @param depth simulated refraction depth
  63887. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  63888. * @param camera The camera to apply the render pass to.
  63889. * @param options The required width/height ratio to downsize to before computing the render pass.
  63890. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63891. * @param engine The engine which the post process will be applied. (default: current engine)
  63892. * @param reusable If the post process can be reused on the same frame. (default: false)
  63893. */
  63894. constructor(name: string, refractionTextureUrl: string,
  63895. /** the base color of the refraction (used to taint the rendering) */
  63896. color: Color3,
  63897. /** simulated refraction depth */
  63898. depth: number,
  63899. /** the coefficient of the base color (0 to remove base color tainting) */
  63900. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63901. /**
  63902. * Disposes of the post process
  63903. * @param camera Camera to dispose post process on
  63904. */
  63905. dispose(camera: Camera): void;
  63906. }
  63907. }
  63908. declare module "babylonjs/Shaders/sharpen.fragment" {
  63909. /** @hidden */
  63910. export var sharpenPixelShader: {
  63911. name: string;
  63912. shader: string;
  63913. };
  63914. }
  63915. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  63916. import { Nullable } from "babylonjs/types";
  63917. import { Camera } from "babylonjs/Cameras/camera";
  63918. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63919. import "babylonjs/Shaders/sharpen.fragment";
  63920. import { Engine } from "babylonjs/Engines/engine";
  63921. /**
  63922. * The SharpenPostProcess applies a sharpen kernel to every pixel
  63923. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  63924. */
  63925. export class SharpenPostProcess extends PostProcess {
  63926. /**
  63927. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  63928. */
  63929. colorAmount: number;
  63930. /**
  63931. * How much sharpness should be applied (default: 0.3)
  63932. */
  63933. edgeAmount: number;
  63934. /**
  63935. * Creates a new instance ConvolutionPostProcess
  63936. * @param name The name of the effect.
  63937. * @param options The required width/height ratio to downsize to before computing the render pass.
  63938. * @param camera The camera to apply the render pass to.
  63939. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63940. * @param engine The engine which the post process will be applied. (default: current engine)
  63941. * @param reusable If the post process can be reused on the same frame. (default: false)
  63942. * @param textureType Type of textures used when performing the post process. (default: 0)
  63943. * @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)
  63944. */
  63945. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63946. }
  63947. }
  63948. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  63949. import { Nullable } from "babylonjs/types";
  63950. import { Camera } from "babylonjs/Cameras/camera";
  63951. import { Engine } from "babylonjs/Engines/engine";
  63952. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  63953. import { IInspectable } from "babylonjs/Misc/iInspectable";
  63954. /**
  63955. * PostProcessRenderPipeline
  63956. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  63957. */
  63958. export class PostProcessRenderPipeline {
  63959. private engine;
  63960. private _renderEffects;
  63961. private _renderEffectsForIsolatedPass;
  63962. /**
  63963. * List of inspectable custom properties (used by the Inspector)
  63964. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  63965. */
  63966. inspectableCustomProperties: IInspectable[];
  63967. /**
  63968. * @hidden
  63969. */
  63970. protected _cameras: Camera[];
  63971. /** @hidden */
  63972. _name: string;
  63973. /**
  63974. * Gets pipeline name
  63975. */
  63976. readonly name: string;
  63977. /** Gets the list of attached cameras */
  63978. readonly cameras: Camera[];
  63979. /**
  63980. * Initializes a PostProcessRenderPipeline
  63981. * @param engine engine to add the pipeline to
  63982. * @param name name of the pipeline
  63983. */
  63984. constructor(engine: Engine, name: string);
  63985. /**
  63986. * Gets the class name
  63987. * @returns "PostProcessRenderPipeline"
  63988. */
  63989. getClassName(): string;
  63990. /**
  63991. * If all the render effects in the pipeline are supported
  63992. */
  63993. readonly isSupported: boolean;
  63994. /**
  63995. * Adds an effect to the pipeline
  63996. * @param renderEffect the effect to add
  63997. */
  63998. addEffect(renderEffect: PostProcessRenderEffect): void;
  63999. /** @hidden */
  64000. _rebuild(): void;
  64001. /** @hidden */
  64002. _enableEffect(renderEffectName: string, cameras: Camera): void;
  64003. /** @hidden */
  64004. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  64005. /** @hidden */
  64006. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  64007. /** @hidden */
  64008. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  64009. /** @hidden */
  64010. _attachCameras(cameras: Camera, unique: boolean): void;
  64011. /** @hidden */
  64012. _attachCameras(cameras: Camera[], unique: boolean): void;
  64013. /** @hidden */
  64014. _detachCameras(cameras: Camera): void;
  64015. /** @hidden */
  64016. _detachCameras(cameras: Nullable<Camera[]>): void;
  64017. /** @hidden */
  64018. _update(): void;
  64019. /** @hidden */
  64020. _reset(): void;
  64021. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  64022. /**
  64023. * Disposes of the pipeline
  64024. */
  64025. dispose(): void;
  64026. }
  64027. }
  64028. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  64029. import { Camera } from "babylonjs/Cameras/camera";
  64030. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64031. /**
  64032. * PostProcessRenderPipelineManager class
  64033. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64034. */
  64035. export class PostProcessRenderPipelineManager {
  64036. private _renderPipelines;
  64037. /**
  64038. * Initializes a PostProcessRenderPipelineManager
  64039. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64040. */
  64041. constructor();
  64042. /**
  64043. * Gets the list of supported render pipelines
  64044. */
  64045. readonly supportedPipelines: PostProcessRenderPipeline[];
  64046. /**
  64047. * Adds a pipeline to the manager
  64048. * @param renderPipeline The pipeline to add
  64049. */
  64050. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  64051. /**
  64052. * Attaches a camera to the pipeline
  64053. * @param renderPipelineName The name of the pipeline to attach to
  64054. * @param cameras the camera to attach
  64055. * @param unique if the camera can be attached multiple times to the pipeline
  64056. */
  64057. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  64058. /**
  64059. * Detaches a camera from the pipeline
  64060. * @param renderPipelineName The name of the pipeline to detach from
  64061. * @param cameras the camera to detach
  64062. */
  64063. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  64064. /**
  64065. * Enables an effect by name on a pipeline
  64066. * @param renderPipelineName the name of the pipeline to enable the effect in
  64067. * @param renderEffectName the name of the effect to enable
  64068. * @param cameras the cameras that the effect should be enabled on
  64069. */
  64070. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  64071. /**
  64072. * Disables an effect by name on a pipeline
  64073. * @param renderPipelineName the name of the pipeline to disable the effect in
  64074. * @param renderEffectName the name of the effect to disable
  64075. * @param cameras the cameras that the effect should be disabled on
  64076. */
  64077. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  64078. /**
  64079. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  64080. */
  64081. update(): void;
  64082. /** @hidden */
  64083. _rebuild(): void;
  64084. /**
  64085. * Disposes of the manager and pipelines
  64086. */
  64087. dispose(): void;
  64088. }
  64089. }
  64090. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  64091. import { ISceneComponent } from "babylonjs/sceneComponent";
  64092. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  64093. import { Scene } from "babylonjs/scene";
  64094. module "babylonjs/scene" {
  64095. interface Scene {
  64096. /** @hidden (Backing field) */
  64097. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  64098. /**
  64099. * Gets the postprocess render pipeline manager
  64100. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64101. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  64102. */
  64103. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  64104. }
  64105. }
  64106. /**
  64107. * Defines the Render Pipeline scene component responsible to rendering pipelines
  64108. */
  64109. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  64110. /**
  64111. * The component name helpfull to identify the component in the list of scene components.
  64112. */
  64113. readonly name: string;
  64114. /**
  64115. * The scene the component belongs to.
  64116. */
  64117. scene: Scene;
  64118. /**
  64119. * Creates a new instance of the component for the given scene
  64120. * @param scene Defines the scene to register the component in
  64121. */
  64122. constructor(scene: Scene);
  64123. /**
  64124. * Registers the component in a given scene
  64125. */
  64126. register(): void;
  64127. /**
  64128. * Rebuilds the elements related to this component in case of
  64129. * context lost for instance.
  64130. */
  64131. rebuild(): void;
  64132. /**
  64133. * Disposes the component and the associated ressources
  64134. */
  64135. dispose(): void;
  64136. private _gatherRenderTargets;
  64137. }
  64138. }
  64139. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  64140. import { Nullable } from "babylonjs/types";
  64141. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  64142. import { Camera } from "babylonjs/Cameras/camera";
  64143. import { IDisposable } from "babylonjs/scene";
  64144. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  64145. import { Scene } from "babylonjs/scene";
  64146. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  64147. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  64148. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  64149. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  64150. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  64151. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64152. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  64153. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64154. import { Animation } from "babylonjs/Animations/animation";
  64155. /**
  64156. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  64157. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  64158. */
  64159. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  64160. private _scene;
  64161. private _camerasToBeAttached;
  64162. /**
  64163. * ID of the sharpen post process,
  64164. */
  64165. private readonly SharpenPostProcessId;
  64166. /**
  64167. * @ignore
  64168. * ID of the image processing post process;
  64169. */
  64170. readonly ImageProcessingPostProcessId: string;
  64171. /**
  64172. * @ignore
  64173. * ID of the Fast Approximate Anti-Aliasing post process;
  64174. */
  64175. readonly FxaaPostProcessId: string;
  64176. /**
  64177. * ID of the chromatic aberration post process,
  64178. */
  64179. private readonly ChromaticAberrationPostProcessId;
  64180. /**
  64181. * ID of the grain post process
  64182. */
  64183. private readonly GrainPostProcessId;
  64184. /**
  64185. * Sharpen post process which will apply a sharpen convolution to enhance edges
  64186. */
  64187. sharpen: SharpenPostProcess;
  64188. private _sharpenEffect;
  64189. private bloom;
  64190. /**
  64191. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  64192. */
  64193. depthOfField: DepthOfFieldEffect;
  64194. /**
  64195. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  64196. */
  64197. fxaa: FxaaPostProcess;
  64198. /**
  64199. * Image post processing pass used to perform operations such as tone mapping or color grading.
  64200. */
  64201. imageProcessing: ImageProcessingPostProcess;
  64202. /**
  64203. * Chromatic aberration post process which will shift rgb colors in the image
  64204. */
  64205. chromaticAberration: ChromaticAberrationPostProcess;
  64206. private _chromaticAberrationEffect;
  64207. /**
  64208. * Grain post process which add noise to the image
  64209. */
  64210. grain: GrainPostProcess;
  64211. private _grainEffect;
  64212. /**
  64213. * Glow post process which adds a glow to emissive areas of the image
  64214. */
  64215. private _glowLayer;
  64216. /**
  64217. * Animations which can be used to tweak settings over a period of time
  64218. */
  64219. animations: Animation[];
  64220. private _imageProcessingConfigurationObserver;
  64221. private _sharpenEnabled;
  64222. private _bloomEnabled;
  64223. private _depthOfFieldEnabled;
  64224. private _depthOfFieldBlurLevel;
  64225. private _fxaaEnabled;
  64226. private _imageProcessingEnabled;
  64227. private _defaultPipelineTextureType;
  64228. private _bloomScale;
  64229. private _chromaticAberrationEnabled;
  64230. private _grainEnabled;
  64231. private _buildAllowed;
  64232. /**
  64233. * Gets active scene
  64234. */
  64235. readonly scene: Scene;
  64236. /**
  64237. * Enable or disable the sharpen process from the pipeline
  64238. */
  64239. sharpenEnabled: boolean;
  64240. private _resizeObserver;
  64241. private _hardwareScaleLevel;
  64242. private _bloomKernel;
  64243. /**
  64244. * Specifies the size of the bloom blur kernel, relative to the final output size
  64245. */
  64246. bloomKernel: number;
  64247. /**
  64248. * Specifies the weight of the bloom in the final rendering
  64249. */
  64250. private _bloomWeight;
  64251. /**
  64252. * Specifies the luma threshold for the area that will be blurred by the bloom
  64253. */
  64254. private _bloomThreshold;
  64255. private _hdr;
  64256. /**
  64257. * The strength of the bloom.
  64258. */
  64259. bloomWeight: number;
  64260. /**
  64261. * The strength of the bloom.
  64262. */
  64263. bloomThreshold: number;
  64264. /**
  64265. * The scale of the bloom, lower value will provide better performance.
  64266. */
  64267. bloomScale: number;
  64268. /**
  64269. * Enable or disable the bloom from the pipeline
  64270. */
  64271. bloomEnabled: boolean;
  64272. private _rebuildBloom;
  64273. /**
  64274. * If the depth of field is enabled.
  64275. */
  64276. depthOfFieldEnabled: boolean;
  64277. /**
  64278. * Blur level of the depth of field effect. (Higher blur will effect performance)
  64279. */
  64280. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  64281. /**
  64282. * If the anti aliasing is enabled.
  64283. */
  64284. fxaaEnabled: boolean;
  64285. private _samples;
  64286. /**
  64287. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  64288. */
  64289. samples: number;
  64290. /**
  64291. * If image processing is enabled.
  64292. */
  64293. imageProcessingEnabled: boolean;
  64294. /**
  64295. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  64296. */
  64297. glowLayerEnabled: boolean;
  64298. /**
  64299. * Gets the glow layer (or null if not defined)
  64300. */
  64301. readonly glowLayer: Nullable<GlowLayer>;
  64302. /**
  64303. * Enable or disable the chromaticAberration process from the pipeline
  64304. */
  64305. chromaticAberrationEnabled: boolean;
  64306. /**
  64307. * Enable or disable the grain process from the pipeline
  64308. */
  64309. grainEnabled: boolean;
  64310. /**
  64311. * @constructor
  64312. * @param name - The rendering pipeline name (default: "")
  64313. * @param hdr - If high dynamic range textures should be used (default: true)
  64314. * @param scene - The scene linked to this pipeline (default: the last created scene)
  64315. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  64316. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  64317. */
  64318. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  64319. /**
  64320. * Get the class name
  64321. * @returns "DefaultRenderingPipeline"
  64322. */
  64323. getClassName(): string;
  64324. /**
  64325. * Force the compilation of the entire pipeline.
  64326. */
  64327. prepare(): void;
  64328. private _hasCleared;
  64329. private _prevPostProcess;
  64330. private _prevPrevPostProcess;
  64331. private _setAutoClearAndTextureSharing;
  64332. private _depthOfFieldSceneObserver;
  64333. private _buildPipeline;
  64334. private _disposePostProcesses;
  64335. /**
  64336. * Adds a camera to the pipeline
  64337. * @param camera the camera to be added
  64338. */
  64339. addCamera(camera: Camera): void;
  64340. /**
  64341. * Removes a camera from the pipeline
  64342. * @param camera the camera to remove
  64343. */
  64344. removeCamera(camera: Camera): void;
  64345. /**
  64346. * Dispose of the pipeline and stop all post processes
  64347. */
  64348. dispose(): void;
  64349. /**
  64350. * Serialize the rendering pipeline (Used when exporting)
  64351. * @returns the serialized object
  64352. */
  64353. serialize(): any;
  64354. /**
  64355. * Parse the serialized pipeline
  64356. * @param source Source pipeline.
  64357. * @param scene The scene to load the pipeline to.
  64358. * @param rootUrl The URL of the serialized pipeline.
  64359. * @returns An instantiated pipeline from the serialized object.
  64360. */
  64361. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  64362. }
  64363. }
  64364. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  64365. /** @hidden */
  64366. export var lensHighlightsPixelShader: {
  64367. name: string;
  64368. shader: string;
  64369. };
  64370. }
  64371. declare module "babylonjs/Shaders/depthOfField.fragment" {
  64372. /** @hidden */
  64373. export var depthOfFieldPixelShader: {
  64374. name: string;
  64375. shader: string;
  64376. };
  64377. }
  64378. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  64379. import { Camera } from "babylonjs/Cameras/camera";
  64380. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64381. import { Scene } from "babylonjs/scene";
  64382. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64383. import "babylonjs/Shaders/chromaticAberration.fragment";
  64384. import "babylonjs/Shaders/lensHighlights.fragment";
  64385. import "babylonjs/Shaders/depthOfField.fragment";
  64386. /**
  64387. * BABYLON.JS Chromatic Aberration GLSL Shader
  64388. * Author: Olivier Guyot
  64389. * Separates very slightly R, G and B colors on the edges of the screen
  64390. * Inspired by Francois Tarlier & Martins Upitis
  64391. */
  64392. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  64393. /**
  64394. * @ignore
  64395. * The chromatic aberration PostProcess id in the pipeline
  64396. */
  64397. LensChromaticAberrationEffect: string;
  64398. /**
  64399. * @ignore
  64400. * The highlights enhancing PostProcess id in the pipeline
  64401. */
  64402. HighlightsEnhancingEffect: string;
  64403. /**
  64404. * @ignore
  64405. * The depth-of-field PostProcess id in the pipeline
  64406. */
  64407. LensDepthOfFieldEffect: string;
  64408. private _scene;
  64409. private _depthTexture;
  64410. private _grainTexture;
  64411. private _chromaticAberrationPostProcess;
  64412. private _highlightsPostProcess;
  64413. private _depthOfFieldPostProcess;
  64414. private _edgeBlur;
  64415. private _grainAmount;
  64416. private _chromaticAberration;
  64417. private _distortion;
  64418. private _highlightsGain;
  64419. private _highlightsThreshold;
  64420. private _dofDistance;
  64421. private _dofAperture;
  64422. private _dofDarken;
  64423. private _dofPentagon;
  64424. private _blurNoise;
  64425. /**
  64426. * @constructor
  64427. *
  64428. * Effect parameters are as follow:
  64429. * {
  64430. * chromatic_aberration: number; // from 0 to x (1 for realism)
  64431. * edge_blur: number; // from 0 to x (1 for realism)
  64432. * distortion: number; // from 0 to x (1 for realism)
  64433. * grain_amount: number; // from 0 to 1
  64434. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  64435. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  64436. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  64437. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  64438. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  64439. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  64440. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  64441. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  64442. * }
  64443. * Note: if an effect parameter is unset, effect is disabled
  64444. *
  64445. * @param name The rendering pipeline name
  64446. * @param parameters - An object containing all parameters (see above)
  64447. * @param scene The scene linked to this pipeline
  64448. * @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)
  64449. * @param cameras The array of cameras that the rendering pipeline will be attached to
  64450. */
  64451. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  64452. /**
  64453. * Get the class name
  64454. * @returns "LensRenderingPipeline"
  64455. */
  64456. getClassName(): string;
  64457. /**
  64458. * Gets associated scene
  64459. */
  64460. readonly scene: Scene;
  64461. /**
  64462. * Gets or sets the edge blur
  64463. */
  64464. edgeBlur: number;
  64465. /**
  64466. * Gets or sets the grain amount
  64467. */
  64468. grainAmount: number;
  64469. /**
  64470. * Gets or sets the chromatic aberration amount
  64471. */
  64472. chromaticAberration: number;
  64473. /**
  64474. * Gets or sets the depth of field aperture
  64475. */
  64476. dofAperture: number;
  64477. /**
  64478. * Gets or sets the edge distortion
  64479. */
  64480. edgeDistortion: number;
  64481. /**
  64482. * Gets or sets the depth of field distortion
  64483. */
  64484. dofDistortion: number;
  64485. /**
  64486. * Gets or sets the darken out of focus amount
  64487. */
  64488. darkenOutOfFocus: number;
  64489. /**
  64490. * Gets or sets a boolean indicating if blur noise is enabled
  64491. */
  64492. blurNoise: boolean;
  64493. /**
  64494. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  64495. */
  64496. pentagonBokeh: boolean;
  64497. /**
  64498. * Gets or sets the highlight grain amount
  64499. */
  64500. highlightsGain: number;
  64501. /**
  64502. * Gets or sets the highlight threshold
  64503. */
  64504. highlightsThreshold: number;
  64505. /**
  64506. * Sets the amount of blur at the edges
  64507. * @param amount blur amount
  64508. */
  64509. setEdgeBlur(amount: number): void;
  64510. /**
  64511. * Sets edge blur to 0
  64512. */
  64513. disableEdgeBlur(): void;
  64514. /**
  64515. * Sets the amout of grain
  64516. * @param amount Amount of grain
  64517. */
  64518. setGrainAmount(amount: number): void;
  64519. /**
  64520. * Set grain amount to 0
  64521. */
  64522. disableGrain(): void;
  64523. /**
  64524. * Sets the chromatic aberration amount
  64525. * @param amount amount of chromatic aberration
  64526. */
  64527. setChromaticAberration(amount: number): void;
  64528. /**
  64529. * Sets chromatic aberration amount to 0
  64530. */
  64531. disableChromaticAberration(): void;
  64532. /**
  64533. * Sets the EdgeDistortion amount
  64534. * @param amount amount of EdgeDistortion
  64535. */
  64536. setEdgeDistortion(amount: number): void;
  64537. /**
  64538. * Sets edge distortion to 0
  64539. */
  64540. disableEdgeDistortion(): void;
  64541. /**
  64542. * Sets the FocusDistance amount
  64543. * @param amount amount of FocusDistance
  64544. */
  64545. setFocusDistance(amount: number): void;
  64546. /**
  64547. * Disables depth of field
  64548. */
  64549. disableDepthOfField(): void;
  64550. /**
  64551. * Sets the Aperture amount
  64552. * @param amount amount of Aperture
  64553. */
  64554. setAperture(amount: number): void;
  64555. /**
  64556. * Sets the DarkenOutOfFocus amount
  64557. * @param amount amount of DarkenOutOfFocus
  64558. */
  64559. setDarkenOutOfFocus(amount: number): void;
  64560. private _pentagonBokehIsEnabled;
  64561. /**
  64562. * Creates a pentagon bokeh effect
  64563. */
  64564. enablePentagonBokeh(): void;
  64565. /**
  64566. * Disables the pentagon bokeh effect
  64567. */
  64568. disablePentagonBokeh(): void;
  64569. /**
  64570. * Enables noise blur
  64571. */
  64572. enableNoiseBlur(): void;
  64573. /**
  64574. * Disables noise blur
  64575. */
  64576. disableNoiseBlur(): void;
  64577. /**
  64578. * Sets the HighlightsGain amount
  64579. * @param amount amount of HighlightsGain
  64580. */
  64581. setHighlightsGain(amount: number): void;
  64582. /**
  64583. * Sets the HighlightsThreshold amount
  64584. * @param amount amount of HighlightsThreshold
  64585. */
  64586. setHighlightsThreshold(amount: number): void;
  64587. /**
  64588. * Disables highlights
  64589. */
  64590. disableHighlights(): void;
  64591. /**
  64592. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  64593. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  64594. */
  64595. dispose(disableDepthRender?: boolean): void;
  64596. private _createChromaticAberrationPostProcess;
  64597. private _createHighlightsPostProcess;
  64598. private _createDepthOfFieldPostProcess;
  64599. private _createGrainTexture;
  64600. }
  64601. }
  64602. declare module "babylonjs/Shaders/ssao2.fragment" {
  64603. /** @hidden */
  64604. export var ssao2PixelShader: {
  64605. name: string;
  64606. shader: string;
  64607. };
  64608. }
  64609. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  64610. /** @hidden */
  64611. export var ssaoCombinePixelShader: {
  64612. name: string;
  64613. shader: string;
  64614. };
  64615. }
  64616. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  64617. import { Camera } from "babylonjs/Cameras/camera";
  64618. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64619. import { Scene } from "babylonjs/scene";
  64620. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64621. import "babylonjs/Shaders/ssao2.fragment";
  64622. import "babylonjs/Shaders/ssaoCombine.fragment";
  64623. /**
  64624. * Render pipeline to produce ssao effect
  64625. */
  64626. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  64627. /**
  64628. * @ignore
  64629. * The PassPostProcess id in the pipeline that contains the original scene color
  64630. */
  64631. SSAOOriginalSceneColorEffect: string;
  64632. /**
  64633. * @ignore
  64634. * The SSAO PostProcess id in the pipeline
  64635. */
  64636. SSAORenderEffect: string;
  64637. /**
  64638. * @ignore
  64639. * The horizontal blur PostProcess id in the pipeline
  64640. */
  64641. SSAOBlurHRenderEffect: string;
  64642. /**
  64643. * @ignore
  64644. * The vertical blur PostProcess id in the pipeline
  64645. */
  64646. SSAOBlurVRenderEffect: string;
  64647. /**
  64648. * @ignore
  64649. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  64650. */
  64651. SSAOCombineRenderEffect: string;
  64652. /**
  64653. * The output strength of the SSAO post-process. Default value is 1.0.
  64654. */
  64655. totalStrength: number;
  64656. /**
  64657. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  64658. */
  64659. maxZ: number;
  64660. /**
  64661. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  64662. */
  64663. minZAspect: number;
  64664. private _samples;
  64665. /**
  64666. * Number of samples used for the SSAO calculations. Default value is 8
  64667. */
  64668. samples: number;
  64669. private _textureSamples;
  64670. /**
  64671. * Number of samples to use for antialiasing
  64672. */
  64673. textureSamples: number;
  64674. /**
  64675. * Ratio object used for SSAO ratio and blur ratio
  64676. */
  64677. private _ratio;
  64678. /**
  64679. * Dynamically generated sphere sampler.
  64680. */
  64681. private _sampleSphere;
  64682. /**
  64683. * Blur filter offsets
  64684. */
  64685. private _samplerOffsets;
  64686. private _expensiveBlur;
  64687. /**
  64688. * If bilateral blur should be used
  64689. */
  64690. expensiveBlur: boolean;
  64691. /**
  64692. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  64693. */
  64694. radius: number;
  64695. /**
  64696. * The base color of the SSAO post-process
  64697. * The final result is "base + ssao" between [0, 1]
  64698. */
  64699. base: number;
  64700. /**
  64701. * Support test.
  64702. */
  64703. static readonly IsSupported: boolean;
  64704. private _scene;
  64705. private _depthTexture;
  64706. private _normalTexture;
  64707. private _randomTexture;
  64708. private _originalColorPostProcess;
  64709. private _ssaoPostProcess;
  64710. private _blurHPostProcess;
  64711. private _blurVPostProcess;
  64712. private _ssaoCombinePostProcess;
  64713. private _firstUpdate;
  64714. /**
  64715. * Gets active scene
  64716. */
  64717. readonly scene: Scene;
  64718. /**
  64719. * @constructor
  64720. * @param name The rendering pipeline name
  64721. * @param scene The scene linked to this pipeline
  64722. * @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 }
  64723. * @param cameras The array of cameras that the rendering pipeline will be attached to
  64724. */
  64725. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  64726. /**
  64727. * Get the class name
  64728. * @returns "SSAO2RenderingPipeline"
  64729. */
  64730. getClassName(): string;
  64731. /**
  64732. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  64733. */
  64734. dispose(disableGeometryBufferRenderer?: boolean): void;
  64735. private _createBlurPostProcess;
  64736. /** @hidden */
  64737. _rebuild(): void;
  64738. private _bits;
  64739. private _radicalInverse_VdC;
  64740. private _hammersley;
  64741. private _hemisphereSample_uniform;
  64742. private _generateHemisphere;
  64743. private _createSSAOPostProcess;
  64744. private _createSSAOCombinePostProcess;
  64745. private _createRandomTexture;
  64746. /**
  64747. * Serialize the rendering pipeline (Used when exporting)
  64748. * @returns the serialized object
  64749. */
  64750. serialize(): any;
  64751. /**
  64752. * Parse the serialized pipeline
  64753. * @param source Source pipeline.
  64754. * @param scene The scene to load the pipeline to.
  64755. * @param rootUrl The URL of the serialized pipeline.
  64756. * @returns An instantiated pipeline from the serialized object.
  64757. */
  64758. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  64759. }
  64760. }
  64761. declare module "babylonjs/Shaders/ssao.fragment" {
  64762. /** @hidden */
  64763. export var ssaoPixelShader: {
  64764. name: string;
  64765. shader: string;
  64766. };
  64767. }
  64768. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  64769. import { Camera } from "babylonjs/Cameras/camera";
  64770. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64771. import { Scene } from "babylonjs/scene";
  64772. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64773. import "babylonjs/Shaders/ssao.fragment";
  64774. import "babylonjs/Shaders/ssaoCombine.fragment";
  64775. /**
  64776. * Render pipeline to produce ssao effect
  64777. */
  64778. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  64779. /**
  64780. * @ignore
  64781. * The PassPostProcess id in the pipeline that contains the original scene color
  64782. */
  64783. SSAOOriginalSceneColorEffect: string;
  64784. /**
  64785. * @ignore
  64786. * The SSAO PostProcess id in the pipeline
  64787. */
  64788. SSAORenderEffect: string;
  64789. /**
  64790. * @ignore
  64791. * The horizontal blur PostProcess id in the pipeline
  64792. */
  64793. SSAOBlurHRenderEffect: string;
  64794. /**
  64795. * @ignore
  64796. * The vertical blur PostProcess id in the pipeline
  64797. */
  64798. SSAOBlurVRenderEffect: string;
  64799. /**
  64800. * @ignore
  64801. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  64802. */
  64803. SSAOCombineRenderEffect: string;
  64804. /**
  64805. * The output strength of the SSAO post-process. Default value is 1.0.
  64806. */
  64807. totalStrength: number;
  64808. /**
  64809. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  64810. */
  64811. radius: number;
  64812. /**
  64813. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  64814. * Must not be equal to fallOff and superior to fallOff.
  64815. * Default value is 0.0075
  64816. */
  64817. area: number;
  64818. /**
  64819. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  64820. * Must not be equal to area and inferior to area.
  64821. * Default value is 0.000001
  64822. */
  64823. fallOff: number;
  64824. /**
  64825. * The base color of the SSAO post-process
  64826. * The final result is "base + ssao" between [0, 1]
  64827. */
  64828. base: number;
  64829. private _scene;
  64830. private _depthTexture;
  64831. private _randomTexture;
  64832. private _originalColorPostProcess;
  64833. private _ssaoPostProcess;
  64834. private _blurHPostProcess;
  64835. private _blurVPostProcess;
  64836. private _ssaoCombinePostProcess;
  64837. private _firstUpdate;
  64838. /**
  64839. * Gets active scene
  64840. */
  64841. readonly scene: Scene;
  64842. /**
  64843. * @constructor
  64844. * @param name - The rendering pipeline name
  64845. * @param scene - The scene linked to this pipeline
  64846. * @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 }
  64847. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  64848. */
  64849. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  64850. /**
  64851. * Get the class name
  64852. * @returns "SSAORenderingPipeline"
  64853. */
  64854. getClassName(): string;
  64855. /**
  64856. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  64857. */
  64858. dispose(disableDepthRender?: boolean): void;
  64859. private _createBlurPostProcess;
  64860. /** @hidden */
  64861. _rebuild(): void;
  64862. private _createSSAOPostProcess;
  64863. private _createSSAOCombinePostProcess;
  64864. private _createRandomTexture;
  64865. }
  64866. }
  64867. declare module "babylonjs/Shaders/standard.fragment" {
  64868. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  64869. /** @hidden */
  64870. export var standardPixelShader: {
  64871. name: string;
  64872. shader: string;
  64873. };
  64874. }
  64875. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  64876. import { Nullable } from "babylonjs/types";
  64877. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  64878. import { Camera } from "babylonjs/Cameras/camera";
  64879. import { Texture } from "babylonjs/Materials/Textures/texture";
  64880. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  64881. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64882. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  64883. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  64884. import { IDisposable } from "babylonjs/scene";
  64885. import { SpotLight } from "babylonjs/Lights/spotLight";
  64886. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  64887. import { Scene } from "babylonjs/scene";
  64888. import { Animation } from "babylonjs/Animations/animation";
  64889. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64890. import "babylonjs/Shaders/standard.fragment";
  64891. /**
  64892. * Standard rendering pipeline
  64893. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  64894. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  64895. */
  64896. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  64897. /**
  64898. * Public members
  64899. */
  64900. /**
  64901. * Post-process which contains the original scene color before the pipeline applies all the effects
  64902. */
  64903. originalPostProcess: Nullable<PostProcess>;
  64904. /**
  64905. * Post-process used to down scale an image x4
  64906. */
  64907. downSampleX4PostProcess: Nullable<PostProcess>;
  64908. /**
  64909. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  64910. */
  64911. brightPassPostProcess: Nullable<PostProcess>;
  64912. /**
  64913. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  64914. */
  64915. blurHPostProcesses: PostProcess[];
  64916. /**
  64917. * Post-process array storing all the vertical blur post-processes used by the pipeline
  64918. */
  64919. blurVPostProcesses: PostProcess[];
  64920. /**
  64921. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  64922. */
  64923. textureAdderPostProcess: Nullable<PostProcess>;
  64924. /**
  64925. * Post-process used to create volumetric lighting effect
  64926. */
  64927. volumetricLightPostProcess: Nullable<PostProcess>;
  64928. /**
  64929. * Post-process used to smooth the previous volumetric light post-process on the X axis
  64930. */
  64931. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  64932. /**
  64933. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  64934. */
  64935. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  64936. /**
  64937. * Post-process used to merge the volumetric light effect and the real scene color
  64938. */
  64939. volumetricLightMergePostProces: Nullable<PostProcess>;
  64940. /**
  64941. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  64942. */
  64943. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  64944. /**
  64945. * Base post-process used to calculate the average luminance of the final image for HDR
  64946. */
  64947. luminancePostProcess: Nullable<PostProcess>;
  64948. /**
  64949. * Post-processes used to create down sample post-processes in order to get
  64950. * the average luminance of the final image for HDR
  64951. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  64952. */
  64953. luminanceDownSamplePostProcesses: PostProcess[];
  64954. /**
  64955. * Post-process used to create a HDR effect (light adaptation)
  64956. */
  64957. hdrPostProcess: Nullable<PostProcess>;
  64958. /**
  64959. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  64960. */
  64961. textureAdderFinalPostProcess: Nullable<PostProcess>;
  64962. /**
  64963. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  64964. */
  64965. lensFlareFinalPostProcess: Nullable<PostProcess>;
  64966. /**
  64967. * Post-process used to merge the final HDR post-process and the real scene color
  64968. */
  64969. hdrFinalPostProcess: Nullable<PostProcess>;
  64970. /**
  64971. * Post-process used to create a lens flare effect
  64972. */
  64973. lensFlarePostProcess: Nullable<PostProcess>;
  64974. /**
  64975. * Post-process that merges the result of the lens flare post-process and the real scene color
  64976. */
  64977. lensFlareComposePostProcess: Nullable<PostProcess>;
  64978. /**
  64979. * Post-process used to create a motion blur effect
  64980. */
  64981. motionBlurPostProcess: Nullable<PostProcess>;
  64982. /**
  64983. * Post-process used to create a depth of field effect
  64984. */
  64985. depthOfFieldPostProcess: Nullable<PostProcess>;
  64986. /**
  64987. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  64988. */
  64989. fxaaPostProcess: Nullable<FxaaPostProcess>;
  64990. /**
  64991. * Represents the brightness threshold in order to configure the illuminated surfaces
  64992. */
  64993. brightThreshold: number;
  64994. /**
  64995. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  64996. */
  64997. blurWidth: number;
  64998. /**
  64999. * Sets if the blur for highlighted surfaces must be only horizontal
  65000. */
  65001. horizontalBlur: boolean;
  65002. /**
  65003. * Gets the overall exposure used by the pipeline
  65004. */
  65005. /**
  65006. * Sets the overall exposure used by the pipeline
  65007. */
  65008. exposure: number;
  65009. /**
  65010. * Texture used typically to simulate "dirty" on camera lens
  65011. */
  65012. lensTexture: Nullable<Texture>;
  65013. /**
  65014. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  65015. */
  65016. volumetricLightCoefficient: number;
  65017. /**
  65018. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  65019. */
  65020. volumetricLightPower: number;
  65021. /**
  65022. * Used the set the blur intensity to smooth the volumetric lights
  65023. */
  65024. volumetricLightBlurScale: number;
  65025. /**
  65026. * Light (spot or directional) used to generate the volumetric lights rays
  65027. * The source light must have a shadow generate so the pipeline can get its
  65028. * depth map
  65029. */
  65030. sourceLight: Nullable<SpotLight | DirectionalLight>;
  65031. /**
  65032. * For eye adaptation, represents the minimum luminance the eye can see
  65033. */
  65034. hdrMinimumLuminance: number;
  65035. /**
  65036. * For eye adaptation, represents the decrease luminance speed
  65037. */
  65038. hdrDecreaseRate: number;
  65039. /**
  65040. * For eye adaptation, represents the increase luminance speed
  65041. */
  65042. hdrIncreaseRate: number;
  65043. /**
  65044. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  65045. */
  65046. /**
  65047. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  65048. */
  65049. hdrAutoExposure: boolean;
  65050. /**
  65051. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  65052. */
  65053. lensColorTexture: Nullable<Texture>;
  65054. /**
  65055. * The overall strengh for the lens flare effect
  65056. */
  65057. lensFlareStrength: number;
  65058. /**
  65059. * Dispersion coefficient for lens flare ghosts
  65060. */
  65061. lensFlareGhostDispersal: number;
  65062. /**
  65063. * Main lens flare halo width
  65064. */
  65065. lensFlareHaloWidth: number;
  65066. /**
  65067. * Based on the lens distortion effect, defines how much the lens flare result
  65068. * is distorted
  65069. */
  65070. lensFlareDistortionStrength: number;
  65071. /**
  65072. * Configures the blur intensity used for for lens flare (halo)
  65073. */
  65074. lensFlareBlurWidth: number;
  65075. /**
  65076. * Lens star texture must be used to simulate rays on the flares and is available
  65077. * in the documentation
  65078. */
  65079. lensStarTexture: Nullable<Texture>;
  65080. /**
  65081. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  65082. * flare effect by taking account of the dirt texture
  65083. */
  65084. lensFlareDirtTexture: Nullable<Texture>;
  65085. /**
  65086. * Represents the focal length for the depth of field effect
  65087. */
  65088. depthOfFieldDistance: number;
  65089. /**
  65090. * Represents the blur intensity for the blurred part of the depth of field effect
  65091. */
  65092. depthOfFieldBlurWidth: number;
  65093. /**
  65094. * Gets how much the image is blurred by the movement while using the motion blur post-process
  65095. */
  65096. /**
  65097. * Sets how much the image is blurred by the movement while using the motion blur post-process
  65098. */
  65099. motionStrength: number;
  65100. /**
  65101. * Gets wether or not the motion blur post-process is object based or screen based.
  65102. */
  65103. /**
  65104. * Sets wether or not the motion blur post-process should be object based or screen based
  65105. */
  65106. objectBasedMotionBlur: boolean;
  65107. /**
  65108. * List of animations for the pipeline (IAnimatable implementation)
  65109. */
  65110. animations: Animation[];
  65111. /**
  65112. * Private members
  65113. */
  65114. private _scene;
  65115. private _currentDepthOfFieldSource;
  65116. private _basePostProcess;
  65117. private _fixedExposure;
  65118. private _currentExposure;
  65119. private _hdrAutoExposure;
  65120. private _hdrCurrentLuminance;
  65121. private _motionStrength;
  65122. private _isObjectBasedMotionBlur;
  65123. private _floatTextureType;
  65124. private _camerasToBeAttached;
  65125. private _ratio;
  65126. private _bloomEnabled;
  65127. private _depthOfFieldEnabled;
  65128. private _vlsEnabled;
  65129. private _lensFlareEnabled;
  65130. private _hdrEnabled;
  65131. private _motionBlurEnabled;
  65132. private _fxaaEnabled;
  65133. private _motionBlurSamples;
  65134. private _volumetricLightStepsCount;
  65135. private _samples;
  65136. /**
  65137. * @ignore
  65138. * Specifies if the bloom pipeline is enabled
  65139. */
  65140. BloomEnabled: boolean;
  65141. /**
  65142. * @ignore
  65143. * Specifies if the depth of field pipeline is enabed
  65144. */
  65145. DepthOfFieldEnabled: boolean;
  65146. /**
  65147. * @ignore
  65148. * Specifies if the lens flare pipeline is enabed
  65149. */
  65150. LensFlareEnabled: boolean;
  65151. /**
  65152. * @ignore
  65153. * Specifies if the HDR pipeline is enabled
  65154. */
  65155. HDREnabled: boolean;
  65156. /**
  65157. * @ignore
  65158. * Specifies if the volumetric lights scattering effect is enabled
  65159. */
  65160. VLSEnabled: boolean;
  65161. /**
  65162. * @ignore
  65163. * Specifies if the motion blur effect is enabled
  65164. */
  65165. MotionBlurEnabled: boolean;
  65166. /**
  65167. * Specifies if anti-aliasing is enabled
  65168. */
  65169. fxaaEnabled: boolean;
  65170. /**
  65171. * Specifies the number of steps used to calculate the volumetric lights
  65172. * Typically in interval [50, 200]
  65173. */
  65174. volumetricLightStepsCount: number;
  65175. /**
  65176. * Specifies the number of samples used for the motion blur effect
  65177. * Typically in interval [16, 64]
  65178. */
  65179. motionBlurSamples: number;
  65180. /**
  65181. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  65182. */
  65183. samples: number;
  65184. /**
  65185. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  65186. * @constructor
  65187. * @param name The rendering pipeline name
  65188. * @param scene The scene linked to this pipeline
  65189. * @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)
  65190. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  65191. * @param cameras The array of cameras that the rendering pipeline will be attached to
  65192. */
  65193. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  65194. private _buildPipeline;
  65195. private _createDownSampleX4PostProcess;
  65196. private _createBrightPassPostProcess;
  65197. private _createBlurPostProcesses;
  65198. private _createTextureAdderPostProcess;
  65199. private _createVolumetricLightPostProcess;
  65200. private _createLuminancePostProcesses;
  65201. private _createHdrPostProcess;
  65202. private _createLensFlarePostProcess;
  65203. private _createDepthOfFieldPostProcess;
  65204. private _createMotionBlurPostProcess;
  65205. private _getDepthTexture;
  65206. private _disposePostProcesses;
  65207. /**
  65208. * Dispose of the pipeline and stop all post processes
  65209. */
  65210. dispose(): void;
  65211. /**
  65212. * Serialize the rendering pipeline (Used when exporting)
  65213. * @returns the serialized object
  65214. */
  65215. serialize(): any;
  65216. /**
  65217. * Parse the serialized pipeline
  65218. * @param source Source pipeline.
  65219. * @param scene The scene to load the pipeline to.
  65220. * @param rootUrl The URL of the serialized pipeline.
  65221. * @returns An instantiated pipeline from the serialized object.
  65222. */
  65223. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  65224. /**
  65225. * Luminance steps
  65226. */
  65227. static LuminanceSteps: number;
  65228. }
  65229. }
  65230. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  65231. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  65232. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  65233. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  65234. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  65235. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  65236. }
  65237. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  65238. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  65239. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  65240. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65241. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  65242. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65243. }
  65244. declare module "babylonjs/Shaders/tonemap.fragment" {
  65245. /** @hidden */
  65246. export var tonemapPixelShader: {
  65247. name: string;
  65248. shader: string;
  65249. };
  65250. }
  65251. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  65252. import { Camera } from "babylonjs/Cameras/camera";
  65253. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65254. import "babylonjs/Shaders/tonemap.fragment";
  65255. import { Engine } from "babylonjs/Engines/engine";
  65256. /** Defines operator used for tonemapping */
  65257. export enum TonemappingOperator {
  65258. /** Hable */
  65259. Hable = 0,
  65260. /** Reinhard */
  65261. Reinhard = 1,
  65262. /** HejiDawson */
  65263. HejiDawson = 2,
  65264. /** Photographic */
  65265. Photographic = 3
  65266. }
  65267. /**
  65268. * Defines a post process to apply tone mapping
  65269. */
  65270. export class TonemapPostProcess extends PostProcess {
  65271. private _operator;
  65272. /** Defines the required exposure adjustement */
  65273. exposureAdjustment: number;
  65274. /**
  65275. * Creates a new TonemapPostProcess
  65276. * @param name defines the name of the postprocess
  65277. * @param _operator defines the operator to use
  65278. * @param exposureAdjustment defines the required exposure adjustement
  65279. * @param camera defines the camera to use (can be null)
  65280. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  65281. * @param engine defines the hosting engine (can be ignore if camera is set)
  65282. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  65283. */
  65284. constructor(name: string, _operator: TonemappingOperator,
  65285. /** Defines the required exposure adjustement */
  65286. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  65287. }
  65288. }
  65289. declare module "babylonjs/Shaders/depth.vertex" {
  65290. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65291. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65292. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65293. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65294. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65295. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65296. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65297. /** @hidden */
  65298. export var depthVertexShader: {
  65299. name: string;
  65300. shader: string;
  65301. };
  65302. }
  65303. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  65304. /** @hidden */
  65305. export var volumetricLightScatteringPixelShader: {
  65306. name: string;
  65307. shader: string;
  65308. };
  65309. }
  65310. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  65311. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65312. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65313. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65314. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65315. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65316. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65317. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65318. /** @hidden */
  65319. export var volumetricLightScatteringPassVertexShader: {
  65320. name: string;
  65321. shader: string;
  65322. };
  65323. }
  65324. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  65325. /** @hidden */
  65326. export var volumetricLightScatteringPassPixelShader: {
  65327. name: string;
  65328. shader: string;
  65329. };
  65330. }
  65331. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  65332. import { Vector3 } from "babylonjs/Maths/math.vector";
  65333. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65334. import { Mesh } from "babylonjs/Meshes/mesh";
  65335. import { Camera } from "babylonjs/Cameras/camera";
  65336. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65337. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65338. import { Scene } from "babylonjs/scene";
  65339. import "babylonjs/Meshes/Builders/planeBuilder";
  65340. import "babylonjs/Shaders/depth.vertex";
  65341. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  65342. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  65343. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  65344. import { Engine } from "babylonjs/Engines/engine";
  65345. /**
  65346. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  65347. */
  65348. export class VolumetricLightScatteringPostProcess extends PostProcess {
  65349. private _volumetricLightScatteringPass;
  65350. private _volumetricLightScatteringRTT;
  65351. private _viewPort;
  65352. private _screenCoordinates;
  65353. private _cachedDefines;
  65354. /**
  65355. * If not undefined, the mesh position is computed from the attached node position
  65356. */
  65357. attachedNode: {
  65358. position: Vector3;
  65359. };
  65360. /**
  65361. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  65362. */
  65363. customMeshPosition: Vector3;
  65364. /**
  65365. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  65366. */
  65367. useCustomMeshPosition: boolean;
  65368. /**
  65369. * If the post-process should inverse the light scattering direction
  65370. */
  65371. invert: boolean;
  65372. /**
  65373. * The internal mesh used by the post-process
  65374. */
  65375. mesh: Mesh;
  65376. /**
  65377. * @hidden
  65378. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  65379. */
  65380. useDiffuseColor: boolean;
  65381. /**
  65382. * Array containing the excluded meshes not rendered in the internal pass
  65383. */
  65384. excludedMeshes: AbstractMesh[];
  65385. /**
  65386. * Controls the overall intensity of the post-process
  65387. */
  65388. exposure: number;
  65389. /**
  65390. * Dissipates each sample's contribution in range [0, 1]
  65391. */
  65392. decay: number;
  65393. /**
  65394. * Controls the overall intensity of each sample
  65395. */
  65396. weight: number;
  65397. /**
  65398. * Controls the density of each sample
  65399. */
  65400. density: number;
  65401. /**
  65402. * @constructor
  65403. * @param name The post-process name
  65404. * @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)
  65405. * @param camera The camera that the post-process will be attached to
  65406. * @param mesh The mesh used to create the light scattering
  65407. * @param samples The post-process quality, default 100
  65408. * @param samplingModeThe post-process filtering mode
  65409. * @param engine The babylon engine
  65410. * @param reusable If the post-process is reusable
  65411. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  65412. */
  65413. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  65414. /**
  65415. * Returns the string "VolumetricLightScatteringPostProcess"
  65416. * @returns "VolumetricLightScatteringPostProcess"
  65417. */
  65418. getClassName(): string;
  65419. private _isReady;
  65420. /**
  65421. * Sets the new light position for light scattering effect
  65422. * @param position The new custom light position
  65423. */
  65424. setCustomMeshPosition(position: Vector3): void;
  65425. /**
  65426. * Returns the light position for light scattering effect
  65427. * @return Vector3 The custom light position
  65428. */
  65429. getCustomMeshPosition(): Vector3;
  65430. /**
  65431. * Disposes the internal assets and detaches the post-process from the camera
  65432. */
  65433. dispose(camera: Camera): void;
  65434. /**
  65435. * Returns the render target texture used by the post-process
  65436. * @return the render target texture used by the post-process
  65437. */
  65438. getPass(): RenderTargetTexture;
  65439. private _meshExcluded;
  65440. private _createPass;
  65441. private _updateMeshScreenCoordinates;
  65442. /**
  65443. * Creates a default mesh for the Volumeric Light Scattering post-process
  65444. * @param name The mesh name
  65445. * @param scene The scene where to create the mesh
  65446. * @return the default mesh
  65447. */
  65448. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  65449. }
  65450. }
  65451. declare module "babylonjs/PostProcesses/index" {
  65452. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  65453. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  65454. export * from "babylonjs/PostProcesses/bloomEffect";
  65455. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  65456. export * from "babylonjs/PostProcesses/blurPostProcess";
  65457. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  65458. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  65459. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  65460. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  65461. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  65462. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  65463. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  65464. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  65465. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  65466. export * from "babylonjs/PostProcesses/filterPostProcess";
  65467. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  65468. export * from "babylonjs/PostProcesses/grainPostProcess";
  65469. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  65470. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  65471. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  65472. export * from "babylonjs/PostProcesses/passPostProcess";
  65473. export * from "babylonjs/PostProcesses/postProcess";
  65474. export * from "babylonjs/PostProcesses/postProcessManager";
  65475. export * from "babylonjs/PostProcesses/refractionPostProcess";
  65476. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  65477. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  65478. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  65479. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  65480. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  65481. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  65482. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  65483. }
  65484. declare module "babylonjs/Probes/index" {
  65485. export * from "babylonjs/Probes/reflectionProbe";
  65486. }
  65487. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  65488. import { Scene } from "babylonjs/scene";
  65489. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65490. import { SmartArray } from "babylonjs/Misc/smartArray";
  65491. import { ISceneComponent } from "babylonjs/sceneComponent";
  65492. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  65493. import "babylonjs/Meshes/Builders/boxBuilder";
  65494. import "babylonjs/Shaders/color.fragment";
  65495. import "babylonjs/Shaders/color.vertex";
  65496. import { Color3 } from "babylonjs/Maths/math.color";
  65497. module "babylonjs/scene" {
  65498. interface Scene {
  65499. /** @hidden (Backing field) */
  65500. _boundingBoxRenderer: BoundingBoxRenderer;
  65501. /** @hidden (Backing field) */
  65502. _forceShowBoundingBoxes: boolean;
  65503. /**
  65504. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  65505. */
  65506. forceShowBoundingBoxes: boolean;
  65507. /**
  65508. * Gets the bounding box renderer associated with the scene
  65509. * @returns a BoundingBoxRenderer
  65510. */
  65511. getBoundingBoxRenderer(): BoundingBoxRenderer;
  65512. }
  65513. }
  65514. module "babylonjs/Meshes/abstractMesh" {
  65515. interface AbstractMesh {
  65516. /** @hidden (Backing field) */
  65517. _showBoundingBox: boolean;
  65518. /**
  65519. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  65520. */
  65521. showBoundingBox: boolean;
  65522. }
  65523. }
  65524. /**
  65525. * Component responsible of rendering the bounding box of the meshes in a scene.
  65526. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  65527. */
  65528. export class BoundingBoxRenderer implements ISceneComponent {
  65529. /**
  65530. * The component name helpfull to identify the component in the list of scene components.
  65531. */
  65532. readonly name: string;
  65533. /**
  65534. * The scene the component belongs to.
  65535. */
  65536. scene: Scene;
  65537. /**
  65538. * Color of the bounding box lines placed in front of an object
  65539. */
  65540. frontColor: Color3;
  65541. /**
  65542. * Color of the bounding box lines placed behind an object
  65543. */
  65544. backColor: Color3;
  65545. /**
  65546. * Defines if the renderer should show the back lines or not
  65547. */
  65548. showBackLines: boolean;
  65549. /**
  65550. * @hidden
  65551. */
  65552. renderList: SmartArray<BoundingBox>;
  65553. private _colorShader;
  65554. private _vertexBuffers;
  65555. private _indexBuffer;
  65556. private _fillIndexBuffer;
  65557. private _fillIndexData;
  65558. /**
  65559. * Instantiates a new bounding box renderer in a scene.
  65560. * @param scene the scene the renderer renders in
  65561. */
  65562. constructor(scene: Scene);
  65563. /**
  65564. * Registers the component in a given scene
  65565. */
  65566. register(): void;
  65567. private _evaluateSubMesh;
  65568. private _activeMesh;
  65569. private _prepareRessources;
  65570. private _createIndexBuffer;
  65571. /**
  65572. * Rebuilds the elements related to this component in case of
  65573. * context lost for instance.
  65574. */
  65575. rebuild(): void;
  65576. /**
  65577. * @hidden
  65578. */
  65579. reset(): void;
  65580. /**
  65581. * Render the bounding boxes of a specific rendering group
  65582. * @param renderingGroupId defines the rendering group to render
  65583. */
  65584. render(renderingGroupId: number): void;
  65585. /**
  65586. * In case of occlusion queries, we can render the occlusion bounding box through this method
  65587. * @param mesh Define the mesh to render the occlusion bounding box for
  65588. */
  65589. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  65590. /**
  65591. * Dispose and release the resources attached to this renderer.
  65592. */
  65593. dispose(): void;
  65594. }
  65595. }
  65596. declare module "babylonjs/Shaders/depth.fragment" {
  65597. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  65598. /** @hidden */
  65599. export var depthPixelShader: {
  65600. name: string;
  65601. shader: string;
  65602. };
  65603. }
  65604. declare module "babylonjs/Rendering/depthRenderer" {
  65605. import { Nullable } from "babylonjs/types";
  65606. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65607. import { Scene } from "babylonjs/scene";
  65608. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65609. import { Camera } from "babylonjs/Cameras/camera";
  65610. import "babylonjs/Shaders/depth.fragment";
  65611. import "babylonjs/Shaders/depth.vertex";
  65612. /**
  65613. * This represents a depth renderer in Babylon.
  65614. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  65615. */
  65616. export class DepthRenderer {
  65617. private _scene;
  65618. private _depthMap;
  65619. private _effect;
  65620. private readonly _storeNonLinearDepth;
  65621. private readonly _clearColor;
  65622. /** Get if the depth renderer is using packed depth or not */
  65623. readonly isPacked: boolean;
  65624. private _cachedDefines;
  65625. private _camera;
  65626. /**
  65627. * Specifiess that the depth renderer will only be used within
  65628. * the camera it is created for.
  65629. * This can help forcing its rendering during the camera processing.
  65630. */
  65631. useOnlyInActiveCamera: boolean;
  65632. /** @hidden */
  65633. static _SceneComponentInitialization: (scene: Scene) => void;
  65634. /**
  65635. * Instantiates a depth renderer
  65636. * @param scene The scene the renderer belongs to
  65637. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  65638. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  65639. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  65640. */
  65641. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  65642. /**
  65643. * Creates the depth rendering effect and checks if the effect is ready.
  65644. * @param subMesh The submesh to be used to render the depth map of
  65645. * @param useInstances If multiple world instances should be used
  65646. * @returns if the depth renderer is ready to render the depth map
  65647. */
  65648. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  65649. /**
  65650. * Gets the texture which the depth map will be written to.
  65651. * @returns The depth map texture
  65652. */
  65653. getDepthMap(): RenderTargetTexture;
  65654. /**
  65655. * Disposes of the depth renderer.
  65656. */
  65657. dispose(): void;
  65658. }
  65659. }
  65660. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  65661. import { Nullable } from "babylonjs/types";
  65662. import { Scene } from "babylonjs/scene";
  65663. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  65664. import { Camera } from "babylonjs/Cameras/camera";
  65665. import { ISceneComponent } from "babylonjs/sceneComponent";
  65666. module "babylonjs/scene" {
  65667. interface Scene {
  65668. /** @hidden (Backing field) */
  65669. _depthRenderer: {
  65670. [id: string]: DepthRenderer;
  65671. };
  65672. /**
  65673. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  65674. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  65675. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  65676. * @returns the created depth renderer
  65677. */
  65678. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  65679. /**
  65680. * Disables a depth renderer for a given camera
  65681. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  65682. */
  65683. disableDepthRenderer(camera?: Nullable<Camera>): void;
  65684. }
  65685. }
  65686. /**
  65687. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  65688. * in several rendering techniques.
  65689. */
  65690. export class DepthRendererSceneComponent implements ISceneComponent {
  65691. /**
  65692. * The component name helpfull to identify the component in the list of scene components.
  65693. */
  65694. readonly name: string;
  65695. /**
  65696. * The scene the component belongs to.
  65697. */
  65698. scene: Scene;
  65699. /**
  65700. * Creates a new instance of the component for the given scene
  65701. * @param scene Defines the scene to register the component in
  65702. */
  65703. constructor(scene: Scene);
  65704. /**
  65705. * Registers the component in a given scene
  65706. */
  65707. register(): void;
  65708. /**
  65709. * Rebuilds the elements related to this component in case of
  65710. * context lost for instance.
  65711. */
  65712. rebuild(): void;
  65713. /**
  65714. * Disposes the component and the associated ressources
  65715. */
  65716. dispose(): void;
  65717. private _gatherRenderTargets;
  65718. private _gatherActiveCameraRenderTargets;
  65719. }
  65720. }
  65721. declare module "babylonjs/Shaders/outline.fragment" {
  65722. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  65723. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  65724. /** @hidden */
  65725. export var outlinePixelShader: {
  65726. name: string;
  65727. shader: string;
  65728. };
  65729. }
  65730. declare module "babylonjs/Shaders/outline.vertex" {
  65731. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65732. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65733. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65734. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65735. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  65736. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65737. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65738. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65739. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  65740. /** @hidden */
  65741. export var outlineVertexShader: {
  65742. name: string;
  65743. shader: string;
  65744. };
  65745. }
  65746. declare module "babylonjs/Rendering/outlineRenderer" {
  65747. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65748. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  65749. import { Scene } from "babylonjs/scene";
  65750. import { ISceneComponent } from "babylonjs/sceneComponent";
  65751. import "babylonjs/Shaders/outline.fragment";
  65752. import "babylonjs/Shaders/outline.vertex";
  65753. module "babylonjs/scene" {
  65754. interface Scene {
  65755. /** @hidden */
  65756. _outlineRenderer: OutlineRenderer;
  65757. /**
  65758. * Gets the outline renderer associated with the scene
  65759. * @returns a OutlineRenderer
  65760. */
  65761. getOutlineRenderer(): OutlineRenderer;
  65762. }
  65763. }
  65764. module "babylonjs/Meshes/abstractMesh" {
  65765. interface AbstractMesh {
  65766. /** @hidden (Backing field) */
  65767. _renderOutline: boolean;
  65768. /**
  65769. * Gets or sets a boolean indicating if the outline must be rendered as well
  65770. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  65771. */
  65772. renderOutline: boolean;
  65773. /** @hidden (Backing field) */
  65774. _renderOverlay: boolean;
  65775. /**
  65776. * Gets or sets a boolean indicating if the overlay must be rendered as well
  65777. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  65778. */
  65779. renderOverlay: boolean;
  65780. }
  65781. }
  65782. /**
  65783. * This class is responsible to draw bothe outline/overlay of meshes.
  65784. * It should not be used directly but through the available method on mesh.
  65785. */
  65786. export class OutlineRenderer implements ISceneComponent {
  65787. /**
  65788. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  65789. */
  65790. private static _StencilReference;
  65791. /**
  65792. * The name of the component. Each component must have a unique name.
  65793. */
  65794. name: string;
  65795. /**
  65796. * The scene the component belongs to.
  65797. */
  65798. scene: Scene;
  65799. /**
  65800. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  65801. */
  65802. zOffset: number;
  65803. private _engine;
  65804. private _effect;
  65805. private _cachedDefines;
  65806. private _savedDepthWrite;
  65807. /**
  65808. * Instantiates a new outline renderer. (There could be only one per scene).
  65809. * @param scene Defines the scene it belongs to
  65810. */
  65811. constructor(scene: Scene);
  65812. /**
  65813. * Register the component to one instance of a scene.
  65814. */
  65815. register(): void;
  65816. /**
  65817. * Rebuilds the elements related to this component in case of
  65818. * context lost for instance.
  65819. */
  65820. rebuild(): void;
  65821. /**
  65822. * Disposes the component and the associated ressources.
  65823. */
  65824. dispose(): void;
  65825. /**
  65826. * Renders the outline in the canvas.
  65827. * @param subMesh Defines the sumesh to render
  65828. * @param batch Defines the batch of meshes in case of instances
  65829. * @param useOverlay Defines if the rendering is for the overlay or the outline
  65830. */
  65831. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  65832. /**
  65833. * Returns whether or not the outline renderer is ready for a given submesh.
  65834. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  65835. * @param subMesh Defines the submesh to check readyness for
  65836. * @param useInstances Defines wheter wee are trying to render instances or not
  65837. * @returns true if ready otherwise false
  65838. */
  65839. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  65840. private _beforeRenderingMesh;
  65841. private _afterRenderingMesh;
  65842. }
  65843. }
  65844. declare module "babylonjs/Rendering/index" {
  65845. export * from "babylonjs/Rendering/boundingBoxRenderer";
  65846. export * from "babylonjs/Rendering/depthRenderer";
  65847. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  65848. export * from "babylonjs/Rendering/edgesRenderer";
  65849. export * from "babylonjs/Rendering/geometryBufferRenderer";
  65850. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  65851. export * from "babylonjs/Rendering/outlineRenderer";
  65852. export * from "babylonjs/Rendering/renderingGroup";
  65853. export * from "babylonjs/Rendering/renderingManager";
  65854. export * from "babylonjs/Rendering/utilityLayerRenderer";
  65855. }
  65856. declare module "babylonjs/Sprites/spritePackedManager" {
  65857. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  65858. import { Scene } from "babylonjs/scene";
  65859. /**
  65860. * Class used to manage multiple sprites of different sizes on the same spritesheet
  65861. * @see http://doc.babylonjs.com/babylon101/sprites
  65862. */
  65863. export class SpritePackedManager extends SpriteManager {
  65864. /** defines the packed manager's name */
  65865. name: string;
  65866. /**
  65867. * Creates a new sprite manager from a packed sprite sheet
  65868. * @param name defines the manager's name
  65869. * @param imgUrl defines the sprite sheet url
  65870. * @param capacity defines the maximum allowed number of sprites
  65871. * @param scene defines the hosting scene
  65872. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  65873. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  65874. * @param samplingMode defines the smapling mode to use with spritesheet
  65875. * @param fromPacked set to true; do not alter
  65876. */
  65877. constructor(
  65878. /** defines the packed manager's name */
  65879. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  65880. }
  65881. }
  65882. declare module "babylonjs/Sprites/index" {
  65883. export * from "babylonjs/Sprites/sprite";
  65884. export * from "babylonjs/Sprites/spriteManager";
  65885. export * from "babylonjs/Sprites/spritePackedManager";
  65886. export * from "babylonjs/Sprites/spriteSceneComponent";
  65887. }
  65888. declare module "babylonjs/States/index" {
  65889. export * from "babylonjs/States/alphaCullingState";
  65890. export * from "babylonjs/States/depthCullingState";
  65891. export * from "babylonjs/States/stencilState";
  65892. }
  65893. declare module "babylonjs/Misc/assetsManager" {
  65894. import { Scene } from "babylonjs/scene";
  65895. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65896. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  65897. import { Skeleton } from "babylonjs/Bones/skeleton";
  65898. import { Observable } from "babylonjs/Misc/observable";
  65899. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  65900. import { Texture } from "babylonjs/Materials/Textures/texture";
  65901. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  65902. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  65903. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65904. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  65905. /**
  65906. * Defines the list of states available for a task inside a AssetsManager
  65907. */
  65908. export enum AssetTaskState {
  65909. /**
  65910. * Initialization
  65911. */
  65912. INIT = 0,
  65913. /**
  65914. * Running
  65915. */
  65916. RUNNING = 1,
  65917. /**
  65918. * Done
  65919. */
  65920. DONE = 2,
  65921. /**
  65922. * Error
  65923. */
  65924. ERROR = 3
  65925. }
  65926. /**
  65927. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  65928. */
  65929. export abstract class AbstractAssetTask {
  65930. /**
  65931. * Task name
  65932. */ name: string;
  65933. /**
  65934. * Callback called when the task is successful
  65935. */
  65936. onSuccess: (task: any) => void;
  65937. /**
  65938. * Callback called when the task is not successful
  65939. */
  65940. onError: (task: any, message?: string, exception?: any) => void;
  65941. /**
  65942. * Creates a new AssetsManager
  65943. * @param name defines the name of the task
  65944. */
  65945. constructor(
  65946. /**
  65947. * Task name
  65948. */ name: string);
  65949. private _isCompleted;
  65950. private _taskState;
  65951. private _errorObject;
  65952. /**
  65953. * Get if the task is completed
  65954. */
  65955. readonly isCompleted: boolean;
  65956. /**
  65957. * Gets the current state of the task
  65958. */
  65959. readonly taskState: AssetTaskState;
  65960. /**
  65961. * Gets the current error object (if task is in error)
  65962. */
  65963. readonly errorObject: {
  65964. message?: string;
  65965. exception?: any;
  65966. };
  65967. /**
  65968. * Internal only
  65969. * @hidden
  65970. */
  65971. _setErrorObject(message?: string, exception?: any): void;
  65972. /**
  65973. * Execute the current task
  65974. * @param scene defines the scene where you want your assets to be loaded
  65975. * @param onSuccess is a callback called when the task is successfully executed
  65976. * @param onError is a callback called if an error occurs
  65977. */
  65978. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  65979. /**
  65980. * Execute the current task
  65981. * @param scene defines the scene where you want your assets to be loaded
  65982. * @param onSuccess is a callback called when the task is successfully executed
  65983. * @param onError is a callback called if an error occurs
  65984. */
  65985. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  65986. /**
  65987. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  65988. * This can be used with failed tasks that have the reason for failure fixed.
  65989. */
  65990. reset(): void;
  65991. private onErrorCallback;
  65992. private onDoneCallback;
  65993. }
  65994. /**
  65995. * Define the interface used by progress events raised during assets loading
  65996. */
  65997. export interface IAssetsProgressEvent {
  65998. /**
  65999. * Defines the number of remaining tasks to process
  66000. */
  66001. remainingCount: number;
  66002. /**
  66003. * Defines the total number of tasks
  66004. */
  66005. totalCount: number;
  66006. /**
  66007. * Defines the task that was just processed
  66008. */
  66009. task: AbstractAssetTask;
  66010. }
  66011. /**
  66012. * Class used to share progress information about assets loading
  66013. */
  66014. export class AssetsProgressEvent implements IAssetsProgressEvent {
  66015. /**
  66016. * Defines the number of remaining tasks to process
  66017. */
  66018. remainingCount: number;
  66019. /**
  66020. * Defines the total number of tasks
  66021. */
  66022. totalCount: number;
  66023. /**
  66024. * Defines the task that was just processed
  66025. */
  66026. task: AbstractAssetTask;
  66027. /**
  66028. * Creates a AssetsProgressEvent
  66029. * @param remainingCount defines the number of remaining tasks to process
  66030. * @param totalCount defines the total number of tasks
  66031. * @param task defines the task that was just processed
  66032. */
  66033. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  66034. }
  66035. /**
  66036. * Define a task used by AssetsManager to load meshes
  66037. */
  66038. export class MeshAssetTask extends AbstractAssetTask {
  66039. /**
  66040. * Defines the name of the task
  66041. */
  66042. name: string;
  66043. /**
  66044. * Defines the list of mesh's names you want to load
  66045. */
  66046. meshesNames: any;
  66047. /**
  66048. * Defines the root url to use as a base to load your meshes and associated resources
  66049. */
  66050. rootUrl: string;
  66051. /**
  66052. * Defines the filename of the scene to load from
  66053. */
  66054. sceneFilename: string;
  66055. /**
  66056. * Gets the list of loaded meshes
  66057. */
  66058. loadedMeshes: Array<AbstractMesh>;
  66059. /**
  66060. * Gets the list of loaded particle systems
  66061. */
  66062. loadedParticleSystems: Array<IParticleSystem>;
  66063. /**
  66064. * Gets the list of loaded skeletons
  66065. */
  66066. loadedSkeletons: Array<Skeleton>;
  66067. /**
  66068. * Gets the list of loaded animation groups
  66069. */
  66070. loadedAnimationGroups: Array<AnimationGroup>;
  66071. /**
  66072. * Callback called when the task is successful
  66073. */
  66074. onSuccess: (task: MeshAssetTask) => void;
  66075. /**
  66076. * Callback called when the task is successful
  66077. */
  66078. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  66079. /**
  66080. * Creates a new MeshAssetTask
  66081. * @param name defines the name of the task
  66082. * @param meshesNames defines the list of mesh's names you want to load
  66083. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  66084. * @param sceneFilename defines the filename of the scene to load from
  66085. */
  66086. constructor(
  66087. /**
  66088. * Defines the name of the task
  66089. */
  66090. name: string,
  66091. /**
  66092. * Defines the list of mesh's names you want to load
  66093. */
  66094. meshesNames: any,
  66095. /**
  66096. * Defines the root url to use as a base to load your meshes and associated resources
  66097. */
  66098. rootUrl: string,
  66099. /**
  66100. * Defines the filename of the scene to load from
  66101. */
  66102. sceneFilename: string);
  66103. /**
  66104. * Execute the current task
  66105. * @param scene defines the scene where you want your assets to be loaded
  66106. * @param onSuccess is a callback called when the task is successfully executed
  66107. * @param onError is a callback called if an error occurs
  66108. */
  66109. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66110. }
  66111. /**
  66112. * Define a task used by AssetsManager to load text content
  66113. */
  66114. export class TextFileAssetTask extends AbstractAssetTask {
  66115. /**
  66116. * Defines the name of the task
  66117. */
  66118. name: string;
  66119. /**
  66120. * Defines the location of the file to load
  66121. */
  66122. url: string;
  66123. /**
  66124. * Gets the loaded text string
  66125. */
  66126. text: string;
  66127. /**
  66128. * Callback called when the task is successful
  66129. */
  66130. onSuccess: (task: TextFileAssetTask) => void;
  66131. /**
  66132. * Callback called when the task is successful
  66133. */
  66134. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  66135. /**
  66136. * Creates a new TextFileAssetTask object
  66137. * @param name defines the name of the task
  66138. * @param url defines the location of the file to load
  66139. */
  66140. constructor(
  66141. /**
  66142. * Defines the name of the task
  66143. */
  66144. name: string,
  66145. /**
  66146. * Defines the location of the file to load
  66147. */
  66148. url: string);
  66149. /**
  66150. * Execute the current task
  66151. * @param scene defines the scene where you want your assets to be loaded
  66152. * @param onSuccess is a callback called when the task is successfully executed
  66153. * @param onError is a callback called if an error occurs
  66154. */
  66155. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66156. }
  66157. /**
  66158. * Define a task used by AssetsManager to load binary data
  66159. */
  66160. export class BinaryFileAssetTask extends AbstractAssetTask {
  66161. /**
  66162. * Defines the name of the task
  66163. */
  66164. name: string;
  66165. /**
  66166. * Defines the location of the file to load
  66167. */
  66168. url: string;
  66169. /**
  66170. * Gets the lodaded data (as an array buffer)
  66171. */
  66172. data: ArrayBuffer;
  66173. /**
  66174. * Callback called when the task is successful
  66175. */
  66176. onSuccess: (task: BinaryFileAssetTask) => void;
  66177. /**
  66178. * Callback called when the task is successful
  66179. */
  66180. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  66181. /**
  66182. * Creates a new BinaryFileAssetTask object
  66183. * @param name defines the name of the new task
  66184. * @param url defines the location of the file to load
  66185. */
  66186. constructor(
  66187. /**
  66188. * Defines the name of the task
  66189. */
  66190. name: string,
  66191. /**
  66192. * Defines the location of the file to load
  66193. */
  66194. url: string);
  66195. /**
  66196. * Execute the current task
  66197. * @param scene defines the scene where you want your assets to be loaded
  66198. * @param onSuccess is a callback called when the task is successfully executed
  66199. * @param onError is a callback called if an error occurs
  66200. */
  66201. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66202. }
  66203. /**
  66204. * Define a task used by AssetsManager to load images
  66205. */
  66206. export class ImageAssetTask extends AbstractAssetTask {
  66207. /**
  66208. * Defines the name of the task
  66209. */
  66210. name: string;
  66211. /**
  66212. * Defines the location of the image to load
  66213. */
  66214. url: string;
  66215. /**
  66216. * Gets the loaded images
  66217. */
  66218. image: HTMLImageElement;
  66219. /**
  66220. * Callback called when the task is successful
  66221. */
  66222. onSuccess: (task: ImageAssetTask) => void;
  66223. /**
  66224. * Callback called when the task is successful
  66225. */
  66226. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  66227. /**
  66228. * Creates a new ImageAssetTask
  66229. * @param name defines the name of the task
  66230. * @param url defines the location of the image to load
  66231. */
  66232. constructor(
  66233. /**
  66234. * Defines the name of the task
  66235. */
  66236. name: string,
  66237. /**
  66238. * Defines the location of the image to load
  66239. */
  66240. url: string);
  66241. /**
  66242. * Execute the current task
  66243. * @param scene defines the scene where you want your assets to be loaded
  66244. * @param onSuccess is a callback called when the task is successfully executed
  66245. * @param onError is a callback called if an error occurs
  66246. */
  66247. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66248. }
  66249. /**
  66250. * Defines the interface used by texture loading tasks
  66251. */
  66252. export interface ITextureAssetTask<TEX extends BaseTexture> {
  66253. /**
  66254. * Gets the loaded texture
  66255. */
  66256. texture: TEX;
  66257. }
  66258. /**
  66259. * Define a task used by AssetsManager to load 2D textures
  66260. */
  66261. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  66262. /**
  66263. * Defines the name of the task
  66264. */
  66265. name: string;
  66266. /**
  66267. * Defines the location of the file to load
  66268. */
  66269. url: string;
  66270. /**
  66271. * Defines if mipmap should not be generated (default is false)
  66272. */
  66273. noMipmap?: boolean | undefined;
  66274. /**
  66275. * Defines if texture must be inverted on Y axis (default is false)
  66276. */
  66277. invertY?: boolean | undefined;
  66278. /**
  66279. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66280. */
  66281. samplingMode: number;
  66282. /**
  66283. * Gets the loaded texture
  66284. */
  66285. texture: Texture;
  66286. /**
  66287. * Callback called when the task is successful
  66288. */
  66289. onSuccess: (task: TextureAssetTask) => void;
  66290. /**
  66291. * Callback called when the task is successful
  66292. */
  66293. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  66294. /**
  66295. * Creates a new TextureAssetTask object
  66296. * @param name defines the name of the task
  66297. * @param url defines the location of the file to load
  66298. * @param noMipmap defines if mipmap should not be generated (default is false)
  66299. * @param invertY defines if texture must be inverted on Y axis (default is false)
  66300. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66301. */
  66302. constructor(
  66303. /**
  66304. * Defines the name of the task
  66305. */
  66306. name: string,
  66307. /**
  66308. * Defines the location of the file to load
  66309. */
  66310. url: string,
  66311. /**
  66312. * Defines if mipmap should not be generated (default is false)
  66313. */
  66314. noMipmap?: boolean | undefined,
  66315. /**
  66316. * Defines if texture must be inverted on Y axis (default is false)
  66317. */
  66318. invertY?: boolean | undefined,
  66319. /**
  66320. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66321. */
  66322. samplingMode?: number);
  66323. /**
  66324. * Execute the current task
  66325. * @param scene defines the scene where you want your assets to be loaded
  66326. * @param onSuccess is a callback called when the task is successfully executed
  66327. * @param onError is a callback called if an error occurs
  66328. */
  66329. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66330. }
  66331. /**
  66332. * Define a task used by AssetsManager to load cube textures
  66333. */
  66334. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  66335. /**
  66336. * Defines the name of the task
  66337. */
  66338. name: string;
  66339. /**
  66340. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66341. */
  66342. url: string;
  66343. /**
  66344. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66345. */
  66346. extensions?: string[] | undefined;
  66347. /**
  66348. * Defines if mipmaps should not be generated (default is false)
  66349. */
  66350. noMipmap?: boolean | undefined;
  66351. /**
  66352. * Defines the explicit list of files (undefined by default)
  66353. */
  66354. files?: string[] | undefined;
  66355. /**
  66356. * Gets the loaded texture
  66357. */
  66358. texture: CubeTexture;
  66359. /**
  66360. * Callback called when the task is successful
  66361. */
  66362. onSuccess: (task: CubeTextureAssetTask) => void;
  66363. /**
  66364. * Callback called when the task is successful
  66365. */
  66366. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  66367. /**
  66368. * Creates a new CubeTextureAssetTask
  66369. * @param name defines the name of the task
  66370. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66371. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66372. * @param noMipmap defines if mipmaps should not be generated (default is false)
  66373. * @param files defines the explicit list of files (undefined by default)
  66374. */
  66375. constructor(
  66376. /**
  66377. * Defines the name of the task
  66378. */
  66379. name: string,
  66380. /**
  66381. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66382. */
  66383. url: string,
  66384. /**
  66385. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66386. */
  66387. extensions?: string[] | undefined,
  66388. /**
  66389. * Defines if mipmaps should not be generated (default is false)
  66390. */
  66391. noMipmap?: boolean | undefined,
  66392. /**
  66393. * Defines the explicit list of files (undefined by default)
  66394. */
  66395. files?: string[] | undefined);
  66396. /**
  66397. * Execute the current task
  66398. * @param scene defines the scene where you want your assets to be loaded
  66399. * @param onSuccess is a callback called when the task is successfully executed
  66400. * @param onError is a callback called if an error occurs
  66401. */
  66402. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66403. }
  66404. /**
  66405. * Define a task used by AssetsManager to load HDR cube textures
  66406. */
  66407. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  66408. /**
  66409. * Defines the name of the task
  66410. */
  66411. name: string;
  66412. /**
  66413. * Defines the location of the file to load
  66414. */
  66415. url: string;
  66416. /**
  66417. * Defines the desired size (the more it increases the longer the generation will be)
  66418. */
  66419. size: number;
  66420. /**
  66421. * Defines if mipmaps should not be generated (default is false)
  66422. */
  66423. noMipmap: boolean;
  66424. /**
  66425. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  66426. */
  66427. generateHarmonics: boolean;
  66428. /**
  66429. * 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)
  66430. */
  66431. gammaSpace: boolean;
  66432. /**
  66433. * Internal Use Only
  66434. */
  66435. reserved: boolean;
  66436. /**
  66437. * Gets the loaded texture
  66438. */
  66439. texture: HDRCubeTexture;
  66440. /**
  66441. * Callback called when the task is successful
  66442. */
  66443. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  66444. /**
  66445. * Callback called when the task is successful
  66446. */
  66447. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  66448. /**
  66449. * Creates a new HDRCubeTextureAssetTask object
  66450. * @param name defines the name of the task
  66451. * @param url defines the location of the file to load
  66452. * @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.
  66453. * @param noMipmap defines if mipmaps should not be generated (default is false)
  66454. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  66455. * @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)
  66456. * @param reserved Internal use only
  66457. */
  66458. constructor(
  66459. /**
  66460. * Defines the name of the task
  66461. */
  66462. name: string,
  66463. /**
  66464. * Defines the location of the file to load
  66465. */
  66466. url: string,
  66467. /**
  66468. * Defines the desired size (the more it increases the longer the generation will be)
  66469. */
  66470. size: number,
  66471. /**
  66472. * Defines if mipmaps should not be generated (default is false)
  66473. */
  66474. noMipmap?: boolean,
  66475. /**
  66476. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  66477. */
  66478. generateHarmonics?: boolean,
  66479. /**
  66480. * 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)
  66481. */
  66482. gammaSpace?: boolean,
  66483. /**
  66484. * Internal Use Only
  66485. */
  66486. reserved?: boolean);
  66487. /**
  66488. * Execute the current task
  66489. * @param scene defines the scene where you want your assets to be loaded
  66490. * @param onSuccess is a callback called when the task is successfully executed
  66491. * @param onError is a callback called if an error occurs
  66492. */
  66493. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66494. }
  66495. /**
  66496. * Define a task used by AssetsManager to load Equirectangular cube textures
  66497. */
  66498. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  66499. /**
  66500. * Defines the name of the task
  66501. */
  66502. name: string;
  66503. /**
  66504. * Defines the location of the file to load
  66505. */
  66506. url: string;
  66507. /**
  66508. * Defines the desired size (the more it increases the longer the generation will be)
  66509. */
  66510. size: number;
  66511. /**
  66512. * Defines if mipmaps should not be generated (default is false)
  66513. */
  66514. noMipmap: boolean;
  66515. /**
  66516. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  66517. * but the standard material would require them in Gamma space) (default is true)
  66518. */
  66519. gammaSpace: boolean;
  66520. /**
  66521. * Gets the loaded texture
  66522. */
  66523. texture: EquiRectangularCubeTexture;
  66524. /**
  66525. * Callback called when the task is successful
  66526. */
  66527. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  66528. /**
  66529. * Callback called when the task is successful
  66530. */
  66531. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  66532. /**
  66533. * Creates a new EquiRectangularCubeTextureAssetTask object
  66534. * @param name defines the name of the task
  66535. * @param url defines the location of the file to load
  66536. * @param size defines the desired size (the more it increases the longer the generation will be)
  66537. * If the size is omitted this implies you are using a preprocessed cubemap.
  66538. * @param noMipmap defines if mipmaps should not be generated (default is false)
  66539. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  66540. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  66541. * (default is true)
  66542. */
  66543. constructor(
  66544. /**
  66545. * Defines the name of the task
  66546. */
  66547. name: string,
  66548. /**
  66549. * Defines the location of the file to load
  66550. */
  66551. url: string,
  66552. /**
  66553. * Defines the desired size (the more it increases the longer the generation will be)
  66554. */
  66555. size: number,
  66556. /**
  66557. * Defines if mipmaps should not be generated (default is false)
  66558. */
  66559. noMipmap?: boolean,
  66560. /**
  66561. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  66562. * but the standard material would require them in Gamma space) (default is true)
  66563. */
  66564. gammaSpace?: boolean);
  66565. /**
  66566. * Execute the current task
  66567. * @param scene defines the scene where you want your assets to be loaded
  66568. * @param onSuccess is a callback called when the task is successfully executed
  66569. * @param onError is a callback called if an error occurs
  66570. */
  66571. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66572. }
  66573. /**
  66574. * This class can be used to easily import assets into a scene
  66575. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  66576. */
  66577. export class AssetsManager {
  66578. private _scene;
  66579. private _isLoading;
  66580. protected _tasks: AbstractAssetTask[];
  66581. protected _waitingTasksCount: number;
  66582. protected _totalTasksCount: number;
  66583. /**
  66584. * Callback called when all tasks are processed
  66585. */
  66586. onFinish: (tasks: AbstractAssetTask[]) => void;
  66587. /**
  66588. * Callback called when a task is successful
  66589. */
  66590. onTaskSuccess: (task: AbstractAssetTask) => void;
  66591. /**
  66592. * Callback called when a task had an error
  66593. */
  66594. onTaskError: (task: AbstractAssetTask) => void;
  66595. /**
  66596. * Callback called when a task is done (whatever the result is)
  66597. */
  66598. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  66599. /**
  66600. * Observable called when all tasks are processed
  66601. */
  66602. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  66603. /**
  66604. * Observable called when a task had an error
  66605. */
  66606. onTaskErrorObservable: Observable<AbstractAssetTask>;
  66607. /**
  66608. * Observable called when all tasks were executed
  66609. */
  66610. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  66611. /**
  66612. * Observable called when a task is done (whatever the result is)
  66613. */
  66614. onProgressObservable: Observable<IAssetsProgressEvent>;
  66615. /**
  66616. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  66617. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  66618. */
  66619. useDefaultLoadingScreen: boolean;
  66620. /**
  66621. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  66622. * when all assets have been downloaded.
  66623. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  66624. */
  66625. autoHideLoadingUI: boolean;
  66626. /**
  66627. * Creates a new AssetsManager
  66628. * @param scene defines the scene to work on
  66629. */
  66630. constructor(scene: Scene);
  66631. /**
  66632. * Add a MeshAssetTask to the list of active tasks
  66633. * @param taskName defines the name of the new task
  66634. * @param meshesNames defines the name of meshes to load
  66635. * @param rootUrl defines the root url to use to locate files
  66636. * @param sceneFilename defines the filename of the scene file
  66637. * @returns a new MeshAssetTask object
  66638. */
  66639. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  66640. /**
  66641. * Add a TextFileAssetTask to the list of active tasks
  66642. * @param taskName defines the name of the new task
  66643. * @param url defines the url of the file to load
  66644. * @returns a new TextFileAssetTask object
  66645. */
  66646. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  66647. /**
  66648. * Add a BinaryFileAssetTask to the list of active tasks
  66649. * @param taskName defines the name of the new task
  66650. * @param url defines the url of the file to load
  66651. * @returns a new BinaryFileAssetTask object
  66652. */
  66653. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  66654. /**
  66655. * Add a ImageAssetTask to the list of active tasks
  66656. * @param taskName defines the name of the new task
  66657. * @param url defines the url of the file to load
  66658. * @returns a new ImageAssetTask object
  66659. */
  66660. addImageTask(taskName: string, url: string): ImageAssetTask;
  66661. /**
  66662. * Add a TextureAssetTask to the list of active tasks
  66663. * @param taskName defines the name of the new task
  66664. * @param url defines the url of the file to load
  66665. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66666. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  66667. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  66668. * @returns a new TextureAssetTask object
  66669. */
  66670. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  66671. /**
  66672. * Add a CubeTextureAssetTask to the list of active tasks
  66673. * @param taskName defines the name of the new task
  66674. * @param url defines the url of the file to load
  66675. * @param extensions defines the extension to use to load the cube map (can be null)
  66676. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66677. * @param files defines the list of files to load (can be null)
  66678. * @returns a new CubeTextureAssetTask object
  66679. */
  66680. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  66681. /**
  66682. *
  66683. * Add a HDRCubeTextureAssetTask to the list of active tasks
  66684. * @param taskName defines the name of the new task
  66685. * @param url defines the url of the file to load
  66686. * @param size defines the size you want for the cubemap (can be null)
  66687. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66688. * @param generateHarmonics defines if you want to automatically generate (true by default)
  66689. * @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)
  66690. * @param reserved Internal use only
  66691. * @returns a new HDRCubeTextureAssetTask object
  66692. */
  66693. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  66694. /**
  66695. *
  66696. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  66697. * @param taskName defines the name of the new task
  66698. * @param url defines the url of the file to load
  66699. * @param size defines the size you want for the cubemap (can be null)
  66700. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66701. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  66702. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  66703. * @returns a new EquiRectangularCubeTextureAssetTask object
  66704. */
  66705. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  66706. /**
  66707. * Remove a task from the assets manager.
  66708. * @param task the task to remove
  66709. */
  66710. removeTask(task: AbstractAssetTask): void;
  66711. private _decreaseWaitingTasksCount;
  66712. private _runTask;
  66713. /**
  66714. * Reset the AssetsManager and remove all tasks
  66715. * @return the current instance of the AssetsManager
  66716. */
  66717. reset(): AssetsManager;
  66718. /**
  66719. * Start the loading process
  66720. * @return the current instance of the AssetsManager
  66721. */
  66722. load(): AssetsManager;
  66723. /**
  66724. * Start the loading process as an async operation
  66725. * @return a promise returning the list of failed tasks
  66726. */
  66727. loadAsync(): Promise<void>;
  66728. }
  66729. }
  66730. declare module "babylonjs/Misc/deferred" {
  66731. /**
  66732. * Wrapper class for promise with external resolve and reject.
  66733. */
  66734. export class Deferred<T> {
  66735. /**
  66736. * The promise associated with this deferred object.
  66737. */
  66738. readonly promise: Promise<T>;
  66739. private _resolve;
  66740. private _reject;
  66741. /**
  66742. * The resolve method of the promise associated with this deferred object.
  66743. */
  66744. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  66745. /**
  66746. * The reject method of the promise associated with this deferred object.
  66747. */
  66748. readonly reject: (reason?: any) => void;
  66749. /**
  66750. * Constructor for this deferred object.
  66751. */
  66752. constructor();
  66753. }
  66754. }
  66755. declare module "babylonjs/Misc/meshExploder" {
  66756. import { Mesh } from "babylonjs/Meshes/mesh";
  66757. /**
  66758. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  66759. */
  66760. export class MeshExploder {
  66761. private _centerMesh;
  66762. private _meshes;
  66763. private _meshesOrigins;
  66764. private _toCenterVectors;
  66765. private _scaledDirection;
  66766. private _newPosition;
  66767. private _centerPosition;
  66768. /**
  66769. * Explodes meshes from a center mesh.
  66770. * @param meshes The meshes to explode.
  66771. * @param centerMesh The mesh to be center of explosion.
  66772. */
  66773. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  66774. private _setCenterMesh;
  66775. /**
  66776. * Get class name
  66777. * @returns "MeshExploder"
  66778. */
  66779. getClassName(): string;
  66780. /**
  66781. * "Exploded meshes"
  66782. * @returns Array of meshes with the centerMesh at index 0.
  66783. */
  66784. getMeshes(): Array<Mesh>;
  66785. /**
  66786. * Explodes meshes giving a specific direction
  66787. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  66788. */
  66789. explode(direction?: number): void;
  66790. }
  66791. }
  66792. declare module "babylonjs/Misc/filesInput" {
  66793. import { Engine } from "babylonjs/Engines/engine";
  66794. import { Scene } from "babylonjs/scene";
  66795. import { SceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  66796. /**
  66797. * Class used to help managing file picking and drag'n'drop
  66798. */
  66799. export class FilesInput {
  66800. /**
  66801. * List of files ready to be loaded
  66802. */
  66803. static readonly FilesToLoad: {
  66804. [key: string]: File;
  66805. };
  66806. /**
  66807. * Callback called when a file is processed
  66808. */
  66809. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  66810. private _engine;
  66811. private _currentScene;
  66812. private _sceneLoadedCallback;
  66813. private _progressCallback;
  66814. private _additionalRenderLoopLogicCallback;
  66815. private _textureLoadingCallback;
  66816. private _startingProcessingFilesCallback;
  66817. private _onReloadCallback;
  66818. private _errorCallback;
  66819. private _elementToMonitor;
  66820. private _sceneFileToLoad;
  66821. private _filesToLoad;
  66822. /**
  66823. * Creates a new FilesInput
  66824. * @param engine defines the rendering engine
  66825. * @param scene defines the hosting scene
  66826. * @param sceneLoadedCallback callback called when scene is loaded
  66827. * @param progressCallback callback called to track progress
  66828. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  66829. * @param textureLoadingCallback callback called when a texture is loading
  66830. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  66831. * @param onReloadCallback callback called when a reload is requested
  66832. * @param errorCallback callback call if an error occurs
  66833. */
  66834. constructor(engine: Engine, scene: Scene, sceneLoadedCallback: (sceneFile: File, scene: Scene) => void, progressCallback: (progress: SceneLoaderProgressEvent) => void, additionalRenderLoopLogicCallback: () => void, textureLoadingCallback: (remaining: number) => void, startingProcessingFilesCallback: (files?: File[]) => void, onReloadCallback: (sceneFile: File) => void, errorCallback: (sceneFile: File, scene: Scene, message: string) => void);
  66835. private _dragEnterHandler;
  66836. private _dragOverHandler;
  66837. private _dropHandler;
  66838. /**
  66839. * Calls this function to listen to drag'n'drop events on a specific DOM element
  66840. * @param elementToMonitor defines the DOM element to track
  66841. */
  66842. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  66843. /**
  66844. * Release all associated resources
  66845. */
  66846. dispose(): void;
  66847. private renderFunction;
  66848. private drag;
  66849. private drop;
  66850. private _traverseFolder;
  66851. private _processFiles;
  66852. /**
  66853. * Load files from a drop event
  66854. * @param event defines the drop event to use as source
  66855. */
  66856. loadFiles(event: any): void;
  66857. private _processReload;
  66858. /**
  66859. * Reload the current scene from the loaded files
  66860. */
  66861. reload(): void;
  66862. }
  66863. }
  66864. declare module "babylonjs/Misc/HighDynamicRange/index" {
  66865. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  66866. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  66867. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  66868. }
  66869. declare module "babylonjs/Misc/sceneOptimizer" {
  66870. import { Scene, IDisposable } from "babylonjs/scene";
  66871. import { Observable } from "babylonjs/Misc/observable";
  66872. /**
  66873. * Defines the root class used to create scene optimization to use with SceneOptimizer
  66874. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  66875. */
  66876. export class SceneOptimization {
  66877. /**
  66878. * Defines the priority of this optimization (0 by default which means first in the list)
  66879. */
  66880. priority: number;
  66881. /**
  66882. * Gets a string describing the action executed by the current optimization
  66883. * @returns description string
  66884. */
  66885. getDescription(): string;
  66886. /**
  66887. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  66888. * @param scene defines the current scene where to apply this optimization
  66889. * @param optimizer defines the current optimizer
  66890. * @returns true if everything that can be done was applied
  66891. */
  66892. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  66893. /**
  66894. * Creates the SceneOptimization object
  66895. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  66896. * @param desc defines the description associated with the optimization
  66897. */
  66898. constructor(
  66899. /**
  66900. * Defines the priority of this optimization (0 by default which means first in the list)
  66901. */
  66902. priority?: number);
  66903. }
  66904. /**
  66905. * Defines an optimization used to reduce the size of render target textures
  66906. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  66907. */
  66908. export class TextureOptimization extends SceneOptimization {
  66909. /**
  66910. * Defines the priority of this optimization (0 by default which means first in the list)
  66911. */
  66912. priority: number;
  66913. /**
  66914. * 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
  66915. */
  66916. maximumSize: number;
  66917. /**
  66918. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  66919. */
  66920. step: number;
  66921. /**
  66922. * Gets a string describing the action executed by the current optimization
  66923. * @returns description string
  66924. */
  66925. getDescription(): string;
  66926. /**
  66927. * Creates the TextureOptimization object
  66928. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  66929. * @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
  66930. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  66931. */
  66932. constructor(
  66933. /**
  66934. * Defines the priority of this optimization (0 by default which means first in the list)
  66935. */
  66936. priority?: number,
  66937. /**
  66938. * 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
  66939. */
  66940. maximumSize?: number,
  66941. /**
  66942. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  66943. */
  66944. step?: number);
  66945. /**
  66946. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  66947. * @param scene defines the current scene where to apply this optimization
  66948. * @param optimizer defines the current optimizer
  66949. * @returns true if everything that can be done was applied
  66950. */
  66951. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  66952. }
  66953. /**
  66954. * Defines an optimization used to increase or decrease the rendering resolution
  66955. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  66956. */
  66957. export class HardwareScalingOptimization extends SceneOptimization {
  66958. /**
  66959. * Defines the priority of this optimization (0 by default which means first in the list)
  66960. */
  66961. priority: number;
  66962. /**
  66963. * Defines the maximum scale to use (2 by default)
  66964. */
  66965. maximumScale: number;
  66966. /**
  66967. * Defines the step to use between two passes (0.5 by default)
  66968. */
  66969. step: number;
  66970. private _currentScale;
  66971. private _directionOffset;
  66972. /**
  66973. * Gets a string describing the action executed by the current optimization
  66974. * @return description string
  66975. */
  66976. getDescription(): string;
  66977. /**
  66978. * Creates the HardwareScalingOptimization object
  66979. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  66980. * @param maximumScale defines the maximum scale to use (2 by default)
  66981. * @param step defines the step to use between two passes (0.5 by default)
  66982. */
  66983. constructor(
  66984. /**
  66985. * Defines the priority of this optimization (0 by default which means first in the list)
  66986. */
  66987. priority?: number,
  66988. /**
  66989. * Defines the maximum scale to use (2 by default)
  66990. */
  66991. maximumScale?: number,
  66992. /**
  66993. * Defines the step to use between two passes (0.5 by default)
  66994. */
  66995. step?: number);
  66996. /**
  66997. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  66998. * @param scene defines the current scene where to apply this optimization
  66999. * @param optimizer defines the current optimizer
  67000. * @returns true if everything that can be done was applied
  67001. */
  67002. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67003. }
  67004. /**
  67005. * Defines an optimization used to remove shadows
  67006. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67007. */
  67008. export class ShadowsOptimization extends SceneOptimization {
  67009. /**
  67010. * Gets a string describing the action executed by the current optimization
  67011. * @return description string
  67012. */
  67013. getDescription(): string;
  67014. /**
  67015. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67016. * @param scene defines the current scene where to apply this optimization
  67017. * @param optimizer defines the current optimizer
  67018. * @returns true if everything that can be done was applied
  67019. */
  67020. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67021. }
  67022. /**
  67023. * Defines an optimization used to turn post-processes off
  67024. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67025. */
  67026. export class PostProcessesOptimization extends SceneOptimization {
  67027. /**
  67028. * Gets a string describing the action executed by the current optimization
  67029. * @return description string
  67030. */
  67031. getDescription(): string;
  67032. /**
  67033. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67034. * @param scene defines the current scene where to apply this optimization
  67035. * @param optimizer defines the current optimizer
  67036. * @returns true if everything that can be done was applied
  67037. */
  67038. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67039. }
  67040. /**
  67041. * Defines an optimization used to turn lens flares off
  67042. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67043. */
  67044. export class LensFlaresOptimization extends SceneOptimization {
  67045. /**
  67046. * Gets a string describing the action executed by the current optimization
  67047. * @return description string
  67048. */
  67049. getDescription(): string;
  67050. /**
  67051. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67052. * @param scene defines the current scene where to apply this optimization
  67053. * @param optimizer defines the current optimizer
  67054. * @returns true if everything that can be done was applied
  67055. */
  67056. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67057. }
  67058. /**
  67059. * Defines an optimization based on user defined callback.
  67060. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67061. */
  67062. export class CustomOptimization extends SceneOptimization {
  67063. /**
  67064. * Callback called to apply the custom optimization.
  67065. */
  67066. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  67067. /**
  67068. * Callback called to get custom description
  67069. */
  67070. onGetDescription: () => string;
  67071. /**
  67072. * Gets a string describing the action executed by the current optimization
  67073. * @returns description string
  67074. */
  67075. getDescription(): string;
  67076. /**
  67077. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67078. * @param scene defines the current scene where to apply this optimization
  67079. * @param optimizer defines the current optimizer
  67080. * @returns true if everything that can be done was applied
  67081. */
  67082. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67083. }
  67084. /**
  67085. * Defines an optimization used to turn particles off
  67086. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67087. */
  67088. export class ParticlesOptimization extends SceneOptimization {
  67089. /**
  67090. * Gets a string describing the action executed by the current optimization
  67091. * @return description string
  67092. */
  67093. getDescription(): string;
  67094. /**
  67095. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67096. * @param scene defines the current scene where to apply this optimization
  67097. * @param optimizer defines the current optimizer
  67098. * @returns true if everything that can be done was applied
  67099. */
  67100. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67101. }
  67102. /**
  67103. * Defines an optimization used to turn render targets off
  67104. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67105. */
  67106. export class RenderTargetsOptimization extends SceneOptimization {
  67107. /**
  67108. * Gets a string describing the action executed by the current optimization
  67109. * @return description string
  67110. */
  67111. getDescription(): string;
  67112. /**
  67113. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67114. * @param scene defines the current scene where to apply this optimization
  67115. * @param optimizer defines the current optimizer
  67116. * @returns true if everything that can be done was applied
  67117. */
  67118. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67119. }
  67120. /**
  67121. * Defines an optimization used to merge meshes with compatible materials
  67122. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67123. */
  67124. export class MergeMeshesOptimization extends SceneOptimization {
  67125. private static _UpdateSelectionTree;
  67126. /**
  67127. * Gets or sets a boolean which defines if optimization octree has to be updated
  67128. */
  67129. /**
  67130. * Gets or sets a boolean which defines if optimization octree has to be updated
  67131. */
  67132. static UpdateSelectionTree: boolean;
  67133. /**
  67134. * Gets a string describing the action executed by the current optimization
  67135. * @return description string
  67136. */
  67137. getDescription(): string;
  67138. private _canBeMerged;
  67139. /**
  67140. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67141. * @param scene defines the current scene where to apply this optimization
  67142. * @param optimizer defines the current optimizer
  67143. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  67144. * @returns true if everything that can be done was applied
  67145. */
  67146. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  67147. }
  67148. /**
  67149. * Defines a list of options used by SceneOptimizer
  67150. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67151. */
  67152. export class SceneOptimizerOptions {
  67153. /**
  67154. * Defines the target frame rate to reach (60 by default)
  67155. */
  67156. targetFrameRate: number;
  67157. /**
  67158. * Defines the interval between two checkes (2000ms by default)
  67159. */
  67160. trackerDuration: number;
  67161. /**
  67162. * Gets the list of optimizations to apply
  67163. */
  67164. optimizations: SceneOptimization[];
  67165. /**
  67166. * Creates a new list of options used by SceneOptimizer
  67167. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  67168. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  67169. */
  67170. constructor(
  67171. /**
  67172. * Defines the target frame rate to reach (60 by default)
  67173. */
  67174. targetFrameRate?: number,
  67175. /**
  67176. * Defines the interval between two checkes (2000ms by default)
  67177. */
  67178. trackerDuration?: number);
  67179. /**
  67180. * Add a new optimization
  67181. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  67182. * @returns the current SceneOptimizerOptions
  67183. */
  67184. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  67185. /**
  67186. * Add a new custom optimization
  67187. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  67188. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  67189. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67190. * @returns the current SceneOptimizerOptions
  67191. */
  67192. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  67193. /**
  67194. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  67195. * @param targetFrameRate defines the target frame rate (60 by default)
  67196. * @returns a SceneOptimizerOptions object
  67197. */
  67198. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67199. /**
  67200. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  67201. * @param targetFrameRate defines the target frame rate (60 by default)
  67202. * @returns a SceneOptimizerOptions object
  67203. */
  67204. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67205. /**
  67206. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  67207. * @param targetFrameRate defines the target frame rate (60 by default)
  67208. * @returns a SceneOptimizerOptions object
  67209. */
  67210. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67211. }
  67212. /**
  67213. * Class used to run optimizations in order to reach a target frame rate
  67214. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67215. */
  67216. export class SceneOptimizer implements IDisposable {
  67217. private _isRunning;
  67218. private _options;
  67219. private _scene;
  67220. private _currentPriorityLevel;
  67221. private _targetFrameRate;
  67222. private _trackerDuration;
  67223. private _currentFrameRate;
  67224. private _sceneDisposeObserver;
  67225. private _improvementMode;
  67226. /**
  67227. * Defines an observable called when the optimizer reaches the target frame rate
  67228. */
  67229. onSuccessObservable: Observable<SceneOptimizer>;
  67230. /**
  67231. * Defines an observable called when the optimizer enables an optimization
  67232. */
  67233. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  67234. /**
  67235. * Defines an observable called when the optimizer is not able to reach the target frame rate
  67236. */
  67237. onFailureObservable: Observable<SceneOptimizer>;
  67238. /**
  67239. * Gets a boolean indicating if the optimizer is in improvement mode
  67240. */
  67241. readonly isInImprovementMode: boolean;
  67242. /**
  67243. * Gets the current priority level (0 at start)
  67244. */
  67245. readonly currentPriorityLevel: number;
  67246. /**
  67247. * Gets the current frame rate checked by the SceneOptimizer
  67248. */
  67249. readonly currentFrameRate: number;
  67250. /**
  67251. * Gets or sets the current target frame rate (60 by default)
  67252. */
  67253. /**
  67254. * Gets or sets the current target frame rate (60 by default)
  67255. */
  67256. targetFrameRate: number;
  67257. /**
  67258. * Gets or sets the current interval between two checks (every 2000ms by default)
  67259. */
  67260. /**
  67261. * Gets or sets the current interval between two checks (every 2000ms by default)
  67262. */
  67263. trackerDuration: number;
  67264. /**
  67265. * Gets the list of active optimizations
  67266. */
  67267. readonly optimizations: SceneOptimization[];
  67268. /**
  67269. * Creates a new SceneOptimizer
  67270. * @param scene defines the scene to work on
  67271. * @param options defines the options to use with the SceneOptimizer
  67272. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  67273. * @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)
  67274. */
  67275. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  67276. /**
  67277. * Stops the current optimizer
  67278. */
  67279. stop(): void;
  67280. /**
  67281. * Reset the optimizer to initial step (current priority level = 0)
  67282. */
  67283. reset(): void;
  67284. /**
  67285. * Start the optimizer. By default it will try to reach a specific framerate
  67286. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  67287. */
  67288. start(): void;
  67289. private _checkCurrentState;
  67290. /**
  67291. * Release all resources
  67292. */
  67293. dispose(): void;
  67294. /**
  67295. * Helper function to create a SceneOptimizer with one single line of code
  67296. * @param scene defines the scene to work on
  67297. * @param options defines the options to use with the SceneOptimizer
  67298. * @param onSuccess defines a callback to call on success
  67299. * @param onFailure defines a callback to call on failure
  67300. * @returns the new SceneOptimizer object
  67301. */
  67302. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  67303. }
  67304. }
  67305. declare module "babylonjs/Misc/sceneSerializer" {
  67306. import { Scene } from "babylonjs/scene";
  67307. /**
  67308. * Class used to serialize a scene into a string
  67309. */
  67310. export class SceneSerializer {
  67311. /**
  67312. * Clear cache used by a previous serialization
  67313. */
  67314. static ClearCache(): void;
  67315. /**
  67316. * Serialize a scene into a JSON compatible object
  67317. * @param scene defines the scene to serialize
  67318. * @returns a JSON compatible object
  67319. */
  67320. static Serialize(scene: Scene): any;
  67321. /**
  67322. * Serialize a mesh into a JSON compatible object
  67323. * @param toSerialize defines the mesh to serialize
  67324. * @param withParents defines if parents must be serialized as well
  67325. * @param withChildren defines if children must be serialized as well
  67326. * @returns a JSON compatible object
  67327. */
  67328. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  67329. }
  67330. }
  67331. declare module "babylonjs/Misc/textureTools" {
  67332. import { Texture } from "babylonjs/Materials/Textures/texture";
  67333. /**
  67334. * Class used to host texture specific utilities
  67335. */
  67336. export class TextureTools {
  67337. /**
  67338. * Uses the GPU to create a copy texture rescaled at a given size
  67339. * @param texture Texture to copy from
  67340. * @param width defines the desired width
  67341. * @param height defines the desired height
  67342. * @param useBilinearMode defines if bilinear mode has to be used
  67343. * @return the generated texture
  67344. */
  67345. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  67346. }
  67347. }
  67348. declare module "babylonjs/Misc/videoRecorder" {
  67349. import { Nullable } from "babylonjs/types";
  67350. import { Engine } from "babylonjs/Engines/engine";
  67351. /**
  67352. * This represents the different options available for the video capture.
  67353. */
  67354. export interface VideoRecorderOptions {
  67355. /** Defines the mime type of the video. */
  67356. mimeType: string;
  67357. /** Defines the FPS the video should be recorded at. */
  67358. fps: number;
  67359. /** Defines the chunk size for the recording data. */
  67360. recordChunckSize: number;
  67361. /** The audio tracks to attach to the recording. */
  67362. audioTracks?: MediaStreamTrack[];
  67363. }
  67364. /**
  67365. * This can help with recording videos from BabylonJS.
  67366. * This is based on the available WebRTC functionalities of the browser.
  67367. *
  67368. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  67369. */
  67370. export class VideoRecorder {
  67371. private static readonly _defaultOptions;
  67372. /**
  67373. * Returns whether or not the VideoRecorder is available in your browser.
  67374. * @param engine Defines the Babylon Engine.
  67375. * @returns true if supported otherwise false.
  67376. */
  67377. static IsSupported(engine: Engine): boolean;
  67378. private readonly _options;
  67379. private _canvas;
  67380. private _mediaRecorder;
  67381. private _recordedChunks;
  67382. private _fileName;
  67383. private _resolve;
  67384. private _reject;
  67385. /**
  67386. * True when a recording is already in progress.
  67387. */
  67388. readonly isRecording: boolean;
  67389. /**
  67390. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  67391. * @param engine Defines the BabylonJS Engine you wish to record.
  67392. * @param options Defines options that can be used to customize the capture.
  67393. */
  67394. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  67395. /**
  67396. * Stops the current recording before the default capture timeout passed in the startRecording function.
  67397. */
  67398. stopRecording(): void;
  67399. /**
  67400. * Starts recording the canvas for a max duration specified in parameters.
  67401. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  67402. * If null no automatic download will start and you can rely on the promise to get the data back.
  67403. * @param maxDuration Defines the maximum recording time in seconds.
  67404. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  67405. * @return A promise callback at the end of the recording with the video data in Blob.
  67406. */
  67407. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  67408. /**
  67409. * Releases internal resources used during the recording.
  67410. */
  67411. dispose(): void;
  67412. private _handleDataAvailable;
  67413. private _handleError;
  67414. private _handleStop;
  67415. }
  67416. }
  67417. declare module "babylonjs/Misc/screenshotTools" {
  67418. import { Camera } from "babylonjs/Cameras/camera";
  67419. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  67420. import { Engine } from "babylonjs/Engines/engine";
  67421. /**
  67422. * Class containing a set of static utilities functions for screenshots
  67423. */
  67424. export class ScreenshotTools {
  67425. /**
  67426. * Captures a screenshot of the current rendering
  67427. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67428. * @param engine defines the rendering engine
  67429. * @param camera defines the source camera
  67430. * @param size This parameter can be set to a single number or to an object with the
  67431. * following (optional) properties: precision, width, height. If a single number is passed,
  67432. * it will be used for both width and height. If an object is passed, the screenshot size
  67433. * will be derived from the parameters. The precision property is a multiplier allowing
  67434. * rendering at a higher or lower resolution
  67435. * @param successCallback defines the callback receives a single parameter which contains the
  67436. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  67437. * src parameter of an <img> to display it
  67438. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  67439. * Check your browser for supported MIME types
  67440. */
  67441. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  67442. /**
  67443. * Captures a screenshot of the current rendering
  67444. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67445. * @param engine defines the rendering engine
  67446. * @param camera defines the source camera
  67447. * @param size This parameter can be set to a single number or to an object with the
  67448. * following (optional) properties: precision, width, height. If a single number is passed,
  67449. * it will be used for both width and height. If an object is passed, the screenshot size
  67450. * will be derived from the parameters. The precision property is a multiplier allowing
  67451. * rendering at a higher or lower resolution
  67452. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  67453. * Check your browser for supported MIME types
  67454. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  67455. * to the src parameter of an <img> to display it
  67456. */
  67457. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  67458. /**
  67459. * Generates an image screenshot from the specified camera.
  67460. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67461. * @param engine The engine to use for rendering
  67462. * @param camera The camera to use for rendering
  67463. * @param size This parameter can be set to a single number or to an object with the
  67464. * following (optional) properties: precision, width, height. If a single number is passed,
  67465. * it will be used for both width and height. If an object is passed, the screenshot size
  67466. * will be derived from the parameters. The precision property is a multiplier allowing
  67467. * rendering at a higher or lower resolution
  67468. * @param successCallback The callback receives a single parameter which contains the
  67469. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  67470. * src parameter of an <img> to display it
  67471. * @param mimeType The MIME type of the screenshot image (default: image/png).
  67472. * Check your browser for supported MIME types
  67473. * @param samples Texture samples (default: 1)
  67474. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  67475. * @param fileName A name for for the downloaded file.
  67476. */
  67477. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  67478. /**
  67479. * Generates an image screenshot from the specified camera.
  67480. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67481. * @param engine The engine to use for rendering
  67482. * @param camera The camera to use for rendering
  67483. * @param size This parameter can be set to a single number or to an object with the
  67484. * following (optional) properties: precision, width, height. If a single number is passed,
  67485. * it will be used for both width and height. If an object is passed, the screenshot size
  67486. * will be derived from the parameters. The precision property is a multiplier allowing
  67487. * rendering at a higher or lower resolution
  67488. * @param mimeType The MIME type of the screenshot image (default: image/png).
  67489. * Check your browser for supported MIME types
  67490. * @param samples Texture samples (default: 1)
  67491. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  67492. * @param fileName A name for for the downloaded file.
  67493. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  67494. * to the src parameter of an <img> to display it
  67495. */
  67496. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  67497. /**
  67498. * Gets height and width for screenshot size
  67499. * @private
  67500. */
  67501. private static _getScreenshotSize;
  67502. }
  67503. }
  67504. declare module "babylonjs/Misc/dataReader" {
  67505. /**
  67506. * Interface for a data buffer
  67507. */
  67508. export interface IDataBuffer {
  67509. /**
  67510. * Reads bytes from the data buffer.
  67511. * @param byteOffset The byte offset to read
  67512. * @param byteLength The byte length to read
  67513. * @returns A promise that resolves when the bytes are read
  67514. */
  67515. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  67516. /**
  67517. * The byte length of the buffer.
  67518. */
  67519. readonly byteLength: number;
  67520. }
  67521. /**
  67522. * Utility class for reading from a data buffer
  67523. */
  67524. export class DataReader {
  67525. /**
  67526. * The data buffer associated with this data reader.
  67527. */
  67528. readonly buffer: IDataBuffer;
  67529. /**
  67530. * The current byte offset from the beginning of the data buffer.
  67531. */
  67532. byteOffset: number;
  67533. private _dataView;
  67534. private _dataByteOffset;
  67535. /**
  67536. * Constructor
  67537. * @param buffer The buffer to read
  67538. */
  67539. constructor(buffer: IDataBuffer);
  67540. /**
  67541. * Loads the given byte length.
  67542. * @param byteLength The byte length to load
  67543. * @returns A promise that resolves when the load is complete
  67544. */
  67545. loadAsync(byteLength: number): Promise<void>;
  67546. /**
  67547. * Read a unsigned 32-bit integer from the currently loaded data range.
  67548. * @returns The 32-bit integer read
  67549. */
  67550. readUint32(): number;
  67551. /**
  67552. * Read a byte array from the currently loaded data range.
  67553. * @param byteLength The byte length to read
  67554. * @returns The byte array read
  67555. */
  67556. readUint8Array(byteLength: number): Uint8Array;
  67557. /**
  67558. * Read a string from the currently loaded data range.
  67559. * @param byteLength The byte length to read
  67560. * @returns The string read
  67561. */
  67562. readString(byteLength: number): string;
  67563. /**
  67564. * Skips the given byte length the currently loaded data range.
  67565. * @param byteLength The byte length to skip
  67566. */
  67567. skipBytes(byteLength: number): void;
  67568. }
  67569. }
  67570. declare module "babylonjs/Misc/index" {
  67571. export * from "babylonjs/Misc/andOrNotEvaluator";
  67572. export * from "babylonjs/Misc/assetsManager";
  67573. export * from "babylonjs/Misc/dds";
  67574. export * from "babylonjs/Misc/decorators";
  67575. export * from "babylonjs/Misc/deferred";
  67576. export * from "babylonjs/Misc/environmentTextureTools";
  67577. export * from "babylonjs/Misc/meshExploder";
  67578. export * from "babylonjs/Misc/filesInput";
  67579. export * from "babylonjs/Misc/HighDynamicRange/index";
  67580. export * from "babylonjs/Misc/khronosTextureContainer";
  67581. export * from "babylonjs/Misc/observable";
  67582. export * from "babylonjs/Misc/performanceMonitor";
  67583. export * from "babylonjs/Misc/promise";
  67584. export * from "babylonjs/Misc/sceneOptimizer";
  67585. export * from "babylonjs/Misc/sceneSerializer";
  67586. export * from "babylonjs/Misc/smartArray";
  67587. export * from "babylonjs/Misc/stringDictionary";
  67588. export * from "babylonjs/Misc/tags";
  67589. export * from "babylonjs/Misc/textureTools";
  67590. export * from "babylonjs/Misc/tga";
  67591. export * from "babylonjs/Misc/tools";
  67592. export * from "babylonjs/Misc/videoRecorder";
  67593. export * from "babylonjs/Misc/virtualJoystick";
  67594. export * from "babylonjs/Misc/workerPool";
  67595. export * from "babylonjs/Misc/logger";
  67596. export * from "babylonjs/Misc/typeStore";
  67597. export * from "babylonjs/Misc/filesInputStore";
  67598. export * from "babylonjs/Misc/deepCopier";
  67599. export * from "babylonjs/Misc/pivotTools";
  67600. export * from "babylonjs/Misc/precisionDate";
  67601. export * from "babylonjs/Misc/screenshotTools";
  67602. export * from "babylonjs/Misc/typeStore";
  67603. export * from "babylonjs/Misc/webRequest";
  67604. export * from "babylonjs/Misc/iInspectable";
  67605. export * from "babylonjs/Misc/brdfTextureTools";
  67606. export * from "babylonjs/Misc/rgbdTextureTools";
  67607. export * from "babylonjs/Misc/gradients";
  67608. export * from "babylonjs/Misc/perfCounter";
  67609. export * from "babylonjs/Misc/fileRequest";
  67610. export * from "babylonjs/Misc/customAnimationFrameRequester";
  67611. export * from "babylonjs/Misc/retryStrategy";
  67612. export * from "babylonjs/Misc/interfaces/screenshotSize";
  67613. export * from "babylonjs/Misc/canvasGenerator";
  67614. export * from "babylonjs/Misc/fileTools";
  67615. export * from "babylonjs/Misc/stringTools";
  67616. export * from "babylonjs/Misc/dataReader";
  67617. }
  67618. declare module "babylonjs/index" {
  67619. export * from "babylonjs/abstractScene";
  67620. export * from "babylonjs/Actions/index";
  67621. export * from "babylonjs/Animations/index";
  67622. export * from "babylonjs/assetContainer";
  67623. export * from "babylonjs/Audio/index";
  67624. export * from "babylonjs/Behaviors/index";
  67625. export * from "babylonjs/Bones/index";
  67626. export * from "babylonjs/Cameras/index";
  67627. export * from "babylonjs/Collisions/index";
  67628. export * from "babylonjs/Culling/index";
  67629. export * from "babylonjs/Debug/index";
  67630. export * from "babylonjs/Engines/index";
  67631. export * from "babylonjs/Events/index";
  67632. export * from "babylonjs/Gamepads/index";
  67633. export * from "babylonjs/Gizmos/index";
  67634. export * from "babylonjs/Helpers/index";
  67635. export * from "babylonjs/Instrumentation/index";
  67636. export * from "babylonjs/Layers/index";
  67637. export * from "babylonjs/LensFlares/index";
  67638. export * from "babylonjs/Lights/index";
  67639. export * from "babylonjs/Loading/index";
  67640. export * from "babylonjs/Materials/index";
  67641. export * from "babylonjs/Maths/index";
  67642. export * from "babylonjs/Meshes/index";
  67643. export * from "babylonjs/Morph/index";
  67644. export * from "babylonjs/Navigation/index";
  67645. export * from "babylonjs/node";
  67646. export * from "babylonjs/Offline/index";
  67647. export * from "babylonjs/Particles/index";
  67648. export * from "babylonjs/Physics/index";
  67649. export * from "babylonjs/PostProcesses/index";
  67650. export * from "babylonjs/Probes/index";
  67651. export * from "babylonjs/Rendering/index";
  67652. export * from "babylonjs/scene";
  67653. export * from "babylonjs/sceneComponent";
  67654. export * from "babylonjs/Sprites/index";
  67655. export * from "babylonjs/States/index";
  67656. export * from "babylonjs/Misc/index";
  67657. export * from "babylonjs/types";
  67658. }
  67659. declare module "babylonjs/Animations/pathCursor" {
  67660. import { Vector3 } from "babylonjs/Maths/math.vector";
  67661. import { Path2 } from "babylonjs/Maths/math.path";
  67662. /**
  67663. * A cursor which tracks a point on a path
  67664. */
  67665. export class PathCursor {
  67666. private path;
  67667. /**
  67668. * Stores path cursor callbacks for when an onchange event is triggered
  67669. */
  67670. private _onchange;
  67671. /**
  67672. * The value of the path cursor
  67673. */
  67674. value: number;
  67675. /**
  67676. * The animation array of the path cursor
  67677. */
  67678. animations: Animation[];
  67679. /**
  67680. * Initializes the path cursor
  67681. * @param path The path to track
  67682. */
  67683. constructor(path: Path2);
  67684. /**
  67685. * Gets the cursor point on the path
  67686. * @returns A point on the path cursor at the cursor location
  67687. */
  67688. getPoint(): Vector3;
  67689. /**
  67690. * Moves the cursor ahead by the step amount
  67691. * @param step The amount to move the cursor forward
  67692. * @returns This path cursor
  67693. */
  67694. moveAhead(step?: number): PathCursor;
  67695. /**
  67696. * Moves the cursor behind by the step amount
  67697. * @param step The amount to move the cursor back
  67698. * @returns This path cursor
  67699. */
  67700. moveBack(step?: number): PathCursor;
  67701. /**
  67702. * Moves the cursor by the step amount
  67703. * If the step amount is greater than one, an exception is thrown
  67704. * @param step The amount to move the cursor
  67705. * @returns This path cursor
  67706. */
  67707. move(step: number): PathCursor;
  67708. /**
  67709. * Ensures that the value is limited between zero and one
  67710. * @returns This path cursor
  67711. */
  67712. private ensureLimits;
  67713. /**
  67714. * Runs onchange callbacks on change (used by the animation engine)
  67715. * @returns This path cursor
  67716. */
  67717. private raiseOnChange;
  67718. /**
  67719. * Executes a function on change
  67720. * @param f A path cursor onchange callback
  67721. * @returns This path cursor
  67722. */
  67723. onchange(f: (cursor: PathCursor) => void): PathCursor;
  67724. }
  67725. }
  67726. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  67727. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  67728. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  67729. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  67730. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  67731. }
  67732. declare module "babylonjs/Engines/Processors/Expressions/index" {
  67733. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  67734. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  67735. }
  67736. declare module "babylonjs/Engines/Processors/index" {
  67737. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  67738. export * from "babylonjs/Engines/Processors/Expressions/index";
  67739. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  67740. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  67741. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  67742. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  67743. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  67744. export * from "babylonjs/Engines/Processors/shaderProcessor";
  67745. }
  67746. declare module "babylonjs/Legacy/legacy" {
  67747. import * as Babylon from "babylonjs/index";
  67748. export * from "babylonjs/index";
  67749. }
  67750. declare module "babylonjs/Shaders/blur.fragment" {
  67751. /** @hidden */
  67752. export var blurPixelShader: {
  67753. name: string;
  67754. shader: string;
  67755. };
  67756. }
  67757. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  67758. /** @hidden */
  67759. export var pointCloudVertexDeclaration: {
  67760. name: string;
  67761. shader: string;
  67762. };
  67763. }
  67764. declare module "babylonjs" {
  67765. export * from "babylonjs/Legacy/legacy";
  67766. }
  67767. declare module BABYLON {
  67768. /** Alias type for value that can be null */
  67769. export type Nullable<T> = T | null;
  67770. /**
  67771. * Alias type for number that are floats
  67772. * @ignorenaming
  67773. */
  67774. export type float = number;
  67775. /**
  67776. * Alias type for number that are doubles.
  67777. * @ignorenaming
  67778. */
  67779. export type double = number;
  67780. /**
  67781. * Alias type for number that are integer
  67782. * @ignorenaming
  67783. */
  67784. export type int = number;
  67785. /** Alias type for number array or Float32Array */
  67786. export type FloatArray = number[] | Float32Array;
  67787. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  67788. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  67789. /**
  67790. * Alias for types that can be used by a Buffer or VertexBuffer.
  67791. */
  67792. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  67793. /**
  67794. * Alias type for primitive types
  67795. * @ignorenaming
  67796. */
  67797. type Primitive = undefined | null | boolean | string | number | Function;
  67798. /**
  67799. * Type modifier to make all the properties of an object Readonly
  67800. */
  67801. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  67802. /**
  67803. * Type modifier to make all the properties of an object Readonly recursively
  67804. */
  67805. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  67806. /**
  67807. * Type modifier to make object properties readonly.
  67808. */
  67809. export type DeepImmutableObject<T> = {
  67810. readonly [K in keyof T]: DeepImmutable<T[K]>;
  67811. };
  67812. /** @hidden */
  67813. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  67814. }
  67815. }
  67816. declare module BABYLON {
  67817. /**
  67818. * A class serves as a medium between the observable and its observers
  67819. */
  67820. export class EventState {
  67821. /**
  67822. * Create a new EventState
  67823. * @param mask defines the mask associated with this state
  67824. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  67825. * @param target defines the original target of the state
  67826. * @param currentTarget defines the current target of the state
  67827. */
  67828. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  67829. /**
  67830. * Initialize the current event state
  67831. * @param mask defines the mask associated with this state
  67832. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  67833. * @param target defines the original target of the state
  67834. * @param currentTarget defines the current target of the state
  67835. * @returns the current event state
  67836. */
  67837. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  67838. /**
  67839. * An Observer can set this property to true to prevent subsequent observers of being notified
  67840. */
  67841. skipNextObservers: boolean;
  67842. /**
  67843. * Get the mask value that were used to trigger the event corresponding to this EventState object
  67844. */
  67845. mask: number;
  67846. /**
  67847. * The object that originally notified the event
  67848. */
  67849. target?: any;
  67850. /**
  67851. * The current object in the bubbling phase
  67852. */
  67853. currentTarget?: any;
  67854. /**
  67855. * This will be populated with the return value of the last function that was executed.
  67856. * If it is the first function in the callback chain it will be the event data.
  67857. */
  67858. lastReturnValue?: any;
  67859. }
  67860. /**
  67861. * Represent an Observer registered to a given Observable object.
  67862. */
  67863. export class Observer<T> {
  67864. /**
  67865. * Defines the callback to call when the observer is notified
  67866. */
  67867. callback: (eventData: T, eventState: EventState) => void;
  67868. /**
  67869. * Defines the mask of the observer (used to filter notifications)
  67870. */
  67871. mask: number;
  67872. /**
  67873. * Defines the current scope used to restore the JS context
  67874. */
  67875. scope: any;
  67876. /** @hidden */
  67877. _willBeUnregistered: boolean;
  67878. /**
  67879. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  67880. */
  67881. unregisterOnNextCall: boolean;
  67882. /**
  67883. * Creates a new observer
  67884. * @param callback defines the callback to call when the observer is notified
  67885. * @param mask defines the mask of the observer (used to filter notifications)
  67886. * @param scope defines the current scope used to restore the JS context
  67887. */
  67888. constructor(
  67889. /**
  67890. * Defines the callback to call when the observer is notified
  67891. */
  67892. callback: (eventData: T, eventState: EventState) => void,
  67893. /**
  67894. * Defines the mask of the observer (used to filter notifications)
  67895. */
  67896. mask: number,
  67897. /**
  67898. * Defines the current scope used to restore the JS context
  67899. */
  67900. scope?: any);
  67901. }
  67902. /**
  67903. * Represent a list of observers registered to multiple Observables object.
  67904. */
  67905. export class MultiObserver<T> {
  67906. private _observers;
  67907. private _observables;
  67908. /**
  67909. * Release associated resources
  67910. */
  67911. dispose(): void;
  67912. /**
  67913. * Raise a callback when one of the observable will notify
  67914. * @param observables defines a list of observables to watch
  67915. * @param callback defines the callback to call on notification
  67916. * @param mask defines the mask used to filter notifications
  67917. * @param scope defines the current scope used to restore the JS context
  67918. * @returns the new MultiObserver
  67919. */
  67920. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  67921. }
  67922. /**
  67923. * The Observable class is a simple implementation of the Observable pattern.
  67924. *
  67925. * 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.
  67926. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  67927. * 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).
  67928. * 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.
  67929. */
  67930. export class Observable<T> {
  67931. private _observers;
  67932. private _eventState;
  67933. private _onObserverAdded;
  67934. /**
  67935. * Gets the list of observers
  67936. */
  67937. readonly observers: Array<Observer<T>>;
  67938. /**
  67939. * Creates a new observable
  67940. * @param onObserverAdded defines a callback to call when a new observer is added
  67941. */
  67942. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  67943. /**
  67944. * Create a new Observer with the specified callback
  67945. * @param callback the callback that will be executed for that Observer
  67946. * @param mask the mask used to filter observers
  67947. * @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.
  67948. * @param scope optional scope for the callback to be called from
  67949. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  67950. * @returns the new observer created for the callback
  67951. */
  67952. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  67953. /**
  67954. * Create a new Observer with the specified callback and unregisters after the next notification
  67955. * @param callback the callback that will be executed for that Observer
  67956. * @returns the new observer created for the callback
  67957. */
  67958. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  67959. /**
  67960. * Remove an Observer from the Observable object
  67961. * @param observer the instance of the Observer to remove
  67962. * @returns false if it doesn't belong to this Observable
  67963. */
  67964. remove(observer: Nullable<Observer<T>>): boolean;
  67965. /**
  67966. * Remove a callback from the Observable object
  67967. * @param callback the callback to remove
  67968. * @param scope optional scope. If used only the callbacks with this scope will be removed
  67969. * @returns false if it doesn't belong to this Observable
  67970. */
  67971. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  67972. private _deferUnregister;
  67973. private _remove;
  67974. /**
  67975. * Moves the observable to the top of the observer list making it get called first when notified
  67976. * @param observer the observer to move
  67977. */
  67978. makeObserverTopPriority(observer: Observer<T>): void;
  67979. /**
  67980. * Moves the observable to the bottom of the observer list making it get called last when notified
  67981. * @param observer the observer to move
  67982. */
  67983. makeObserverBottomPriority(observer: Observer<T>): void;
  67984. /**
  67985. * Notify all Observers by calling their respective callback with the given data
  67986. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  67987. * @param eventData defines the data to send to all observers
  67988. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  67989. * @param target defines the original target of the state
  67990. * @param currentTarget defines the current target of the state
  67991. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  67992. */
  67993. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  67994. /**
  67995. * Calling this will execute each callback, expecting it to be a promise or return a value.
  67996. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  67997. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  67998. * and it is crucial that all callbacks will be executed.
  67999. * The order of the callbacks is kept, callbacks are not executed parallel.
  68000. *
  68001. * @param eventData The data to be sent to each callback
  68002. * @param mask is used to filter observers defaults to -1
  68003. * @param target defines the callback target (see EventState)
  68004. * @param currentTarget defines he current object in the bubbling phase
  68005. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  68006. */
  68007. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  68008. /**
  68009. * Notify a specific observer
  68010. * @param observer defines the observer to notify
  68011. * @param eventData defines the data to be sent to each callback
  68012. * @param mask is used to filter observers defaults to -1
  68013. */
  68014. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  68015. /**
  68016. * Gets a boolean indicating if the observable has at least one observer
  68017. * @returns true is the Observable has at least one Observer registered
  68018. */
  68019. hasObservers(): boolean;
  68020. /**
  68021. * Clear the list of observers
  68022. */
  68023. clear(): void;
  68024. /**
  68025. * Clone the current observable
  68026. * @returns a new observable
  68027. */
  68028. clone(): Observable<T>;
  68029. /**
  68030. * Does this observable handles observer registered with a given mask
  68031. * @param mask defines the mask to be tested
  68032. * @return whether or not one observer registered with the given mask is handeled
  68033. **/
  68034. hasSpecificMask(mask?: number): boolean;
  68035. }
  68036. }
  68037. declare module BABYLON {
  68038. /**
  68039. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  68040. * Babylon.js
  68041. */
  68042. export class DomManagement {
  68043. /**
  68044. * Checks if the window object exists
  68045. * @returns true if the window object exists
  68046. */
  68047. static IsWindowObjectExist(): boolean;
  68048. /**
  68049. * Checks if the navigator object exists
  68050. * @returns true if the navigator object exists
  68051. */
  68052. static IsNavigatorAvailable(): boolean;
  68053. /**
  68054. * Extracts text content from a DOM element hierarchy
  68055. * @param element defines the root element
  68056. * @returns a string
  68057. */
  68058. static GetDOMTextContent(element: HTMLElement): string;
  68059. }
  68060. }
  68061. declare module BABYLON {
  68062. /**
  68063. * Logger used througouht the application to allow configuration of
  68064. * the log level required for the messages.
  68065. */
  68066. export class Logger {
  68067. /**
  68068. * No log
  68069. */
  68070. static readonly NoneLogLevel: number;
  68071. /**
  68072. * Only message logs
  68073. */
  68074. static readonly MessageLogLevel: number;
  68075. /**
  68076. * Only warning logs
  68077. */
  68078. static readonly WarningLogLevel: number;
  68079. /**
  68080. * Only error logs
  68081. */
  68082. static readonly ErrorLogLevel: number;
  68083. /**
  68084. * All logs
  68085. */
  68086. static readonly AllLogLevel: number;
  68087. private static _LogCache;
  68088. /**
  68089. * Gets a value indicating the number of loading errors
  68090. * @ignorenaming
  68091. */
  68092. static errorsCount: number;
  68093. /**
  68094. * Callback called when a new log is added
  68095. */
  68096. static OnNewCacheEntry: (entry: string) => void;
  68097. private static _AddLogEntry;
  68098. private static _FormatMessage;
  68099. private static _LogDisabled;
  68100. private static _LogEnabled;
  68101. private static _WarnDisabled;
  68102. private static _WarnEnabled;
  68103. private static _ErrorDisabled;
  68104. private static _ErrorEnabled;
  68105. /**
  68106. * Log a message to the console
  68107. */
  68108. static Log: (message: string) => void;
  68109. /**
  68110. * Write a warning message to the console
  68111. */
  68112. static Warn: (message: string) => void;
  68113. /**
  68114. * Write an error message to the console
  68115. */
  68116. static Error: (message: string) => void;
  68117. /**
  68118. * Gets current log cache (list of logs)
  68119. */
  68120. static readonly LogCache: string;
  68121. /**
  68122. * Clears the log cache
  68123. */
  68124. static ClearLogCache(): void;
  68125. /**
  68126. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  68127. */
  68128. static LogLevels: number;
  68129. }
  68130. }
  68131. declare module BABYLON {
  68132. /** @hidden */
  68133. export class _TypeStore {
  68134. /** @hidden */
  68135. static RegisteredTypes: {
  68136. [key: string]: Object;
  68137. };
  68138. /** @hidden */
  68139. static GetClass(fqdn: string): any;
  68140. }
  68141. }
  68142. declare module BABYLON {
  68143. /**
  68144. * Helper to manipulate strings
  68145. */
  68146. export class StringTools {
  68147. /**
  68148. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  68149. * @param str Source string
  68150. * @param suffix Suffix to search for in the source string
  68151. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68152. */
  68153. static EndsWith(str: string, suffix: string): boolean;
  68154. /**
  68155. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  68156. * @param str Source string
  68157. * @param suffix Suffix to search for in the source string
  68158. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68159. */
  68160. static StartsWith(str: string, suffix: string): boolean;
  68161. /**
  68162. * Decodes a buffer into a string
  68163. * @param buffer The buffer to decode
  68164. * @returns The decoded string
  68165. */
  68166. static Decode(buffer: Uint8Array | Uint16Array): string;
  68167. /**
  68168. * Encode a buffer to a base64 string
  68169. * @param buffer defines the buffer to encode
  68170. * @returns the encoded string
  68171. */
  68172. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  68173. }
  68174. }
  68175. declare module BABYLON {
  68176. /**
  68177. * Class containing a set of static utilities functions for deep copy.
  68178. */
  68179. export class DeepCopier {
  68180. /**
  68181. * Tries to copy an object by duplicating every property
  68182. * @param source defines the source object
  68183. * @param destination defines the target object
  68184. * @param doNotCopyList defines a list of properties to avoid
  68185. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  68186. */
  68187. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  68188. }
  68189. }
  68190. declare module BABYLON {
  68191. /**
  68192. * Class containing a set of static utilities functions for precision date
  68193. */
  68194. export class PrecisionDate {
  68195. /**
  68196. * Gets either window.performance.now() if supported or Date.now() else
  68197. */
  68198. static readonly Now: number;
  68199. }
  68200. }
  68201. declare module BABYLON {
  68202. /** @hidden */
  68203. export class _DevTools {
  68204. static WarnImport(name: string): string;
  68205. }
  68206. }
  68207. declare module BABYLON {
  68208. /**
  68209. * Interface used to define the mechanism to get data from the network
  68210. */
  68211. export interface IWebRequest {
  68212. /**
  68213. * Returns client's response url
  68214. */
  68215. responseURL: string;
  68216. /**
  68217. * Returns client's status
  68218. */
  68219. status: number;
  68220. /**
  68221. * Returns client's status as a text
  68222. */
  68223. statusText: string;
  68224. }
  68225. }
  68226. declare module BABYLON {
  68227. /**
  68228. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  68229. */
  68230. export class WebRequest implements IWebRequest {
  68231. private _xhr;
  68232. /**
  68233. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  68234. * i.e. when loading files, where the server/service expects an Authorization header
  68235. */
  68236. static CustomRequestHeaders: {
  68237. [key: string]: string;
  68238. };
  68239. /**
  68240. * Add callback functions in this array to update all the requests before they get sent to the network
  68241. */
  68242. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  68243. private _injectCustomRequestHeaders;
  68244. /**
  68245. * Gets or sets a function to be called when loading progress changes
  68246. */
  68247. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  68248. /**
  68249. * Returns client's state
  68250. */
  68251. readonly readyState: number;
  68252. /**
  68253. * Returns client's status
  68254. */
  68255. readonly status: number;
  68256. /**
  68257. * Returns client's status as a text
  68258. */
  68259. readonly statusText: string;
  68260. /**
  68261. * Returns client's response
  68262. */
  68263. readonly response: any;
  68264. /**
  68265. * Returns client's response url
  68266. */
  68267. readonly responseURL: string;
  68268. /**
  68269. * Returns client's response as text
  68270. */
  68271. readonly responseText: string;
  68272. /**
  68273. * Gets or sets the expected response type
  68274. */
  68275. responseType: XMLHttpRequestResponseType;
  68276. /** @hidden */
  68277. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  68278. /** @hidden */
  68279. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  68280. /**
  68281. * Cancels any network activity
  68282. */
  68283. abort(): void;
  68284. /**
  68285. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  68286. * @param body defines an optional request body
  68287. */
  68288. send(body?: Document | BodyInit | null): void;
  68289. /**
  68290. * Sets the request method, request URL
  68291. * @param method defines the method to use (GET, POST, etc..)
  68292. * @param url defines the url to connect with
  68293. */
  68294. open(method: string, url: string): void;
  68295. /**
  68296. * Sets the value of a request header.
  68297. * @param name The name of the header whose value is to be set
  68298. * @param value The value to set as the body of the header
  68299. */
  68300. setRequestHeader(name: string, value: string): void;
  68301. /**
  68302. * Get the string containing the text of a particular header's value.
  68303. * @param name The name of the header
  68304. * @returns The string containing the text of the given header name
  68305. */
  68306. getResponseHeader(name: string): Nullable<string>;
  68307. }
  68308. }
  68309. declare module BABYLON {
  68310. /**
  68311. * File request interface
  68312. */
  68313. export interface IFileRequest {
  68314. /**
  68315. * Raised when the request is complete (success or error).
  68316. */
  68317. onCompleteObservable: Observable<IFileRequest>;
  68318. /**
  68319. * Aborts the request for a file.
  68320. */
  68321. abort: () => void;
  68322. }
  68323. }
  68324. declare module BABYLON {
  68325. /**
  68326. * Define options used to create a render target texture
  68327. */
  68328. export class RenderTargetCreationOptions {
  68329. /**
  68330. * Specifies is mipmaps must be generated
  68331. */
  68332. generateMipMaps?: boolean;
  68333. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  68334. generateDepthBuffer?: boolean;
  68335. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  68336. generateStencilBuffer?: boolean;
  68337. /** Defines texture type (int by default) */
  68338. type?: number;
  68339. /** Defines sampling mode (trilinear by default) */
  68340. samplingMode?: number;
  68341. /** Defines format (RGBA by default) */
  68342. format?: number;
  68343. }
  68344. }
  68345. declare module BABYLON {
  68346. /**
  68347. * @hidden
  68348. **/
  68349. export class _TimeToken {
  68350. _startTimeQuery: Nullable<WebGLQuery>;
  68351. _endTimeQuery: Nullable<WebGLQuery>;
  68352. _timeElapsedQuery: Nullable<WebGLQuery>;
  68353. _timeElapsedQueryEnded: boolean;
  68354. }
  68355. }
  68356. declare module BABYLON {
  68357. /** Defines the cross module used constants to avoid circular dependncies */
  68358. export class Constants {
  68359. /** Defines that alpha blending is disabled */
  68360. static readonly ALPHA_DISABLE: number;
  68361. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  68362. static readonly ALPHA_ADD: number;
  68363. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  68364. static readonly ALPHA_COMBINE: number;
  68365. /** Defines that alpha blending to DEST - SRC * DEST */
  68366. static readonly ALPHA_SUBTRACT: number;
  68367. /** Defines that alpha blending to SRC * DEST */
  68368. static readonly ALPHA_MULTIPLY: number;
  68369. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  68370. static readonly ALPHA_MAXIMIZED: number;
  68371. /** Defines that alpha blending to SRC + DEST */
  68372. static readonly ALPHA_ONEONE: number;
  68373. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  68374. static readonly ALPHA_PREMULTIPLIED: number;
  68375. /**
  68376. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  68377. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  68378. */
  68379. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  68380. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  68381. static readonly ALPHA_INTERPOLATE: number;
  68382. /**
  68383. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  68384. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  68385. */
  68386. static readonly ALPHA_SCREENMODE: number;
  68387. /**
  68388. * Defines that alpha blending to SRC + DST
  68389. * Alpha will be set to SRC ALPHA + DST ALPHA
  68390. */
  68391. static readonly ALPHA_ONEONE_ONEONE: number;
  68392. /**
  68393. * Defines that alpha blending to SRC * DST ALPHA + DST
  68394. * Alpha will be set to 0
  68395. */
  68396. static readonly ALPHA_ALPHATOCOLOR: number;
  68397. /**
  68398. * Defines that alpha blending to SRC * (1 - DST) + DST * (1 - SRC)
  68399. */
  68400. static readonly ALPHA_REVERSEONEMINUS: number;
  68401. /**
  68402. * Defines that alpha blending to SRC + DST * (1 - SRC ALPHA)
  68403. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  68404. */
  68405. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  68406. /**
  68407. * Defines that alpha blending to SRC + DST
  68408. * Alpha will be set to SRC ALPHA
  68409. */
  68410. static readonly ALPHA_ONEONE_ONEZERO: number;
  68411. /** Defines that alpha blending equation a SUM */
  68412. static readonly ALPHA_EQUATION_ADD: number;
  68413. /** Defines that alpha blending equation a SUBSTRACTION */
  68414. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  68415. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  68416. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  68417. /** Defines that alpha blending equation a MAX operation */
  68418. static readonly ALPHA_EQUATION_MAX: number;
  68419. /** Defines that alpha blending equation a MIN operation */
  68420. static readonly ALPHA_EQUATION_MIN: number;
  68421. /**
  68422. * Defines that alpha blending equation a DARKEN operation:
  68423. * It takes the min of the src and sums the alpha channels.
  68424. */
  68425. static readonly ALPHA_EQUATION_DARKEN: number;
  68426. /** Defines that the ressource is not delayed*/
  68427. static readonly DELAYLOADSTATE_NONE: number;
  68428. /** Defines that the ressource was successfully delay loaded */
  68429. static readonly DELAYLOADSTATE_LOADED: number;
  68430. /** Defines that the ressource is currently delay loading */
  68431. static readonly DELAYLOADSTATE_LOADING: number;
  68432. /** Defines that the ressource is delayed and has not started loading */
  68433. static readonly DELAYLOADSTATE_NOTLOADED: number;
  68434. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  68435. static readonly NEVER: number;
  68436. /** 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 */
  68437. static readonly ALWAYS: number;
  68438. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  68439. static readonly LESS: number;
  68440. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  68441. static readonly EQUAL: number;
  68442. /** 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 */
  68443. static readonly LEQUAL: number;
  68444. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  68445. static readonly GREATER: number;
  68446. /** 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 */
  68447. static readonly GEQUAL: number;
  68448. /** 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 */
  68449. static readonly NOTEQUAL: number;
  68450. /** Passed to stencilOperation to specify that stencil value must be kept */
  68451. static readonly KEEP: number;
  68452. /** Passed to stencilOperation to specify that stencil value must be replaced */
  68453. static readonly REPLACE: number;
  68454. /** Passed to stencilOperation to specify that stencil value must be incremented */
  68455. static readonly INCR: number;
  68456. /** Passed to stencilOperation to specify that stencil value must be decremented */
  68457. static readonly DECR: number;
  68458. /** Passed to stencilOperation to specify that stencil value must be inverted */
  68459. static readonly INVERT: number;
  68460. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  68461. static readonly INCR_WRAP: number;
  68462. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  68463. static readonly DECR_WRAP: number;
  68464. /** Texture is not repeating outside of 0..1 UVs */
  68465. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  68466. /** Texture is repeating outside of 0..1 UVs */
  68467. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  68468. /** Texture is repeating and mirrored */
  68469. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  68470. /** ALPHA */
  68471. static readonly TEXTUREFORMAT_ALPHA: number;
  68472. /** LUMINANCE */
  68473. static readonly TEXTUREFORMAT_LUMINANCE: number;
  68474. /** LUMINANCE_ALPHA */
  68475. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  68476. /** RGB */
  68477. static readonly TEXTUREFORMAT_RGB: number;
  68478. /** RGBA */
  68479. static readonly TEXTUREFORMAT_RGBA: number;
  68480. /** RED */
  68481. static readonly TEXTUREFORMAT_RED: number;
  68482. /** RED (2nd reference) */
  68483. static readonly TEXTUREFORMAT_R: number;
  68484. /** RG */
  68485. static readonly TEXTUREFORMAT_RG: number;
  68486. /** RED_INTEGER */
  68487. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  68488. /** RED_INTEGER (2nd reference) */
  68489. static readonly TEXTUREFORMAT_R_INTEGER: number;
  68490. /** RG_INTEGER */
  68491. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  68492. /** RGB_INTEGER */
  68493. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  68494. /** RGBA_INTEGER */
  68495. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  68496. /** UNSIGNED_BYTE */
  68497. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  68498. /** UNSIGNED_BYTE (2nd reference) */
  68499. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  68500. /** FLOAT */
  68501. static readonly TEXTURETYPE_FLOAT: number;
  68502. /** HALF_FLOAT */
  68503. static readonly TEXTURETYPE_HALF_FLOAT: number;
  68504. /** BYTE */
  68505. static readonly TEXTURETYPE_BYTE: number;
  68506. /** SHORT */
  68507. static readonly TEXTURETYPE_SHORT: number;
  68508. /** UNSIGNED_SHORT */
  68509. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  68510. /** INT */
  68511. static readonly TEXTURETYPE_INT: number;
  68512. /** UNSIGNED_INT */
  68513. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  68514. /** UNSIGNED_SHORT_4_4_4_4 */
  68515. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  68516. /** UNSIGNED_SHORT_5_5_5_1 */
  68517. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  68518. /** UNSIGNED_SHORT_5_6_5 */
  68519. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  68520. /** UNSIGNED_INT_2_10_10_10_REV */
  68521. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  68522. /** UNSIGNED_INT_24_8 */
  68523. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  68524. /** UNSIGNED_INT_10F_11F_11F_REV */
  68525. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  68526. /** UNSIGNED_INT_5_9_9_9_REV */
  68527. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  68528. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  68529. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  68530. /** nearest is mag = nearest and min = nearest and mip = linear */
  68531. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  68532. /** Bilinear is mag = linear and min = linear and mip = nearest */
  68533. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  68534. /** Trilinear is mag = linear and min = linear and mip = linear */
  68535. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  68536. /** nearest is mag = nearest and min = nearest and mip = linear */
  68537. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  68538. /** Bilinear is mag = linear and min = linear and mip = nearest */
  68539. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  68540. /** Trilinear is mag = linear and min = linear and mip = linear */
  68541. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  68542. /** mag = nearest and min = nearest and mip = nearest */
  68543. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  68544. /** mag = nearest and min = linear and mip = nearest */
  68545. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  68546. /** mag = nearest and min = linear and mip = linear */
  68547. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  68548. /** mag = nearest and min = linear and mip = none */
  68549. static readonly TEXTURE_NEAREST_LINEAR: number;
  68550. /** mag = nearest and min = nearest and mip = none */
  68551. static readonly TEXTURE_NEAREST_NEAREST: number;
  68552. /** mag = linear and min = nearest and mip = nearest */
  68553. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  68554. /** mag = linear and min = nearest and mip = linear */
  68555. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  68556. /** mag = linear and min = linear and mip = none */
  68557. static readonly TEXTURE_LINEAR_LINEAR: number;
  68558. /** mag = linear and min = nearest and mip = none */
  68559. static readonly TEXTURE_LINEAR_NEAREST: number;
  68560. /** Explicit coordinates mode */
  68561. static readonly TEXTURE_EXPLICIT_MODE: number;
  68562. /** Spherical coordinates mode */
  68563. static readonly TEXTURE_SPHERICAL_MODE: number;
  68564. /** Planar coordinates mode */
  68565. static readonly TEXTURE_PLANAR_MODE: number;
  68566. /** Cubic coordinates mode */
  68567. static readonly TEXTURE_CUBIC_MODE: number;
  68568. /** Projection coordinates mode */
  68569. static readonly TEXTURE_PROJECTION_MODE: number;
  68570. /** Skybox coordinates mode */
  68571. static readonly TEXTURE_SKYBOX_MODE: number;
  68572. /** Inverse Cubic coordinates mode */
  68573. static readonly TEXTURE_INVCUBIC_MODE: number;
  68574. /** Equirectangular coordinates mode */
  68575. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  68576. /** Equirectangular Fixed coordinates mode */
  68577. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  68578. /** Equirectangular Fixed Mirrored coordinates mode */
  68579. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  68580. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  68581. static readonly SCALEMODE_FLOOR: number;
  68582. /** Defines that texture rescaling will look for the nearest power of 2 size */
  68583. static readonly SCALEMODE_NEAREST: number;
  68584. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  68585. static readonly SCALEMODE_CEILING: number;
  68586. /**
  68587. * The dirty texture flag value
  68588. */
  68589. static readonly MATERIAL_TextureDirtyFlag: number;
  68590. /**
  68591. * The dirty light flag value
  68592. */
  68593. static readonly MATERIAL_LightDirtyFlag: number;
  68594. /**
  68595. * The dirty fresnel flag value
  68596. */
  68597. static readonly MATERIAL_FresnelDirtyFlag: number;
  68598. /**
  68599. * The dirty attribute flag value
  68600. */
  68601. static readonly MATERIAL_AttributesDirtyFlag: number;
  68602. /**
  68603. * The dirty misc flag value
  68604. */
  68605. static readonly MATERIAL_MiscDirtyFlag: number;
  68606. /**
  68607. * The all dirty flag value
  68608. */
  68609. static readonly MATERIAL_AllDirtyFlag: number;
  68610. /**
  68611. * Returns the triangle fill mode
  68612. */
  68613. static readonly MATERIAL_TriangleFillMode: number;
  68614. /**
  68615. * Returns the wireframe mode
  68616. */
  68617. static readonly MATERIAL_WireFrameFillMode: number;
  68618. /**
  68619. * Returns the point fill mode
  68620. */
  68621. static readonly MATERIAL_PointFillMode: number;
  68622. /**
  68623. * Returns the point list draw mode
  68624. */
  68625. static readonly MATERIAL_PointListDrawMode: number;
  68626. /**
  68627. * Returns the line list draw mode
  68628. */
  68629. static readonly MATERIAL_LineListDrawMode: number;
  68630. /**
  68631. * Returns the line loop draw mode
  68632. */
  68633. static readonly MATERIAL_LineLoopDrawMode: number;
  68634. /**
  68635. * Returns the line strip draw mode
  68636. */
  68637. static readonly MATERIAL_LineStripDrawMode: number;
  68638. /**
  68639. * Returns the triangle strip draw mode
  68640. */
  68641. static readonly MATERIAL_TriangleStripDrawMode: number;
  68642. /**
  68643. * Returns the triangle fan draw mode
  68644. */
  68645. static readonly MATERIAL_TriangleFanDrawMode: number;
  68646. /**
  68647. * Stores the clock-wise side orientation
  68648. */
  68649. static readonly MATERIAL_ClockWiseSideOrientation: number;
  68650. /**
  68651. * Stores the counter clock-wise side orientation
  68652. */
  68653. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  68654. /**
  68655. * Nothing
  68656. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68657. */
  68658. static readonly ACTION_NothingTrigger: number;
  68659. /**
  68660. * On pick
  68661. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68662. */
  68663. static readonly ACTION_OnPickTrigger: number;
  68664. /**
  68665. * On left pick
  68666. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68667. */
  68668. static readonly ACTION_OnLeftPickTrigger: number;
  68669. /**
  68670. * On right pick
  68671. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68672. */
  68673. static readonly ACTION_OnRightPickTrigger: number;
  68674. /**
  68675. * On center pick
  68676. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68677. */
  68678. static readonly ACTION_OnCenterPickTrigger: number;
  68679. /**
  68680. * On pick down
  68681. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68682. */
  68683. static readonly ACTION_OnPickDownTrigger: number;
  68684. /**
  68685. * On double pick
  68686. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68687. */
  68688. static readonly ACTION_OnDoublePickTrigger: number;
  68689. /**
  68690. * On pick up
  68691. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68692. */
  68693. static readonly ACTION_OnPickUpTrigger: number;
  68694. /**
  68695. * On pick out.
  68696. * This trigger will only be raised if you also declared a OnPickDown
  68697. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68698. */
  68699. static readonly ACTION_OnPickOutTrigger: number;
  68700. /**
  68701. * On long press
  68702. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68703. */
  68704. static readonly ACTION_OnLongPressTrigger: number;
  68705. /**
  68706. * On pointer over
  68707. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68708. */
  68709. static readonly ACTION_OnPointerOverTrigger: number;
  68710. /**
  68711. * On pointer out
  68712. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68713. */
  68714. static readonly ACTION_OnPointerOutTrigger: number;
  68715. /**
  68716. * On every frame
  68717. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68718. */
  68719. static readonly ACTION_OnEveryFrameTrigger: number;
  68720. /**
  68721. * On intersection enter
  68722. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68723. */
  68724. static readonly ACTION_OnIntersectionEnterTrigger: number;
  68725. /**
  68726. * On intersection exit
  68727. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68728. */
  68729. static readonly ACTION_OnIntersectionExitTrigger: number;
  68730. /**
  68731. * On key down
  68732. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68733. */
  68734. static readonly ACTION_OnKeyDownTrigger: number;
  68735. /**
  68736. * On key up
  68737. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68738. */
  68739. static readonly ACTION_OnKeyUpTrigger: number;
  68740. /**
  68741. * Billboard mode will only apply to Y axis
  68742. */
  68743. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  68744. /**
  68745. * Billboard mode will apply to all axes
  68746. */
  68747. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  68748. /**
  68749. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  68750. */
  68751. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  68752. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  68753. * Test order :
  68754. * Is the bounding sphere outside the frustum ?
  68755. * If not, are the bounding box vertices outside the frustum ?
  68756. * It not, then the cullable object is in the frustum.
  68757. */
  68758. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  68759. /** Culling strategy : Bounding Sphere Only.
  68760. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  68761. * It's also less accurate than the standard because some not visible objects can still be selected.
  68762. * Test : is the bounding sphere outside the frustum ?
  68763. * If not, then the cullable object is in the frustum.
  68764. */
  68765. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  68766. /** Culling strategy : Optimistic Inclusion.
  68767. * This in an inclusion test first, then the standard exclusion test.
  68768. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  68769. * 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.
  68770. * Anyway, it's as accurate as the standard strategy.
  68771. * Test :
  68772. * Is the cullable object bounding sphere center in the frustum ?
  68773. * If not, apply the default culling strategy.
  68774. */
  68775. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  68776. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  68777. * This in an inclusion test first, then the bounding sphere only exclusion test.
  68778. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  68779. * 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.
  68780. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  68781. * Test :
  68782. * Is the cullable object bounding sphere center in the frustum ?
  68783. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  68784. */
  68785. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  68786. /**
  68787. * No logging while loading
  68788. */
  68789. static readonly SCENELOADER_NO_LOGGING: number;
  68790. /**
  68791. * Minimal logging while loading
  68792. */
  68793. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  68794. /**
  68795. * Summary logging while loading
  68796. */
  68797. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  68798. /**
  68799. * Detailled logging while loading
  68800. */
  68801. static readonly SCENELOADER_DETAILED_LOGGING: number;
  68802. }
  68803. }
  68804. declare module BABYLON {
  68805. /**
  68806. * This represents the required contract to create a new type of texture loader.
  68807. */
  68808. export interface IInternalTextureLoader {
  68809. /**
  68810. * Defines wether the loader supports cascade loading the different faces.
  68811. */
  68812. supportCascades: boolean;
  68813. /**
  68814. * This returns if the loader support the current file information.
  68815. * @param extension defines the file extension of the file being loaded
  68816. * @param textureFormatInUse defines the current compressed format in use iun the engine
  68817. * @param fallback defines the fallback internal texture if any
  68818. * @param isBase64 defines whether the texture is encoded as a base64
  68819. * @param isBuffer defines whether the texture data are stored as a buffer
  68820. * @returns true if the loader can load the specified file
  68821. */
  68822. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  68823. /**
  68824. * Transform the url before loading if required.
  68825. * @param rootUrl the url of the texture
  68826. * @param textureFormatInUse defines the current compressed format in use iun the engine
  68827. * @returns the transformed texture
  68828. */
  68829. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  68830. /**
  68831. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  68832. * @param rootUrl the url of the texture
  68833. * @param textureFormatInUse defines the current compressed format in use iun the engine
  68834. * @returns the fallback texture
  68835. */
  68836. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  68837. /**
  68838. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  68839. * @param data contains the texture data
  68840. * @param texture defines the BabylonJS internal texture
  68841. * @param createPolynomials will be true if polynomials have been requested
  68842. * @param onLoad defines the callback to trigger once the texture is ready
  68843. * @param onError defines the callback to trigger in case of error
  68844. */
  68845. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  68846. /**
  68847. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  68848. * @param data contains the texture data
  68849. * @param texture defines the BabylonJS internal texture
  68850. * @param callback defines the method to call once ready to upload
  68851. */
  68852. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  68853. }
  68854. }
  68855. declare module BABYLON {
  68856. /**
  68857. * Class used to store and describe the pipeline context associated with an effect
  68858. */
  68859. export interface IPipelineContext {
  68860. /**
  68861. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  68862. */
  68863. isAsync: boolean;
  68864. /**
  68865. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  68866. */
  68867. isReady: boolean;
  68868. /** @hidden */
  68869. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  68870. }
  68871. }
  68872. declare module BABYLON {
  68873. /**
  68874. * Class used to store gfx data (like WebGLBuffer)
  68875. */
  68876. export class DataBuffer {
  68877. /**
  68878. * Gets or sets the number of objects referencing this buffer
  68879. */
  68880. references: number;
  68881. /** Gets or sets the size of the underlying buffer */
  68882. capacity: number;
  68883. /**
  68884. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  68885. */
  68886. is32Bits: boolean;
  68887. /**
  68888. * Gets the underlying buffer
  68889. */
  68890. readonly underlyingResource: any;
  68891. }
  68892. }
  68893. declare module BABYLON {
  68894. /** @hidden */
  68895. export interface IShaderProcessor {
  68896. attributeProcessor?: (attribute: string) => string;
  68897. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  68898. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  68899. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  68900. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  68901. lineProcessor?: (line: string, isFragment: boolean) => string;
  68902. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  68903. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  68904. }
  68905. }
  68906. declare module BABYLON {
  68907. /** @hidden */
  68908. export interface ProcessingOptions {
  68909. defines: string[];
  68910. indexParameters: any;
  68911. isFragment: boolean;
  68912. shouldUseHighPrecisionShader: boolean;
  68913. supportsUniformBuffers: boolean;
  68914. shadersRepository: string;
  68915. includesShadersStore: {
  68916. [key: string]: string;
  68917. };
  68918. processor?: IShaderProcessor;
  68919. version: string;
  68920. platformName: string;
  68921. lookForClosingBracketForUniformBuffer?: boolean;
  68922. }
  68923. }
  68924. declare module BABYLON {
  68925. /** @hidden */
  68926. export class ShaderCodeNode {
  68927. line: string;
  68928. children: ShaderCodeNode[];
  68929. additionalDefineKey?: string;
  68930. additionalDefineValue?: string;
  68931. isValid(preprocessors: {
  68932. [key: string]: string;
  68933. }): boolean;
  68934. process(preprocessors: {
  68935. [key: string]: string;
  68936. }, options: ProcessingOptions): string;
  68937. }
  68938. }
  68939. declare module BABYLON {
  68940. /** @hidden */
  68941. export class ShaderCodeCursor {
  68942. private _lines;
  68943. lineIndex: number;
  68944. readonly currentLine: string;
  68945. readonly canRead: boolean;
  68946. lines: string[];
  68947. }
  68948. }
  68949. declare module BABYLON {
  68950. /** @hidden */
  68951. export class ShaderCodeConditionNode extends ShaderCodeNode {
  68952. process(preprocessors: {
  68953. [key: string]: string;
  68954. }, options: ProcessingOptions): string;
  68955. }
  68956. }
  68957. declare module BABYLON {
  68958. /** @hidden */
  68959. export class ShaderDefineExpression {
  68960. isTrue(preprocessors: {
  68961. [key: string]: string;
  68962. }): boolean;
  68963. }
  68964. }
  68965. declare module BABYLON {
  68966. /** @hidden */
  68967. export class ShaderCodeTestNode extends ShaderCodeNode {
  68968. testExpression: ShaderDefineExpression;
  68969. isValid(preprocessors: {
  68970. [key: string]: string;
  68971. }): boolean;
  68972. }
  68973. }
  68974. declare module BABYLON {
  68975. /** @hidden */
  68976. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  68977. define: string;
  68978. not: boolean;
  68979. constructor(define: string, not?: boolean);
  68980. isTrue(preprocessors: {
  68981. [key: string]: string;
  68982. }): boolean;
  68983. }
  68984. }
  68985. declare module BABYLON {
  68986. /** @hidden */
  68987. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  68988. leftOperand: ShaderDefineExpression;
  68989. rightOperand: ShaderDefineExpression;
  68990. isTrue(preprocessors: {
  68991. [key: string]: string;
  68992. }): boolean;
  68993. }
  68994. }
  68995. declare module BABYLON {
  68996. /** @hidden */
  68997. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  68998. leftOperand: ShaderDefineExpression;
  68999. rightOperand: ShaderDefineExpression;
  69000. isTrue(preprocessors: {
  69001. [key: string]: string;
  69002. }): boolean;
  69003. }
  69004. }
  69005. declare module BABYLON {
  69006. /** @hidden */
  69007. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  69008. define: string;
  69009. operand: string;
  69010. testValue: string;
  69011. constructor(define: string, operand: string, testValue: string);
  69012. isTrue(preprocessors: {
  69013. [key: string]: string;
  69014. }): boolean;
  69015. }
  69016. }
  69017. declare module BABYLON {
  69018. /**
  69019. * Class used to enable access to offline support
  69020. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  69021. */
  69022. export interface IOfflineProvider {
  69023. /**
  69024. * Gets a boolean indicating if scene must be saved in the database
  69025. */
  69026. enableSceneOffline: boolean;
  69027. /**
  69028. * Gets a boolean indicating if textures must be saved in the database
  69029. */
  69030. enableTexturesOffline: boolean;
  69031. /**
  69032. * Open the offline support and make it available
  69033. * @param successCallback defines the callback to call on success
  69034. * @param errorCallback defines the callback to call on error
  69035. */
  69036. open(successCallback: () => void, errorCallback: () => void): void;
  69037. /**
  69038. * Loads an image from the offline support
  69039. * @param url defines the url to load from
  69040. * @param image defines the target DOM image
  69041. */
  69042. loadImage(url: string, image: HTMLImageElement): void;
  69043. /**
  69044. * Loads a file from offline support
  69045. * @param url defines the URL to load from
  69046. * @param sceneLoaded defines a callback to call on success
  69047. * @param progressCallBack defines a callback to call when progress changed
  69048. * @param errorCallback defines a callback to call on error
  69049. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  69050. */
  69051. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  69052. }
  69053. }
  69054. declare module BABYLON {
  69055. /**
  69056. * Class used to help managing file picking and drag'n'drop
  69057. * File Storage
  69058. */
  69059. export class FilesInputStore {
  69060. /**
  69061. * List of files ready to be loaded
  69062. */
  69063. static FilesToLoad: {
  69064. [key: string]: File;
  69065. };
  69066. }
  69067. }
  69068. declare module BABYLON {
  69069. /**
  69070. * Class used to define a retry strategy when error happens while loading assets
  69071. */
  69072. export class RetryStrategy {
  69073. /**
  69074. * Function used to defines an exponential back off strategy
  69075. * @param maxRetries defines the maximum number of retries (3 by default)
  69076. * @param baseInterval defines the interval between retries
  69077. * @returns the strategy function to use
  69078. */
  69079. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  69080. }
  69081. }
  69082. declare module BABYLON {
  69083. /**
  69084. * @ignore
  69085. * Application error to support additional information when loading a file
  69086. */
  69087. export abstract class BaseError extends Error {
  69088. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  69089. }
  69090. }
  69091. declare module BABYLON {
  69092. /** @ignore */
  69093. export class LoadFileError extends BaseError {
  69094. request?: WebRequest;
  69095. file?: File;
  69096. /**
  69097. * Creates a new LoadFileError
  69098. * @param message defines the message of the error
  69099. * @param request defines the optional web request
  69100. * @param file defines the optional file
  69101. */
  69102. constructor(message: string, object?: WebRequest | File);
  69103. }
  69104. /** @ignore */
  69105. export class RequestFileError extends BaseError {
  69106. request: WebRequest;
  69107. /**
  69108. * Creates a new LoadFileError
  69109. * @param message defines the message of the error
  69110. * @param request defines the optional web request
  69111. */
  69112. constructor(message: string, request: WebRequest);
  69113. }
  69114. /** @ignore */
  69115. export class ReadFileError extends BaseError {
  69116. file: File;
  69117. /**
  69118. * Creates a new ReadFileError
  69119. * @param message defines the message of the error
  69120. * @param file defines the optional file
  69121. */
  69122. constructor(message: string, file: File);
  69123. }
  69124. /**
  69125. * @hidden
  69126. */
  69127. export class FileTools {
  69128. /**
  69129. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  69130. */
  69131. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  69132. /**
  69133. * Gets or sets the base URL to use to load assets
  69134. */
  69135. static BaseUrl: string;
  69136. /**
  69137. * Default behaviour for cors in the application.
  69138. * It can be a string if the expected behavior is identical in the entire app.
  69139. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  69140. */
  69141. static CorsBehavior: string | ((url: string | string[]) => string);
  69142. /**
  69143. * Gets or sets a function used to pre-process url before using them to load assets
  69144. */
  69145. static PreprocessUrl: (url: string) => string;
  69146. /**
  69147. * Removes unwanted characters from an url
  69148. * @param url defines the url to clean
  69149. * @returns the cleaned url
  69150. */
  69151. private static _CleanUrl;
  69152. /**
  69153. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  69154. * @param url define the url we are trying
  69155. * @param element define the dom element where to configure the cors policy
  69156. */
  69157. static SetCorsBehavior(url: string | string[], element: {
  69158. crossOrigin: string | null;
  69159. }): void;
  69160. /**
  69161. * Loads an image as an HTMLImageElement.
  69162. * @param input url string, ArrayBuffer, or Blob to load
  69163. * @param onLoad callback called when the image successfully loads
  69164. * @param onError callback called when the image fails to load
  69165. * @param offlineProvider offline provider for caching
  69166. * @param mimeType optional mime type
  69167. * @returns the HTMLImageElement of the loaded image
  69168. */
  69169. 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>;
  69170. /**
  69171. * Reads a file from a File object
  69172. * @param file defines the file to load
  69173. * @param onSuccess defines the callback to call when data is loaded
  69174. * @param onProgress defines the callback to call during loading process
  69175. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  69176. * @param onError defines the callback to call when an error occurs
  69177. * @returns a file request object
  69178. */
  69179. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  69180. /**
  69181. * Loads a file from a url
  69182. * @param url url to load
  69183. * @param onSuccess callback called when the file successfully loads
  69184. * @param onProgress callback called while file is loading (if the server supports this mode)
  69185. * @param offlineProvider defines the offline provider for caching
  69186. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  69187. * @param onError callback called when the file fails to load
  69188. * @returns a file request object
  69189. */
  69190. 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;
  69191. /**
  69192. * Loads a file
  69193. * @param url url to load
  69194. * @param onSuccess callback called when the file successfully loads
  69195. * @param onProgress callback called while file is loading (if the server supports this mode)
  69196. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  69197. * @param onError callback called when the file fails to load
  69198. * @param onOpened callback called when the web request is opened
  69199. * @returns a file request object
  69200. */
  69201. 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;
  69202. /**
  69203. * Checks if the loaded document was accessed via `file:`-Protocol.
  69204. * @returns boolean
  69205. */
  69206. static IsFileURL(): boolean;
  69207. }
  69208. }
  69209. declare module BABYLON {
  69210. /** @hidden */
  69211. export class ShaderProcessor {
  69212. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  69213. private static _ProcessPrecision;
  69214. private static _ExtractOperation;
  69215. private static _BuildSubExpression;
  69216. private static _BuildExpression;
  69217. private static _MoveCursorWithinIf;
  69218. private static _MoveCursor;
  69219. private static _EvaluatePreProcessors;
  69220. private static _PreparePreProcessors;
  69221. private static _ProcessShaderConversion;
  69222. private static _ProcessIncludes;
  69223. }
  69224. }
  69225. declare module BABYLON {
  69226. /**
  69227. * @hidden
  69228. */
  69229. export interface IColor4Like {
  69230. r: float;
  69231. g: float;
  69232. b: float;
  69233. a: float;
  69234. }
  69235. /**
  69236. * @hidden
  69237. */
  69238. export interface IColor3Like {
  69239. r: float;
  69240. g: float;
  69241. b: float;
  69242. }
  69243. /**
  69244. * @hidden
  69245. */
  69246. export interface IVector4Like {
  69247. x: float;
  69248. y: float;
  69249. z: float;
  69250. w: float;
  69251. }
  69252. /**
  69253. * @hidden
  69254. */
  69255. export interface IVector3Like {
  69256. x: float;
  69257. y: float;
  69258. z: float;
  69259. }
  69260. /**
  69261. * @hidden
  69262. */
  69263. export interface IVector2Like {
  69264. x: float;
  69265. y: float;
  69266. }
  69267. /**
  69268. * @hidden
  69269. */
  69270. export interface IMatrixLike {
  69271. toArray(): DeepImmutable<Float32Array>;
  69272. updateFlag: int;
  69273. }
  69274. /**
  69275. * @hidden
  69276. */
  69277. export interface IViewportLike {
  69278. x: float;
  69279. y: float;
  69280. width: float;
  69281. height: float;
  69282. }
  69283. /**
  69284. * @hidden
  69285. */
  69286. export interface IPlaneLike {
  69287. normal: IVector3Like;
  69288. d: float;
  69289. normalize(): void;
  69290. }
  69291. }
  69292. declare module BABYLON {
  69293. /**
  69294. * Interface used to define common properties for effect fallbacks
  69295. */
  69296. export interface IEffectFallbacks {
  69297. /**
  69298. * Removes the defines that should be removed when falling back.
  69299. * @param currentDefines defines the current define statements for the shader.
  69300. * @param effect defines the current effect we try to compile
  69301. * @returns The resulting defines with defines of the current rank removed.
  69302. */
  69303. reduce(currentDefines: string, effect: Effect): string;
  69304. /**
  69305. * Removes the fallback from the bound mesh.
  69306. */
  69307. unBindMesh(): void;
  69308. /**
  69309. * Checks to see if more fallbacks are still availible.
  69310. */
  69311. hasMoreFallbacks: boolean;
  69312. }
  69313. }
  69314. declare module BABYLON {
  69315. /**
  69316. * Class used to evalaute queries containing `and` and `or` operators
  69317. */
  69318. export class AndOrNotEvaluator {
  69319. /**
  69320. * Evaluate a query
  69321. * @param query defines the query to evaluate
  69322. * @param evaluateCallback defines the callback used to filter result
  69323. * @returns true if the query matches
  69324. */
  69325. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  69326. private static _HandleParenthesisContent;
  69327. private static _SimplifyNegation;
  69328. }
  69329. }
  69330. declare module BABYLON {
  69331. /**
  69332. * Class used to store custom tags
  69333. */
  69334. export class Tags {
  69335. /**
  69336. * Adds support for tags on the given object
  69337. * @param obj defines the object to use
  69338. */
  69339. static EnableFor(obj: any): void;
  69340. /**
  69341. * Removes tags support
  69342. * @param obj defines the object to use
  69343. */
  69344. static DisableFor(obj: any): void;
  69345. /**
  69346. * Gets a boolean indicating if the given object has tags
  69347. * @param obj defines the object to use
  69348. * @returns a boolean
  69349. */
  69350. static HasTags(obj: any): boolean;
  69351. /**
  69352. * Gets the tags available on a given object
  69353. * @param obj defines the object to use
  69354. * @param asString defines if the tags must be returned as a string instead of an array of strings
  69355. * @returns the tags
  69356. */
  69357. static GetTags(obj: any, asString?: boolean): any;
  69358. /**
  69359. * Adds tags to an object
  69360. * @param obj defines the object to use
  69361. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  69362. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  69363. */
  69364. static AddTagsTo(obj: any, tagsString: string): void;
  69365. /**
  69366. * @hidden
  69367. */
  69368. static _AddTagTo(obj: any, tag: string): void;
  69369. /**
  69370. * Removes specific tags from a specific object
  69371. * @param obj defines the object to use
  69372. * @param tagsString defines the tags to remove
  69373. */
  69374. static RemoveTagsFrom(obj: any, tagsString: string): void;
  69375. /**
  69376. * @hidden
  69377. */
  69378. static _RemoveTagFrom(obj: any, tag: string): void;
  69379. /**
  69380. * Defines if tags hosted on an object match a given query
  69381. * @param obj defines the object to use
  69382. * @param tagsQuery defines the tag query
  69383. * @returns a boolean
  69384. */
  69385. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  69386. }
  69387. }
  69388. declare module BABYLON {
  69389. /**
  69390. * Scalar computation library
  69391. */
  69392. export class Scalar {
  69393. /**
  69394. * Two pi constants convenient for computation.
  69395. */
  69396. static TwoPi: number;
  69397. /**
  69398. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  69399. * @param a number
  69400. * @param b number
  69401. * @param epsilon (default = 1.401298E-45)
  69402. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  69403. */
  69404. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  69405. /**
  69406. * Returns a string : the upper case translation of the number i to hexadecimal.
  69407. * @param i number
  69408. * @returns the upper case translation of the number i to hexadecimal.
  69409. */
  69410. static ToHex(i: number): string;
  69411. /**
  69412. * Returns -1 if value is negative and +1 is value is positive.
  69413. * @param value the value
  69414. * @returns the value itself if it's equal to zero.
  69415. */
  69416. static Sign(value: number): number;
  69417. /**
  69418. * Returns the value itself if it's between min and max.
  69419. * Returns min if the value is lower than min.
  69420. * Returns max if the value is greater than max.
  69421. * @param value the value to clmap
  69422. * @param min the min value to clamp to (default: 0)
  69423. * @param max the max value to clamp to (default: 1)
  69424. * @returns the clamped value
  69425. */
  69426. static Clamp(value: number, min?: number, max?: number): number;
  69427. /**
  69428. * the log2 of value.
  69429. * @param value the value to compute log2 of
  69430. * @returns the log2 of value.
  69431. */
  69432. static Log2(value: number): number;
  69433. /**
  69434. * Loops the value, so that it is never larger than length and never smaller than 0.
  69435. *
  69436. * This is similar to the modulo operator but it works with floating point numbers.
  69437. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  69438. * With t = 5 and length = 2.5, the result would be 0.0.
  69439. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  69440. * @param value the value
  69441. * @param length the length
  69442. * @returns the looped value
  69443. */
  69444. static Repeat(value: number, length: number): number;
  69445. /**
  69446. * Normalize the value between 0.0 and 1.0 using min and max values
  69447. * @param value value to normalize
  69448. * @param min max to normalize between
  69449. * @param max min to normalize between
  69450. * @returns the normalized value
  69451. */
  69452. static Normalize(value: number, min: number, max: number): number;
  69453. /**
  69454. * Denormalize the value from 0.0 and 1.0 using min and max values
  69455. * @param normalized value to denormalize
  69456. * @param min max to denormalize between
  69457. * @param max min to denormalize between
  69458. * @returns the denormalized value
  69459. */
  69460. static Denormalize(normalized: number, min: number, max: number): number;
  69461. /**
  69462. * Calculates the shortest difference between two given angles given in degrees.
  69463. * @param current current angle in degrees
  69464. * @param target target angle in degrees
  69465. * @returns the delta
  69466. */
  69467. static DeltaAngle(current: number, target: number): number;
  69468. /**
  69469. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  69470. * @param tx value
  69471. * @param length length
  69472. * @returns The returned value will move back and forth between 0 and length
  69473. */
  69474. static PingPong(tx: number, length: number): number;
  69475. /**
  69476. * Interpolates between min and max with smoothing at the limits.
  69477. *
  69478. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  69479. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  69480. * @param from from
  69481. * @param to to
  69482. * @param tx value
  69483. * @returns the smooth stepped value
  69484. */
  69485. static SmoothStep(from: number, to: number, tx: number): number;
  69486. /**
  69487. * Moves a value current towards target.
  69488. *
  69489. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  69490. * Negative values of maxDelta pushes the value away from target.
  69491. * @param current current value
  69492. * @param target target value
  69493. * @param maxDelta max distance to move
  69494. * @returns resulting value
  69495. */
  69496. static MoveTowards(current: number, target: number, maxDelta: number): number;
  69497. /**
  69498. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  69499. *
  69500. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  69501. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  69502. * @param current current value
  69503. * @param target target value
  69504. * @param maxDelta max distance to move
  69505. * @returns resulting angle
  69506. */
  69507. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  69508. /**
  69509. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  69510. * @param start start value
  69511. * @param end target value
  69512. * @param amount amount to lerp between
  69513. * @returns the lerped value
  69514. */
  69515. static Lerp(start: number, end: number, amount: number): number;
  69516. /**
  69517. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  69518. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  69519. * @param start start value
  69520. * @param end target value
  69521. * @param amount amount to lerp between
  69522. * @returns the lerped value
  69523. */
  69524. static LerpAngle(start: number, end: number, amount: number): number;
  69525. /**
  69526. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  69527. * @param a start value
  69528. * @param b target value
  69529. * @param value value between a and b
  69530. * @returns the inverseLerp value
  69531. */
  69532. static InverseLerp(a: number, b: number, value: number): number;
  69533. /**
  69534. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  69535. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  69536. * @param value1 spline value
  69537. * @param tangent1 spline value
  69538. * @param value2 spline value
  69539. * @param tangent2 spline value
  69540. * @param amount input value
  69541. * @returns hermite result
  69542. */
  69543. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  69544. /**
  69545. * Returns a random float number between and min and max values
  69546. * @param min min value of random
  69547. * @param max max value of random
  69548. * @returns random value
  69549. */
  69550. static RandomRange(min: number, max: number): number;
  69551. /**
  69552. * This function returns percentage of a number in a given range.
  69553. *
  69554. * RangeToPercent(40,20,60) will return 0.5 (50%)
  69555. * RangeToPercent(34,0,100) will return 0.34 (34%)
  69556. * @param number to convert to percentage
  69557. * @param min min range
  69558. * @param max max range
  69559. * @returns the percentage
  69560. */
  69561. static RangeToPercent(number: number, min: number, max: number): number;
  69562. /**
  69563. * This function returns number that corresponds to the percentage in a given range.
  69564. *
  69565. * PercentToRange(0.34,0,100) will return 34.
  69566. * @param percent to convert to number
  69567. * @param min min range
  69568. * @param max max range
  69569. * @returns the number
  69570. */
  69571. static PercentToRange(percent: number, min: number, max: number): number;
  69572. /**
  69573. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  69574. * @param angle The angle to normalize in radian.
  69575. * @return The converted angle.
  69576. */
  69577. static NormalizeRadians(angle: number): number;
  69578. }
  69579. }
  69580. declare module BABYLON {
  69581. /**
  69582. * Constant used to convert a value to gamma space
  69583. * @ignorenaming
  69584. */
  69585. export const ToGammaSpace: number;
  69586. /**
  69587. * Constant used to convert a value to linear space
  69588. * @ignorenaming
  69589. */
  69590. export const ToLinearSpace = 2.2;
  69591. /**
  69592. * Constant used to define the minimal number value in Babylon.js
  69593. * @ignorenaming
  69594. */
  69595. let Epsilon: number;
  69596. }
  69597. declare module BABYLON {
  69598. /**
  69599. * Class used to represent a viewport on screen
  69600. */
  69601. export class Viewport {
  69602. /** viewport left coordinate */
  69603. x: number;
  69604. /** viewport top coordinate */
  69605. y: number;
  69606. /**viewport width */
  69607. width: number;
  69608. /** viewport height */
  69609. height: number;
  69610. /**
  69611. * Creates a Viewport object located at (x, y) and sized (width, height)
  69612. * @param x defines viewport left coordinate
  69613. * @param y defines viewport top coordinate
  69614. * @param width defines the viewport width
  69615. * @param height defines the viewport height
  69616. */
  69617. constructor(
  69618. /** viewport left coordinate */
  69619. x: number,
  69620. /** viewport top coordinate */
  69621. y: number,
  69622. /**viewport width */
  69623. width: number,
  69624. /** viewport height */
  69625. height: number);
  69626. /**
  69627. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  69628. * @param renderWidth defines the rendering width
  69629. * @param renderHeight defines the rendering height
  69630. * @returns a new Viewport
  69631. */
  69632. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  69633. /**
  69634. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  69635. * @param renderWidth defines the rendering width
  69636. * @param renderHeight defines the rendering height
  69637. * @param ref defines the target viewport
  69638. * @returns the current viewport
  69639. */
  69640. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  69641. /**
  69642. * Returns a new Viewport copied from the current one
  69643. * @returns a new Viewport
  69644. */
  69645. clone(): Viewport;
  69646. }
  69647. }
  69648. declare module BABYLON {
  69649. /**
  69650. * Class containing a set of static utilities functions for arrays.
  69651. */
  69652. export class ArrayTools {
  69653. /**
  69654. * Returns an array of the given size filled with element built from the given constructor and the paramters
  69655. * @param size the number of element to construct and put in the array
  69656. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  69657. * @returns a new array filled with new objects
  69658. */
  69659. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  69660. }
  69661. }
  69662. declare module BABYLON {
  69663. /**
  69664. * Class representing a vector containing 2 coordinates
  69665. */
  69666. export class Vector2 {
  69667. /** defines the first coordinate */
  69668. x: number;
  69669. /** defines the second coordinate */
  69670. y: number;
  69671. /**
  69672. * Creates a new Vector2 from the given x and y coordinates
  69673. * @param x defines the first coordinate
  69674. * @param y defines the second coordinate
  69675. */
  69676. constructor(
  69677. /** defines the first coordinate */
  69678. x?: number,
  69679. /** defines the second coordinate */
  69680. y?: number);
  69681. /**
  69682. * Gets a string with the Vector2 coordinates
  69683. * @returns a string with the Vector2 coordinates
  69684. */
  69685. toString(): string;
  69686. /**
  69687. * Gets class name
  69688. * @returns the string "Vector2"
  69689. */
  69690. getClassName(): string;
  69691. /**
  69692. * Gets current vector hash code
  69693. * @returns the Vector2 hash code as a number
  69694. */
  69695. getHashCode(): number;
  69696. /**
  69697. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  69698. * @param array defines the source array
  69699. * @param index defines the offset in source array
  69700. * @returns the current Vector2
  69701. */
  69702. toArray(array: FloatArray, index?: number): Vector2;
  69703. /**
  69704. * Copy the current vector to an array
  69705. * @returns a new array with 2 elements: the Vector2 coordinates.
  69706. */
  69707. asArray(): number[];
  69708. /**
  69709. * Sets the Vector2 coordinates with the given Vector2 coordinates
  69710. * @param source defines the source Vector2
  69711. * @returns the current updated Vector2
  69712. */
  69713. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  69714. /**
  69715. * Sets the Vector2 coordinates with the given floats
  69716. * @param x defines the first coordinate
  69717. * @param y defines the second coordinate
  69718. * @returns the current updated Vector2
  69719. */
  69720. copyFromFloats(x: number, y: number): Vector2;
  69721. /**
  69722. * Sets the Vector2 coordinates with the given floats
  69723. * @param x defines the first coordinate
  69724. * @param y defines the second coordinate
  69725. * @returns the current updated Vector2
  69726. */
  69727. set(x: number, y: number): Vector2;
  69728. /**
  69729. * Add another vector with the current one
  69730. * @param otherVector defines the other vector
  69731. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  69732. */
  69733. add(otherVector: DeepImmutable<Vector2>): Vector2;
  69734. /**
  69735. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  69736. * @param otherVector defines the other vector
  69737. * @param result defines the target vector
  69738. * @returns the unmodified current Vector2
  69739. */
  69740. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  69741. /**
  69742. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  69743. * @param otherVector defines the other vector
  69744. * @returns the current updated Vector2
  69745. */
  69746. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  69747. /**
  69748. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  69749. * @param otherVector defines the other vector
  69750. * @returns a new Vector2
  69751. */
  69752. addVector3(otherVector: Vector3): Vector2;
  69753. /**
  69754. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  69755. * @param otherVector defines the other vector
  69756. * @returns a new Vector2
  69757. */
  69758. subtract(otherVector: Vector2): Vector2;
  69759. /**
  69760. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  69761. * @param otherVector defines the other vector
  69762. * @param result defines the target vector
  69763. * @returns the unmodified current Vector2
  69764. */
  69765. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  69766. /**
  69767. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  69768. * @param otherVector defines the other vector
  69769. * @returns the current updated Vector2
  69770. */
  69771. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  69772. /**
  69773. * Multiplies in place the current Vector2 coordinates by the given ones
  69774. * @param otherVector defines the other vector
  69775. * @returns the current updated Vector2
  69776. */
  69777. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  69778. /**
  69779. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  69780. * @param otherVector defines the other vector
  69781. * @returns a new Vector2
  69782. */
  69783. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  69784. /**
  69785. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  69786. * @param otherVector defines the other vector
  69787. * @param result defines the target vector
  69788. * @returns the unmodified current Vector2
  69789. */
  69790. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  69791. /**
  69792. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  69793. * @param x defines the first coordinate
  69794. * @param y defines the second coordinate
  69795. * @returns a new Vector2
  69796. */
  69797. multiplyByFloats(x: number, y: number): Vector2;
  69798. /**
  69799. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  69800. * @param otherVector defines the other vector
  69801. * @returns a new Vector2
  69802. */
  69803. divide(otherVector: Vector2): Vector2;
  69804. /**
  69805. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  69806. * @param otherVector defines the other vector
  69807. * @param result defines the target vector
  69808. * @returns the unmodified current Vector2
  69809. */
  69810. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  69811. /**
  69812. * Divides the current Vector2 coordinates by the given ones
  69813. * @param otherVector defines the other vector
  69814. * @returns the current updated Vector2
  69815. */
  69816. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  69817. /**
  69818. * Gets a new Vector2 with current Vector2 negated coordinates
  69819. * @returns a new Vector2
  69820. */
  69821. negate(): Vector2;
  69822. /**
  69823. * Multiply the Vector2 coordinates by scale
  69824. * @param scale defines the scaling factor
  69825. * @returns the current updated Vector2
  69826. */
  69827. scaleInPlace(scale: number): Vector2;
  69828. /**
  69829. * Returns a new Vector2 scaled by "scale" from the current Vector2
  69830. * @param scale defines the scaling factor
  69831. * @returns a new Vector2
  69832. */
  69833. scale(scale: number): Vector2;
  69834. /**
  69835. * Scale the current Vector2 values by a factor to a given Vector2
  69836. * @param scale defines the scale factor
  69837. * @param result defines the Vector2 object where to store the result
  69838. * @returns the unmodified current Vector2
  69839. */
  69840. scaleToRef(scale: number, result: Vector2): Vector2;
  69841. /**
  69842. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  69843. * @param scale defines the scale factor
  69844. * @param result defines the Vector2 object where to store the result
  69845. * @returns the unmodified current Vector2
  69846. */
  69847. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  69848. /**
  69849. * Gets a boolean if two vectors are equals
  69850. * @param otherVector defines the other vector
  69851. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  69852. */
  69853. equals(otherVector: DeepImmutable<Vector2>): boolean;
  69854. /**
  69855. * Gets a boolean if two vectors are equals (using an epsilon value)
  69856. * @param otherVector defines the other vector
  69857. * @param epsilon defines the minimal distance to consider equality
  69858. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  69859. */
  69860. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  69861. /**
  69862. * Gets a new Vector2 from current Vector2 floored values
  69863. * @returns a new Vector2
  69864. */
  69865. floor(): Vector2;
  69866. /**
  69867. * Gets a new Vector2 from current Vector2 floored values
  69868. * @returns a new Vector2
  69869. */
  69870. fract(): Vector2;
  69871. /**
  69872. * Gets the length of the vector
  69873. * @returns the vector length (float)
  69874. */
  69875. length(): number;
  69876. /**
  69877. * Gets the vector squared length
  69878. * @returns the vector squared length (float)
  69879. */
  69880. lengthSquared(): number;
  69881. /**
  69882. * Normalize the vector
  69883. * @returns the current updated Vector2
  69884. */
  69885. normalize(): Vector2;
  69886. /**
  69887. * Gets a new Vector2 copied from the Vector2
  69888. * @returns a new Vector2
  69889. */
  69890. clone(): Vector2;
  69891. /**
  69892. * Gets a new Vector2(0, 0)
  69893. * @returns a new Vector2
  69894. */
  69895. static Zero(): Vector2;
  69896. /**
  69897. * Gets a new Vector2(1, 1)
  69898. * @returns a new Vector2
  69899. */
  69900. static One(): Vector2;
  69901. /**
  69902. * Gets a new Vector2 set from the given index element of the given array
  69903. * @param array defines the data source
  69904. * @param offset defines the offset in the data source
  69905. * @returns a new Vector2
  69906. */
  69907. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  69908. /**
  69909. * Sets "result" from the given index element of the given array
  69910. * @param array defines the data source
  69911. * @param offset defines the offset in the data source
  69912. * @param result defines the target vector
  69913. */
  69914. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  69915. /**
  69916. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  69917. * @param value1 defines 1st point of control
  69918. * @param value2 defines 2nd point of control
  69919. * @param value3 defines 3rd point of control
  69920. * @param value4 defines 4th point of control
  69921. * @param amount defines the interpolation factor
  69922. * @returns a new Vector2
  69923. */
  69924. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  69925. /**
  69926. * 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".
  69927. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  69928. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  69929. * @param value defines the value to clamp
  69930. * @param min defines the lower limit
  69931. * @param max defines the upper limit
  69932. * @returns a new Vector2
  69933. */
  69934. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  69935. /**
  69936. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  69937. * @param value1 defines the 1st control point
  69938. * @param tangent1 defines the outgoing tangent
  69939. * @param value2 defines the 2nd control point
  69940. * @param tangent2 defines the incoming tangent
  69941. * @param amount defines the interpolation factor
  69942. * @returns a new Vector2
  69943. */
  69944. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  69945. /**
  69946. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  69947. * @param start defines the start vector
  69948. * @param end defines the end vector
  69949. * @param amount defines the interpolation factor
  69950. * @returns a new Vector2
  69951. */
  69952. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  69953. /**
  69954. * Gets the dot product of the vector "left" and the vector "right"
  69955. * @param left defines first vector
  69956. * @param right defines second vector
  69957. * @returns the dot product (float)
  69958. */
  69959. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  69960. /**
  69961. * Returns a new Vector2 equal to the normalized given vector
  69962. * @param vector defines the vector to normalize
  69963. * @returns a new Vector2
  69964. */
  69965. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  69966. /**
  69967. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  69968. * @param left defines 1st vector
  69969. * @param right defines 2nd vector
  69970. * @returns a new Vector2
  69971. */
  69972. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  69973. /**
  69974. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  69975. * @param left defines 1st vector
  69976. * @param right defines 2nd vector
  69977. * @returns a new Vector2
  69978. */
  69979. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  69980. /**
  69981. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  69982. * @param vector defines the vector to transform
  69983. * @param transformation defines the matrix to apply
  69984. * @returns a new Vector2
  69985. */
  69986. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  69987. /**
  69988. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  69989. * @param vector defines the vector to transform
  69990. * @param transformation defines the matrix to apply
  69991. * @param result defines the target vector
  69992. */
  69993. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  69994. /**
  69995. * Determines if a given vector is included in a triangle
  69996. * @param p defines the vector to test
  69997. * @param p0 defines 1st triangle point
  69998. * @param p1 defines 2nd triangle point
  69999. * @param p2 defines 3rd triangle point
  70000. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  70001. */
  70002. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  70003. /**
  70004. * Gets the distance between the vectors "value1" and "value2"
  70005. * @param value1 defines first vector
  70006. * @param value2 defines second vector
  70007. * @returns the distance between vectors
  70008. */
  70009. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  70010. /**
  70011. * Returns the squared distance between the vectors "value1" and "value2"
  70012. * @param value1 defines first vector
  70013. * @param value2 defines second vector
  70014. * @returns the squared distance between vectors
  70015. */
  70016. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  70017. /**
  70018. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  70019. * @param value1 defines first vector
  70020. * @param value2 defines second vector
  70021. * @returns a new Vector2
  70022. */
  70023. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  70024. /**
  70025. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  70026. * @param p defines the middle point
  70027. * @param segA defines one point of the segment
  70028. * @param segB defines the other point of the segment
  70029. * @returns the shortest distance
  70030. */
  70031. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  70032. }
  70033. /**
  70034. * Classed used to store (x,y,z) vector representation
  70035. * A Vector3 is the main object used in 3D geometry
  70036. * It can represent etiher the coordinates of a point the space, either a direction
  70037. * Reminder: js uses a left handed forward facing system
  70038. */
  70039. export class Vector3 {
  70040. /**
  70041. * Defines the first coordinates (on X axis)
  70042. */
  70043. x: number;
  70044. /**
  70045. * Defines the second coordinates (on Y axis)
  70046. */
  70047. y: number;
  70048. /**
  70049. * Defines the third coordinates (on Z axis)
  70050. */
  70051. z: number;
  70052. private static _UpReadOnly;
  70053. private static _ZeroReadOnly;
  70054. /**
  70055. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  70056. * @param x defines the first coordinates (on X axis)
  70057. * @param y defines the second coordinates (on Y axis)
  70058. * @param z defines the third coordinates (on Z axis)
  70059. */
  70060. constructor(
  70061. /**
  70062. * Defines the first coordinates (on X axis)
  70063. */
  70064. x?: number,
  70065. /**
  70066. * Defines the second coordinates (on Y axis)
  70067. */
  70068. y?: number,
  70069. /**
  70070. * Defines the third coordinates (on Z axis)
  70071. */
  70072. z?: number);
  70073. /**
  70074. * Creates a string representation of the Vector3
  70075. * @returns a string with the Vector3 coordinates.
  70076. */
  70077. toString(): string;
  70078. /**
  70079. * Gets the class name
  70080. * @returns the string "Vector3"
  70081. */
  70082. getClassName(): string;
  70083. /**
  70084. * Creates the Vector3 hash code
  70085. * @returns a number which tends to be unique between Vector3 instances
  70086. */
  70087. getHashCode(): number;
  70088. /**
  70089. * Creates an array containing three elements : the coordinates of the Vector3
  70090. * @returns a new array of numbers
  70091. */
  70092. asArray(): number[];
  70093. /**
  70094. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  70095. * @param array defines the destination array
  70096. * @param index defines the offset in the destination array
  70097. * @returns the current Vector3
  70098. */
  70099. toArray(array: FloatArray, index?: number): Vector3;
  70100. /**
  70101. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  70102. * @returns a new Quaternion object, computed from the Vector3 coordinates
  70103. */
  70104. toQuaternion(): Quaternion;
  70105. /**
  70106. * Adds the given vector to the current Vector3
  70107. * @param otherVector defines the second operand
  70108. * @returns the current updated Vector3
  70109. */
  70110. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70111. /**
  70112. * Adds the given coordinates to the current Vector3
  70113. * @param x defines the x coordinate of the operand
  70114. * @param y defines the y coordinate of the operand
  70115. * @param z defines the z coordinate of the operand
  70116. * @returns the current updated Vector3
  70117. */
  70118. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70119. /**
  70120. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  70121. * @param otherVector defines the second operand
  70122. * @returns the resulting Vector3
  70123. */
  70124. add(otherVector: DeepImmutable<Vector3>): Vector3;
  70125. /**
  70126. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  70127. * @param otherVector defines the second operand
  70128. * @param result defines the Vector3 object where to store the result
  70129. * @returns the current Vector3
  70130. */
  70131. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70132. /**
  70133. * Subtract the given vector from the current Vector3
  70134. * @param otherVector defines the second operand
  70135. * @returns the current updated Vector3
  70136. */
  70137. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70138. /**
  70139. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  70140. * @param otherVector defines the second operand
  70141. * @returns the resulting Vector3
  70142. */
  70143. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  70144. /**
  70145. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  70146. * @param otherVector defines the second operand
  70147. * @param result defines the Vector3 object where to store the result
  70148. * @returns the current Vector3
  70149. */
  70150. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70151. /**
  70152. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  70153. * @param x defines the x coordinate of the operand
  70154. * @param y defines the y coordinate of the operand
  70155. * @param z defines the z coordinate of the operand
  70156. * @returns the resulting Vector3
  70157. */
  70158. subtractFromFloats(x: number, y: number, z: number): Vector3;
  70159. /**
  70160. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  70161. * @param x defines the x coordinate of the operand
  70162. * @param y defines the y coordinate of the operand
  70163. * @param z defines the z coordinate of the operand
  70164. * @param result defines the Vector3 object where to store the result
  70165. * @returns the current Vector3
  70166. */
  70167. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  70168. /**
  70169. * Gets a new Vector3 set with the current Vector3 negated coordinates
  70170. * @returns a new Vector3
  70171. */
  70172. negate(): Vector3;
  70173. /**
  70174. * Multiplies the Vector3 coordinates by the float "scale"
  70175. * @param scale defines the multiplier factor
  70176. * @returns the current updated Vector3
  70177. */
  70178. scaleInPlace(scale: number): Vector3;
  70179. /**
  70180. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  70181. * @param scale defines the multiplier factor
  70182. * @returns a new Vector3
  70183. */
  70184. scale(scale: number): Vector3;
  70185. /**
  70186. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  70187. * @param scale defines the multiplier factor
  70188. * @param result defines the Vector3 object where to store the result
  70189. * @returns the current Vector3
  70190. */
  70191. scaleToRef(scale: number, result: Vector3): Vector3;
  70192. /**
  70193. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  70194. * @param scale defines the scale factor
  70195. * @param result defines the Vector3 object where to store the result
  70196. * @returns the unmodified current Vector3
  70197. */
  70198. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  70199. /**
  70200. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  70201. * @param otherVector defines the second operand
  70202. * @returns true if both vectors are equals
  70203. */
  70204. equals(otherVector: DeepImmutable<Vector3>): boolean;
  70205. /**
  70206. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  70207. * @param otherVector defines the second operand
  70208. * @param epsilon defines the minimal distance to define values as equals
  70209. * @returns true if both vectors are distant less than epsilon
  70210. */
  70211. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  70212. /**
  70213. * Returns true if the current Vector3 coordinates equals the given floats
  70214. * @param x defines the x coordinate of the operand
  70215. * @param y defines the y coordinate of the operand
  70216. * @param z defines the z coordinate of the operand
  70217. * @returns true if both vectors are equals
  70218. */
  70219. equalsToFloats(x: number, y: number, z: number): boolean;
  70220. /**
  70221. * Multiplies the current Vector3 coordinates by the given ones
  70222. * @param otherVector defines the second operand
  70223. * @returns the current updated Vector3
  70224. */
  70225. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70226. /**
  70227. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  70228. * @param otherVector defines the second operand
  70229. * @returns the new Vector3
  70230. */
  70231. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  70232. /**
  70233. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  70234. * @param otherVector defines the second operand
  70235. * @param result defines the Vector3 object where to store the result
  70236. * @returns the current Vector3
  70237. */
  70238. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70239. /**
  70240. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  70241. * @param x defines the x coordinate of the operand
  70242. * @param y defines the y coordinate of the operand
  70243. * @param z defines the z coordinate of the operand
  70244. * @returns the new Vector3
  70245. */
  70246. multiplyByFloats(x: number, y: number, z: number): Vector3;
  70247. /**
  70248. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  70249. * @param otherVector defines the second operand
  70250. * @returns the new Vector3
  70251. */
  70252. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  70253. /**
  70254. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  70255. * @param otherVector defines the second operand
  70256. * @param result defines the Vector3 object where to store the result
  70257. * @returns the current Vector3
  70258. */
  70259. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70260. /**
  70261. * Divides the current Vector3 coordinates by the given ones.
  70262. * @param otherVector defines the second operand
  70263. * @returns the current updated Vector3
  70264. */
  70265. divideInPlace(otherVector: Vector3): Vector3;
  70266. /**
  70267. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  70268. * @param other defines the second operand
  70269. * @returns the current updated Vector3
  70270. */
  70271. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  70272. /**
  70273. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  70274. * @param other defines the second operand
  70275. * @returns the current updated Vector3
  70276. */
  70277. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  70278. /**
  70279. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  70280. * @param x defines the x coordinate of the operand
  70281. * @param y defines the y coordinate of the operand
  70282. * @param z defines the z coordinate of the operand
  70283. * @returns the current updated Vector3
  70284. */
  70285. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70286. /**
  70287. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  70288. * @param x defines the x coordinate of the operand
  70289. * @param y defines the y coordinate of the operand
  70290. * @param z defines the z coordinate of the operand
  70291. * @returns the current updated Vector3
  70292. */
  70293. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70294. /**
  70295. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  70296. * Check if is non uniform within a certain amount of decimal places to account for this
  70297. * @param epsilon the amount the values can differ
  70298. * @returns if the the vector is non uniform to a certain number of decimal places
  70299. */
  70300. isNonUniformWithinEpsilon(epsilon: number): boolean;
  70301. /**
  70302. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  70303. */
  70304. readonly isNonUniform: boolean;
  70305. /**
  70306. * Gets a new Vector3 from current Vector3 floored values
  70307. * @returns a new Vector3
  70308. */
  70309. floor(): Vector3;
  70310. /**
  70311. * Gets a new Vector3 from current Vector3 floored values
  70312. * @returns a new Vector3
  70313. */
  70314. fract(): Vector3;
  70315. /**
  70316. * Gets the length of the Vector3
  70317. * @returns the length of the Vector3
  70318. */
  70319. length(): number;
  70320. /**
  70321. * Gets the squared length of the Vector3
  70322. * @returns squared length of the Vector3
  70323. */
  70324. lengthSquared(): number;
  70325. /**
  70326. * Normalize the current Vector3.
  70327. * Please note that this is an in place operation.
  70328. * @returns the current updated Vector3
  70329. */
  70330. normalize(): Vector3;
  70331. /**
  70332. * Reorders the x y z properties of the vector in place
  70333. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  70334. * @returns the current updated vector
  70335. */
  70336. reorderInPlace(order: string): this;
  70337. /**
  70338. * Rotates the vector around 0,0,0 by a quaternion
  70339. * @param quaternion the rotation quaternion
  70340. * @param result vector to store the result
  70341. * @returns the resulting vector
  70342. */
  70343. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  70344. /**
  70345. * Rotates a vector around a given point
  70346. * @param quaternion the rotation quaternion
  70347. * @param point the point to rotate around
  70348. * @param result vector to store the result
  70349. * @returns the resulting vector
  70350. */
  70351. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  70352. /**
  70353. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  70354. * The cross product is then orthogonal to both current and "other"
  70355. * @param other defines the right operand
  70356. * @returns the cross product
  70357. */
  70358. cross(other: Vector3): Vector3;
  70359. /**
  70360. * Normalize the current Vector3 with the given input length.
  70361. * Please note that this is an in place operation.
  70362. * @param len the length of the vector
  70363. * @returns the current updated Vector3
  70364. */
  70365. normalizeFromLength(len: number): Vector3;
  70366. /**
  70367. * Normalize the current Vector3 to a new vector
  70368. * @returns the new Vector3
  70369. */
  70370. normalizeToNew(): Vector3;
  70371. /**
  70372. * Normalize the current Vector3 to the reference
  70373. * @param reference define the Vector3 to update
  70374. * @returns the updated Vector3
  70375. */
  70376. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  70377. /**
  70378. * Creates a new Vector3 copied from the current Vector3
  70379. * @returns the new Vector3
  70380. */
  70381. clone(): Vector3;
  70382. /**
  70383. * Copies the given vector coordinates to the current Vector3 ones
  70384. * @param source defines the source Vector3
  70385. * @returns the current updated Vector3
  70386. */
  70387. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  70388. /**
  70389. * Copies the given floats to the current Vector3 coordinates
  70390. * @param x defines the x coordinate of the operand
  70391. * @param y defines the y coordinate of the operand
  70392. * @param z defines the z coordinate of the operand
  70393. * @returns the current updated Vector3
  70394. */
  70395. copyFromFloats(x: number, y: number, z: number): Vector3;
  70396. /**
  70397. * Copies the given floats to the current Vector3 coordinates
  70398. * @param x defines the x coordinate of the operand
  70399. * @param y defines the y coordinate of the operand
  70400. * @param z defines the z coordinate of the operand
  70401. * @returns the current updated Vector3
  70402. */
  70403. set(x: number, y: number, z: number): Vector3;
  70404. /**
  70405. * Copies the given float to the current Vector3 coordinates
  70406. * @param v defines the x, y and z coordinates of the operand
  70407. * @returns the current updated Vector3
  70408. */
  70409. setAll(v: number): Vector3;
  70410. /**
  70411. * Get the clip factor between two vectors
  70412. * @param vector0 defines the first operand
  70413. * @param vector1 defines the second operand
  70414. * @param axis defines the axis to use
  70415. * @param size defines the size along the axis
  70416. * @returns the clip factor
  70417. */
  70418. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  70419. /**
  70420. * Get angle between two vectors
  70421. * @param vector0 angle between vector0 and vector1
  70422. * @param vector1 angle between vector0 and vector1
  70423. * @param normal direction of the normal
  70424. * @return the angle between vector0 and vector1
  70425. */
  70426. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  70427. /**
  70428. * Returns a new Vector3 set from the index "offset" of the given array
  70429. * @param array defines the source array
  70430. * @param offset defines the offset in the source array
  70431. * @returns the new Vector3
  70432. */
  70433. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  70434. /**
  70435. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  70436. * This function is deprecated. Use FromArray instead
  70437. * @param array defines the source array
  70438. * @param offset defines the offset in the source array
  70439. * @returns the new Vector3
  70440. */
  70441. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  70442. /**
  70443. * Sets the given vector "result" with the element values from the index "offset" of the given array
  70444. * @param array defines the source array
  70445. * @param offset defines the offset in the source array
  70446. * @param result defines the Vector3 where to store the result
  70447. */
  70448. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  70449. /**
  70450. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  70451. * This function is deprecated. Use FromArrayToRef instead.
  70452. * @param array defines the source array
  70453. * @param offset defines the offset in the source array
  70454. * @param result defines the Vector3 where to store the result
  70455. */
  70456. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  70457. /**
  70458. * Sets the given vector "result" with the given floats.
  70459. * @param x defines the x coordinate of the source
  70460. * @param y defines the y coordinate of the source
  70461. * @param z defines the z coordinate of the source
  70462. * @param result defines the Vector3 where to store the result
  70463. */
  70464. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  70465. /**
  70466. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  70467. * @returns a new empty Vector3
  70468. */
  70469. static Zero(): Vector3;
  70470. /**
  70471. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  70472. * @returns a new unit Vector3
  70473. */
  70474. static One(): Vector3;
  70475. /**
  70476. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  70477. * @returns a new up Vector3
  70478. */
  70479. static Up(): Vector3;
  70480. /**
  70481. * Gets a up Vector3 that must not be updated
  70482. */
  70483. static readonly UpReadOnly: DeepImmutable<Vector3>;
  70484. /**
  70485. * Gets a zero Vector3 that must not be updated
  70486. */
  70487. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  70488. /**
  70489. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  70490. * @returns a new down Vector3
  70491. */
  70492. static Down(): Vector3;
  70493. /**
  70494. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  70495. * @returns a new forward Vector3
  70496. */
  70497. static Forward(): Vector3;
  70498. /**
  70499. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  70500. * @returns a new forward Vector3
  70501. */
  70502. static Backward(): Vector3;
  70503. /**
  70504. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  70505. * @returns a new right Vector3
  70506. */
  70507. static Right(): Vector3;
  70508. /**
  70509. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  70510. * @returns a new left Vector3
  70511. */
  70512. static Left(): Vector3;
  70513. /**
  70514. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  70515. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  70516. * @param vector defines the Vector3 to transform
  70517. * @param transformation defines the transformation matrix
  70518. * @returns the transformed Vector3
  70519. */
  70520. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  70521. /**
  70522. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  70523. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  70524. * @param vector defines the Vector3 to transform
  70525. * @param transformation defines the transformation matrix
  70526. * @param result defines the Vector3 where to store the result
  70527. */
  70528. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70529. /**
  70530. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  70531. * This method computes tranformed coordinates only, not transformed direction vectors
  70532. * @param x define the x coordinate of the source vector
  70533. * @param y define the y coordinate of the source vector
  70534. * @param z define the z coordinate of the source vector
  70535. * @param transformation defines the transformation matrix
  70536. * @param result defines the Vector3 where to store the result
  70537. */
  70538. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70539. /**
  70540. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  70541. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  70542. * @param vector defines the Vector3 to transform
  70543. * @param transformation defines the transformation matrix
  70544. * @returns the new Vector3
  70545. */
  70546. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  70547. /**
  70548. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  70549. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  70550. * @param vector defines the Vector3 to transform
  70551. * @param transformation defines the transformation matrix
  70552. * @param result defines the Vector3 where to store the result
  70553. */
  70554. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70555. /**
  70556. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  70557. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  70558. * @param x define the x coordinate of the source vector
  70559. * @param y define the y coordinate of the source vector
  70560. * @param z define the z coordinate of the source vector
  70561. * @param transformation defines the transformation matrix
  70562. * @param result defines the Vector3 where to store the result
  70563. */
  70564. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70565. /**
  70566. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  70567. * @param value1 defines the first control point
  70568. * @param value2 defines the second control point
  70569. * @param value3 defines the third control point
  70570. * @param value4 defines the fourth control point
  70571. * @param amount defines the amount on the spline to use
  70572. * @returns the new Vector3
  70573. */
  70574. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  70575. /**
  70576. * 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"
  70577. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  70578. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  70579. * @param value defines the current value
  70580. * @param min defines the lower range value
  70581. * @param max defines the upper range value
  70582. * @returns the new Vector3
  70583. */
  70584. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  70585. /**
  70586. * 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"
  70587. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  70588. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  70589. * @param value defines the current value
  70590. * @param min defines the lower range value
  70591. * @param max defines the upper range value
  70592. * @param result defines the Vector3 where to store the result
  70593. */
  70594. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  70595. /**
  70596. * Checks if a given vector is inside a specific range
  70597. * @param v defines the vector to test
  70598. * @param min defines the minimum range
  70599. * @param max defines the maximum range
  70600. */
  70601. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  70602. /**
  70603. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  70604. * @param value1 defines the first control point
  70605. * @param tangent1 defines the first tangent vector
  70606. * @param value2 defines the second control point
  70607. * @param tangent2 defines the second tangent vector
  70608. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  70609. * @returns the new Vector3
  70610. */
  70611. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  70612. /**
  70613. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  70614. * @param start defines the start value
  70615. * @param end defines the end value
  70616. * @param amount max defines amount between both (between 0 and 1)
  70617. * @returns the new Vector3
  70618. */
  70619. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  70620. /**
  70621. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  70622. * @param start defines the start value
  70623. * @param end defines the end value
  70624. * @param amount max defines amount between both (between 0 and 1)
  70625. * @param result defines the Vector3 where to store the result
  70626. */
  70627. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  70628. /**
  70629. * Returns the dot product (float) between the vectors "left" and "right"
  70630. * @param left defines the left operand
  70631. * @param right defines the right operand
  70632. * @returns the dot product
  70633. */
  70634. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  70635. /**
  70636. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  70637. * The cross product is then orthogonal to both "left" and "right"
  70638. * @param left defines the left operand
  70639. * @param right defines the right operand
  70640. * @returns the cross product
  70641. */
  70642. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  70643. /**
  70644. * Sets the given vector "result" with the cross product of "left" and "right"
  70645. * The cross product is then orthogonal to both "left" and "right"
  70646. * @param left defines the left operand
  70647. * @param right defines the right operand
  70648. * @param result defines the Vector3 where to store the result
  70649. */
  70650. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  70651. /**
  70652. * Returns a new Vector3 as the normalization of the given vector
  70653. * @param vector defines the Vector3 to normalize
  70654. * @returns the new Vector3
  70655. */
  70656. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  70657. /**
  70658. * Sets the given vector "result" with the normalization of the given first vector
  70659. * @param vector defines the Vector3 to normalize
  70660. * @param result defines the Vector3 where to store the result
  70661. */
  70662. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  70663. /**
  70664. * Project a Vector3 onto screen space
  70665. * @param vector defines the Vector3 to project
  70666. * @param world defines the world matrix to use
  70667. * @param transform defines the transform (view x projection) matrix to use
  70668. * @param viewport defines the screen viewport to use
  70669. * @returns the new Vector3
  70670. */
  70671. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  70672. /** @hidden */
  70673. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  70674. /**
  70675. * Unproject from screen space to object space
  70676. * @param source defines the screen space Vector3 to use
  70677. * @param viewportWidth defines the current width of the viewport
  70678. * @param viewportHeight defines the current height of the viewport
  70679. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70680. * @param transform defines the transform (view x projection) matrix to use
  70681. * @returns the new Vector3
  70682. */
  70683. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  70684. /**
  70685. * Unproject from screen space to object space
  70686. * @param source defines the screen space Vector3 to use
  70687. * @param viewportWidth defines the current width of the viewport
  70688. * @param viewportHeight defines the current height of the viewport
  70689. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70690. * @param view defines the view matrix to use
  70691. * @param projection defines the projection matrix to use
  70692. * @returns the new Vector3
  70693. */
  70694. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  70695. /**
  70696. * Unproject from screen space to object space
  70697. * @param source defines the screen space Vector3 to use
  70698. * @param viewportWidth defines the current width of the viewport
  70699. * @param viewportHeight defines the current height of the viewport
  70700. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70701. * @param view defines the view matrix to use
  70702. * @param projection defines the projection matrix to use
  70703. * @param result defines the Vector3 where to store the result
  70704. */
  70705. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  70706. /**
  70707. * Unproject from screen space to object space
  70708. * @param sourceX defines the screen space x coordinate to use
  70709. * @param sourceY defines the screen space y coordinate to use
  70710. * @param sourceZ defines the screen space z coordinate to use
  70711. * @param viewportWidth defines the current width of the viewport
  70712. * @param viewportHeight defines the current height of the viewport
  70713. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70714. * @param view defines the view matrix to use
  70715. * @param projection defines the projection matrix to use
  70716. * @param result defines the Vector3 where to store the result
  70717. */
  70718. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  70719. /**
  70720. * Gets the minimal coordinate values between two Vector3
  70721. * @param left defines the first operand
  70722. * @param right defines the second operand
  70723. * @returns the new Vector3
  70724. */
  70725. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  70726. /**
  70727. * Gets the maximal coordinate values between two Vector3
  70728. * @param left defines the first operand
  70729. * @param right defines the second operand
  70730. * @returns the new Vector3
  70731. */
  70732. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  70733. /**
  70734. * Returns the distance between the vectors "value1" and "value2"
  70735. * @param value1 defines the first operand
  70736. * @param value2 defines the second operand
  70737. * @returns the distance
  70738. */
  70739. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  70740. /**
  70741. * Returns the squared distance between the vectors "value1" and "value2"
  70742. * @param value1 defines the first operand
  70743. * @param value2 defines the second operand
  70744. * @returns the squared distance
  70745. */
  70746. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  70747. /**
  70748. * Returns a new Vector3 located at the center between "value1" and "value2"
  70749. * @param value1 defines the first operand
  70750. * @param value2 defines the second operand
  70751. * @returns the new Vector3
  70752. */
  70753. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  70754. /**
  70755. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  70756. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  70757. * to something in order to rotate it from its local system to the given target system
  70758. * Note: axis1, axis2 and axis3 are normalized during this operation
  70759. * @param axis1 defines the first axis
  70760. * @param axis2 defines the second axis
  70761. * @param axis3 defines the third axis
  70762. * @returns a new Vector3
  70763. */
  70764. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  70765. /**
  70766. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  70767. * @param axis1 defines the first axis
  70768. * @param axis2 defines the second axis
  70769. * @param axis3 defines the third axis
  70770. * @param ref defines the Vector3 where to store the result
  70771. */
  70772. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  70773. }
  70774. /**
  70775. * Vector4 class created for EulerAngle class conversion to Quaternion
  70776. */
  70777. export class Vector4 {
  70778. /** x value of the vector */
  70779. x: number;
  70780. /** y value of the vector */
  70781. y: number;
  70782. /** z value of the vector */
  70783. z: number;
  70784. /** w value of the vector */
  70785. w: number;
  70786. /**
  70787. * Creates a Vector4 object from the given floats.
  70788. * @param x x value of the vector
  70789. * @param y y value of the vector
  70790. * @param z z value of the vector
  70791. * @param w w value of the vector
  70792. */
  70793. constructor(
  70794. /** x value of the vector */
  70795. x: number,
  70796. /** y value of the vector */
  70797. y: number,
  70798. /** z value of the vector */
  70799. z: number,
  70800. /** w value of the vector */
  70801. w: number);
  70802. /**
  70803. * Returns the string with the Vector4 coordinates.
  70804. * @returns a string containing all the vector values
  70805. */
  70806. toString(): string;
  70807. /**
  70808. * Returns the string "Vector4".
  70809. * @returns "Vector4"
  70810. */
  70811. getClassName(): string;
  70812. /**
  70813. * Returns the Vector4 hash code.
  70814. * @returns a unique hash code
  70815. */
  70816. getHashCode(): number;
  70817. /**
  70818. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  70819. * @returns the resulting array
  70820. */
  70821. asArray(): number[];
  70822. /**
  70823. * Populates the given array from the given index with the Vector4 coordinates.
  70824. * @param array array to populate
  70825. * @param index index of the array to start at (default: 0)
  70826. * @returns the Vector4.
  70827. */
  70828. toArray(array: FloatArray, index?: number): Vector4;
  70829. /**
  70830. * Adds the given vector to the current Vector4.
  70831. * @param otherVector the vector to add
  70832. * @returns the updated Vector4.
  70833. */
  70834. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  70835. /**
  70836. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  70837. * @param otherVector the vector to add
  70838. * @returns the resulting vector
  70839. */
  70840. add(otherVector: DeepImmutable<Vector4>): Vector4;
  70841. /**
  70842. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  70843. * @param otherVector the vector to add
  70844. * @param result the vector to store the result
  70845. * @returns the current Vector4.
  70846. */
  70847. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  70848. /**
  70849. * Subtract in place the given vector from the current Vector4.
  70850. * @param otherVector the vector to subtract
  70851. * @returns the updated Vector4.
  70852. */
  70853. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  70854. /**
  70855. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  70856. * @param otherVector the vector to add
  70857. * @returns the new vector with the result
  70858. */
  70859. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  70860. /**
  70861. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  70862. * @param otherVector the vector to subtract
  70863. * @param result the vector to store the result
  70864. * @returns the current Vector4.
  70865. */
  70866. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  70867. /**
  70868. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  70869. */
  70870. /**
  70871. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  70872. * @param x value to subtract
  70873. * @param y value to subtract
  70874. * @param z value to subtract
  70875. * @param w value to subtract
  70876. * @returns new vector containing the result
  70877. */
  70878. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  70879. /**
  70880. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  70881. * @param x value to subtract
  70882. * @param y value to subtract
  70883. * @param z value to subtract
  70884. * @param w value to subtract
  70885. * @param result the vector to store the result in
  70886. * @returns the current Vector4.
  70887. */
  70888. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  70889. /**
  70890. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  70891. * @returns a new vector with the negated values
  70892. */
  70893. negate(): Vector4;
  70894. /**
  70895. * Multiplies the current Vector4 coordinates by scale (float).
  70896. * @param scale the number to scale with
  70897. * @returns the updated Vector4.
  70898. */
  70899. scaleInPlace(scale: number): Vector4;
  70900. /**
  70901. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  70902. * @param scale the number to scale with
  70903. * @returns a new vector with the result
  70904. */
  70905. scale(scale: number): Vector4;
  70906. /**
  70907. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  70908. * @param scale the number to scale with
  70909. * @param result a vector to store the result in
  70910. * @returns the current Vector4.
  70911. */
  70912. scaleToRef(scale: number, result: Vector4): Vector4;
  70913. /**
  70914. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  70915. * @param scale defines the scale factor
  70916. * @param result defines the Vector4 object where to store the result
  70917. * @returns the unmodified current Vector4
  70918. */
  70919. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  70920. /**
  70921. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  70922. * @param otherVector the vector to compare against
  70923. * @returns true if they are equal
  70924. */
  70925. equals(otherVector: DeepImmutable<Vector4>): boolean;
  70926. /**
  70927. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  70928. * @param otherVector vector to compare against
  70929. * @param epsilon (Default: very small number)
  70930. * @returns true if they are equal
  70931. */
  70932. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  70933. /**
  70934. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  70935. * @param x x value to compare against
  70936. * @param y y value to compare against
  70937. * @param z z value to compare against
  70938. * @param w w value to compare against
  70939. * @returns true if equal
  70940. */
  70941. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  70942. /**
  70943. * Multiplies in place the current Vector4 by the given one.
  70944. * @param otherVector vector to multiple with
  70945. * @returns the updated Vector4.
  70946. */
  70947. multiplyInPlace(otherVector: Vector4): Vector4;
  70948. /**
  70949. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  70950. * @param otherVector vector to multiple with
  70951. * @returns resulting new vector
  70952. */
  70953. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  70954. /**
  70955. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  70956. * @param otherVector vector to multiple with
  70957. * @param result vector to store the result
  70958. * @returns the current Vector4.
  70959. */
  70960. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  70961. /**
  70962. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  70963. * @param x x value multiply with
  70964. * @param y y value multiply with
  70965. * @param z z value multiply with
  70966. * @param w w value multiply with
  70967. * @returns resulting new vector
  70968. */
  70969. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  70970. /**
  70971. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  70972. * @param otherVector vector to devide with
  70973. * @returns resulting new vector
  70974. */
  70975. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  70976. /**
  70977. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  70978. * @param otherVector vector to devide with
  70979. * @param result vector to store the result
  70980. * @returns the current Vector4.
  70981. */
  70982. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  70983. /**
  70984. * Divides the current Vector3 coordinates by the given ones.
  70985. * @param otherVector vector to devide with
  70986. * @returns the updated Vector3.
  70987. */
  70988. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  70989. /**
  70990. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  70991. * @param other defines the second operand
  70992. * @returns the current updated Vector4
  70993. */
  70994. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  70995. /**
  70996. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  70997. * @param other defines the second operand
  70998. * @returns the current updated Vector4
  70999. */
  71000. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  71001. /**
  71002. * Gets a new Vector4 from current Vector4 floored values
  71003. * @returns a new Vector4
  71004. */
  71005. floor(): Vector4;
  71006. /**
  71007. * Gets a new Vector4 from current Vector3 floored values
  71008. * @returns a new Vector4
  71009. */
  71010. fract(): Vector4;
  71011. /**
  71012. * Returns the Vector4 length (float).
  71013. * @returns the length
  71014. */
  71015. length(): number;
  71016. /**
  71017. * Returns the Vector4 squared length (float).
  71018. * @returns the length squared
  71019. */
  71020. lengthSquared(): number;
  71021. /**
  71022. * Normalizes in place the Vector4.
  71023. * @returns the updated Vector4.
  71024. */
  71025. normalize(): Vector4;
  71026. /**
  71027. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  71028. * @returns this converted to a new vector3
  71029. */
  71030. toVector3(): Vector3;
  71031. /**
  71032. * Returns a new Vector4 copied from the current one.
  71033. * @returns the new cloned vector
  71034. */
  71035. clone(): Vector4;
  71036. /**
  71037. * Updates the current Vector4 with the given one coordinates.
  71038. * @param source the source vector to copy from
  71039. * @returns the updated Vector4.
  71040. */
  71041. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  71042. /**
  71043. * Updates the current Vector4 coordinates with the given floats.
  71044. * @param x float to copy from
  71045. * @param y float to copy from
  71046. * @param z float to copy from
  71047. * @param w float to copy from
  71048. * @returns the updated Vector4.
  71049. */
  71050. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  71051. /**
  71052. * Updates the current Vector4 coordinates with the given floats.
  71053. * @param x float to set from
  71054. * @param y float to set from
  71055. * @param z float to set from
  71056. * @param w float to set from
  71057. * @returns the updated Vector4.
  71058. */
  71059. set(x: number, y: number, z: number, w: number): Vector4;
  71060. /**
  71061. * Copies the given float to the current Vector3 coordinates
  71062. * @param v defines the x, y, z and w coordinates of the operand
  71063. * @returns the current updated Vector3
  71064. */
  71065. setAll(v: number): Vector4;
  71066. /**
  71067. * Returns a new Vector4 set from the starting index of the given array.
  71068. * @param array the array to pull values from
  71069. * @param offset the offset into the array to start at
  71070. * @returns the new vector
  71071. */
  71072. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  71073. /**
  71074. * Updates the given vector "result" from the starting index of the given array.
  71075. * @param array the array to pull values from
  71076. * @param offset the offset into the array to start at
  71077. * @param result the vector to store the result in
  71078. */
  71079. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  71080. /**
  71081. * Updates the given vector "result" from the starting index of the given Float32Array.
  71082. * @param array the array to pull values from
  71083. * @param offset the offset into the array to start at
  71084. * @param result the vector to store the result in
  71085. */
  71086. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  71087. /**
  71088. * Updates the given vector "result" coordinates from the given floats.
  71089. * @param x float to set from
  71090. * @param y float to set from
  71091. * @param z float to set from
  71092. * @param w float to set from
  71093. * @param result the vector to the floats in
  71094. */
  71095. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  71096. /**
  71097. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  71098. * @returns the new vector
  71099. */
  71100. static Zero(): Vector4;
  71101. /**
  71102. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  71103. * @returns the new vector
  71104. */
  71105. static One(): Vector4;
  71106. /**
  71107. * Returns a new normalized Vector4 from the given one.
  71108. * @param vector the vector to normalize
  71109. * @returns the vector
  71110. */
  71111. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  71112. /**
  71113. * Updates the given vector "result" from the normalization of the given one.
  71114. * @param vector the vector to normalize
  71115. * @param result the vector to store the result in
  71116. */
  71117. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  71118. /**
  71119. * Returns a vector with the minimum values from the left and right vectors
  71120. * @param left left vector to minimize
  71121. * @param right right vector to minimize
  71122. * @returns a new vector with the minimum of the left and right vector values
  71123. */
  71124. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  71125. /**
  71126. * Returns a vector with the maximum values from the left and right vectors
  71127. * @param left left vector to maximize
  71128. * @param right right vector to maximize
  71129. * @returns a new vector with the maximum of the left and right vector values
  71130. */
  71131. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  71132. /**
  71133. * Returns the distance (float) between the vectors "value1" and "value2".
  71134. * @param value1 value to calulate the distance between
  71135. * @param value2 value to calulate the distance between
  71136. * @return the distance between the two vectors
  71137. */
  71138. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  71139. /**
  71140. * Returns the squared distance (float) between the vectors "value1" and "value2".
  71141. * @param value1 value to calulate the distance between
  71142. * @param value2 value to calulate the distance between
  71143. * @return the distance between the two vectors squared
  71144. */
  71145. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  71146. /**
  71147. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  71148. * @param value1 value to calulate the center between
  71149. * @param value2 value to calulate the center between
  71150. * @return the center between the two vectors
  71151. */
  71152. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  71153. /**
  71154. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  71155. * This methods computes transformed normalized direction vectors only.
  71156. * @param vector the vector to transform
  71157. * @param transformation the transformation matrix to apply
  71158. * @returns the new vector
  71159. */
  71160. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  71161. /**
  71162. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  71163. * This methods computes transformed normalized direction vectors only.
  71164. * @param vector the vector to transform
  71165. * @param transformation the transformation matrix to apply
  71166. * @param result the vector to store the result in
  71167. */
  71168. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  71169. /**
  71170. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  71171. * This methods computes transformed normalized direction vectors only.
  71172. * @param x value to transform
  71173. * @param y value to transform
  71174. * @param z value to transform
  71175. * @param w value to transform
  71176. * @param transformation the transformation matrix to apply
  71177. * @param result the vector to store the results in
  71178. */
  71179. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  71180. /**
  71181. * Creates a new Vector4 from a Vector3
  71182. * @param source defines the source data
  71183. * @param w defines the 4th component (default is 0)
  71184. * @returns a new Vector4
  71185. */
  71186. static FromVector3(source: Vector3, w?: number): Vector4;
  71187. }
  71188. /**
  71189. * Class used to store quaternion data
  71190. * @see https://en.wikipedia.org/wiki/Quaternion
  71191. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  71192. */
  71193. export class Quaternion {
  71194. /** defines the first component (0 by default) */
  71195. x: number;
  71196. /** defines the second component (0 by default) */
  71197. y: number;
  71198. /** defines the third component (0 by default) */
  71199. z: number;
  71200. /** defines the fourth component (1.0 by default) */
  71201. w: number;
  71202. /**
  71203. * Creates a new Quaternion from the given floats
  71204. * @param x defines the first component (0 by default)
  71205. * @param y defines the second component (0 by default)
  71206. * @param z defines the third component (0 by default)
  71207. * @param w defines the fourth component (1.0 by default)
  71208. */
  71209. constructor(
  71210. /** defines the first component (0 by default) */
  71211. x?: number,
  71212. /** defines the second component (0 by default) */
  71213. y?: number,
  71214. /** defines the third component (0 by default) */
  71215. z?: number,
  71216. /** defines the fourth component (1.0 by default) */
  71217. w?: number);
  71218. /**
  71219. * Gets a string representation for the current quaternion
  71220. * @returns a string with the Quaternion coordinates
  71221. */
  71222. toString(): string;
  71223. /**
  71224. * Gets the class name of the quaternion
  71225. * @returns the string "Quaternion"
  71226. */
  71227. getClassName(): string;
  71228. /**
  71229. * Gets a hash code for this quaternion
  71230. * @returns the quaternion hash code
  71231. */
  71232. getHashCode(): number;
  71233. /**
  71234. * Copy the quaternion to an array
  71235. * @returns a new array populated with 4 elements from the quaternion coordinates
  71236. */
  71237. asArray(): number[];
  71238. /**
  71239. * Check if two quaternions are equals
  71240. * @param otherQuaternion defines the second operand
  71241. * @return true if the current quaternion and the given one coordinates are strictly equals
  71242. */
  71243. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  71244. /**
  71245. * Clone the current quaternion
  71246. * @returns a new quaternion copied from the current one
  71247. */
  71248. clone(): Quaternion;
  71249. /**
  71250. * Copy a quaternion to the current one
  71251. * @param other defines the other quaternion
  71252. * @returns the updated current quaternion
  71253. */
  71254. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  71255. /**
  71256. * Updates the current quaternion with the given float coordinates
  71257. * @param x defines the x coordinate
  71258. * @param y defines the y coordinate
  71259. * @param z defines the z coordinate
  71260. * @param w defines the w coordinate
  71261. * @returns the updated current quaternion
  71262. */
  71263. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  71264. /**
  71265. * Updates the current quaternion from the given float coordinates
  71266. * @param x defines the x coordinate
  71267. * @param y defines the y coordinate
  71268. * @param z defines the z coordinate
  71269. * @param w defines the w coordinate
  71270. * @returns the updated current quaternion
  71271. */
  71272. set(x: number, y: number, z: number, w: number): Quaternion;
  71273. /**
  71274. * Adds two quaternions
  71275. * @param other defines the second operand
  71276. * @returns a new quaternion as the addition result of the given one and the current quaternion
  71277. */
  71278. add(other: DeepImmutable<Quaternion>): Quaternion;
  71279. /**
  71280. * Add a quaternion to the current one
  71281. * @param other defines the quaternion to add
  71282. * @returns the current quaternion
  71283. */
  71284. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  71285. /**
  71286. * Subtract two quaternions
  71287. * @param other defines the second operand
  71288. * @returns a new quaternion as the subtraction result of the given one from the current one
  71289. */
  71290. subtract(other: Quaternion): Quaternion;
  71291. /**
  71292. * Multiplies the current quaternion by a scale factor
  71293. * @param value defines the scale factor
  71294. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  71295. */
  71296. scale(value: number): Quaternion;
  71297. /**
  71298. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  71299. * @param scale defines the scale factor
  71300. * @param result defines the Quaternion object where to store the result
  71301. * @returns the unmodified current quaternion
  71302. */
  71303. scaleToRef(scale: number, result: Quaternion): Quaternion;
  71304. /**
  71305. * Multiplies in place the current quaternion by a scale factor
  71306. * @param value defines the scale factor
  71307. * @returns the current modified quaternion
  71308. */
  71309. scaleInPlace(value: number): Quaternion;
  71310. /**
  71311. * Scale the current quaternion values by a factor and add the result to a given quaternion
  71312. * @param scale defines the scale factor
  71313. * @param result defines the Quaternion object where to store the result
  71314. * @returns the unmodified current quaternion
  71315. */
  71316. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  71317. /**
  71318. * Multiplies two quaternions
  71319. * @param q1 defines the second operand
  71320. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  71321. */
  71322. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  71323. /**
  71324. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  71325. * @param q1 defines the second operand
  71326. * @param result defines the target quaternion
  71327. * @returns the current quaternion
  71328. */
  71329. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  71330. /**
  71331. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  71332. * @param q1 defines the second operand
  71333. * @returns the currentupdated quaternion
  71334. */
  71335. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  71336. /**
  71337. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  71338. * @param ref defines the target quaternion
  71339. * @returns the current quaternion
  71340. */
  71341. conjugateToRef(ref: Quaternion): Quaternion;
  71342. /**
  71343. * Conjugates in place (1-q) the current quaternion
  71344. * @returns the current updated quaternion
  71345. */
  71346. conjugateInPlace(): Quaternion;
  71347. /**
  71348. * Conjugates in place (1-q) the current quaternion
  71349. * @returns a new quaternion
  71350. */
  71351. conjugate(): Quaternion;
  71352. /**
  71353. * Gets length of current quaternion
  71354. * @returns the quaternion length (float)
  71355. */
  71356. length(): number;
  71357. /**
  71358. * Normalize in place the current quaternion
  71359. * @returns the current updated quaternion
  71360. */
  71361. normalize(): Quaternion;
  71362. /**
  71363. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  71364. * @param order is a reserved parameter and is ignore for now
  71365. * @returns a new Vector3 containing the Euler angles
  71366. */
  71367. toEulerAngles(order?: string): Vector3;
  71368. /**
  71369. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  71370. * @param result defines the vector which will be filled with the Euler angles
  71371. * @param order is a reserved parameter and is ignore for now
  71372. * @returns the current unchanged quaternion
  71373. */
  71374. toEulerAnglesToRef(result: Vector3): Quaternion;
  71375. /**
  71376. * Updates the given rotation matrix with the current quaternion values
  71377. * @param result defines the target matrix
  71378. * @returns the current unchanged quaternion
  71379. */
  71380. toRotationMatrix(result: Matrix): Quaternion;
  71381. /**
  71382. * Updates the current quaternion from the given rotation matrix values
  71383. * @param matrix defines the source matrix
  71384. * @returns the current updated quaternion
  71385. */
  71386. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  71387. /**
  71388. * Creates a new quaternion from a rotation matrix
  71389. * @param matrix defines the source matrix
  71390. * @returns a new quaternion created from the given rotation matrix values
  71391. */
  71392. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  71393. /**
  71394. * Updates the given quaternion with the given rotation matrix values
  71395. * @param matrix defines the source matrix
  71396. * @param result defines the target quaternion
  71397. */
  71398. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  71399. /**
  71400. * Returns the dot product (float) between the quaternions "left" and "right"
  71401. * @param left defines the left operand
  71402. * @param right defines the right operand
  71403. * @returns the dot product
  71404. */
  71405. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  71406. /**
  71407. * Checks if the two quaternions are close to each other
  71408. * @param quat0 defines the first quaternion to check
  71409. * @param quat1 defines the second quaternion to check
  71410. * @returns true if the two quaternions are close to each other
  71411. */
  71412. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  71413. /**
  71414. * Creates an empty quaternion
  71415. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  71416. */
  71417. static Zero(): Quaternion;
  71418. /**
  71419. * Inverse a given quaternion
  71420. * @param q defines the source quaternion
  71421. * @returns a new quaternion as the inverted current quaternion
  71422. */
  71423. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  71424. /**
  71425. * Inverse a given quaternion
  71426. * @param q defines the source quaternion
  71427. * @param result the quaternion the result will be stored in
  71428. * @returns the result quaternion
  71429. */
  71430. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  71431. /**
  71432. * Creates an identity quaternion
  71433. * @returns the identity quaternion
  71434. */
  71435. static Identity(): Quaternion;
  71436. /**
  71437. * Gets a boolean indicating if the given quaternion is identity
  71438. * @param quaternion defines the quaternion to check
  71439. * @returns true if the quaternion is identity
  71440. */
  71441. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  71442. /**
  71443. * Creates a quaternion from a rotation around an axis
  71444. * @param axis defines the axis to use
  71445. * @param angle defines the angle to use
  71446. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  71447. */
  71448. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  71449. /**
  71450. * Creates a rotation around an axis and stores it into the given quaternion
  71451. * @param axis defines the axis to use
  71452. * @param angle defines the angle to use
  71453. * @param result defines the target quaternion
  71454. * @returns the target quaternion
  71455. */
  71456. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  71457. /**
  71458. * Creates a new quaternion from data stored into an array
  71459. * @param array defines the data source
  71460. * @param offset defines the offset in the source array where the data starts
  71461. * @returns a new quaternion
  71462. */
  71463. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  71464. /**
  71465. * Create a quaternion from Euler rotation angles
  71466. * @param x Pitch
  71467. * @param y Yaw
  71468. * @param z Roll
  71469. * @returns the new Quaternion
  71470. */
  71471. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  71472. /**
  71473. * Updates a quaternion from Euler rotation angles
  71474. * @param x Pitch
  71475. * @param y Yaw
  71476. * @param z Roll
  71477. * @param result the quaternion to store the result
  71478. * @returns the updated quaternion
  71479. */
  71480. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  71481. /**
  71482. * Create a quaternion from Euler rotation vector
  71483. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  71484. * @returns the new Quaternion
  71485. */
  71486. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  71487. /**
  71488. * Updates a quaternion from Euler rotation vector
  71489. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  71490. * @param result the quaternion to store the result
  71491. * @returns the updated quaternion
  71492. */
  71493. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  71494. /**
  71495. * Creates a new quaternion from the given Euler float angles (y, x, z)
  71496. * @param yaw defines the rotation around Y axis
  71497. * @param pitch defines the rotation around X axis
  71498. * @param roll defines the rotation around Z axis
  71499. * @returns the new quaternion
  71500. */
  71501. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  71502. /**
  71503. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  71504. * @param yaw defines the rotation around Y axis
  71505. * @param pitch defines the rotation around X axis
  71506. * @param roll defines the rotation around Z axis
  71507. * @param result defines the target quaternion
  71508. */
  71509. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  71510. /**
  71511. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  71512. * @param alpha defines the rotation around first axis
  71513. * @param beta defines the rotation around second axis
  71514. * @param gamma defines the rotation around third axis
  71515. * @returns the new quaternion
  71516. */
  71517. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  71518. /**
  71519. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  71520. * @param alpha defines the rotation around first axis
  71521. * @param beta defines the rotation around second axis
  71522. * @param gamma defines the rotation around third axis
  71523. * @param result defines the target quaternion
  71524. */
  71525. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  71526. /**
  71527. * 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)
  71528. * @param axis1 defines the first axis
  71529. * @param axis2 defines the second axis
  71530. * @param axis3 defines the third axis
  71531. * @returns the new quaternion
  71532. */
  71533. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  71534. /**
  71535. * 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
  71536. * @param axis1 defines the first axis
  71537. * @param axis2 defines the second axis
  71538. * @param axis3 defines the third axis
  71539. * @param ref defines the target quaternion
  71540. */
  71541. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  71542. /**
  71543. * Interpolates between two quaternions
  71544. * @param left defines first quaternion
  71545. * @param right defines second quaternion
  71546. * @param amount defines the gradient to use
  71547. * @returns the new interpolated quaternion
  71548. */
  71549. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  71550. /**
  71551. * Interpolates between two quaternions and stores it into a target quaternion
  71552. * @param left defines first quaternion
  71553. * @param right defines second quaternion
  71554. * @param amount defines the gradient to use
  71555. * @param result defines the target quaternion
  71556. */
  71557. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  71558. /**
  71559. * Interpolate between two quaternions using Hermite interpolation
  71560. * @param value1 defines first quaternion
  71561. * @param tangent1 defines the incoming tangent
  71562. * @param value2 defines second quaternion
  71563. * @param tangent2 defines the outgoing tangent
  71564. * @param amount defines the target quaternion
  71565. * @returns the new interpolated quaternion
  71566. */
  71567. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  71568. }
  71569. /**
  71570. * Class used to store matrix data (4x4)
  71571. */
  71572. export class Matrix {
  71573. private static _updateFlagSeed;
  71574. private static _identityReadOnly;
  71575. private _isIdentity;
  71576. private _isIdentityDirty;
  71577. private _isIdentity3x2;
  71578. private _isIdentity3x2Dirty;
  71579. /**
  71580. * Gets the update flag of the matrix which is an unique number for the matrix.
  71581. * It will be incremented every time the matrix data change.
  71582. * You can use it to speed the comparison between two versions of the same matrix.
  71583. */
  71584. updateFlag: number;
  71585. private readonly _m;
  71586. /**
  71587. * Gets the internal data of the matrix
  71588. */
  71589. readonly m: DeepImmutable<Float32Array>;
  71590. /** @hidden */
  71591. _markAsUpdated(): void;
  71592. /** @hidden */
  71593. private _updateIdentityStatus;
  71594. /**
  71595. * Creates an empty matrix (filled with zeros)
  71596. */
  71597. constructor();
  71598. /**
  71599. * Check if the current matrix is identity
  71600. * @returns true is the matrix is the identity matrix
  71601. */
  71602. isIdentity(): boolean;
  71603. /**
  71604. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  71605. * @returns true is the matrix is the identity matrix
  71606. */
  71607. isIdentityAs3x2(): boolean;
  71608. /**
  71609. * Gets the determinant of the matrix
  71610. * @returns the matrix determinant
  71611. */
  71612. determinant(): number;
  71613. /**
  71614. * Returns the matrix as a Float32Array
  71615. * @returns the matrix underlying array
  71616. */
  71617. toArray(): DeepImmutable<Float32Array>;
  71618. /**
  71619. * Returns the matrix as a Float32Array
  71620. * @returns the matrix underlying array.
  71621. */
  71622. asArray(): DeepImmutable<Float32Array>;
  71623. /**
  71624. * Inverts the current matrix in place
  71625. * @returns the current inverted matrix
  71626. */
  71627. invert(): Matrix;
  71628. /**
  71629. * Sets all the matrix elements to zero
  71630. * @returns the current matrix
  71631. */
  71632. reset(): Matrix;
  71633. /**
  71634. * Adds the current matrix with a second one
  71635. * @param other defines the matrix to add
  71636. * @returns a new matrix as the addition of the current matrix and the given one
  71637. */
  71638. add(other: DeepImmutable<Matrix>): Matrix;
  71639. /**
  71640. * Sets the given matrix "result" to the addition of the current matrix and the given one
  71641. * @param other defines the matrix to add
  71642. * @param result defines the target matrix
  71643. * @returns the current matrix
  71644. */
  71645. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  71646. /**
  71647. * Adds in place the given matrix to the current matrix
  71648. * @param other defines the second operand
  71649. * @returns the current updated matrix
  71650. */
  71651. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  71652. /**
  71653. * Sets the given matrix to the current inverted Matrix
  71654. * @param other defines the target matrix
  71655. * @returns the unmodified current matrix
  71656. */
  71657. invertToRef(other: Matrix): Matrix;
  71658. /**
  71659. * add a value at the specified position in the current Matrix
  71660. * @param index the index of the value within the matrix. between 0 and 15.
  71661. * @param value the value to be added
  71662. * @returns the current updated matrix
  71663. */
  71664. addAtIndex(index: number, value: number): Matrix;
  71665. /**
  71666. * mutiply the specified position in the current Matrix by a value
  71667. * @param index the index of the value within the matrix. between 0 and 15.
  71668. * @param value the value to be added
  71669. * @returns the current updated matrix
  71670. */
  71671. multiplyAtIndex(index: number, value: number): Matrix;
  71672. /**
  71673. * Inserts the translation vector (using 3 floats) in the current matrix
  71674. * @param x defines the 1st component of the translation
  71675. * @param y defines the 2nd component of the translation
  71676. * @param z defines the 3rd component of the translation
  71677. * @returns the current updated matrix
  71678. */
  71679. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  71680. /**
  71681. * Adds the translation vector (using 3 floats) in the current matrix
  71682. * @param x defines the 1st component of the translation
  71683. * @param y defines the 2nd component of the translation
  71684. * @param z defines the 3rd component of the translation
  71685. * @returns the current updated matrix
  71686. */
  71687. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  71688. /**
  71689. * Inserts the translation vector in the current matrix
  71690. * @param vector3 defines the translation to insert
  71691. * @returns the current updated matrix
  71692. */
  71693. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  71694. /**
  71695. * Gets the translation value of the current matrix
  71696. * @returns a new Vector3 as the extracted translation from the matrix
  71697. */
  71698. getTranslation(): Vector3;
  71699. /**
  71700. * Fill a Vector3 with the extracted translation from the matrix
  71701. * @param result defines the Vector3 where to store the translation
  71702. * @returns the current matrix
  71703. */
  71704. getTranslationToRef(result: Vector3): Matrix;
  71705. /**
  71706. * Remove rotation and scaling part from the matrix
  71707. * @returns the updated matrix
  71708. */
  71709. removeRotationAndScaling(): Matrix;
  71710. /**
  71711. * Multiply two matrices
  71712. * @param other defines the second operand
  71713. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  71714. */
  71715. multiply(other: DeepImmutable<Matrix>): Matrix;
  71716. /**
  71717. * Copy the current matrix from the given one
  71718. * @param other defines the source matrix
  71719. * @returns the current updated matrix
  71720. */
  71721. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  71722. /**
  71723. * Populates the given array from the starting index with the current matrix values
  71724. * @param array defines the target array
  71725. * @param offset defines the offset in the target array where to start storing values
  71726. * @returns the current matrix
  71727. */
  71728. copyToArray(array: Float32Array, offset?: number): Matrix;
  71729. /**
  71730. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  71731. * @param other defines the second operand
  71732. * @param result defines the matrix where to store the multiplication
  71733. * @returns the current matrix
  71734. */
  71735. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  71736. /**
  71737. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  71738. * @param other defines the second operand
  71739. * @param result defines the array where to store the multiplication
  71740. * @param offset defines the offset in the target array where to start storing values
  71741. * @returns the current matrix
  71742. */
  71743. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  71744. /**
  71745. * Check equality between this matrix and a second one
  71746. * @param value defines the second matrix to compare
  71747. * @returns true is the current matrix and the given one values are strictly equal
  71748. */
  71749. equals(value: DeepImmutable<Matrix>): boolean;
  71750. /**
  71751. * Clone the current matrix
  71752. * @returns a new matrix from the current matrix
  71753. */
  71754. clone(): Matrix;
  71755. /**
  71756. * Returns the name of the current matrix class
  71757. * @returns the string "Matrix"
  71758. */
  71759. getClassName(): string;
  71760. /**
  71761. * Gets the hash code of the current matrix
  71762. * @returns the hash code
  71763. */
  71764. getHashCode(): number;
  71765. /**
  71766. * Decomposes the current Matrix into a translation, rotation and scaling components
  71767. * @param scale defines the scale vector3 given as a reference to update
  71768. * @param rotation defines the rotation quaternion given as a reference to update
  71769. * @param translation defines the translation vector3 given as a reference to update
  71770. * @returns true if operation was successful
  71771. */
  71772. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  71773. /**
  71774. * Gets specific row of the matrix
  71775. * @param index defines the number of the row to get
  71776. * @returns the index-th row of the current matrix as a new Vector4
  71777. */
  71778. getRow(index: number): Nullable<Vector4>;
  71779. /**
  71780. * Sets the index-th row of the current matrix to the vector4 values
  71781. * @param index defines the number of the row to set
  71782. * @param row defines the target vector4
  71783. * @returns the updated current matrix
  71784. */
  71785. setRow(index: number, row: Vector4): Matrix;
  71786. /**
  71787. * Compute the transpose of the matrix
  71788. * @returns the new transposed matrix
  71789. */
  71790. transpose(): Matrix;
  71791. /**
  71792. * Compute the transpose of the matrix and store it in a given matrix
  71793. * @param result defines the target matrix
  71794. * @returns the current matrix
  71795. */
  71796. transposeToRef(result: Matrix): Matrix;
  71797. /**
  71798. * Sets the index-th row of the current matrix with the given 4 x float values
  71799. * @param index defines the row index
  71800. * @param x defines the x component to set
  71801. * @param y defines the y component to set
  71802. * @param z defines the z component to set
  71803. * @param w defines the w component to set
  71804. * @returns the updated current matrix
  71805. */
  71806. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  71807. /**
  71808. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  71809. * @param scale defines the scale factor
  71810. * @returns a new matrix
  71811. */
  71812. scale(scale: number): Matrix;
  71813. /**
  71814. * Scale the current matrix values by a factor to a given result matrix
  71815. * @param scale defines the scale factor
  71816. * @param result defines the matrix to store the result
  71817. * @returns the current matrix
  71818. */
  71819. scaleToRef(scale: number, result: Matrix): Matrix;
  71820. /**
  71821. * Scale the current matrix values by a factor and add the result to a given matrix
  71822. * @param scale defines the scale factor
  71823. * @param result defines the Matrix to store the result
  71824. * @returns the current matrix
  71825. */
  71826. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  71827. /**
  71828. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  71829. * @param ref matrix to store the result
  71830. */
  71831. toNormalMatrix(ref: Matrix): void;
  71832. /**
  71833. * Gets only rotation part of the current matrix
  71834. * @returns a new matrix sets to the extracted rotation matrix from the current one
  71835. */
  71836. getRotationMatrix(): Matrix;
  71837. /**
  71838. * Extracts the rotation matrix from the current one and sets it as the given "result"
  71839. * @param result defines the target matrix to store data to
  71840. * @returns the current matrix
  71841. */
  71842. getRotationMatrixToRef(result: Matrix): Matrix;
  71843. /**
  71844. * Toggles model matrix from being right handed to left handed in place and vice versa
  71845. */
  71846. toggleModelMatrixHandInPlace(): void;
  71847. /**
  71848. * Toggles projection matrix from being right handed to left handed in place and vice versa
  71849. */
  71850. toggleProjectionMatrixHandInPlace(): void;
  71851. /**
  71852. * Creates a matrix from an array
  71853. * @param array defines the source array
  71854. * @param offset defines an offset in the source array
  71855. * @returns a new Matrix set from the starting index of the given array
  71856. */
  71857. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  71858. /**
  71859. * Copy the content of an array into a given matrix
  71860. * @param array defines the source array
  71861. * @param offset defines an offset in the source array
  71862. * @param result defines the target matrix
  71863. */
  71864. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  71865. /**
  71866. * Stores an array into a matrix after having multiplied each component by a given factor
  71867. * @param array defines the source array
  71868. * @param offset defines the offset in the source array
  71869. * @param scale defines the scaling factor
  71870. * @param result defines the target matrix
  71871. */
  71872. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  71873. /**
  71874. * Gets an identity matrix that must not be updated
  71875. */
  71876. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  71877. /**
  71878. * Stores a list of values (16) inside a given matrix
  71879. * @param initialM11 defines 1st value of 1st row
  71880. * @param initialM12 defines 2nd value of 1st row
  71881. * @param initialM13 defines 3rd value of 1st row
  71882. * @param initialM14 defines 4th value of 1st row
  71883. * @param initialM21 defines 1st value of 2nd row
  71884. * @param initialM22 defines 2nd value of 2nd row
  71885. * @param initialM23 defines 3rd value of 2nd row
  71886. * @param initialM24 defines 4th value of 2nd row
  71887. * @param initialM31 defines 1st value of 3rd row
  71888. * @param initialM32 defines 2nd value of 3rd row
  71889. * @param initialM33 defines 3rd value of 3rd row
  71890. * @param initialM34 defines 4th value of 3rd row
  71891. * @param initialM41 defines 1st value of 4th row
  71892. * @param initialM42 defines 2nd value of 4th row
  71893. * @param initialM43 defines 3rd value of 4th row
  71894. * @param initialM44 defines 4th value of 4th row
  71895. * @param result defines the target matrix
  71896. */
  71897. 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;
  71898. /**
  71899. * Creates new matrix from a list of values (16)
  71900. * @param initialM11 defines 1st value of 1st row
  71901. * @param initialM12 defines 2nd value of 1st row
  71902. * @param initialM13 defines 3rd value of 1st row
  71903. * @param initialM14 defines 4th value of 1st row
  71904. * @param initialM21 defines 1st value of 2nd row
  71905. * @param initialM22 defines 2nd value of 2nd row
  71906. * @param initialM23 defines 3rd value of 2nd row
  71907. * @param initialM24 defines 4th value of 2nd row
  71908. * @param initialM31 defines 1st value of 3rd row
  71909. * @param initialM32 defines 2nd value of 3rd row
  71910. * @param initialM33 defines 3rd value of 3rd row
  71911. * @param initialM34 defines 4th value of 3rd row
  71912. * @param initialM41 defines 1st value of 4th row
  71913. * @param initialM42 defines 2nd value of 4th row
  71914. * @param initialM43 defines 3rd value of 4th row
  71915. * @param initialM44 defines 4th value of 4th row
  71916. * @returns the new matrix
  71917. */
  71918. 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;
  71919. /**
  71920. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  71921. * @param scale defines the scale vector3
  71922. * @param rotation defines the rotation quaternion
  71923. * @param translation defines the translation vector3
  71924. * @returns a new matrix
  71925. */
  71926. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  71927. /**
  71928. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  71929. * @param scale defines the scale vector3
  71930. * @param rotation defines the rotation quaternion
  71931. * @param translation defines the translation vector3
  71932. * @param result defines the target matrix
  71933. */
  71934. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  71935. /**
  71936. * Creates a new identity matrix
  71937. * @returns a new identity matrix
  71938. */
  71939. static Identity(): Matrix;
  71940. /**
  71941. * Creates a new identity matrix and stores the result in a given matrix
  71942. * @param result defines the target matrix
  71943. */
  71944. static IdentityToRef(result: Matrix): void;
  71945. /**
  71946. * Creates a new zero matrix
  71947. * @returns a new zero matrix
  71948. */
  71949. static Zero(): Matrix;
  71950. /**
  71951. * Creates a new rotation matrix for "angle" radians around the X axis
  71952. * @param angle defines the angle (in radians) to use
  71953. * @return the new matrix
  71954. */
  71955. static RotationX(angle: number): Matrix;
  71956. /**
  71957. * Creates a new matrix as the invert of a given matrix
  71958. * @param source defines the source matrix
  71959. * @returns the new matrix
  71960. */
  71961. static Invert(source: DeepImmutable<Matrix>): Matrix;
  71962. /**
  71963. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  71964. * @param angle defines the angle (in radians) to use
  71965. * @param result defines the target matrix
  71966. */
  71967. static RotationXToRef(angle: number, result: Matrix): void;
  71968. /**
  71969. * Creates a new rotation matrix for "angle" radians around the Y axis
  71970. * @param angle defines the angle (in radians) to use
  71971. * @return the new matrix
  71972. */
  71973. static RotationY(angle: number): Matrix;
  71974. /**
  71975. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  71976. * @param angle defines the angle (in radians) to use
  71977. * @param result defines the target matrix
  71978. */
  71979. static RotationYToRef(angle: number, result: Matrix): void;
  71980. /**
  71981. * Creates a new rotation matrix for "angle" radians around the Z axis
  71982. * @param angle defines the angle (in radians) to use
  71983. * @return the new matrix
  71984. */
  71985. static RotationZ(angle: number): Matrix;
  71986. /**
  71987. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  71988. * @param angle defines the angle (in radians) to use
  71989. * @param result defines the target matrix
  71990. */
  71991. static RotationZToRef(angle: number, result: Matrix): void;
  71992. /**
  71993. * Creates a new rotation matrix for "angle" radians around the given axis
  71994. * @param axis defines the axis to use
  71995. * @param angle defines the angle (in radians) to use
  71996. * @return the new matrix
  71997. */
  71998. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  71999. /**
  72000. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  72001. * @param axis defines the axis to use
  72002. * @param angle defines the angle (in radians) to use
  72003. * @param result defines the target matrix
  72004. */
  72005. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  72006. /**
  72007. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  72008. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  72009. * @param from defines the vector to align
  72010. * @param to defines the vector to align to
  72011. * @param result defines the target matrix
  72012. */
  72013. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  72014. /**
  72015. * Creates a rotation matrix
  72016. * @param yaw defines the yaw angle in radians (Y axis)
  72017. * @param pitch defines the pitch angle in radians (X axis)
  72018. * @param roll defines the roll angle in radians (X axis)
  72019. * @returns the new rotation matrix
  72020. */
  72021. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  72022. /**
  72023. * Creates a rotation matrix and stores it in a given matrix
  72024. * @param yaw defines the yaw angle in radians (Y axis)
  72025. * @param pitch defines the pitch angle in radians (X axis)
  72026. * @param roll defines the roll angle in radians (X axis)
  72027. * @param result defines the target matrix
  72028. */
  72029. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  72030. /**
  72031. * Creates a scaling matrix
  72032. * @param x defines the scale factor on X axis
  72033. * @param y defines the scale factor on Y axis
  72034. * @param z defines the scale factor on Z axis
  72035. * @returns the new matrix
  72036. */
  72037. static Scaling(x: number, y: number, z: number): Matrix;
  72038. /**
  72039. * Creates a scaling matrix and stores it in a given matrix
  72040. * @param x defines the scale factor on X axis
  72041. * @param y defines the scale factor on Y axis
  72042. * @param z defines the scale factor on Z axis
  72043. * @param result defines the target matrix
  72044. */
  72045. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  72046. /**
  72047. * Creates a translation matrix
  72048. * @param x defines the translation on X axis
  72049. * @param y defines the translation on Y axis
  72050. * @param z defines the translationon Z axis
  72051. * @returns the new matrix
  72052. */
  72053. static Translation(x: number, y: number, z: number): Matrix;
  72054. /**
  72055. * Creates a translation matrix and stores it in a given matrix
  72056. * @param x defines the translation on X axis
  72057. * @param y defines the translation on Y axis
  72058. * @param z defines the translationon Z axis
  72059. * @param result defines the target matrix
  72060. */
  72061. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  72062. /**
  72063. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  72064. * @param startValue defines the start value
  72065. * @param endValue defines the end value
  72066. * @param gradient defines the gradient factor
  72067. * @returns the new matrix
  72068. */
  72069. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  72070. /**
  72071. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  72072. * @param startValue defines the start value
  72073. * @param endValue defines the end value
  72074. * @param gradient defines the gradient factor
  72075. * @param result defines the Matrix object where to store data
  72076. */
  72077. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  72078. /**
  72079. * Builds a new matrix whose values are computed by:
  72080. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  72081. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  72082. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  72083. * @param startValue defines the first matrix
  72084. * @param endValue defines the second matrix
  72085. * @param gradient defines the gradient between the two matrices
  72086. * @returns the new matrix
  72087. */
  72088. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  72089. /**
  72090. * Update a matrix to values which are computed by:
  72091. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  72092. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  72093. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  72094. * @param startValue defines the first matrix
  72095. * @param endValue defines the second matrix
  72096. * @param gradient defines the gradient between the two matrices
  72097. * @param result defines the target matrix
  72098. */
  72099. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  72100. /**
  72101. * 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"
  72102. * This function works in left handed mode
  72103. * @param eye defines the final position of the entity
  72104. * @param target defines where the entity should look at
  72105. * @param up defines the up vector for the entity
  72106. * @returns the new matrix
  72107. */
  72108. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  72109. /**
  72110. * 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".
  72111. * This function works in left handed mode
  72112. * @param eye defines the final position of the entity
  72113. * @param target defines where the entity should look at
  72114. * @param up defines the up vector for the entity
  72115. * @param result defines the target matrix
  72116. */
  72117. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  72118. /**
  72119. * 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"
  72120. * This function works in right handed mode
  72121. * @param eye defines the final position of the entity
  72122. * @param target defines where the entity should look at
  72123. * @param up defines the up vector for the entity
  72124. * @returns the new matrix
  72125. */
  72126. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  72127. /**
  72128. * 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".
  72129. * This function works in right handed mode
  72130. * @param eye defines the final position of the entity
  72131. * @param target defines where the entity should look at
  72132. * @param up defines the up vector for the entity
  72133. * @param result defines the target matrix
  72134. */
  72135. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  72136. /**
  72137. * Create a left-handed orthographic projection matrix
  72138. * @param width defines the viewport width
  72139. * @param height defines the viewport height
  72140. * @param znear defines the near clip plane
  72141. * @param zfar defines the far clip plane
  72142. * @returns a new matrix as a left-handed orthographic projection matrix
  72143. */
  72144. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  72145. /**
  72146. * Store a left-handed orthographic projection to a given matrix
  72147. * @param width defines the viewport width
  72148. * @param height defines the viewport height
  72149. * @param znear defines the near clip plane
  72150. * @param zfar defines the far clip plane
  72151. * @param result defines the target matrix
  72152. */
  72153. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  72154. /**
  72155. * Create a left-handed orthographic projection matrix
  72156. * @param left defines the viewport left coordinate
  72157. * @param right defines the viewport right coordinate
  72158. * @param bottom defines the viewport bottom coordinate
  72159. * @param top defines the viewport top coordinate
  72160. * @param znear defines the near clip plane
  72161. * @param zfar defines the far clip plane
  72162. * @returns a new matrix as a left-handed orthographic projection matrix
  72163. */
  72164. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  72165. /**
  72166. * Stores a left-handed orthographic projection into a given matrix
  72167. * @param left defines the viewport left coordinate
  72168. * @param right defines the viewport right coordinate
  72169. * @param bottom defines the viewport bottom coordinate
  72170. * @param top defines the viewport top coordinate
  72171. * @param znear defines the near clip plane
  72172. * @param zfar defines the far clip plane
  72173. * @param result defines the target matrix
  72174. */
  72175. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  72176. /**
  72177. * Creates a right-handed orthographic projection matrix
  72178. * @param left defines the viewport left coordinate
  72179. * @param right defines the viewport right coordinate
  72180. * @param bottom defines the viewport bottom coordinate
  72181. * @param top defines the viewport top coordinate
  72182. * @param znear defines the near clip plane
  72183. * @param zfar defines the far clip plane
  72184. * @returns a new matrix as a right-handed orthographic projection matrix
  72185. */
  72186. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  72187. /**
  72188. * Stores a right-handed orthographic projection into a given matrix
  72189. * @param left defines the viewport left coordinate
  72190. * @param right defines the viewport right coordinate
  72191. * @param bottom defines the viewport bottom coordinate
  72192. * @param top defines the viewport top coordinate
  72193. * @param znear defines the near clip plane
  72194. * @param zfar defines the far clip plane
  72195. * @param result defines the target matrix
  72196. */
  72197. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  72198. /**
  72199. * Creates a left-handed perspective projection matrix
  72200. * @param width defines the viewport width
  72201. * @param height defines the viewport height
  72202. * @param znear defines the near clip plane
  72203. * @param zfar defines the far clip plane
  72204. * @returns a new matrix as a left-handed perspective projection matrix
  72205. */
  72206. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  72207. /**
  72208. * Creates a left-handed perspective projection matrix
  72209. * @param fov defines the horizontal field of view
  72210. * @param aspect defines the aspect ratio
  72211. * @param znear defines the near clip plane
  72212. * @param zfar defines the far clip plane
  72213. * @returns a new matrix as a left-handed perspective projection matrix
  72214. */
  72215. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  72216. /**
  72217. * Stores a left-handed perspective projection into a given matrix
  72218. * @param fov defines the horizontal field of view
  72219. * @param aspect defines the aspect ratio
  72220. * @param znear defines the near clip plane
  72221. * @param zfar defines the far clip plane
  72222. * @param result defines the target matrix
  72223. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72224. */
  72225. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72226. /**
  72227. * Creates a right-handed perspective projection matrix
  72228. * @param fov defines the horizontal field of view
  72229. * @param aspect defines the aspect ratio
  72230. * @param znear defines the near clip plane
  72231. * @param zfar defines the far clip plane
  72232. * @returns a new matrix as a right-handed perspective projection matrix
  72233. */
  72234. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  72235. /**
  72236. * Stores a right-handed perspective projection into a given matrix
  72237. * @param fov defines the horizontal field of view
  72238. * @param aspect defines the aspect ratio
  72239. * @param znear defines the near clip plane
  72240. * @param zfar defines the far clip plane
  72241. * @param result defines the target matrix
  72242. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72243. */
  72244. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72245. /**
  72246. * Stores a perspective projection for WebVR info a given matrix
  72247. * @param fov defines the field of view
  72248. * @param znear defines the near clip plane
  72249. * @param zfar defines the far clip plane
  72250. * @param result defines the target matrix
  72251. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  72252. */
  72253. static PerspectiveFovWebVRToRef(fov: {
  72254. upDegrees: number;
  72255. downDegrees: number;
  72256. leftDegrees: number;
  72257. rightDegrees: number;
  72258. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  72259. /**
  72260. * Computes a complete transformation matrix
  72261. * @param viewport defines the viewport to use
  72262. * @param world defines the world matrix
  72263. * @param view defines the view matrix
  72264. * @param projection defines the projection matrix
  72265. * @param zmin defines the near clip plane
  72266. * @param zmax defines the far clip plane
  72267. * @returns the transformation matrix
  72268. */
  72269. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  72270. /**
  72271. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  72272. * @param matrix defines the matrix to use
  72273. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  72274. */
  72275. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  72276. /**
  72277. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  72278. * @param matrix defines the matrix to use
  72279. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  72280. */
  72281. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  72282. /**
  72283. * Compute the transpose of a given matrix
  72284. * @param matrix defines the matrix to transpose
  72285. * @returns the new matrix
  72286. */
  72287. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  72288. /**
  72289. * Compute the transpose of a matrix and store it in a target matrix
  72290. * @param matrix defines the matrix to transpose
  72291. * @param result defines the target matrix
  72292. */
  72293. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  72294. /**
  72295. * Computes a reflection matrix from a plane
  72296. * @param plane defines the reflection plane
  72297. * @returns a new matrix
  72298. */
  72299. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  72300. /**
  72301. * Computes a reflection matrix from a plane
  72302. * @param plane defines the reflection plane
  72303. * @param result defines the target matrix
  72304. */
  72305. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  72306. /**
  72307. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  72308. * @param xaxis defines the value of the 1st axis
  72309. * @param yaxis defines the value of the 2nd axis
  72310. * @param zaxis defines the value of the 3rd axis
  72311. * @param result defines the target matrix
  72312. */
  72313. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  72314. /**
  72315. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  72316. * @param quat defines the quaternion to use
  72317. * @param result defines the target matrix
  72318. */
  72319. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  72320. }
  72321. /**
  72322. * @hidden
  72323. */
  72324. export class TmpVectors {
  72325. static Vector2: Vector2[];
  72326. static Vector3: Vector3[];
  72327. static Vector4: Vector4[];
  72328. static Quaternion: Quaternion[];
  72329. static Matrix: Matrix[];
  72330. }
  72331. }
  72332. declare module BABYLON {
  72333. /**
  72334. * Defines potential orientation for back face culling
  72335. */
  72336. export enum Orientation {
  72337. /**
  72338. * Clockwise
  72339. */
  72340. CW = 0,
  72341. /** Counter clockwise */
  72342. CCW = 1
  72343. }
  72344. /** Class used to represent a Bezier curve */
  72345. export class BezierCurve {
  72346. /**
  72347. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  72348. * @param t defines the time
  72349. * @param x1 defines the left coordinate on X axis
  72350. * @param y1 defines the left coordinate on Y axis
  72351. * @param x2 defines the right coordinate on X axis
  72352. * @param y2 defines the right coordinate on Y axis
  72353. * @returns the interpolated value
  72354. */
  72355. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  72356. }
  72357. /**
  72358. * Defines angle representation
  72359. */
  72360. export class Angle {
  72361. private _radians;
  72362. /**
  72363. * Creates an Angle object of "radians" radians (float).
  72364. * @param radians the angle in radians
  72365. */
  72366. constructor(radians: number);
  72367. /**
  72368. * Get value in degrees
  72369. * @returns the Angle value in degrees (float)
  72370. */
  72371. degrees(): number;
  72372. /**
  72373. * Get value in radians
  72374. * @returns the Angle value in radians (float)
  72375. */
  72376. radians(): number;
  72377. /**
  72378. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  72379. * @param a defines first vector
  72380. * @param b defines second vector
  72381. * @returns a new Angle
  72382. */
  72383. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  72384. /**
  72385. * Gets a new Angle object from the given float in radians
  72386. * @param radians defines the angle value in radians
  72387. * @returns a new Angle
  72388. */
  72389. static FromRadians(radians: number): Angle;
  72390. /**
  72391. * Gets a new Angle object from the given float in degrees
  72392. * @param degrees defines the angle value in degrees
  72393. * @returns a new Angle
  72394. */
  72395. static FromDegrees(degrees: number): Angle;
  72396. }
  72397. /**
  72398. * This represents an arc in a 2d space.
  72399. */
  72400. export class Arc2 {
  72401. /** Defines the start point of the arc */
  72402. startPoint: Vector2;
  72403. /** Defines the mid point of the arc */
  72404. midPoint: Vector2;
  72405. /** Defines the end point of the arc */
  72406. endPoint: Vector2;
  72407. /**
  72408. * Defines the center point of the arc.
  72409. */
  72410. centerPoint: Vector2;
  72411. /**
  72412. * Defines the radius of the arc.
  72413. */
  72414. radius: number;
  72415. /**
  72416. * Defines the angle of the arc (from mid point to end point).
  72417. */
  72418. angle: Angle;
  72419. /**
  72420. * Defines the start angle of the arc (from start point to middle point).
  72421. */
  72422. startAngle: Angle;
  72423. /**
  72424. * Defines the orientation of the arc (clock wise/counter clock wise).
  72425. */
  72426. orientation: Orientation;
  72427. /**
  72428. * Creates an Arc object from the three given points : start, middle and end.
  72429. * @param startPoint Defines the start point of the arc
  72430. * @param midPoint Defines the midlle point of the arc
  72431. * @param endPoint Defines the end point of the arc
  72432. */
  72433. constructor(
  72434. /** Defines the start point of the arc */
  72435. startPoint: Vector2,
  72436. /** Defines the mid point of the arc */
  72437. midPoint: Vector2,
  72438. /** Defines the end point of the arc */
  72439. endPoint: Vector2);
  72440. }
  72441. /**
  72442. * Represents a 2D path made up of multiple 2D points
  72443. */
  72444. export class Path2 {
  72445. private _points;
  72446. private _length;
  72447. /**
  72448. * If the path start and end point are the same
  72449. */
  72450. closed: boolean;
  72451. /**
  72452. * Creates a Path2 object from the starting 2D coordinates x and y.
  72453. * @param x the starting points x value
  72454. * @param y the starting points y value
  72455. */
  72456. constructor(x: number, y: number);
  72457. /**
  72458. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  72459. * @param x the added points x value
  72460. * @param y the added points y value
  72461. * @returns the updated Path2.
  72462. */
  72463. addLineTo(x: number, y: number): Path2;
  72464. /**
  72465. * 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.
  72466. * @param midX middle point x value
  72467. * @param midY middle point y value
  72468. * @param endX end point x value
  72469. * @param endY end point y value
  72470. * @param numberOfSegments (default: 36)
  72471. * @returns the updated Path2.
  72472. */
  72473. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  72474. /**
  72475. * Closes the Path2.
  72476. * @returns the Path2.
  72477. */
  72478. close(): Path2;
  72479. /**
  72480. * Gets the sum of the distance between each sequential point in the path
  72481. * @returns the Path2 total length (float).
  72482. */
  72483. length(): number;
  72484. /**
  72485. * Gets the points which construct the path
  72486. * @returns the Path2 internal array of points.
  72487. */
  72488. getPoints(): Vector2[];
  72489. /**
  72490. * Retreives the point at the distance aways from the starting point
  72491. * @param normalizedLengthPosition the length along the path to retreive the point from
  72492. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  72493. */
  72494. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  72495. /**
  72496. * Creates a new path starting from an x and y position
  72497. * @param x starting x value
  72498. * @param y starting y value
  72499. * @returns a new Path2 starting at the coordinates (x, y).
  72500. */
  72501. static StartingAt(x: number, y: number): Path2;
  72502. }
  72503. /**
  72504. * Represents a 3D path made up of multiple 3D points
  72505. */
  72506. export class Path3D {
  72507. /**
  72508. * an array of Vector3, the curve axis of the Path3D
  72509. */
  72510. path: Vector3[];
  72511. private _curve;
  72512. private _distances;
  72513. private _tangents;
  72514. private _normals;
  72515. private _binormals;
  72516. private _raw;
  72517. /**
  72518. * new Path3D(path, normal, raw)
  72519. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  72520. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  72521. * @param path an array of Vector3, the curve axis of the Path3D
  72522. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  72523. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  72524. */
  72525. constructor(
  72526. /**
  72527. * an array of Vector3, the curve axis of the Path3D
  72528. */
  72529. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean);
  72530. /**
  72531. * Returns the Path3D array of successive Vector3 designing its curve.
  72532. * @returns the Path3D array of successive Vector3 designing its curve.
  72533. */
  72534. getCurve(): Vector3[];
  72535. /**
  72536. * Returns an array populated with tangent vectors on each Path3D curve point.
  72537. * @returns an array populated with tangent vectors on each Path3D curve point.
  72538. */
  72539. getTangents(): Vector3[];
  72540. /**
  72541. * Returns an array populated with normal vectors on each Path3D curve point.
  72542. * @returns an array populated with normal vectors on each Path3D curve point.
  72543. */
  72544. getNormals(): Vector3[];
  72545. /**
  72546. * Returns an array populated with binormal vectors on each Path3D curve point.
  72547. * @returns an array populated with binormal vectors on each Path3D curve point.
  72548. */
  72549. getBinormals(): Vector3[];
  72550. /**
  72551. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  72552. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  72553. */
  72554. getDistances(): number[];
  72555. /**
  72556. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  72557. * @param path path which all values are copied into the curves points
  72558. * @param firstNormal which should be projected onto the curve
  72559. * @returns the same object updated.
  72560. */
  72561. update(path: Vector3[], firstNormal?: Nullable<Vector3>): Path3D;
  72562. private _compute;
  72563. private _getFirstNonNullVector;
  72564. private _getLastNonNullVector;
  72565. private _normalVector;
  72566. }
  72567. /**
  72568. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  72569. * A Curve3 is designed from a series of successive Vector3.
  72570. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  72571. */
  72572. export class Curve3 {
  72573. private _points;
  72574. private _length;
  72575. /**
  72576. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  72577. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  72578. * @param v1 (Vector3) the control point
  72579. * @param v2 (Vector3) the end point of the Quadratic Bezier
  72580. * @param nbPoints (integer) the wanted number of points in the curve
  72581. * @returns the created Curve3
  72582. */
  72583. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  72584. /**
  72585. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  72586. * @param v0 (Vector3) the origin point of the Cubic Bezier
  72587. * @param v1 (Vector3) the first control point
  72588. * @param v2 (Vector3) the second control point
  72589. * @param v3 (Vector3) the end point of the Cubic Bezier
  72590. * @param nbPoints (integer) the wanted number of points in the curve
  72591. * @returns the created Curve3
  72592. */
  72593. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  72594. /**
  72595. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  72596. * @param p1 (Vector3) the origin point of the Hermite Spline
  72597. * @param t1 (Vector3) the tangent vector at the origin point
  72598. * @param p2 (Vector3) the end point of the Hermite Spline
  72599. * @param t2 (Vector3) the tangent vector at the end point
  72600. * @param nbPoints (integer) the wanted number of points in the curve
  72601. * @returns the created Curve3
  72602. */
  72603. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  72604. /**
  72605. * Returns a Curve3 object along a CatmullRom Spline curve :
  72606. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  72607. * @param nbPoints (integer) the wanted number of points between each curve control points
  72608. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  72609. * @returns the created Curve3
  72610. */
  72611. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  72612. /**
  72613. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  72614. * A Curve3 is designed from a series of successive Vector3.
  72615. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  72616. * @param points points which make up the curve
  72617. */
  72618. constructor(points: Vector3[]);
  72619. /**
  72620. * @returns the Curve3 stored array of successive Vector3
  72621. */
  72622. getPoints(): Vector3[];
  72623. /**
  72624. * @returns the computed length (float) of the curve.
  72625. */
  72626. length(): number;
  72627. /**
  72628. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  72629. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  72630. * curveA and curveB keep unchanged.
  72631. * @param curve the curve to continue from this curve
  72632. * @returns the newly constructed curve
  72633. */
  72634. continue(curve: DeepImmutable<Curve3>): Curve3;
  72635. private _computeLength;
  72636. }
  72637. }
  72638. declare module BABYLON {
  72639. /**
  72640. * This represents the main contract an easing function should follow.
  72641. * Easing functions are used throughout the animation system.
  72642. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72643. */
  72644. export interface IEasingFunction {
  72645. /**
  72646. * Given an input gradient between 0 and 1, this returns the corrseponding value
  72647. * of the easing function.
  72648. * The link below provides some of the most common examples of easing functions.
  72649. * @see https://easings.net/
  72650. * @param gradient Defines the value between 0 and 1 we want the easing value for
  72651. * @returns the corresponding value on the curve defined by the easing function
  72652. */
  72653. ease(gradient: number): number;
  72654. }
  72655. /**
  72656. * Base class used for every default easing function.
  72657. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72658. */
  72659. export class EasingFunction implements IEasingFunction {
  72660. /**
  72661. * Interpolation follows the mathematical formula associated with the easing function.
  72662. */
  72663. static readonly EASINGMODE_EASEIN: number;
  72664. /**
  72665. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  72666. */
  72667. static readonly EASINGMODE_EASEOUT: number;
  72668. /**
  72669. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  72670. */
  72671. static readonly EASINGMODE_EASEINOUT: number;
  72672. private _easingMode;
  72673. /**
  72674. * Sets the easing mode of the current function.
  72675. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  72676. */
  72677. setEasingMode(easingMode: number): void;
  72678. /**
  72679. * Gets the current easing mode.
  72680. * @returns the easing mode
  72681. */
  72682. getEasingMode(): number;
  72683. /**
  72684. * @hidden
  72685. */
  72686. easeInCore(gradient: number): number;
  72687. /**
  72688. * Given an input gradient between 0 and 1, this returns the corresponding value
  72689. * of the easing function.
  72690. * @param gradient Defines the value between 0 and 1 we want the easing value for
  72691. * @returns the corresponding value on the curve defined by the easing function
  72692. */
  72693. ease(gradient: number): number;
  72694. }
  72695. /**
  72696. * Easing function with a circle shape (see link below).
  72697. * @see https://easings.net/#easeInCirc
  72698. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72699. */
  72700. export class CircleEase extends EasingFunction implements IEasingFunction {
  72701. /** @hidden */
  72702. easeInCore(gradient: number): number;
  72703. }
  72704. /**
  72705. * Easing function with a ease back shape (see link below).
  72706. * @see https://easings.net/#easeInBack
  72707. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72708. */
  72709. export class BackEase extends EasingFunction implements IEasingFunction {
  72710. /** Defines the amplitude of the function */
  72711. amplitude: number;
  72712. /**
  72713. * Instantiates a back ease easing
  72714. * @see https://easings.net/#easeInBack
  72715. * @param amplitude Defines the amplitude of the function
  72716. */
  72717. constructor(
  72718. /** Defines the amplitude of the function */
  72719. amplitude?: number);
  72720. /** @hidden */
  72721. easeInCore(gradient: number): number;
  72722. }
  72723. /**
  72724. * Easing function with a bouncing shape (see link below).
  72725. * @see https://easings.net/#easeInBounce
  72726. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72727. */
  72728. export class BounceEase extends EasingFunction implements IEasingFunction {
  72729. /** Defines the number of bounces */
  72730. bounces: number;
  72731. /** Defines the amplitude of the bounce */
  72732. bounciness: number;
  72733. /**
  72734. * Instantiates a bounce easing
  72735. * @see https://easings.net/#easeInBounce
  72736. * @param bounces Defines the number of bounces
  72737. * @param bounciness Defines the amplitude of the bounce
  72738. */
  72739. constructor(
  72740. /** Defines the number of bounces */
  72741. bounces?: number,
  72742. /** Defines the amplitude of the bounce */
  72743. bounciness?: number);
  72744. /** @hidden */
  72745. easeInCore(gradient: number): number;
  72746. }
  72747. /**
  72748. * Easing function with a power of 3 shape (see link below).
  72749. * @see https://easings.net/#easeInCubic
  72750. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72751. */
  72752. export class CubicEase extends EasingFunction implements IEasingFunction {
  72753. /** @hidden */
  72754. easeInCore(gradient: number): number;
  72755. }
  72756. /**
  72757. * Easing function with an elastic shape (see link below).
  72758. * @see https://easings.net/#easeInElastic
  72759. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72760. */
  72761. export class ElasticEase extends EasingFunction implements IEasingFunction {
  72762. /** Defines the number of oscillations*/
  72763. oscillations: number;
  72764. /** Defines the amplitude of the oscillations*/
  72765. springiness: number;
  72766. /**
  72767. * Instantiates an elastic easing function
  72768. * @see https://easings.net/#easeInElastic
  72769. * @param oscillations Defines the number of oscillations
  72770. * @param springiness Defines the amplitude of the oscillations
  72771. */
  72772. constructor(
  72773. /** Defines the number of oscillations*/
  72774. oscillations?: number,
  72775. /** Defines the amplitude of the oscillations*/
  72776. springiness?: number);
  72777. /** @hidden */
  72778. easeInCore(gradient: number): number;
  72779. }
  72780. /**
  72781. * Easing function with an exponential shape (see link below).
  72782. * @see https://easings.net/#easeInExpo
  72783. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72784. */
  72785. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  72786. /** Defines the exponent of the function */
  72787. exponent: number;
  72788. /**
  72789. * Instantiates an exponential easing function
  72790. * @see https://easings.net/#easeInExpo
  72791. * @param exponent Defines the exponent of the function
  72792. */
  72793. constructor(
  72794. /** Defines the exponent of the function */
  72795. exponent?: number);
  72796. /** @hidden */
  72797. easeInCore(gradient: number): number;
  72798. }
  72799. /**
  72800. * Easing function with a power shape (see link below).
  72801. * @see https://easings.net/#easeInQuad
  72802. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72803. */
  72804. export class PowerEase extends EasingFunction implements IEasingFunction {
  72805. /** Defines the power of the function */
  72806. power: number;
  72807. /**
  72808. * Instantiates an power base easing function
  72809. * @see https://easings.net/#easeInQuad
  72810. * @param power Defines the power of the function
  72811. */
  72812. constructor(
  72813. /** Defines the power of the function */
  72814. power?: number);
  72815. /** @hidden */
  72816. easeInCore(gradient: number): number;
  72817. }
  72818. /**
  72819. * Easing function with a power of 2 shape (see link below).
  72820. * @see https://easings.net/#easeInQuad
  72821. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72822. */
  72823. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  72824. /** @hidden */
  72825. easeInCore(gradient: number): number;
  72826. }
  72827. /**
  72828. * Easing function with a power of 4 shape (see link below).
  72829. * @see https://easings.net/#easeInQuart
  72830. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72831. */
  72832. export class QuarticEase extends EasingFunction implements IEasingFunction {
  72833. /** @hidden */
  72834. easeInCore(gradient: number): number;
  72835. }
  72836. /**
  72837. * Easing function with a power of 5 shape (see link below).
  72838. * @see https://easings.net/#easeInQuint
  72839. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72840. */
  72841. export class QuinticEase extends EasingFunction implements IEasingFunction {
  72842. /** @hidden */
  72843. easeInCore(gradient: number): number;
  72844. }
  72845. /**
  72846. * Easing function with a sin shape (see link below).
  72847. * @see https://easings.net/#easeInSine
  72848. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72849. */
  72850. export class SineEase extends EasingFunction implements IEasingFunction {
  72851. /** @hidden */
  72852. easeInCore(gradient: number): number;
  72853. }
  72854. /**
  72855. * Easing function with a bezier shape (see link below).
  72856. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  72857. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72858. */
  72859. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  72860. /** Defines the x component of the start tangent in the bezier curve */
  72861. x1: number;
  72862. /** Defines the y component of the start tangent in the bezier curve */
  72863. y1: number;
  72864. /** Defines the x component of the end tangent in the bezier curve */
  72865. x2: number;
  72866. /** Defines the y component of the end tangent in the bezier curve */
  72867. y2: number;
  72868. /**
  72869. * Instantiates a bezier function
  72870. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  72871. * @param x1 Defines the x component of the start tangent in the bezier curve
  72872. * @param y1 Defines the y component of the start tangent in the bezier curve
  72873. * @param x2 Defines the x component of the end tangent in the bezier curve
  72874. * @param y2 Defines the y component of the end tangent in the bezier curve
  72875. */
  72876. constructor(
  72877. /** Defines the x component of the start tangent in the bezier curve */
  72878. x1?: number,
  72879. /** Defines the y component of the start tangent in the bezier curve */
  72880. y1?: number,
  72881. /** Defines the x component of the end tangent in the bezier curve */
  72882. x2?: number,
  72883. /** Defines the y component of the end tangent in the bezier curve */
  72884. y2?: number);
  72885. /** @hidden */
  72886. easeInCore(gradient: number): number;
  72887. }
  72888. }
  72889. declare module BABYLON {
  72890. /**
  72891. * Class used to hold a RBG color
  72892. */
  72893. export class Color3 {
  72894. /**
  72895. * Defines the red component (between 0 and 1, default is 0)
  72896. */
  72897. r: number;
  72898. /**
  72899. * Defines the green component (between 0 and 1, default is 0)
  72900. */
  72901. g: number;
  72902. /**
  72903. * Defines the blue component (between 0 and 1, default is 0)
  72904. */
  72905. b: number;
  72906. /**
  72907. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  72908. * @param r defines the red component (between 0 and 1, default is 0)
  72909. * @param g defines the green component (between 0 and 1, default is 0)
  72910. * @param b defines the blue component (between 0 and 1, default is 0)
  72911. */
  72912. constructor(
  72913. /**
  72914. * Defines the red component (between 0 and 1, default is 0)
  72915. */
  72916. r?: number,
  72917. /**
  72918. * Defines the green component (between 0 and 1, default is 0)
  72919. */
  72920. g?: number,
  72921. /**
  72922. * Defines the blue component (between 0 and 1, default is 0)
  72923. */
  72924. b?: number);
  72925. /**
  72926. * Creates a string with the Color3 current values
  72927. * @returns the string representation of the Color3 object
  72928. */
  72929. toString(): string;
  72930. /**
  72931. * Returns the string "Color3"
  72932. * @returns "Color3"
  72933. */
  72934. getClassName(): string;
  72935. /**
  72936. * Compute the Color3 hash code
  72937. * @returns an unique number that can be used to hash Color3 objects
  72938. */
  72939. getHashCode(): number;
  72940. /**
  72941. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  72942. * @param array defines the array where to store the r,g,b components
  72943. * @param index defines an optional index in the target array to define where to start storing values
  72944. * @returns the current Color3 object
  72945. */
  72946. toArray(array: FloatArray, index?: number): Color3;
  72947. /**
  72948. * Returns a new Color4 object from the current Color3 and the given alpha
  72949. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  72950. * @returns a new Color4 object
  72951. */
  72952. toColor4(alpha?: number): Color4;
  72953. /**
  72954. * Returns a new array populated with 3 numeric elements : red, green and blue values
  72955. * @returns the new array
  72956. */
  72957. asArray(): number[];
  72958. /**
  72959. * Returns the luminance value
  72960. * @returns a float value
  72961. */
  72962. toLuminance(): number;
  72963. /**
  72964. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  72965. * @param otherColor defines the second operand
  72966. * @returns the new Color3 object
  72967. */
  72968. multiply(otherColor: DeepImmutable<Color3>): Color3;
  72969. /**
  72970. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  72971. * @param otherColor defines the second operand
  72972. * @param result defines the Color3 object where to store the result
  72973. * @returns the current Color3
  72974. */
  72975. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  72976. /**
  72977. * Determines equality between Color3 objects
  72978. * @param otherColor defines the second operand
  72979. * @returns true if the rgb values are equal to the given ones
  72980. */
  72981. equals(otherColor: DeepImmutable<Color3>): boolean;
  72982. /**
  72983. * Determines equality between the current Color3 object and a set of r,b,g values
  72984. * @param r defines the red component to check
  72985. * @param g defines the green component to check
  72986. * @param b defines the blue component to check
  72987. * @returns true if the rgb values are equal to the given ones
  72988. */
  72989. equalsFloats(r: number, g: number, b: number): boolean;
  72990. /**
  72991. * Multiplies in place each rgb value by scale
  72992. * @param scale defines the scaling factor
  72993. * @returns the updated Color3
  72994. */
  72995. scale(scale: number): Color3;
  72996. /**
  72997. * Multiplies the rgb values by scale and stores the result into "result"
  72998. * @param scale defines the scaling factor
  72999. * @param result defines the Color3 object where to store the result
  73000. * @returns the unmodified current Color3
  73001. */
  73002. scaleToRef(scale: number, result: Color3): Color3;
  73003. /**
  73004. * Scale the current Color3 values by a factor and add the result to a given Color3
  73005. * @param scale defines the scale factor
  73006. * @param result defines color to store the result into
  73007. * @returns the unmodified current Color3
  73008. */
  73009. scaleAndAddToRef(scale: number, result: Color3): Color3;
  73010. /**
  73011. * Clamps the rgb values by the min and max values and stores the result into "result"
  73012. * @param min defines minimum clamping value (default is 0)
  73013. * @param max defines maximum clamping value (default is 1)
  73014. * @param result defines color to store the result into
  73015. * @returns the original Color3
  73016. */
  73017. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  73018. /**
  73019. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  73020. * @param otherColor defines the second operand
  73021. * @returns the new Color3
  73022. */
  73023. add(otherColor: DeepImmutable<Color3>): Color3;
  73024. /**
  73025. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  73026. * @param otherColor defines the second operand
  73027. * @param result defines Color3 object to store the result into
  73028. * @returns the unmodified current Color3
  73029. */
  73030. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  73031. /**
  73032. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  73033. * @param otherColor defines the second operand
  73034. * @returns the new Color3
  73035. */
  73036. subtract(otherColor: DeepImmutable<Color3>): Color3;
  73037. /**
  73038. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  73039. * @param otherColor defines the second operand
  73040. * @param result defines Color3 object to store the result into
  73041. * @returns the unmodified current Color3
  73042. */
  73043. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  73044. /**
  73045. * Copy the current object
  73046. * @returns a new Color3 copied the current one
  73047. */
  73048. clone(): Color3;
  73049. /**
  73050. * Copies the rgb values from the source in the current Color3
  73051. * @param source defines the source Color3 object
  73052. * @returns the updated Color3 object
  73053. */
  73054. copyFrom(source: DeepImmutable<Color3>): Color3;
  73055. /**
  73056. * Updates the Color3 rgb values from the given floats
  73057. * @param r defines the red component to read from
  73058. * @param g defines the green component to read from
  73059. * @param b defines the blue component to read from
  73060. * @returns the current Color3 object
  73061. */
  73062. copyFromFloats(r: number, g: number, b: number): Color3;
  73063. /**
  73064. * Updates the Color3 rgb values from the given floats
  73065. * @param r defines the red component to read from
  73066. * @param g defines the green component to read from
  73067. * @param b defines the blue component to read from
  73068. * @returns the current Color3 object
  73069. */
  73070. set(r: number, g: number, b: number): Color3;
  73071. /**
  73072. * Compute the Color3 hexadecimal code as a string
  73073. * @returns a string containing the hexadecimal representation of the Color3 object
  73074. */
  73075. toHexString(): string;
  73076. /**
  73077. * Computes a new Color3 converted from the current one to linear space
  73078. * @returns a new Color3 object
  73079. */
  73080. toLinearSpace(): Color3;
  73081. /**
  73082. * Converts current color in rgb space to HSV values
  73083. * @returns a new color3 representing the HSV values
  73084. */
  73085. toHSV(): Color3;
  73086. /**
  73087. * Converts current color in rgb space to HSV values
  73088. * @param result defines the Color3 where to store the HSV values
  73089. */
  73090. toHSVToRef(result: Color3): void;
  73091. /**
  73092. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  73093. * @param convertedColor defines the Color3 object where to store the linear space version
  73094. * @returns the unmodified Color3
  73095. */
  73096. toLinearSpaceToRef(convertedColor: Color3): Color3;
  73097. /**
  73098. * Computes a new Color3 converted from the current one to gamma space
  73099. * @returns a new Color3 object
  73100. */
  73101. toGammaSpace(): Color3;
  73102. /**
  73103. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  73104. * @param convertedColor defines the Color3 object where to store the gamma space version
  73105. * @returns the unmodified Color3
  73106. */
  73107. toGammaSpaceToRef(convertedColor: Color3): Color3;
  73108. private static _BlackReadOnly;
  73109. /**
  73110. * Convert Hue, saturation and value to a Color3 (RGB)
  73111. * @param hue defines the hue
  73112. * @param saturation defines the saturation
  73113. * @param value defines the value
  73114. * @param result defines the Color3 where to store the RGB values
  73115. */
  73116. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  73117. /**
  73118. * Creates a new Color3 from the string containing valid hexadecimal values
  73119. * @param hex defines a string containing valid hexadecimal values
  73120. * @returns a new Color3 object
  73121. */
  73122. static FromHexString(hex: string): Color3;
  73123. /**
  73124. * Creates a new Color3 from the starting index of the given array
  73125. * @param array defines the source array
  73126. * @param offset defines an offset in the source array
  73127. * @returns a new Color3 object
  73128. */
  73129. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  73130. /**
  73131. * Creates a new Color3 from integer values (< 256)
  73132. * @param r defines the red component to read from (value between 0 and 255)
  73133. * @param g defines the green component to read from (value between 0 and 255)
  73134. * @param b defines the blue component to read from (value between 0 and 255)
  73135. * @returns a new Color3 object
  73136. */
  73137. static FromInts(r: number, g: number, b: number): Color3;
  73138. /**
  73139. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  73140. * @param start defines the start Color3 value
  73141. * @param end defines the end Color3 value
  73142. * @param amount defines the gradient value between start and end
  73143. * @returns a new Color3 object
  73144. */
  73145. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  73146. /**
  73147. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  73148. * @param left defines the start value
  73149. * @param right defines the end value
  73150. * @param amount defines the gradient factor
  73151. * @param result defines the Color3 object where to store the result
  73152. */
  73153. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  73154. /**
  73155. * Returns a Color3 value containing a red color
  73156. * @returns a new Color3 object
  73157. */
  73158. static Red(): Color3;
  73159. /**
  73160. * Returns a Color3 value containing a green color
  73161. * @returns a new Color3 object
  73162. */
  73163. static Green(): Color3;
  73164. /**
  73165. * Returns a Color3 value containing a blue color
  73166. * @returns a new Color3 object
  73167. */
  73168. static Blue(): Color3;
  73169. /**
  73170. * Returns a Color3 value containing a black color
  73171. * @returns a new Color3 object
  73172. */
  73173. static Black(): Color3;
  73174. /**
  73175. * Gets a Color3 value containing a black color that must not be updated
  73176. */
  73177. static readonly BlackReadOnly: DeepImmutable<Color3>;
  73178. /**
  73179. * Returns a Color3 value containing a white color
  73180. * @returns a new Color3 object
  73181. */
  73182. static White(): Color3;
  73183. /**
  73184. * Returns a Color3 value containing a purple color
  73185. * @returns a new Color3 object
  73186. */
  73187. static Purple(): Color3;
  73188. /**
  73189. * Returns a Color3 value containing a magenta color
  73190. * @returns a new Color3 object
  73191. */
  73192. static Magenta(): Color3;
  73193. /**
  73194. * Returns a Color3 value containing a yellow color
  73195. * @returns a new Color3 object
  73196. */
  73197. static Yellow(): Color3;
  73198. /**
  73199. * Returns a Color3 value containing a gray color
  73200. * @returns a new Color3 object
  73201. */
  73202. static Gray(): Color3;
  73203. /**
  73204. * Returns a Color3 value containing a teal color
  73205. * @returns a new Color3 object
  73206. */
  73207. static Teal(): Color3;
  73208. /**
  73209. * Returns a Color3 value containing a random color
  73210. * @returns a new Color3 object
  73211. */
  73212. static Random(): Color3;
  73213. }
  73214. /**
  73215. * Class used to hold a RBGA color
  73216. */
  73217. export class Color4 {
  73218. /**
  73219. * Defines the red component (between 0 and 1, default is 0)
  73220. */
  73221. r: number;
  73222. /**
  73223. * Defines the green component (between 0 and 1, default is 0)
  73224. */
  73225. g: number;
  73226. /**
  73227. * Defines the blue component (between 0 and 1, default is 0)
  73228. */
  73229. b: number;
  73230. /**
  73231. * Defines the alpha component (between 0 and 1, default is 1)
  73232. */
  73233. a: number;
  73234. /**
  73235. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  73236. * @param r defines the red component (between 0 and 1, default is 0)
  73237. * @param g defines the green component (between 0 and 1, default is 0)
  73238. * @param b defines the blue component (between 0 and 1, default is 0)
  73239. * @param a defines the alpha component (between 0 and 1, default is 1)
  73240. */
  73241. constructor(
  73242. /**
  73243. * Defines the red component (between 0 and 1, default is 0)
  73244. */
  73245. r?: number,
  73246. /**
  73247. * Defines the green component (between 0 and 1, default is 0)
  73248. */
  73249. g?: number,
  73250. /**
  73251. * Defines the blue component (between 0 and 1, default is 0)
  73252. */
  73253. b?: number,
  73254. /**
  73255. * Defines the alpha component (between 0 and 1, default is 1)
  73256. */
  73257. a?: number);
  73258. /**
  73259. * Adds in place the given Color4 values to the current Color4 object
  73260. * @param right defines the second operand
  73261. * @returns the current updated Color4 object
  73262. */
  73263. addInPlace(right: DeepImmutable<Color4>): Color4;
  73264. /**
  73265. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  73266. * @returns the new array
  73267. */
  73268. asArray(): number[];
  73269. /**
  73270. * Stores from the starting index in the given array the Color4 successive values
  73271. * @param array defines the array where to store the r,g,b components
  73272. * @param index defines an optional index in the target array to define where to start storing values
  73273. * @returns the current Color4 object
  73274. */
  73275. toArray(array: number[], index?: number): Color4;
  73276. /**
  73277. * Determines equality between Color4 objects
  73278. * @param otherColor defines the second operand
  73279. * @returns true if the rgba values are equal to the given ones
  73280. */
  73281. equals(otherColor: DeepImmutable<Color4>): boolean;
  73282. /**
  73283. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  73284. * @param right defines the second operand
  73285. * @returns a new Color4 object
  73286. */
  73287. add(right: DeepImmutable<Color4>): Color4;
  73288. /**
  73289. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  73290. * @param right defines the second operand
  73291. * @returns a new Color4 object
  73292. */
  73293. subtract(right: DeepImmutable<Color4>): Color4;
  73294. /**
  73295. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  73296. * @param right defines the second operand
  73297. * @param result defines the Color4 object where to store the result
  73298. * @returns the current Color4 object
  73299. */
  73300. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  73301. /**
  73302. * Creates a new Color4 with the current Color4 values multiplied by scale
  73303. * @param scale defines the scaling factor to apply
  73304. * @returns a new Color4 object
  73305. */
  73306. scale(scale: number): Color4;
  73307. /**
  73308. * Multiplies the current Color4 values by scale and stores the result in "result"
  73309. * @param scale defines the scaling factor to apply
  73310. * @param result defines the Color4 object where to store the result
  73311. * @returns the current unmodified Color4
  73312. */
  73313. scaleToRef(scale: number, result: Color4): Color4;
  73314. /**
  73315. * Scale the current Color4 values by a factor and add the result to a given Color4
  73316. * @param scale defines the scale factor
  73317. * @param result defines the Color4 object where to store the result
  73318. * @returns the unmodified current Color4
  73319. */
  73320. scaleAndAddToRef(scale: number, result: Color4): Color4;
  73321. /**
  73322. * Clamps the rgb values by the min and max values and stores the result into "result"
  73323. * @param min defines minimum clamping value (default is 0)
  73324. * @param max defines maximum clamping value (default is 1)
  73325. * @param result defines color to store the result into.
  73326. * @returns the cuurent Color4
  73327. */
  73328. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  73329. /**
  73330. * Multipy an Color4 value by another and return a new Color4 object
  73331. * @param color defines the Color4 value to multiply by
  73332. * @returns a new Color4 object
  73333. */
  73334. multiply(color: Color4): Color4;
  73335. /**
  73336. * Multipy a Color4 value by another and push the result in a reference value
  73337. * @param color defines the Color4 value to multiply by
  73338. * @param result defines the Color4 to fill the result in
  73339. * @returns the result Color4
  73340. */
  73341. multiplyToRef(color: Color4, result: Color4): Color4;
  73342. /**
  73343. * Creates a string with the Color4 current values
  73344. * @returns the string representation of the Color4 object
  73345. */
  73346. toString(): string;
  73347. /**
  73348. * Returns the string "Color4"
  73349. * @returns "Color4"
  73350. */
  73351. getClassName(): string;
  73352. /**
  73353. * Compute the Color4 hash code
  73354. * @returns an unique number that can be used to hash Color4 objects
  73355. */
  73356. getHashCode(): number;
  73357. /**
  73358. * Creates a new Color4 copied from the current one
  73359. * @returns a new Color4 object
  73360. */
  73361. clone(): Color4;
  73362. /**
  73363. * Copies the given Color4 values into the current one
  73364. * @param source defines the source Color4 object
  73365. * @returns the current updated Color4 object
  73366. */
  73367. copyFrom(source: Color4): Color4;
  73368. /**
  73369. * Copies the given float values into the current one
  73370. * @param r defines the red component to read from
  73371. * @param g defines the green component to read from
  73372. * @param b defines the blue component to read from
  73373. * @param a defines the alpha component to read from
  73374. * @returns the current updated Color4 object
  73375. */
  73376. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  73377. /**
  73378. * Copies the given float values into the current one
  73379. * @param r defines the red component to read from
  73380. * @param g defines the green component to read from
  73381. * @param b defines the blue component to read from
  73382. * @param a defines the alpha component to read from
  73383. * @returns the current updated Color4 object
  73384. */
  73385. set(r: number, g: number, b: number, a: number): Color4;
  73386. /**
  73387. * Compute the Color4 hexadecimal code as a string
  73388. * @returns a string containing the hexadecimal representation of the Color4 object
  73389. */
  73390. toHexString(): string;
  73391. /**
  73392. * Computes a new Color4 converted from the current one to linear space
  73393. * @returns a new Color4 object
  73394. */
  73395. toLinearSpace(): Color4;
  73396. /**
  73397. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  73398. * @param convertedColor defines the Color4 object where to store the linear space version
  73399. * @returns the unmodified Color4
  73400. */
  73401. toLinearSpaceToRef(convertedColor: Color4): Color4;
  73402. /**
  73403. * Computes a new Color4 converted from the current one to gamma space
  73404. * @returns a new Color4 object
  73405. */
  73406. toGammaSpace(): Color4;
  73407. /**
  73408. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  73409. * @param convertedColor defines the Color4 object where to store the gamma space version
  73410. * @returns the unmodified Color4
  73411. */
  73412. toGammaSpaceToRef(convertedColor: Color4): Color4;
  73413. /**
  73414. * Creates a new Color4 from the string containing valid hexadecimal values
  73415. * @param hex defines a string containing valid hexadecimal values
  73416. * @returns a new Color4 object
  73417. */
  73418. static FromHexString(hex: string): Color4;
  73419. /**
  73420. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  73421. * @param left defines the start value
  73422. * @param right defines the end value
  73423. * @param amount defines the gradient factor
  73424. * @returns a new Color4 object
  73425. */
  73426. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  73427. /**
  73428. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  73429. * @param left defines the start value
  73430. * @param right defines the end value
  73431. * @param amount defines the gradient factor
  73432. * @param result defines the Color4 object where to store data
  73433. */
  73434. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  73435. /**
  73436. * Creates a new Color4 from a Color3 and an alpha value
  73437. * @param color3 defines the source Color3 to read from
  73438. * @param alpha defines the alpha component (1.0 by default)
  73439. * @returns a new Color4 object
  73440. */
  73441. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  73442. /**
  73443. * Creates a new Color4 from the starting index element of the given array
  73444. * @param array defines the source array to read from
  73445. * @param offset defines the offset in the source array
  73446. * @returns a new Color4 object
  73447. */
  73448. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  73449. /**
  73450. * Creates a new Color3 from integer values (< 256)
  73451. * @param r defines the red component to read from (value between 0 and 255)
  73452. * @param g defines the green component to read from (value between 0 and 255)
  73453. * @param b defines the blue component to read from (value between 0 and 255)
  73454. * @param a defines the alpha component to read from (value between 0 and 255)
  73455. * @returns a new Color3 object
  73456. */
  73457. static FromInts(r: number, g: number, b: number, a: number): Color4;
  73458. /**
  73459. * Check the content of a given array and convert it to an array containing RGBA data
  73460. * If the original array was already containing count * 4 values then it is returned directly
  73461. * @param colors defines the array to check
  73462. * @param count defines the number of RGBA data to expect
  73463. * @returns an array containing count * 4 values (RGBA)
  73464. */
  73465. static CheckColors4(colors: number[], count: number): number[];
  73466. }
  73467. /**
  73468. * @hidden
  73469. */
  73470. export class TmpColors {
  73471. static Color3: Color3[];
  73472. static Color4: Color4[];
  73473. }
  73474. }
  73475. declare module BABYLON {
  73476. /**
  73477. * Defines an interface which represents an animation key frame
  73478. */
  73479. export interface IAnimationKey {
  73480. /**
  73481. * Frame of the key frame
  73482. */
  73483. frame: number;
  73484. /**
  73485. * Value at the specifies key frame
  73486. */
  73487. value: any;
  73488. /**
  73489. * The input tangent for the cubic hermite spline
  73490. */
  73491. inTangent?: any;
  73492. /**
  73493. * The output tangent for the cubic hermite spline
  73494. */
  73495. outTangent?: any;
  73496. /**
  73497. * The animation interpolation type
  73498. */
  73499. interpolation?: AnimationKeyInterpolation;
  73500. }
  73501. /**
  73502. * Enum for the animation key frame interpolation type
  73503. */
  73504. export enum AnimationKeyInterpolation {
  73505. /**
  73506. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  73507. */
  73508. STEP = 1
  73509. }
  73510. }
  73511. declare module BABYLON {
  73512. /**
  73513. * Represents the range of an animation
  73514. */
  73515. export class AnimationRange {
  73516. /**The name of the animation range**/
  73517. name: string;
  73518. /**The starting frame of the animation */
  73519. from: number;
  73520. /**The ending frame of the animation*/
  73521. to: number;
  73522. /**
  73523. * Initializes the range of an animation
  73524. * @param name The name of the animation range
  73525. * @param from The starting frame of the animation
  73526. * @param to The ending frame of the animation
  73527. */
  73528. constructor(
  73529. /**The name of the animation range**/
  73530. name: string,
  73531. /**The starting frame of the animation */
  73532. from: number,
  73533. /**The ending frame of the animation*/
  73534. to: number);
  73535. /**
  73536. * Makes a copy of the animation range
  73537. * @returns A copy of the animation range
  73538. */
  73539. clone(): AnimationRange;
  73540. }
  73541. }
  73542. declare module BABYLON {
  73543. /**
  73544. * Composed of a frame, and an action function
  73545. */
  73546. export class AnimationEvent {
  73547. /** The frame for which the event is triggered **/
  73548. frame: number;
  73549. /** The event to perform when triggered **/
  73550. action: (currentFrame: number) => void;
  73551. /** Specifies if the event should be triggered only once**/
  73552. onlyOnce?: boolean | undefined;
  73553. /**
  73554. * Specifies if the animation event is done
  73555. */
  73556. isDone: boolean;
  73557. /**
  73558. * Initializes the animation event
  73559. * @param frame The frame for which the event is triggered
  73560. * @param action The event to perform when triggered
  73561. * @param onlyOnce Specifies if the event should be triggered only once
  73562. */
  73563. constructor(
  73564. /** The frame for which the event is triggered **/
  73565. frame: number,
  73566. /** The event to perform when triggered **/
  73567. action: (currentFrame: number) => void,
  73568. /** Specifies if the event should be triggered only once**/
  73569. onlyOnce?: boolean | undefined);
  73570. /** @hidden */
  73571. _clone(): AnimationEvent;
  73572. }
  73573. }
  73574. declare module BABYLON {
  73575. /**
  73576. * Interface used to define a behavior
  73577. */
  73578. export interface Behavior<T> {
  73579. /** gets or sets behavior's name */
  73580. name: string;
  73581. /**
  73582. * Function called when the behavior needs to be initialized (after attaching it to a target)
  73583. */
  73584. init(): void;
  73585. /**
  73586. * Called when the behavior is attached to a target
  73587. * @param target defines the target where the behavior is attached to
  73588. */
  73589. attach(target: T): void;
  73590. /**
  73591. * Called when the behavior is detached from its target
  73592. */
  73593. detach(): void;
  73594. }
  73595. /**
  73596. * Interface implemented by classes supporting behaviors
  73597. */
  73598. export interface IBehaviorAware<T> {
  73599. /**
  73600. * Attach a behavior
  73601. * @param behavior defines the behavior to attach
  73602. * @returns the current host
  73603. */
  73604. addBehavior(behavior: Behavior<T>): T;
  73605. /**
  73606. * Remove a behavior from the current object
  73607. * @param behavior defines the behavior to detach
  73608. * @returns the current host
  73609. */
  73610. removeBehavior(behavior: Behavior<T>): T;
  73611. /**
  73612. * Gets a behavior using its name to search
  73613. * @param name defines the name to search
  73614. * @returns the behavior or null if not found
  73615. */
  73616. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  73617. }
  73618. }
  73619. declare module BABYLON {
  73620. /**
  73621. * Defines an array and its length.
  73622. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  73623. */
  73624. export interface ISmartArrayLike<T> {
  73625. /**
  73626. * The data of the array.
  73627. */
  73628. data: Array<T>;
  73629. /**
  73630. * The active length of the array.
  73631. */
  73632. length: number;
  73633. }
  73634. /**
  73635. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  73636. */
  73637. export class SmartArray<T> implements ISmartArrayLike<T> {
  73638. /**
  73639. * The full set of data from the array.
  73640. */
  73641. data: Array<T>;
  73642. /**
  73643. * The active length of the array.
  73644. */
  73645. length: number;
  73646. protected _id: number;
  73647. /**
  73648. * Instantiates a Smart Array.
  73649. * @param capacity defines the default capacity of the array.
  73650. */
  73651. constructor(capacity: number);
  73652. /**
  73653. * Pushes a value at the end of the active data.
  73654. * @param value defines the object to push in the array.
  73655. */
  73656. push(value: T): void;
  73657. /**
  73658. * Iterates over the active data and apply the lambda to them.
  73659. * @param func defines the action to apply on each value.
  73660. */
  73661. forEach(func: (content: T) => void): void;
  73662. /**
  73663. * Sorts the full sets of data.
  73664. * @param compareFn defines the comparison function to apply.
  73665. */
  73666. sort(compareFn: (a: T, b: T) => number): void;
  73667. /**
  73668. * Resets the active data to an empty array.
  73669. */
  73670. reset(): void;
  73671. /**
  73672. * Releases all the data from the array as well as the array.
  73673. */
  73674. dispose(): void;
  73675. /**
  73676. * Concats the active data with a given array.
  73677. * @param array defines the data to concatenate with.
  73678. */
  73679. concat(array: any): void;
  73680. /**
  73681. * Returns the position of a value in the active data.
  73682. * @param value defines the value to find the index for
  73683. * @returns the index if found in the active data otherwise -1
  73684. */
  73685. indexOf(value: T): number;
  73686. /**
  73687. * Returns whether an element is part of the active data.
  73688. * @param value defines the value to look for
  73689. * @returns true if found in the active data otherwise false
  73690. */
  73691. contains(value: T): boolean;
  73692. private static _GlobalId;
  73693. }
  73694. /**
  73695. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  73696. * The data in this array can only be present once
  73697. */
  73698. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  73699. private _duplicateId;
  73700. /**
  73701. * Pushes a value at the end of the active data.
  73702. * THIS DOES NOT PREVENT DUPPLICATE DATA
  73703. * @param value defines the object to push in the array.
  73704. */
  73705. push(value: T): void;
  73706. /**
  73707. * Pushes a value at the end of the active data.
  73708. * If the data is already present, it won t be added again
  73709. * @param value defines the object to push in the array.
  73710. * @returns true if added false if it was already present
  73711. */
  73712. pushNoDuplicate(value: T): boolean;
  73713. /**
  73714. * Resets the active data to an empty array.
  73715. */
  73716. reset(): void;
  73717. /**
  73718. * Concats the active data with a given array.
  73719. * This ensures no dupplicate will be present in the result.
  73720. * @param array defines the data to concatenate with.
  73721. */
  73722. concatWithNoDuplicate(array: any): void;
  73723. }
  73724. }
  73725. declare module BABYLON {
  73726. /**
  73727. * @ignore
  73728. * This is a list of all the different input types that are available in the application.
  73729. * Fo instance: ArcRotateCameraGamepadInput...
  73730. */
  73731. export var CameraInputTypes: {};
  73732. /**
  73733. * This is the contract to implement in order to create a new input class.
  73734. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  73735. */
  73736. export interface ICameraInput<TCamera extends Camera> {
  73737. /**
  73738. * Defines the camera the input is attached to.
  73739. */
  73740. camera: Nullable<TCamera>;
  73741. /**
  73742. * Gets the class name of the current intput.
  73743. * @returns the class name
  73744. */
  73745. getClassName(): string;
  73746. /**
  73747. * Get the friendly name associated with the input class.
  73748. * @returns the input friendly name
  73749. */
  73750. getSimpleName(): string;
  73751. /**
  73752. * Attach the input controls to a specific dom element to get the input from.
  73753. * @param element Defines the element the controls should be listened from
  73754. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  73755. */
  73756. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  73757. /**
  73758. * Detach the current controls from the specified dom element.
  73759. * @param element Defines the element to stop listening the inputs from
  73760. */
  73761. detachControl(element: Nullable<HTMLElement>): void;
  73762. /**
  73763. * Update the current camera state depending on the inputs that have been used this frame.
  73764. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  73765. */
  73766. checkInputs?: () => void;
  73767. }
  73768. /**
  73769. * Represents a map of input types to input instance or input index to input instance.
  73770. */
  73771. export interface CameraInputsMap<TCamera extends Camera> {
  73772. /**
  73773. * Accessor to the input by input type.
  73774. */
  73775. [name: string]: ICameraInput<TCamera>;
  73776. /**
  73777. * Accessor to the input by input index.
  73778. */
  73779. [idx: number]: ICameraInput<TCamera>;
  73780. }
  73781. /**
  73782. * This represents the input manager used within a camera.
  73783. * It helps dealing with all the different kind of input attached to a camera.
  73784. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  73785. */
  73786. export class CameraInputsManager<TCamera extends Camera> {
  73787. /**
  73788. * Defines the list of inputs attahed to the camera.
  73789. */
  73790. attached: CameraInputsMap<TCamera>;
  73791. /**
  73792. * Defines the dom element the camera is collecting inputs from.
  73793. * This is null if the controls have not been attached.
  73794. */
  73795. attachedElement: Nullable<HTMLElement>;
  73796. /**
  73797. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  73798. */
  73799. noPreventDefault: boolean;
  73800. /**
  73801. * Defined the camera the input manager belongs to.
  73802. */
  73803. camera: TCamera;
  73804. /**
  73805. * Update the current camera state depending on the inputs that have been used this frame.
  73806. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  73807. */
  73808. checkInputs: () => void;
  73809. /**
  73810. * Instantiate a new Camera Input Manager.
  73811. * @param camera Defines the camera the input manager blongs to
  73812. */
  73813. constructor(camera: TCamera);
  73814. /**
  73815. * Add an input method to a camera
  73816. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  73817. * @param input camera input method
  73818. */
  73819. add(input: ICameraInput<TCamera>): void;
  73820. /**
  73821. * Remove a specific input method from a camera
  73822. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  73823. * @param inputToRemove camera input method
  73824. */
  73825. remove(inputToRemove: ICameraInput<TCamera>): void;
  73826. /**
  73827. * Remove a specific input type from a camera
  73828. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  73829. * @param inputType the type of the input to remove
  73830. */
  73831. removeByType(inputType: string): void;
  73832. private _addCheckInputs;
  73833. /**
  73834. * Attach the input controls to the currently attached dom element to listen the events from.
  73835. * @param input Defines the input to attach
  73836. */
  73837. attachInput(input: ICameraInput<TCamera>): void;
  73838. /**
  73839. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  73840. * @param element Defines the dom element to collect the events from
  73841. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  73842. */
  73843. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  73844. /**
  73845. * Detach the current manager inputs controls from a specific dom element.
  73846. * @param element Defines the dom element to collect the events from
  73847. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  73848. */
  73849. detachElement(element: HTMLElement, disconnect?: boolean): void;
  73850. /**
  73851. * Rebuild the dynamic inputCheck function from the current list of
  73852. * defined inputs in the manager.
  73853. */
  73854. rebuildInputCheck(): void;
  73855. /**
  73856. * Remove all attached input methods from a camera
  73857. */
  73858. clear(): void;
  73859. /**
  73860. * Serialize the current input manager attached to a camera.
  73861. * This ensures than once parsed,
  73862. * the input associated to the camera will be identical to the current ones
  73863. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  73864. */
  73865. serialize(serializedCamera: any): void;
  73866. /**
  73867. * Parses an input manager serialized JSON to restore the previous list of inputs
  73868. * and states associated to a camera.
  73869. * @param parsedCamera Defines the JSON to parse
  73870. */
  73871. parse(parsedCamera: any): void;
  73872. }
  73873. }
  73874. declare module BABYLON {
  73875. /**
  73876. * Class used to store data that will be store in GPU memory
  73877. */
  73878. export class Buffer {
  73879. private _engine;
  73880. private _buffer;
  73881. /** @hidden */
  73882. _data: Nullable<DataArray>;
  73883. private _updatable;
  73884. private _instanced;
  73885. private _divisor;
  73886. /**
  73887. * Gets the byte stride.
  73888. */
  73889. readonly byteStride: number;
  73890. /**
  73891. * Constructor
  73892. * @param engine the engine
  73893. * @param data the data to use for this buffer
  73894. * @param updatable whether the data is updatable
  73895. * @param stride the stride (optional)
  73896. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  73897. * @param instanced whether the buffer is instanced (optional)
  73898. * @param useBytes set to true if the stride in in bytes (optional)
  73899. * @param divisor sets an optional divisor for instances (1 by default)
  73900. */
  73901. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  73902. /**
  73903. * Create a new VertexBuffer based on the current buffer
  73904. * @param kind defines the vertex buffer kind (position, normal, etc.)
  73905. * @param offset defines offset in the buffer (0 by default)
  73906. * @param size defines the size in floats of attributes (position is 3 for instance)
  73907. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  73908. * @param instanced defines if the vertex buffer contains indexed data
  73909. * @param useBytes defines if the offset and stride are in bytes *
  73910. * @param divisor sets an optional divisor for instances (1 by default)
  73911. * @returns the new vertex buffer
  73912. */
  73913. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  73914. /**
  73915. * Gets a boolean indicating if the Buffer is updatable?
  73916. * @returns true if the buffer is updatable
  73917. */
  73918. isUpdatable(): boolean;
  73919. /**
  73920. * Gets current buffer's data
  73921. * @returns a DataArray or null
  73922. */
  73923. getData(): Nullable<DataArray>;
  73924. /**
  73925. * Gets underlying native buffer
  73926. * @returns underlying native buffer
  73927. */
  73928. getBuffer(): Nullable<DataBuffer>;
  73929. /**
  73930. * Gets the stride in float32 units (i.e. byte stride / 4).
  73931. * May not be an integer if the byte stride is not divisible by 4.
  73932. * DEPRECATED. Use byteStride instead.
  73933. * @returns the stride in float32 units
  73934. */
  73935. getStrideSize(): number;
  73936. /**
  73937. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  73938. * @param data defines the data to store
  73939. */
  73940. create(data?: Nullable<DataArray>): void;
  73941. /** @hidden */
  73942. _rebuild(): void;
  73943. /**
  73944. * Update current buffer data
  73945. * @param data defines the data to store
  73946. */
  73947. update(data: DataArray): void;
  73948. /**
  73949. * Updates the data directly.
  73950. * @param data the new data
  73951. * @param offset the new offset
  73952. * @param vertexCount the vertex count (optional)
  73953. * @param useBytes set to true if the offset is in bytes
  73954. */
  73955. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  73956. /**
  73957. * Release all resources
  73958. */
  73959. dispose(): void;
  73960. }
  73961. /**
  73962. * Specialized buffer used to store vertex data
  73963. */
  73964. export class VertexBuffer {
  73965. /** @hidden */
  73966. _buffer: Buffer;
  73967. private _kind;
  73968. private _size;
  73969. private _ownsBuffer;
  73970. private _instanced;
  73971. private _instanceDivisor;
  73972. /**
  73973. * The byte type.
  73974. */
  73975. static readonly BYTE: number;
  73976. /**
  73977. * The unsigned byte type.
  73978. */
  73979. static readonly UNSIGNED_BYTE: number;
  73980. /**
  73981. * The short type.
  73982. */
  73983. static readonly SHORT: number;
  73984. /**
  73985. * The unsigned short type.
  73986. */
  73987. static readonly UNSIGNED_SHORT: number;
  73988. /**
  73989. * The integer type.
  73990. */
  73991. static readonly INT: number;
  73992. /**
  73993. * The unsigned integer type.
  73994. */
  73995. static readonly UNSIGNED_INT: number;
  73996. /**
  73997. * The float type.
  73998. */
  73999. static readonly FLOAT: number;
  74000. /**
  74001. * Gets or sets the instance divisor when in instanced mode
  74002. */
  74003. instanceDivisor: number;
  74004. /**
  74005. * Gets the byte stride.
  74006. */
  74007. readonly byteStride: number;
  74008. /**
  74009. * Gets the byte offset.
  74010. */
  74011. readonly byteOffset: number;
  74012. /**
  74013. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  74014. */
  74015. readonly normalized: boolean;
  74016. /**
  74017. * Gets the data type of each component in the array.
  74018. */
  74019. readonly type: number;
  74020. /**
  74021. * Constructor
  74022. * @param engine the engine
  74023. * @param data the data to use for this vertex buffer
  74024. * @param kind the vertex buffer kind
  74025. * @param updatable whether the data is updatable
  74026. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  74027. * @param stride the stride (optional)
  74028. * @param instanced whether the buffer is instanced (optional)
  74029. * @param offset the offset of the data (optional)
  74030. * @param size the number of components (optional)
  74031. * @param type the type of the component (optional)
  74032. * @param normalized whether the data contains normalized data (optional)
  74033. * @param useBytes set to true if stride and offset are in bytes (optional)
  74034. * @param divisor defines the instance divisor to use (1 by default)
  74035. */
  74036. 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);
  74037. /** @hidden */
  74038. _rebuild(): void;
  74039. /**
  74040. * Returns the kind of the VertexBuffer (string)
  74041. * @returns a string
  74042. */
  74043. getKind(): string;
  74044. /**
  74045. * Gets a boolean indicating if the VertexBuffer is updatable?
  74046. * @returns true if the buffer is updatable
  74047. */
  74048. isUpdatable(): boolean;
  74049. /**
  74050. * Gets current buffer's data
  74051. * @returns a DataArray or null
  74052. */
  74053. getData(): Nullable<DataArray>;
  74054. /**
  74055. * Gets underlying native buffer
  74056. * @returns underlying native buffer
  74057. */
  74058. getBuffer(): Nullable<DataBuffer>;
  74059. /**
  74060. * Gets the stride in float32 units (i.e. byte stride / 4).
  74061. * May not be an integer if the byte stride is not divisible by 4.
  74062. * DEPRECATED. Use byteStride instead.
  74063. * @returns the stride in float32 units
  74064. */
  74065. getStrideSize(): number;
  74066. /**
  74067. * Returns the offset as a multiple of the type byte length.
  74068. * DEPRECATED. Use byteOffset instead.
  74069. * @returns the offset in bytes
  74070. */
  74071. getOffset(): number;
  74072. /**
  74073. * Returns the number of components per vertex attribute (integer)
  74074. * @returns the size in float
  74075. */
  74076. getSize(): number;
  74077. /**
  74078. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  74079. * @returns true if this buffer is instanced
  74080. */
  74081. getIsInstanced(): boolean;
  74082. /**
  74083. * Returns the instancing divisor, zero for non-instanced (integer).
  74084. * @returns a number
  74085. */
  74086. getInstanceDivisor(): number;
  74087. /**
  74088. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  74089. * @param data defines the data to store
  74090. */
  74091. create(data?: DataArray): void;
  74092. /**
  74093. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  74094. * This function will create a new buffer if the current one is not updatable
  74095. * @param data defines the data to store
  74096. */
  74097. update(data: DataArray): void;
  74098. /**
  74099. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  74100. * Returns the directly updated WebGLBuffer.
  74101. * @param data the new data
  74102. * @param offset the new offset
  74103. * @param useBytes set to true if the offset is in bytes
  74104. */
  74105. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  74106. /**
  74107. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  74108. */
  74109. dispose(): void;
  74110. /**
  74111. * Enumerates each value of this vertex buffer as numbers.
  74112. * @param count the number of values to enumerate
  74113. * @param callback the callback function called for each value
  74114. */
  74115. forEach(count: number, callback: (value: number, index: number) => void): void;
  74116. /**
  74117. * Positions
  74118. */
  74119. static readonly PositionKind: string;
  74120. /**
  74121. * Normals
  74122. */
  74123. static readonly NormalKind: string;
  74124. /**
  74125. * Tangents
  74126. */
  74127. static readonly TangentKind: string;
  74128. /**
  74129. * Texture coordinates
  74130. */
  74131. static readonly UVKind: string;
  74132. /**
  74133. * Texture coordinates 2
  74134. */
  74135. static readonly UV2Kind: string;
  74136. /**
  74137. * Texture coordinates 3
  74138. */
  74139. static readonly UV3Kind: string;
  74140. /**
  74141. * Texture coordinates 4
  74142. */
  74143. static readonly UV4Kind: string;
  74144. /**
  74145. * Texture coordinates 5
  74146. */
  74147. static readonly UV5Kind: string;
  74148. /**
  74149. * Texture coordinates 6
  74150. */
  74151. static readonly UV6Kind: string;
  74152. /**
  74153. * Colors
  74154. */
  74155. static readonly ColorKind: string;
  74156. /**
  74157. * Matrix indices (for bones)
  74158. */
  74159. static readonly MatricesIndicesKind: string;
  74160. /**
  74161. * Matrix weights (for bones)
  74162. */
  74163. static readonly MatricesWeightsKind: string;
  74164. /**
  74165. * Additional matrix indices (for bones)
  74166. */
  74167. static readonly MatricesIndicesExtraKind: string;
  74168. /**
  74169. * Additional matrix weights (for bones)
  74170. */
  74171. static readonly MatricesWeightsExtraKind: string;
  74172. /**
  74173. * Deduces the stride given a kind.
  74174. * @param kind The kind string to deduce
  74175. * @returns The deduced stride
  74176. */
  74177. static DeduceStride(kind: string): number;
  74178. /**
  74179. * Gets the byte length of the given type.
  74180. * @param type the type
  74181. * @returns the number of bytes
  74182. */
  74183. static GetTypeByteLength(type: number): number;
  74184. /**
  74185. * Enumerates each value of the given parameters as numbers.
  74186. * @param data the data to enumerate
  74187. * @param byteOffset the byte offset of the data
  74188. * @param byteStride the byte stride of the data
  74189. * @param componentCount the number of components per element
  74190. * @param componentType the type of the component
  74191. * @param count the number of values to enumerate
  74192. * @param normalized whether the data is normalized
  74193. * @param callback the callback function called for each value
  74194. */
  74195. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  74196. private static _GetFloatValue;
  74197. }
  74198. }
  74199. declare module BABYLON {
  74200. /**
  74201. * @hidden
  74202. */
  74203. export class IntersectionInfo {
  74204. bu: Nullable<number>;
  74205. bv: Nullable<number>;
  74206. distance: number;
  74207. faceId: number;
  74208. subMeshId: number;
  74209. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  74210. }
  74211. }
  74212. declare module BABYLON {
  74213. /**
  74214. * Represens a plane by the equation ax + by + cz + d = 0
  74215. */
  74216. export class Plane {
  74217. private static _TmpMatrix;
  74218. /**
  74219. * Normal of the plane (a,b,c)
  74220. */
  74221. normal: Vector3;
  74222. /**
  74223. * d component of the plane
  74224. */
  74225. d: number;
  74226. /**
  74227. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  74228. * @param a a component of the plane
  74229. * @param b b component of the plane
  74230. * @param c c component of the plane
  74231. * @param d d component of the plane
  74232. */
  74233. constructor(a: number, b: number, c: number, d: number);
  74234. /**
  74235. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  74236. */
  74237. asArray(): number[];
  74238. /**
  74239. * @returns a new plane copied from the current Plane.
  74240. */
  74241. clone(): Plane;
  74242. /**
  74243. * @returns the string "Plane".
  74244. */
  74245. getClassName(): string;
  74246. /**
  74247. * @returns the Plane hash code.
  74248. */
  74249. getHashCode(): number;
  74250. /**
  74251. * Normalize the current Plane in place.
  74252. * @returns the updated Plane.
  74253. */
  74254. normalize(): Plane;
  74255. /**
  74256. * Applies a transformation the plane and returns the result
  74257. * @param transformation the transformation matrix to be applied to the plane
  74258. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  74259. */
  74260. transform(transformation: DeepImmutable<Matrix>): Plane;
  74261. /**
  74262. * Calcualtte the dot product between the point and the plane normal
  74263. * @param point point to calculate the dot product with
  74264. * @returns the dot product (float) of the point coordinates and the plane normal.
  74265. */
  74266. dotCoordinate(point: DeepImmutable<Vector3>): number;
  74267. /**
  74268. * Updates the current Plane from the plane defined by the three given points.
  74269. * @param point1 one of the points used to contruct the plane
  74270. * @param point2 one of the points used to contruct the plane
  74271. * @param point3 one of the points used to contruct the plane
  74272. * @returns the updated Plane.
  74273. */
  74274. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  74275. /**
  74276. * Checks if the plane is facing a given direction
  74277. * @param direction the direction to check if the plane is facing
  74278. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  74279. * @returns True is the vector "direction" is the same side than the plane normal.
  74280. */
  74281. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  74282. /**
  74283. * Calculates the distance to a point
  74284. * @param point point to calculate distance to
  74285. * @returns the signed distance (float) from the given point to the Plane.
  74286. */
  74287. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  74288. /**
  74289. * Creates a plane from an array
  74290. * @param array the array to create a plane from
  74291. * @returns a new Plane from the given array.
  74292. */
  74293. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  74294. /**
  74295. * Creates a plane from three points
  74296. * @param point1 point used to create the plane
  74297. * @param point2 point used to create the plane
  74298. * @param point3 point used to create the plane
  74299. * @returns a new Plane defined by the three given points.
  74300. */
  74301. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  74302. /**
  74303. * Creates a plane from an origin point and a normal
  74304. * @param origin origin of the plane to be constructed
  74305. * @param normal normal of the plane to be constructed
  74306. * @returns a new Plane the normal vector to this plane at the given origin point.
  74307. * Note : the vector "normal" is updated because normalized.
  74308. */
  74309. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  74310. /**
  74311. * Calculates the distance from a plane and a point
  74312. * @param origin origin of the plane to be constructed
  74313. * @param normal normal of the plane to be constructed
  74314. * @param point point to calculate distance to
  74315. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  74316. */
  74317. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  74318. }
  74319. }
  74320. declare module BABYLON {
  74321. /**
  74322. * Class used to store bounding sphere information
  74323. */
  74324. export class BoundingSphere {
  74325. /**
  74326. * Gets the center of the bounding sphere in local space
  74327. */
  74328. readonly center: Vector3;
  74329. /**
  74330. * Radius of the bounding sphere in local space
  74331. */
  74332. radius: number;
  74333. /**
  74334. * Gets the center of the bounding sphere in world space
  74335. */
  74336. readonly centerWorld: Vector3;
  74337. /**
  74338. * Radius of the bounding sphere in world space
  74339. */
  74340. radiusWorld: number;
  74341. /**
  74342. * Gets the minimum vector in local space
  74343. */
  74344. readonly minimum: Vector3;
  74345. /**
  74346. * Gets the maximum vector in local space
  74347. */
  74348. readonly maximum: Vector3;
  74349. private _worldMatrix;
  74350. private static readonly TmpVector3;
  74351. /**
  74352. * Creates a new bounding sphere
  74353. * @param min defines the minimum vector (in local space)
  74354. * @param max defines the maximum vector (in local space)
  74355. * @param worldMatrix defines the new world matrix
  74356. */
  74357. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  74358. /**
  74359. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  74360. * @param min defines the new minimum vector (in local space)
  74361. * @param max defines the new maximum vector (in local space)
  74362. * @param worldMatrix defines the new world matrix
  74363. */
  74364. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  74365. /**
  74366. * Scale the current bounding sphere by applying a scale factor
  74367. * @param factor defines the scale factor to apply
  74368. * @returns the current bounding box
  74369. */
  74370. scale(factor: number): BoundingSphere;
  74371. /**
  74372. * Gets the world matrix of the bounding box
  74373. * @returns a matrix
  74374. */
  74375. getWorldMatrix(): DeepImmutable<Matrix>;
  74376. /** @hidden */
  74377. _update(worldMatrix: DeepImmutable<Matrix>): void;
  74378. /**
  74379. * Tests if the bounding sphere is intersecting the frustum planes
  74380. * @param frustumPlanes defines the frustum planes to test
  74381. * @returns true if there is an intersection
  74382. */
  74383. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74384. /**
  74385. * Tests if the bounding sphere center is in between the frustum planes.
  74386. * Used for optimistic fast inclusion.
  74387. * @param frustumPlanes defines the frustum planes to test
  74388. * @returns true if the sphere center is in between the frustum planes
  74389. */
  74390. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74391. /**
  74392. * Tests if a point is inside the bounding sphere
  74393. * @param point defines the point to test
  74394. * @returns true if the point is inside the bounding sphere
  74395. */
  74396. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  74397. /**
  74398. * Checks if two sphere intersct
  74399. * @param sphere0 sphere 0
  74400. * @param sphere1 sphere 1
  74401. * @returns true if the speres intersect
  74402. */
  74403. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  74404. }
  74405. }
  74406. declare module BABYLON {
  74407. /**
  74408. * Class used to store bounding box information
  74409. */
  74410. export class BoundingBox implements ICullable {
  74411. /**
  74412. * Gets the 8 vectors representing the bounding box in local space
  74413. */
  74414. readonly vectors: Vector3[];
  74415. /**
  74416. * Gets the center of the bounding box in local space
  74417. */
  74418. readonly center: Vector3;
  74419. /**
  74420. * Gets the center of the bounding box in world space
  74421. */
  74422. readonly centerWorld: Vector3;
  74423. /**
  74424. * Gets the extend size in local space
  74425. */
  74426. readonly extendSize: Vector3;
  74427. /**
  74428. * Gets the extend size in world space
  74429. */
  74430. readonly extendSizeWorld: Vector3;
  74431. /**
  74432. * Gets the OBB (object bounding box) directions
  74433. */
  74434. readonly directions: Vector3[];
  74435. /**
  74436. * Gets the 8 vectors representing the bounding box in world space
  74437. */
  74438. readonly vectorsWorld: Vector3[];
  74439. /**
  74440. * Gets the minimum vector in world space
  74441. */
  74442. readonly minimumWorld: Vector3;
  74443. /**
  74444. * Gets the maximum vector in world space
  74445. */
  74446. readonly maximumWorld: Vector3;
  74447. /**
  74448. * Gets the minimum vector in local space
  74449. */
  74450. readonly minimum: Vector3;
  74451. /**
  74452. * Gets the maximum vector in local space
  74453. */
  74454. readonly maximum: Vector3;
  74455. private _worldMatrix;
  74456. private static readonly TmpVector3;
  74457. /**
  74458. * @hidden
  74459. */
  74460. _tag: number;
  74461. /**
  74462. * Creates a new bounding box
  74463. * @param min defines the minimum vector (in local space)
  74464. * @param max defines the maximum vector (in local space)
  74465. * @param worldMatrix defines the new world matrix
  74466. */
  74467. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  74468. /**
  74469. * Recreates the entire bounding box from scratch as if we call the constructor in place
  74470. * @param min defines the new minimum vector (in local space)
  74471. * @param max defines the new maximum vector (in local space)
  74472. * @param worldMatrix defines the new world matrix
  74473. */
  74474. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  74475. /**
  74476. * Scale the current bounding box by applying a scale factor
  74477. * @param factor defines the scale factor to apply
  74478. * @returns the current bounding box
  74479. */
  74480. scale(factor: number): BoundingBox;
  74481. /**
  74482. * Gets the world matrix of the bounding box
  74483. * @returns a matrix
  74484. */
  74485. getWorldMatrix(): DeepImmutable<Matrix>;
  74486. /** @hidden */
  74487. _update(world: DeepImmutable<Matrix>): void;
  74488. /**
  74489. * Tests if the bounding box is intersecting the frustum planes
  74490. * @param frustumPlanes defines the frustum planes to test
  74491. * @returns true if there is an intersection
  74492. */
  74493. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74494. /**
  74495. * Tests if the bounding box is entirely inside the frustum planes
  74496. * @param frustumPlanes defines the frustum planes to test
  74497. * @returns true if there is an inclusion
  74498. */
  74499. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74500. /**
  74501. * Tests if a point is inside the bounding box
  74502. * @param point defines the point to test
  74503. * @returns true if the point is inside the bounding box
  74504. */
  74505. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  74506. /**
  74507. * Tests if the bounding box intersects with a bounding sphere
  74508. * @param sphere defines the sphere to test
  74509. * @returns true if there is an intersection
  74510. */
  74511. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  74512. /**
  74513. * Tests if the bounding box intersects with a box defined by a min and max vectors
  74514. * @param min defines the min vector to use
  74515. * @param max defines the max vector to use
  74516. * @returns true if there is an intersection
  74517. */
  74518. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  74519. /**
  74520. * Tests if two bounding boxes are intersections
  74521. * @param box0 defines the first box to test
  74522. * @param box1 defines the second box to test
  74523. * @returns true if there is an intersection
  74524. */
  74525. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  74526. /**
  74527. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  74528. * @param minPoint defines the minimum vector of the bounding box
  74529. * @param maxPoint defines the maximum vector of the bounding box
  74530. * @param sphereCenter defines the sphere center
  74531. * @param sphereRadius defines the sphere radius
  74532. * @returns true if there is an intersection
  74533. */
  74534. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  74535. /**
  74536. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  74537. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  74538. * @param frustumPlanes defines the frustum planes to test
  74539. * @return true if there is an inclusion
  74540. */
  74541. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74542. /**
  74543. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  74544. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  74545. * @param frustumPlanes defines the frustum planes to test
  74546. * @return true if there is an intersection
  74547. */
  74548. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74549. }
  74550. }
  74551. declare module BABYLON {
  74552. /** @hidden */
  74553. export class Collider {
  74554. /** Define if a collision was found */
  74555. collisionFound: boolean;
  74556. /**
  74557. * Define last intersection point in local space
  74558. */
  74559. intersectionPoint: Vector3;
  74560. /**
  74561. * Define last collided mesh
  74562. */
  74563. collidedMesh: Nullable<AbstractMesh>;
  74564. private _collisionPoint;
  74565. private _planeIntersectionPoint;
  74566. private _tempVector;
  74567. private _tempVector2;
  74568. private _tempVector3;
  74569. private _tempVector4;
  74570. private _edge;
  74571. private _baseToVertex;
  74572. private _destinationPoint;
  74573. private _slidePlaneNormal;
  74574. private _displacementVector;
  74575. /** @hidden */
  74576. _radius: Vector3;
  74577. /** @hidden */
  74578. _retry: number;
  74579. private _velocity;
  74580. private _basePoint;
  74581. private _epsilon;
  74582. /** @hidden */
  74583. _velocityWorldLength: number;
  74584. /** @hidden */
  74585. _basePointWorld: Vector3;
  74586. private _velocityWorld;
  74587. private _normalizedVelocity;
  74588. /** @hidden */
  74589. _initialVelocity: Vector3;
  74590. /** @hidden */
  74591. _initialPosition: Vector3;
  74592. private _nearestDistance;
  74593. private _collisionMask;
  74594. collisionMask: number;
  74595. /**
  74596. * Gets the plane normal used to compute the sliding response (in local space)
  74597. */
  74598. readonly slidePlaneNormal: Vector3;
  74599. /** @hidden */
  74600. _initialize(source: Vector3, dir: Vector3, e: number): void;
  74601. /** @hidden */
  74602. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  74603. /** @hidden */
  74604. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  74605. /** @hidden */
  74606. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  74607. /** @hidden */
  74608. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  74609. /** @hidden */
  74610. _getResponse(pos: Vector3, vel: Vector3): void;
  74611. }
  74612. }
  74613. declare module BABYLON {
  74614. /**
  74615. * Interface for cullable objects
  74616. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  74617. */
  74618. export interface ICullable {
  74619. /**
  74620. * Checks if the object or part of the object is in the frustum
  74621. * @param frustumPlanes Camera near/planes
  74622. * @returns true if the object is in frustum otherwise false
  74623. */
  74624. isInFrustum(frustumPlanes: Plane[]): boolean;
  74625. /**
  74626. * Checks if a cullable object (mesh...) is in the camera frustum
  74627. * Unlike isInFrustum this cheks the full bounding box
  74628. * @param frustumPlanes Camera near/planes
  74629. * @returns true if the object is in frustum otherwise false
  74630. */
  74631. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  74632. }
  74633. /**
  74634. * Info for a bounding data of a mesh
  74635. */
  74636. export class BoundingInfo implements ICullable {
  74637. /**
  74638. * Bounding box for the mesh
  74639. */
  74640. readonly boundingBox: BoundingBox;
  74641. /**
  74642. * Bounding sphere for the mesh
  74643. */
  74644. readonly boundingSphere: BoundingSphere;
  74645. private _isLocked;
  74646. private static readonly TmpVector3;
  74647. /**
  74648. * Constructs bounding info
  74649. * @param minimum min vector of the bounding box/sphere
  74650. * @param maximum max vector of the bounding box/sphere
  74651. * @param worldMatrix defines the new world matrix
  74652. */
  74653. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  74654. /**
  74655. * Recreates the entire bounding info from scratch as if we call the constructor in place
  74656. * @param min defines the new minimum vector (in local space)
  74657. * @param max defines the new maximum vector (in local space)
  74658. * @param worldMatrix defines the new world matrix
  74659. */
  74660. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  74661. /**
  74662. * min vector of the bounding box/sphere
  74663. */
  74664. readonly minimum: Vector3;
  74665. /**
  74666. * max vector of the bounding box/sphere
  74667. */
  74668. readonly maximum: Vector3;
  74669. /**
  74670. * If the info is locked and won't be updated to avoid perf overhead
  74671. */
  74672. isLocked: boolean;
  74673. /**
  74674. * Updates the bounding sphere and box
  74675. * @param world world matrix to be used to update
  74676. */
  74677. update(world: DeepImmutable<Matrix>): void;
  74678. /**
  74679. * Recreate the bounding info to be centered around a specific point given a specific extend.
  74680. * @param center New center of the bounding info
  74681. * @param extend New extend of the bounding info
  74682. * @returns the current bounding info
  74683. */
  74684. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  74685. /**
  74686. * Scale the current bounding info by applying a scale factor
  74687. * @param factor defines the scale factor to apply
  74688. * @returns the current bounding info
  74689. */
  74690. scale(factor: number): BoundingInfo;
  74691. /**
  74692. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  74693. * @param frustumPlanes defines the frustum to test
  74694. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  74695. * @returns true if the bounding info is in the frustum planes
  74696. */
  74697. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  74698. /**
  74699. * Gets the world distance between the min and max points of the bounding box
  74700. */
  74701. readonly diagonalLength: number;
  74702. /**
  74703. * Checks if a cullable object (mesh...) is in the camera frustum
  74704. * Unlike isInFrustum this cheks the full bounding box
  74705. * @param frustumPlanes Camera near/planes
  74706. * @returns true if the object is in frustum otherwise false
  74707. */
  74708. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74709. /** @hidden */
  74710. _checkCollision(collider: Collider): boolean;
  74711. /**
  74712. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  74713. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  74714. * @param point the point to check intersection with
  74715. * @returns if the point intersects
  74716. */
  74717. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  74718. /**
  74719. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  74720. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  74721. * @param boundingInfo the bounding info to check intersection with
  74722. * @param precise if the intersection should be done using OBB
  74723. * @returns if the bounding info intersects
  74724. */
  74725. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  74726. }
  74727. }
  74728. declare module BABYLON {
  74729. /**
  74730. * Extracts minimum and maximum values from a list of indexed positions
  74731. * @param positions defines the positions to use
  74732. * @param indices defines the indices to the positions
  74733. * @param indexStart defines the start index
  74734. * @param indexCount defines the end index
  74735. * @param bias defines bias value to add to the result
  74736. * @return minimum and maximum values
  74737. */
  74738. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  74739. minimum: Vector3;
  74740. maximum: Vector3;
  74741. };
  74742. /**
  74743. * Extracts minimum and maximum values from a list of positions
  74744. * @param positions defines the positions to use
  74745. * @param start defines the start index in the positions array
  74746. * @param count defines the number of positions to handle
  74747. * @param bias defines bias value to add to the result
  74748. * @param stride defines the stride size to use (distance between two positions in the positions array)
  74749. * @return minimum and maximum values
  74750. */
  74751. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  74752. minimum: Vector3;
  74753. maximum: Vector3;
  74754. };
  74755. }
  74756. declare module BABYLON {
  74757. /** @hidden */
  74758. export class WebGLDataBuffer extends DataBuffer {
  74759. private _buffer;
  74760. constructor(resource: WebGLBuffer);
  74761. readonly underlyingResource: any;
  74762. }
  74763. }
  74764. declare module BABYLON {
  74765. /** @hidden */
  74766. export class WebGLPipelineContext implements IPipelineContext {
  74767. engine: ThinEngine;
  74768. program: Nullable<WebGLProgram>;
  74769. context?: WebGLRenderingContext;
  74770. vertexShader?: WebGLShader;
  74771. fragmentShader?: WebGLShader;
  74772. isParallelCompiled: boolean;
  74773. onCompiled?: () => void;
  74774. transformFeedback?: WebGLTransformFeedback | null;
  74775. readonly isAsync: boolean;
  74776. readonly isReady: boolean;
  74777. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  74778. }
  74779. }
  74780. declare module BABYLON {
  74781. interface ThinEngine {
  74782. /**
  74783. * Create an uniform buffer
  74784. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  74785. * @param elements defines the content of the uniform buffer
  74786. * @returns the webGL uniform buffer
  74787. */
  74788. createUniformBuffer(elements: FloatArray): DataBuffer;
  74789. /**
  74790. * Create a dynamic uniform buffer
  74791. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  74792. * @param elements defines the content of the uniform buffer
  74793. * @returns the webGL uniform buffer
  74794. */
  74795. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  74796. /**
  74797. * Update an existing uniform buffer
  74798. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  74799. * @param uniformBuffer defines the target uniform buffer
  74800. * @param elements defines the content to update
  74801. * @param offset defines the offset in the uniform buffer where update should start
  74802. * @param count defines the size of the data to update
  74803. */
  74804. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  74805. /**
  74806. * Bind an uniform buffer to the current webGL context
  74807. * @param buffer defines the buffer to bind
  74808. */
  74809. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  74810. /**
  74811. * Bind a buffer to the current webGL context at a given location
  74812. * @param buffer defines the buffer to bind
  74813. * @param location defines the index where to bind the buffer
  74814. */
  74815. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  74816. /**
  74817. * Bind a specific block at a given index in a specific shader program
  74818. * @param pipelineContext defines the pipeline context to use
  74819. * @param blockName defines the block name
  74820. * @param index defines the index where to bind the block
  74821. */
  74822. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  74823. }
  74824. }
  74825. declare module BABYLON {
  74826. /**
  74827. * Uniform buffer objects.
  74828. *
  74829. * Handles blocks of uniform on the GPU.
  74830. *
  74831. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  74832. *
  74833. * For more information, please refer to :
  74834. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  74835. */
  74836. export class UniformBuffer {
  74837. private _engine;
  74838. private _buffer;
  74839. private _data;
  74840. private _bufferData;
  74841. private _dynamic?;
  74842. private _uniformLocations;
  74843. private _uniformSizes;
  74844. private _uniformLocationPointer;
  74845. private _needSync;
  74846. private _noUBO;
  74847. private _currentEffect;
  74848. /** @hidden */
  74849. _alreadyBound: boolean;
  74850. private static _MAX_UNIFORM_SIZE;
  74851. private static _tempBuffer;
  74852. /**
  74853. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  74854. * This is dynamic to allow compat with webgl 1 and 2.
  74855. * You will need to pass the name of the uniform as well as the value.
  74856. */
  74857. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  74858. /**
  74859. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  74860. * This is dynamic to allow compat with webgl 1 and 2.
  74861. * You will need to pass the name of the uniform as well as the value.
  74862. */
  74863. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  74864. /**
  74865. * Lambda to Update a single float in a uniform buffer.
  74866. * This is dynamic to allow compat with webgl 1 and 2.
  74867. * You will need to pass the name of the uniform as well as the value.
  74868. */
  74869. updateFloat: (name: string, x: number) => void;
  74870. /**
  74871. * Lambda to Update a vec2 of float in a uniform buffer.
  74872. * This is dynamic to allow compat with webgl 1 and 2.
  74873. * You will need to pass the name of the uniform as well as the value.
  74874. */
  74875. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  74876. /**
  74877. * Lambda to Update a vec3 of float in a uniform buffer.
  74878. * This is dynamic to allow compat with webgl 1 and 2.
  74879. * You will need to pass the name of the uniform as well as the value.
  74880. */
  74881. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  74882. /**
  74883. * Lambda to Update a vec4 of float in a uniform buffer.
  74884. * This is dynamic to allow compat with webgl 1 and 2.
  74885. * You will need to pass the name of the uniform as well as the value.
  74886. */
  74887. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  74888. /**
  74889. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  74890. * This is dynamic to allow compat with webgl 1 and 2.
  74891. * You will need to pass the name of the uniform as well as the value.
  74892. */
  74893. updateMatrix: (name: string, mat: Matrix) => void;
  74894. /**
  74895. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  74896. * This is dynamic to allow compat with webgl 1 and 2.
  74897. * You will need to pass the name of the uniform as well as the value.
  74898. */
  74899. updateVector3: (name: string, vector: Vector3) => void;
  74900. /**
  74901. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  74902. * This is dynamic to allow compat with webgl 1 and 2.
  74903. * You will need to pass the name of the uniform as well as the value.
  74904. */
  74905. updateVector4: (name: string, vector: Vector4) => void;
  74906. /**
  74907. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  74908. * This is dynamic to allow compat with webgl 1 and 2.
  74909. * You will need to pass the name of the uniform as well as the value.
  74910. */
  74911. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  74912. /**
  74913. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  74914. * This is dynamic to allow compat with webgl 1 and 2.
  74915. * You will need to pass the name of the uniform as well as the value.
  74916. */
  74917. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  74918. /**
  74919. * Instantiates a new Uniform buffer objects.
  74920. *
  74921. * Handles blocks of uniform on the GPU.
  74922. *
  74923. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  74924. *
  74925. * For more information, please refer to :
  74926. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  74927. * @param engine Define the engine the buffer is associated with
  74928. * @param data Define the data contained in the buffer
  74929. * @param dynamic Define if the buffer is updatable
  74930. */
  74931. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  74932. /**
  74933. * Indicates if the buffer is using the WebGL2 UBO implementation,
  74934. * or just falling back on setUniformXXX calls.
  74935. */
  74936. readonly useUbo: boolean;
  74937. /**
  74938. * Indicates if the WebGL underlying uniform buffer is in sync
  74939. * with the javascript cache data.
  74940. */
  74941. readonly isSync: boolean;
  74942. /**
  74943. * Indicates if the WebGL underlying uniform buffer is dynamic.
  74944. * Also, a dynamic UniformBuffer will disable cache verification and always
  74945. * update the underlying WebGL uniform buffer to the GPU.
  74946. * @returns if Dynamic, otherwise false
  74947. */
  74948. isDynamic(): boolean;
  74949. /**
  74950. * The data cache on JS side.
  74951. * @returns the underlying data as a float array
  74952. */
  74953. getData(): Float32Array;
  74954. /**
  74955. * The underlying WebGL Uniform buffer.
  74956. * @returns the webgl buffer
  74957. */
  74958. getBuffer(): Nullable<DataBuffer>;
  74959. /**
  74960. * std140 layout specifies how to align data within an UBO structure.
  74961. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  74962. * for specs.
  74963. */
  74964. private _fillAlignment;
  74965. /**
  74966. * Adds an uniform in the buffer.
  74967. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  74968. * for the layout to be correct !
  74969. * @param name Name of the uniform, as used in the uniform block in the shader.
  74970. * @param size Data size, or data directly.
  74971. */
  74972. addUniform(name: string, size: number | number[]): void;
  74973. /**
  74974. * Adds a Matrix 4x4 to the uniform buffer.
  74975. * @param name Name of the uniform, as used in the uniform block in the shader.
  74976. * @param mat A 4x4 matrix.
  74977. */
  74978. addMatrix(name: string, mat: Matrix): void;
  74979. /**
  74980. * Adds a vec2 to the uniform buffer.
  74981. * @param name Name of the uniform, as used in the uniform block in the shader.
  74982. * @param x Define the x component value of the vec2
  74983. * @param y Define the y component value of the vec2
  74984. */
  74985. addFloat2(name: string, x: number, y: number): void;
  74986. /**
  74987. * Adds a vec3 to the uniform buffer.
  74988. * @param name Name of the uniform, as used in the uniform block in the shader.
  74989. * @param x Define the x component value of the vec3
  74990. * @param y Define the y component value of the vec3
  74991. * @param z Define the z component value of the vec3
  74992. */
  74993. addFloat3(name: string, x: number, y: number, z: number): void;
  74994. /**
  74995. * Adds a vec3 to the uniform buffer.
  74996. * @param name Name of the uniform, as used in the uniform block in the shader.
  74997. * @param color Define the vec3 from a Color
  74998. */
  74999. addColor3(name: string, color: Color3): void;
  75000. /**
  75001. * Adds a vec4 to the uniform buffer.
  75002. * @param name Name of the uniform, as used in the uniform block in the shader.
  75003. * @param color Define the rgb components from a Color
  75004. * @param alpha Define the a component of the vec4
  75005. */
  75006. addColor4(name: string, color: Color3, alpha: number): void;
  75007. /**
  75008. * Adds a vec3 to the uniform buffer.
  75009. * @param name Name of the uniform, as used in the uniform block in the shader.
  75010. * @param vector Define the vec3 components from a Vector
  75011. */
  75012. addVector3(name: string, vector: Vector3): void;
  75013. /**
  75014. * Adds a Matrix 3x3 to the uniform buffer.
  75015. * @param name Name of the uniform, as used in the uniform block in the shader.
  75016. */
  75017. addMatrix3x3(name: string): void;
  75018. /**
  75019. * Adds a Matrix 2x2 to the uniform buffer.
  75020. * @param name Name of the uniform, as used in the uniform block in the shader.
  75021. */
  75022. addMatrix2x2(name: string): void;
  75023. /**
  75024. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  75025. */
  75026. create(): void;
  75027. /** @hidden */
  75028. _rebuild(): void;
  75029. /**
  75030. * Updates the WebGL Uniform Buffer on the GPU.
  75031. * If the `dynamic` flag is set to true, no cache comparison is done.
  75032. * Otherwise, the buffer will be updated only if the cache differs.
  75033. */
  75034. update(): void;
  75035. /**
  75036. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  75037. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  75038. * @param data Define the flattened data
  75039. * @param size Define the size of the data.
  75040. */
  75041. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  75042. private _valueCache;
  75043. private _cacheMatrix;
  75044. private _updateMatrix3x3ForUniform;
  75045. private _updateMatrix3x3ForEffect;
  75046. private _updateMatrix2x2ForEffect;
  75047. private _updateMatrix2x2ForUniform;
  75048. private _updateFloatForEffect;
  75049. private _updateFloatForUniform;
  75050. private _updateFloat2ForEffect;
  75051. private _updateFloat2ForUniform;
  75052. private _updateFloat3ForEffect;
  75053. private _updateFloat3ForUniform;
  75054. private _updateFloat4ForEffect;
  75055. private _updateFloat4ForUniform;
  75056. private _updateMatrixForEffect;
  75057. private _updateMatrixForUniform;
  75058. private _updateVector3ForEffect;
  75059. private _updateVector3ForUniform;
  75060. private _updateVector4ForEffect;
  75061. private _updateVector4ForUniform;
  75062. private _updateColor3ForEffect;
  75063. private _updateColor3ForUniform;
  75064. private _updateColor4ForEffect;
  75065. private _updateColor4ForUniform;
  75066. /**
  75067. * Sets a sampler uniform on the effect.
  75068. * @param name Define the name of the sampler.
  75069. * @param texture Define the texture to set in the sampler
  75070. */
  75071. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  75072. /**
  75073. * Directly updates the value of the uniform in the cache AND on the GPU.
  75074. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  75075. * @param data Define the flattened data
  75076. */
  75077. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  75078. /**
  75079. * Binds this uniform buffer to an effect.
  75080. * @param effect Define the effect to bind the buffer to
  75081. * @param name Name of the uniform block in the shader.
  75082. */
  75083. bindToEffect(effect: Effect, name: string): void;
  75084. /**
  75085. * Disposes the uniform buffer.
  75086. */
  75087. dispose(): void;
  75088. }
  75089. }
  75090. declare module BABYLON {
  75091. /**
  75092. * Enum that determines the text-wrapping mode to use.
  75093. */
  75094. export enum InspectableType {
  75095. /**
  75096. * Checkbox for booleans
  75097. */
  75098. Checkbox = 0,
  75099. /**
  75100. * Sliders for numbers
  75101. */
  75102. Slider = 1,
  75103. /**
  75104. * Vector3
  75105. */
  75106. Vector3 = 2,
  75107. /**
  75108. * Quaternions
  75109. */
  75110. Quaternion = 3,
  75111. /**
  75112. * Color3
  75113. */
  75114. Color3 = 4,
  75115. /**
  75116. * String
  75117. */
  75118. String = 5
  75119. }
  75120. /**
  75121. * Interface used to define custom inspectable properties.
  75122. * This interface is used by the inspector to display custom property grids
  75123. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  75124. */
  75125. export interface IInspectable {
  75126. /**
  75127. * Gets the label to display
  75128. */
  75129. label: string;
  75130. /**
  75131. * Gets the name of the property to edit
  75132. */
  75133. propertyName: string;
  75134. /**
  75135. * Gets the type of the editor to use
  75136. */
  75137. type: InspectableType;
  75138. /**
  75139. * Gets the minimum value of the property when using in "slider" mode
  75140. */
  75141. min?: number;
  75142. /**
  75143. * Gets the maximum value of the property when using in "slider" mode
  75144. */
  75145. max?: number;
  75146. /**
  75147. * Gets the setp to use when using in "slider" mode
  75148. */
  75149. step?: number;
  75150. }
  75151. }
  75152. declare module BABYLON {
  75153. /**
  75154. * Class used to provide helper for timing
  75155. */
  75156. export class TimingTools {
  75157. /**
  75158. * Polyfill for setImmediate
  75159. * @param action defines the action to execute after the current execution block
  75160. */
  75161. static SetImmediate(action: () => void): void;
  75162. }
  75163. }
  75164. declare module BABYLON {
  75165. /**
  75166. * Class used to enable instatition of objects by class name
  75167. */
  75168. export class InstantiationTools {
  75169. /**
  75170. * Use this object to register external classes like custom textures or material
  75171. * to allow the laoders to instantiate them
  75172. */
  75173. static RegisteredExternalClasses: {
  75174. [key: string]: Object;
  75175. };
  75176. /**
  75177. * Tries to instantiate a new object from a given class name
  75178. * @param className defines the class name to instantiate
  75179. * @returns the new object or null if the system was not able to do the instantiation
  75180. */
  75181. static Instantiate(className: string): any;
  75182. }
  75183. }
  75184. declare module BABYLON {
  75185. /**
  75186. * Define options used to create a depth texture
  75187. */
  75188. export class DepthTextureCreationOptions {
  75189. /** Specifies whether or not a stencil should be allocated in the texture */
  75190. generateStencil?: boolean;
  75191. /** Specifies whether or not bilinear filtering is enable on the texture */
  75192. bilinearFiltering?: boolean;
  75193. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  75194. comparisonFunction?: number;
  75195. /** Specifies if the created texture is a cube texture */
  75196. isCube?: boolean;
  75197. }
  75198. }
  75199. declare module BABYLON {
  75200. interface ThinEngine {
  75201. /**
  75202. * Creates a depth stencil cube texture.
  75203. * This is only available in WebGL 2.
  75204. * @param size The size of face edge in the cube texture.
  75205. * @param options The options defining the cube texture.
  75206. * @returns The cube texture
  75207. */
  75208. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  75209. /**
  75210. * Creates a cube texture
  75211. * @param rootUrl defines the url where the files to load is located
  75212. * @param scene defines the current scene
  75213. * @param files defines the list of files to load (1 per face)
  75214. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75215. * @param onLoad defines an optional callback raised when the texture is loaded
  75216. * @param onError defines an optional callback raised if there is an issue to load the texture
  75217. * @param format defines the format of the data
  75218. * @param forcedExtension defines the extension to use to pick the right loader
  75219. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  75220. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75221. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75222. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  75223. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  75224. * @returns the cube texture as an InternalTexture
  75225. */
  75226. 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>, excludeLoaders: Array<IInternalTextureLoader>): InternalTexture;
  75227. /**
  75228. * Creates a cube texture
  75229. * @param rootUrl defines the url where the files to load is located
  75230. * @param scene defines the current scene
  75231. * @param files defines the list of files to load (1 per face)
  75232. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75233. * @param onLoad defines an optional callback raised when the texture is loaded
  75234. * @param onError defines an optional callback raised if there is an issue to load the texture
  75235. * @param format defines the format of the data
  75236. * @param forcedExtension defines the extension to use to pick the right loader
  75237. * @returns the cube texture as an InternalTexture
  75238. */
  75239. 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;
  75240. /**
  75241. * Creates a cube texture
  75242. * @param rootUrl defines the url where the files to load is located
  75243. * @param scene defines the current scene
  75244. * @param files defines the list of files to load (1 per face)
  75245. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75246. * @param onLoad defines an optional callback raised when the texture is loaded
  75247. * @param onError defines an optional callback raised if there is an issue to load the texture
  75248. * @param format defines the format of the data
  75249. * @param forcedExtension defines the extension to use to pick the right loader
  75250. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  75251. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75252. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75253. * @returns the cube texture as an InternalTexture
  75254. */
  75255. 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;
  75256. /** @hidden */
  75257. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  75258. /** @hidden */
  75259. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  75260. /** @hidden */
  75261. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  75262. /** @hidden */
  75263. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  75264. /**
  75265. * @hidden
  75266. */
  75267. _setCubeMapTextureParams(loadMipmap: boolean): void;
  75268. }
  75269. }
  75270. declare module BABYLON {
  75271. /**
  75272. * Class for creating a cube texture
  75273. */
  75274. export class CubeTexture extends BaseTexture {
  75275. private _delayedOnLoad;
  75276. /**
  75277. * The url of the texture
  75278. */
  75279. url: string;
  75280. /**
  75281. * Gets or sets the center of the bounding box associated with the cube texture.
  75282. * It must define where the camera used to render the texture was set
  75283. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  75284. */
  75285. boundingBoxPosition: Vector3;
  75286. private _boundingBoxSize;
  75287. /**
  75288. * Gets or sets the size of the bounding box associated with the cube texture
  75289. * When defined, the cubemap will switch to local mode
  75290. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  75291. * @example https://www.babylonjs-playground.com/#RNASML
  75292. */
  75293. /**
  75294. * Returns the bounding box size
  75295. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  75296. */
  75297. boundingBoxSize: Vector3;
  75298. protected _rotationY: number;
  75299. /**
  75300. * Sets texture matrix rotation angle around Y axis in radians.
  75301. */
  75302. /**
  75303. * Gets texture matrix rotation angle around Y axis radians.
  75304. */
  75305. rotationY: number;
  75306. /**
  75307. * Are mip maps generated for this texture or not.
  75308. */
  75309. readonly noMipmap: boolean;
  75310. private _noMipmap;
  75311. private _files;
  75312. protected _forcedExtension: Nullable<string>;
  75313. private _extensions;
  75314. private _textureMatrix;
  75315. private _format;
  75316. private _createPolynomials;
  75317. /** @hidden */
  75318. _prefiltered: boolean;
  75319. /**
  75320. * Creates a cube texture from an array of image urls
  75321. * @param files defines an array of image urls
  75322. * @param scene defines the hosting scene
  75323. * @param noMipmap specifies if mip maps are not used
  75324. * @returns a cube texture
  75325. */
  75326. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  75327. /**
  75328. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  75329. * @param url defines the url of the prefiltered texture
  75330. * @param scene defines the scene the texture is attached to
  75331. * @param forcedExtension defines the extension of the file if different from the url
  75332. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  75333. * @return the prefiltered texture
  75334. */
  75335. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  75336. /**
  75337. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  75338. * as prefiltered data.
  75339. * @param rootUrl defines the url of the texture or the root name of the six images
  75340. * @param scene defines the scene the texture is attached to
  75341. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  75342. * @param noMipmap defines if mipmaps should be created or not
  75343. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  75344. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  75345. * @param onError defines a callback triggered in case of error during load
  75346. * @param format defines the internal format to use for the texture once loaded
  75347. * @param prefiltered defines whether or not the texture is created from prefiltered data
  75348. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  75349. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  75350. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75351. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75352. * @return the cube texture
  75353. */
  75354. constructor(rootUrl: string, scene: Scene, 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);
  75355. /**
  75356. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  75357. */
  75358. readonly isPrefiltered: boolean;
  75359. /**
  75360. * Get the current class name of the texture useful for serialization or dynamic coding.
  75361. * @returns "CubeTexture"
  75362. */
  75363. getClassName(): string;
  75364. /**
  75365. * Update the url (and optional buffer) of this texture if url was null during construction.
  75366. * @param url the url of the texture
  75367. * @param forcedExtension defines the extension to use
  75368. * @param onLoad callback called when the texture is loaded (defaults to null)
  75369. */
  75370. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  75371. /**
  75372. * Delays loading of the cube texture
  75373. * @param forcedExtension defines the extension to use
  75374. */
  75375. delayLoad(forcedExtension?: string): void;
  75376. /**
  75377. * Returns the reflection texture matrix
  75378. * @returns the reflection texture matrix
  75379. */
  75380. getReflectionTextureMatrix(): Matrix;
  75381. /**
  75382. * Sets the reflection texture matrix
  75383. * @param value Reflection texture matrix
  75384. */
  75385. setReflectionTextureMatrix(value: Matrix): void;
  75386. /**
  75387. * Parses text to create a cube texture
  75388. * @param parsedTexture define the serialized text to read from
  75389. * @param scene defines the hosting scene
  75390. * @param rootUrl defines the root url of the cube texture
  75391. * @returns a cube texture
  75392. */
  75393. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  75394. /**
  75395. * Makes a clone, or deep copy, of the cube texture
  75396. * @returns a new cube texture
  75397. */
  75398. clone(): CubeTexture;
  75399. }
  75400. }
  75401. declare module BABYLON {
  75402. /**
  75403. * Manages the defines for the Material
  75404. */
  75405. export class MaterialDefines {
  75406. /** @hidden */
  75407. protected _keys: string[];
  75408. private _isDirty;
  75409. /** @hidden */
  75410. _renderId: number;
  75411. /** @hidden */
  75412. _areLightsDirty: boolean;
  75413. /** @hidden */
  75414. _areLightsDisposed: boolean;
  75415. /** @hidden */
  75416. _areAttributesDirty: boolean;
  75417. /** @hidden */
  75418. _areTexturesDirty: boolean;
  75419. /** @hidden */
  75420. _areFresnelDirty: boolean;
  75421. /** @hidden */
  75422. _areMiscDirty: boolean;
  75423. /** @hidden */
  75424. _areImageProcessingDirty: boolean;
  75425. /** @hidden */
  75426. _normals: boolean;
  75427. /** @hidden */
  75428. _uvs: boolean;
  75429. /** @hidden */
  75430. _needNormals: boolean;
  75431. /** @hidden */
  75432. _needUVs: boolean;
  75433. [id: string]: any;
  75434. /**
  75435. * Specifies if the material needs to be re-calculated
  75436. */
  75437. readonly isDirty: boolean;
  75438. /**
  75439. * Marks the material to indicate that it has been re-calculated
  75440. */
  75441. markAsProcessed(): void;
  75442. /**
  75443. * Marks the material to indicate that it needs to be re-calculated
  75444. */
  75445. markAsUnprocessed(): void;
  75446. /**
  75447. * Marks the material to indicate all of its defines need to be re-calculated
  75448. */
  75449. markAllAsDirty(): void;
  75450. /**
  75451. * Marks the material to indicate that image processing needs to be re-calculated
  75452. */
  75453. markAsImageProcessingDirty(): void;
  75454. /**
  75455. * Marks the material to indicate the lights need to be re-calculated
  75456. * @param disposed Defines whether the light is dirty due to dispose or not
  75457. */
  75458. markAsLightDirty(disposed?: boolean): void;
  75459. /**
  75460. * Marks the attribute state as changed
  75461. */
  75462. markAsAttributesDirty(): void;
  75463. /**
  75464. * Marks the texture state as changed
  75465. */
  75466. markAsTexturesDirty(): void;
  75467. /**
  75468. * Marks the fresnel state as changed
  75469. */
  75470. markAsFresnelDirty(): void;
  75471. /**
  75472. * Marks the misc state as changed
  75473. */
  75474. markAsMiscDirty(): void;
  75475. /**
  75476. * Rebuilds the material defines
  75477. */
  75478. rebuild(): void;
  75479. /**
  75480. * Specifies if two material defines are equal
  75481. * @param other - A material define instance to compare to
  75482. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  75483. */
  75484. isEqual(other: MaterialDefines): boolean;
  75485. /**
  75486. * Clones this instance's defines to another instance
  75487. * @param other - material defines to clone values to
  75488. */
  75489. cloneTo(other: MaterialDefines): void;
  75490. /**
  75491. * Resets the material define values
  75492. */
  75493. reset(): void;
  75494. /**
  75495. * Converts the material define values to a string
  75496. * @returns - String of material define information
  75497. */
  75498. toString(): string;
  75499. }
  75500. }
  75501. declare module BABYLON {
  75502. /**
  75503. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  75504. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  75505. * 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;
  75506. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  75507. */
  75508. export class ColorCurves {
  75509. private _dirty;
  75510. private _tempColor;
  75511. private _globalCurve;
  75512. private _highlightsCurve;
  75513. private _midtonesCurve;
  75514. private _shadowsCurve;
  75515. private _positiveCurve;
  75516. private _negativeCurve;
  75517. private _globalHue;
  75518. private _globalDensity;
  75519. private _globalSaturation;
  75520. private _globalExposure;
  75521. /**
  75522. * Gets the global Hue value.
  75523. * 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).
  75524. */
  75525. /**
  75526. * Sets the global Hue value.
  75527. * 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).
  75528. */
  75529. globalHue: number;
  75530. /**
  75531. * Gets the global Density value.
  75532. * 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.
  75533. * Values less than zero provide a filter of opposite hue.
  75534. */
  75535. /**
  75536. * Sets the global Density value.
  75537. * 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.
  75538. * Values less than zero provide a filter of opposite hue.
  75539. */
  75540. globalDensity: number;
  75541. /**
  75542. * Gets the global Saturation value.
  75543. * 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.
  75544. */
  75545. /**
  75546. * Sets the global Saturation value.
  75547. * 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.
  75548. */
  75549. globalSaturation: number;
  75550. /**
  75551. * Gets the global Exposure value.
  75552. * 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.
  75553. */
  75554. /**
  75555. * Sets the global Exposure value.
  75556. * 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.
  75557. */
  75558. globalExposure: number;
  75559. private _highlightsHue;
  75560. private _highlightsDensity;
  75561. private _highlightsSaturation;
  75562. private _highlightsExposure;
  75563. /**
  75564. * Gets the highlights Hue value.
  75565. * 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).
  75566. */
  75567. /**
  75568. * Sets the highlights Hue value.
  75569. * 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).
  75570. */
  75571. highlightsHue: number;
  75572. /**
  75573. * Gets the highlights Density value.
  75574. * 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.
  75575. * Values less than zero provide a filter of opposite hue.
  75576. */
  75577. /**
  75578. * Sets the highlights Density value.
  75579. * 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.
  75580. * Values less than zero provide a filter of opposite hue.
  75581. */
  75582. highlightsDensity: number;
  75583. /**
  75584. * Gets the highlights Saturation value.
  75585. * 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.
  75586. */
  75587. /**
  75588. * Sets the highlights Saturation value.
  75589. * 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.
  75590. */
  75591. highlightsSaturation: number;
  75592. /**
  75593. * Gets the highlights Exposure value.
  75594. * 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.
  75595. */
  75596. /**
  75597. * Sets the highlights Exposure value.
  75598. * 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.
  75599. */
  75600. highlightsExposure: number;
  75601. private _midtonesHue;
  75602. private _midtonesDensity;
  75603. private _midtonesSaturation;
  75604. private _midtonesExposure;
  75605. /**
  75606. * Gets the midtones Hue value.
  75607. * 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).
  75608. */
  75609. /**
  75610. * Sets the midtones Hue value.
  75611. * 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).
  75612. */
  75613. midtonesHue: number;
  75614. /**
  75615. * Gets the midtones Density value.
  75616. * 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.
  75617. * Values less than zero provide a filter of opposite hue.
  75618. */
  75619. /**
  75620. * Sets the midtones Density value.
  75621. * 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.
  75622. * Values less than zero provide a filter of opposite hue.
  75623. */
  75624. midtonesDensity: number;
  75625. /**
  75626. * Gets the midtones Saturation value.
  75627. * 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.
  75628. */
  75629. /**
  75630. * Sets the midtones Saturation value.
  75631. * 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.
  75632. */
  75633. midtonesSaturation: number;
  75634. /**
  75635. * Gets the midtones Exposure value.
  75636. * 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.
  75637. */
  75638. /**
  75639. * Sets the midtones Exposure value.
  75640. * 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.
  75641. */
  75642. midtonesExposure: number;
  75643. private _shadowsHue;
  75644. private _shadowsDensity;
  75645. private _shadowsSaturation;
  75646. private _shadowsExposure;
  75647. /**
  75648. * Gets the shadows Hue value.
  75649. * 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).
  75650. */
  75651. /**
  75652. * Sets the shadows Hue value.
  75653. * 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).
  75654. */
  75655. shadowsHue: number;
  75656. /**
  75657. * Gets the shadows Density value.
  75658. * 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.
  75659. * Values less than zero provide a filter of opposite hue.
  75660. */
  75661. /**
  75662. * Sets the shadows Density value.
  75663. * 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.
  75664. * Values less than zero provide a filter of opposite hue.
  75665. */
  75666. shadowsDensity: number;
  75667. /**
  75668. * Gets the shadows Saturation value.
  75669. * 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.
  75670. */
  75671. /**
  75672. * Sets the shadows Saturation value.
  75673. * 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.
  75674. */
  75675. shadowsSaturation: number;
  75676. /**
  75677. * Gets the shadows Exposure value.
  75678. * 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.
  75679. */
  75680. /**
  75681. * Sets the shadows Exposure value.
  75682. * 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.
  75683. */
  75684. shadowsExposure: number;
  75685. /**
  75686. * Returns the class name
  75687. * @returns The class name
  75688. */
  75689. getClassName(): string;
  75690. /**
  75691. * Binds the color curves to the shader.
  75692. * @param colorCurves The color curve to bind
  75693. * @param effect The effect to bind to
  75694. * @param positiveUniform The positive uniform shader parameter
  75695. * @param neutralUniform The neutral uniform shader parameter
  75696. * @param negativeUniform The negative uniform shader parameter
  75697. */
  75698. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  75699. /**
  75700. * Prepare the list of uniforms associated with the ColorCurves effects.
  75701. * @param uniformsList The list of uniforms used in the effect
  75702. */
  75703. static PrepareUniforms(uniformsList: string[]): void;
  75704. /**
  75705. * Returns color grading data based on a hue, density, saturation and exposure value.
  75706. * @param filterHue The hue of the color filter.
  75707. * @param filterDensity The density of the color filter.
  75708. * @param saturation The saturation.
  75709. * @param exposure The exposure.
  75710. * @param result The result data container.
  75711. */
  75712. private getColorGradingDataToRef;
  75713. /**
  75714. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  75715. * @param value The input slider value in range [-100,100].
  75716. * @returns Adjusted value.
  75717. */
  75718. private static applyColorGradingSliderNonlinear;
  75719. /**
  75720. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  75721. * @param hue The hue (H) input.
  75722. * @param saturation The saturation (S) input.
  75723. * @param brightness The brightness (B) input.
  75724. * @result An RGBA color represented as Vector4.
  75725. */
  75726. private static fromHSBToRef;
  75727. /**
  75728. * Returns a value clamped between min and max
  75729. * @param value The value to clamp
  75730. * @param min The minimum of value
  75731. * @param max The maximum of value
  75732. * @returns The clamped value.
  75733. */
  75734. private static clamp;
  75735. /**
  75736. * Clones the current color curve instance.
  75737. * @return The cloned curves
  75738. */
  75739. clone(): ColorCurves;
  75740. /**
  75741. * Serializes the current color curve instance to a json representation.
  75742. * @return a JSON representation
  75743. */
  75744. serialize(): any;
  75745. /**
  75746. * Parses the color curve from a json representation.
  75747. * @param source the JSON source to parse
  75748. * @return The parsed curves
  75749. */
  75750. static Parse(source: any): ColorCurves;
  75751. }
  75752. }
  75753. declare module BABYLON {
  75754. /**
  75755. * Interface to follow in your material defines to integrate easily the
  75756. * Image proccessing functions.
  75757. * @hidden
  75758. */
  75759. export interface IImageProcessingConfigurationDefines {
  75760. IMAGEPROCESSING: boolean;
  75761. VIGNETTE: boolean;
  75762. VIGNETTEBLENDMODEMULTIPLY: boolean;
  75763. VIGNETTEBLENDMODEOPAQUE: boolean;
  75764. TONEMAPPING: boolean;
  75765. TONEMAPPING_ACES: boolean;
  75766. CONTRAST: boolean;
  75767. EXPOSURE: boolean;
  75768. COLORCURVES: boolean;
  75769. COLORGRADING: boolean;
  75770. COLORGRADING3D: boolean;
  75771. SAMPLER3DGREENDEPTH: boolean;
  75772. SAMPLER3DBGRMAP: boolean;
  75773. IMAGEPROCESSINGPOSTPROCESS: boolean;
  75774. }
  75775. /**
  75776. * @hidden
  75777. */
  75778. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  75779. IMAGEPROCESSING: boolean;
  75780. VIGNETTE: boolean;
  75781. VIGNETTEBLENDMODEMULTIPLY: boolean;
  75782. VIGNETTEBLENDMODEOPAQUE: boolean;
  75783. TONEMAPPING: boolean;
  75784. TONEMAPPING_ACES: boolean;
  75785. CONTRAST: boolean;
  75786. COLORCURVES: boolean;
  75787. COLORGRADING: boolean;
  75788. COLORGRADING3D: boolean;
  75789. SAMPLER3DGREENDEPTH: boolean;
  75790. SAMPLER3DBGRMAP: boolean;
  75791. IMAGEPROCESSINGPOSTPROCESS: boolean;
  75792. EXPOSURE: boolean;
  75793. constructor();
  75794. }
  75795. /**
  75796. * This groups together the common properties used for image processing either in direct forward pass
  75797. * or through post processing effect depending on the use of the image processing pipeline in your scene
  75798. * or not.
  75799. */
  75800. export class ImageProcessingConfiguration {
  75801. /**
  75802. * Default tone mapping applied in BabylonJS.
  75803. */
  75804. static readonly TONEMAPPING_STANDARD: number;
  75805. /**
  75806. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  75807. * to other engines rendering to increase portability.
  75808. */
  75809. static readonly TONEMAPPING_ACES: number;
  75810. /**
  75811. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  75812. */
  75813. colorCurves: Nullable<ColorCurves>;
  75814. private _colorCurvesEnabled;
  75815. /**
  75816. * Gets wether the color curves effect is enabled.
  75817. */
  75818. /**
  75819. * Sets wether the color curves effect is enabled.
  75820. */
  75821. colorCurvesEnabled: boolean;
  75822. private _colorGradingTexture;
  75823. /**
  75824. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  75825. */
  75826. /**
  75827. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  75828. */
  75829. colorGradingTexture: Nullable<BaseTexture>;
  75830. private _colorGradingEnabled;
  75831. /**
  75832. * Gets wether the color grading effect is enabled.
  75833. */
  75834. /**
  75835. * Sets wether the color grading effect is enabled.
  75836. */
  75837. colorGradingEnabled: boolean;
  75838. private _colorGradingWithGreenDepth;
  75839. /**
  75840. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  75841. */
  75842. /**
  75843. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  75844. */
  75845. colorGradingWithGreenDepth: boolean;
  75846. private _colorGradingBGR;
  75847. /**
  75848. * Gets wether the color grading texture contains BGR values.
  75849. */
  75850. /**
  75851. * Sets wether the color grading texture contains BGR values.
  75852. */
  75853. colorGradingBGR: boolean;
  75854. /** @hidden */
  75855. _exposure: number;
  75856. /**
  75857. * Gets the Exposure used in the effect.
  75858. */
  75859. /**
  75860. * Sets the Exposure used in the effect.
  75861. */
  75862. exposure: number;
  75863. private _toneMappingEnabled;
  75864. /**
  75865. * Gets wether the tone mapping effect is enabled.
  75866. */
  75867. /**
  75868. * Sets wether the tone mapping effect is enabled.
  75869. */
  75870. toneMappingEnabled: boolean;
  75871. private _toneMappingType;
  75872. /**
  75873. * Gets the type of tone mapping effect.
  75874. */
  75875. /**
  75876. * Sets the type of tone mapping effect used in BabylonJS.
  75877. */
  75878. toneMappingType: number;
  75879. protected _contrast: number;
  75880. /**
  75881. * Gets the contrast used in the effect.
  75882. */
  75883. /**
  75884. * Sets the contrast used in the effect.
  75885. */
  75886. contrast: number;
  75887. /**
  75888. * Vignette stretch size.
  75889. */
  75890. vignetteStretch: number;
  75891. /**
  75892. * Vignette centre X Offset.
  75893. */
  75894. vignetteCentreX: number;
  75895. /**
  75896. * Vignette centre Y Offset.
  75897. */
  75898. vignetteCentreY: number;
  75899. /**
  75900. * Vignette weight or intensity of the vignette effect.
  75901. */
  75902. vignetteWeight: number;
  75903. /**
  75904. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  75905. * if vignetteEnabled is set to true.
  75906. */
  75907. vignetteColor: Color4;
  75908. /**
  75909. * Camera field of view used by the Vignette effect.
  75910. */
  75911. vignetteCameraFov: number;
  75912. private _vignetteBlendMode;
  75913. /**
  75914. * Gets the vignette blend mode allowing different kind of effect.
  75915. */
  75916. /**
  75917. * Sets the vignette blend mode allowing different kind of effect.
  75918. */
  75919. vignetteBlendMode: number;
  75920. private _vignetteEnabled;
  75921. /**
  75922. * Gets wether the vignette effect is enabled.
  75923. */
  75924. /**
  75925. * Sets wether the vignette effect is enabled.
  75926. */
  75927. vignetteEnabled: boolean;
  75928. private _applyByPostProcess;
  75929. /**
  75930. * Gets wether the image processing is applied through a post process or not.
  75931. */
  75932. /**
  75933. * Sets wether the image processing is applied through a post process or not.
  75934. */
  75935. applyByPostProcess: boolean;
  75936. private _isEnabled;
  75937. /**
  75938. * Gets wether the image processing is enabled or not.
  75939. */
  75940. /**
  75941. * Sets wether the image processing is enabled or not.
  75942. */
  75943. isEnabled: boolean;
  75944. /**
  75945. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  75946. */
  75947. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  75948. /**
  75949. * Method called each time the image processing information changes requires to recompile the effect.
  75950. */
  75951. protected _updateParameters(): void;
  75952. /**
  75953. * Gets the current class name.
  75954. * @return "ImageProcessingConfiguration"
  75955. */
  75956. getClassName(): string;
  75957. /**
  75958. * Prepare the list of uniforms associated with the Image Processing effects.
  75959. * @param uniforms The list of uniforms used in the effect
  75960. * @param defines the list of defines currently in use
  75961. */
  75962. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  75963. /**
  75964. * Prepare the list of samplers associated with the Image Processing effects.
  75965. * @param samplersList The list of uniforms used in the effect
  75966. * @param defines the list of defines currently in use
  75967. */
  75968. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  75969. /**
  75970. * Prepare the list of defines associated to the shader.
  75971. * @param defines the list of defines to complete
  75972. * @param forPostProcess Define if we are currently in post process mode or not
  75973. */
  75974. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  75975. /**
  75976. * Returns true if all the image processing information are ready.
  75977. * @returns True if ready, otherwise, false
  75978. */
  75979. isReady(): boolean;
  75980. /**
  75981. * Binds the image processing to the shader.
  75982. * @param effect The effect to bind to
  75983. * @param overrideAspectRatio Override the aspect ratio of the effect
  75984. */
  75985. bind(effect: Effect, overrideAspectRatio?: number): void;
  75986. /**
  75987. * Clones the current image processing instance.
  75988. * @return The cloned image processing
  75989. */
  75990. clone(): ImageProcessingConfiguration;
  75991. /**
  75992. * Serializes the current image processing instance to a json representation.
  75993. * @return a JSON representation
  75994. */
  75995. serialize(): any;
  75996. /**
  75997. * Parses the image processing from a json representation.
  75998. * @param source the JSON source to parse
  75999. * @return The parsed image processing
  76000. */
  76001. static Parse(source: any): ImageProcessingConfiguration;
  76002. private static _VIGNETTEMODE_MULTIPLY;
  76003. private static _VIGNETTEMODE_OPAQUE;
  76004. /**
  76005. * Used to apply the vignette as a mix with the pixel color.
  76006. */
  76007. static readonly VIGNETTEMODE_MULTIPLY: number;
  76008. /**
  76009. * Used to apply the vignette as a replacement of the pixel color.
  76010. */
  76011. static readonly VIGNETTEMODE_OPAQUE: number;
  76012. }
  76013. }
  76014. declare module BABYLON {
  76015. /** @hidden */
  76016. export var postprocessVertexShader: {
  76017. name: string;
  76018. shader: string;
  76019. };
  76020. }
  76021. declare module BABYLON {
  76022. interface ThinEngine {
  76023. /**
  76024. * Creates a new render target texture
  76025. * @param size defines the size of the texture
  76026. * @param options defines the options used to create the texture
  76027. * @returns a new render target texture stored in an InternalTexture
  76028. */
  76029. createRenderTargetTexture(size: number | {
  76030. width: number;
  76031. height: number;
  76032. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  76033. /**
  76034. * Creates a depth stencil texture.
  76035. * This is only available in WebGL 2 or with the depth texture extension available.
  76036. * @param size The size of face edge in the texture.
  76037. * @param options The options defining the texture.
  76038. * @returns The texture
  76039. */
  76040. createDepthStencilTexture(size: number | {
  76041. width: number;
  76042. height: number;
  76043. }, options: DepthTextureCreationOptions): InternalTexture;
  76044. /** @hidden */
  76045. _createDepthStencilTexture(size: number | {
  76046. width: number;
  76047. height: number;
  76048. }, options: DepthTextureCreationOptions): InternalTexture;
  76049. }
  76050. }
  76051. declare module BABYLON {
  76052. /** Defines supported spaces */
  76053. export enum Space {
  76054. /** Local (object) space */
  76055. LOCAL = 0,
  76056. /** World space */
  76057. WORLD = 1,
  76058. /** Bone space */
  76059. BONE = 2
  76060. }
  76061. /** Defines the 3 main axes */
  76062. export class Axis {
  76063. /** X axis */
  76064. static X: Vector3;
  76065. /** Y axis */
  76066. static Y: Vector3;
  76067. /** Z axis */
  76068. static Z: Vector3;
  76069. }
  76070. }
  76071. declare module BABYLON {
  76072. /**
  76073. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  76074. * This is the base of the follow, arc rotate cameras and Free camera
  76075. * @see http://doc.babylonjs.com/features/cameras
  76076. */
  76077. export class TargetCamera extends Camera {
  76078. private static _RigCamTransformMatrix;
  76079. private static _TargetTransformMatrix;
  76080. private static _TargetFocalPoint;
  76081. /**
  76082. * Define the current direction the camera is moving to
  76083. */
  76084. cameraDirection: Vector3;
  76085. /**
  76086. * Define the current rotation the camera is rotating to
  76087. */
  76088. cameraRotation: Vector2;
  76089. /**
  76090. * When set, the up vector of the camera will be updated by the rotation of the camera
  76091. */
  76092. updateUpVectorFromRotation: boolean;
  76093. private _tmpQuaternion;
  76094. /**
  76095. * Define the current rotation of the camera
  76096. */
  76097. rotation: Vector3;
  76098. /**
  76099. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  76100. */
  76101. rotationQuaternion: Quaternion;
  76102. /**
  76103. * Define the current speed of the camera
  76104. */
  76105. speed: number;
  76106. /**
  76107. * Add cconstraint to the camera to prevent it to move freely in all directions and
  76108. * around all axis.
  76109. */
  76110. noRotationConstraint: boolean;
  76111. /**
  76112. * Define the current target of the camera as an object or a position.
  76113. */
  76114. lockedTarget: any;
  76115. /** @hidden */
  76116. _currentTarget: Vector3;
  76117. /** @hidden */
  76118. _initialFocalDistance: number;
  76119. /** @hidden */
  76120. _viewMatrix: Matrix;
  76121. /** @hidden */
  76122. _camMatrix: Matrix;
  76123. /** @hidden */
  76124. _cameraTransformMatrix: Matrix;
  76125. /** @hidden */
  76126. _cameraRotationMatrix: Matrix;
  76127. /** @hidden */
  76128. _referencePoint: Vector3;
  76129. /** @hidden */
  76130. _transformedReferencePoint: Vector3;
  76131. protected _globalCurrentTarget: Vector3;
  76132. protected _globalCurrentUpVector: Vector3;
  76133. /** @hidden */
  76134. _reset: () => void;
  76135. private _defaultUp;
  76136. /**
  76137. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  76138. * This is the base of the follow, arc rotate cameras and Free camera
  76139. * @see http://doc.babylonjs.com/features/cameras
  76140. * @param name Defines the name of the camera in the scene
  76141. * @param position Defines the start position of the camera in the scene
  76142. * @param scene Defines the scene the camera belongs to
  76143. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  76144. */
  76145. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  76146. /**
  76147. * Gets the position in front of the camera at a given distance.
  76148. * @param distance The distance from the camera we want the position to be
  76149. * @returns the position
  76150. */
  76151. getFrontPosition(distance: number): Vector3;
  76152. /** @hidden */
  76153. _getLockedTargetPosition(): Nullable<Vector3>;
  76154. private _storedPosition;
  76155. private _storedRotation;
  76156. private _storedRotationQuaternion;
  76157. /**
  76158. * Store current camera state of the camera (fov, position, rotation, etc..)
  76159. * @returns the camera
  76160. */
  76161. storeState(): Camera;
  76162. /**
  76163. * Restored camera state. You must call storeState() first
  76164. * @returns whether it was successful or not
  76165. * @hidden
  76166. */
  76167. _restoreStateValues(): boolean;
  76168. /** @hidden */
  76169. _initCache(): void;
  76170. /** @hidden */
  76171. _updateCache(ignoreParentClass?: boolean): void;
  76172. /** @hidden */
  76173. _isSynchronizedViewMatrix(): boolean;
  76174. /** @hidden */
  76175. _computeLocalCameraSpeed(): number;
  76176. /**
  76177. * Defines the target the camera should look at.
  76178. * @param target Defines the new target as a Vector or a mesh
  76179. */
  76180. setTarget(target: Vector3): void;
  76181. /**
  76182. * Return the current target position of the camera. This value is expressed in local space.
  76183. * @returns the target position
  76184. */
  76185. getTarget(): Vector3;
  76186. /** @hidden */
  76187. _decideIfNeedsToMove(): boolean;
  76188. /** @hidden */
  76189. _updatePosition(): void;
  76190. /** @hidden */
  76191. _checkInputs(): void;
  76192. protected _updateCameraRotationMatrix(): void;
  76193. /**
  76194. * 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)
  76195. * @returns the current camera
  76196. */
  76197. private _rotateUpVectorWithCameraRotationMatrix;
  76198. private _cachedRotationZ;
  76199. private _cachedQuaternionRotationZ;
  76200. /** @hidden */
  76201. _getViewMatrix(): Matrix;
  76202. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  76203. /**
  76204. * @hidden
  76205. */
  76206. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  76207. /**
  76208. * @hidden
  76209. */
  76210. _updateRigCameras(): void;
  76211. private _getRigCamPositionAndTarget;
  76212. /**
  76213. * Gets the current object class name.
  76214. * @return the class name
  76215. */
  76216. getClassName(): string;
  76217. }
  76218. }
  76219. declare module BABYLON {
  76220. /**
  76221. * Gather the list of keyboard event types as constants.
  76222. */
  76223. export class KeyboardEventTypes {
  76224. /**
  76225. * The keydown event is fired when a key becomes active (pressed).
  76226. */
  76227. static readonly KEYDOWN: number;
  76228. /**
  76229. * The keyup event is fired when a key has been released.
  76230. */
  76231. static readonly KEYUP: number;
  76232. }
  76233. /**
  76234. * This class is used to store keyboard related info for the onKeyboardObservable event.
  76235. */
  76236. export class KeyboardInfo {
  76237. /**
  76238. * Defines the type of event (KeyboardEventTypes)
  76239. */
  76240. type: number;
  76241. /**
  76242. * Defines the related dom event
  76243. */
  76244. event: KeyboardEvent;
  76245. /**
  76246. * Instantiates a new keyboard info.
  76247. * This class is used to store keyboard related info for the onKeyboardObservable event.
  76248. * @param type Defines the type of event (KeyboardEventTypes)
  76249. * @param event Defines the related dom event
  76250. */
  76251. constructor(
  76252. /**
  76253. * Defines the type of event (KeyboardEventTypes)
  76254. */
  76255. type: number,
  76256. /**
  76257. * Defines the related dom event
  76258. */
  76259. event: KeyboardEvent);
  76260. }
  76261. /**
  76262. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  76263. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  76264. */
  76265. export class KeyboardInfoPre extends KeyboardInfo {
  76266. /**
  76267. * Defines the type of event (KeyboardEventTypes)
  76268. */
  76269. type: number;
  76270. /**
  76271. * Defines the related dom event
  76272. */
  76273. event: KeyboardEvent;
  76274. /**
  76275. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  76276. */
  76277. skipOnPointerObservable: boolean;
  76278. /**
  76279. * Instantiates a new keyboard pre info.
  76280. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  76281. * @param type Defines the type of event (KeyboardEventTypes)
  76282. * @param event Defines the related dom event
  76283. */
  76284. constructor(
  76285. /**
  76286. * Defines the type of event (KeyboardEventTypes)
  76287. */
  76288. type: number,
  76289. /**
  76290. * Defines the related dom event
  76291. */
  76292. event: KeyboardEvent);
  76293. }
  76294. }
  76295. declare module BABYLON {
  76296. /**
  76297. * Manage the keyboard inputs to control the movement of a free camera.
  76298. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  76299. */
  76300. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  76301. /**
  76302. * Defines the camera the input is attached to.
  76303. */
  76304. camera: FreeCamera;
  76305. /**
  76306. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  76307. */
  76308. keysUp: number[];
  76309. /**
  76310. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  76311. */
  76312. keysDown: number[];
  76313. /**
  76314. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  76315. */
  76316. keysLeft: number[];
  76317. /**
  76318. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  76319. */
  76320. keysRight: number[];
  76321. private _keys;
  76322. private _onCanvasBlurObserver;
  76323. private _onKeyboardObserver;
  76324. private _engine;
  76325. private _scene;
  76326. /**
  76327. * Attach the input controls to a specific dom element to get the input from.
  76328. * @param element Defines the element the controls should be listened from
  76329. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  76330. */
  76331. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  76332. /**
  76333. * Detach the current controls from the specified dom element.
  76334. * @param element Defines the element to stop listening the inputs from
  76335. */
  76336. detachControl(element: Nullable<HTMLElement>): void;
  76337. /**
  76338. * Update the current camera state depending on the inputs that have been used this frame.
  76339. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  76340. */
  76341. checkInputs(): void;
  76342. /**
  76343. * Gets the class name of the current intput.
  76344. * @returns the class name
  76345. */
  76346. getClassName(): string;
  76347. /** @hidden */
  76348. _onLostFocus(): void;
  76349. /**
  76350. * Get the friendly name associated with the input class.
  76351. * @returns the input friendly name
  76352. */
  76353. getSimpleName(): string;
  76354. }
  76355. }
  76356. declare module BABYLON {
  76357. /**
  76358. * Interface describing all the common properties and methods a shadow light needs to implement.
  76359. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  76360. * as well as binding the different shadow properties to the effects.
  76361. */
  76362. export interface IShadowLight extends Light {
  76363. /**
  76364. * The light id in the scene (used in scene.findLighById for instance)
  76365. */
  76366. id: string;
  76367. /**
  76368. * The position the shdow will be casted from.
  76369. */
  76370. position: Vector3;
  76371. /**
  76372. * In 2d mode (needCube being false), the direction used to cast the shadow.
  76373. */
  76374. direction: Vector3;
  76375. /**
  76376. * The transformed position. Position of the light in world space taking parenting in account.
  76377. */
  76378. transformedPosition: Vector3;
  76379. /**
  76380. * The transformed direction. Direction of the light in world space taking parenting in account.
  76381. */
  76382. transformedDirection: Vector3;
  76383. /**
  76384. * The friendly name of the light in the scene.
  76385. */
  76386. name: string;
  76387. /**
  76388. * Defines the shadow projection clipping minimum z value.
  76389. */
  76390. shadowMinZ: number;
  76391. /**
  76392. * Defines the shadow projection clipping maximum z value.
  76393. */
  76394. shadowMaxZ: number;
  76395. /**
  76396. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  76397. * @returns true if the information has been computed, false if it does not need to (no parenting)
  76398. */
  76399. computeTransformedInformation(): boolean;
  76400. /**
  76401. * Gets the scene the light belongs to.
  76402. * @returns The scene
  76403. */
  76404. getScene(): Scene;
  76405. /**
  76406. * Callback defining a custom Projection Matrix Builder.
  76407. * This can be used to override the default projection matrix computation.
  76408. */
  76409. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  76410. /**
  76411. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  76412. * @param matrix The materix to updated with the projection information
  76413. * @param viewMatrix The transform matrix of the light
  76414. * @param renderList The list of mesh to render in the map
  76415. * @returns The current light
  76416. */
  76417. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  76418. /**
  76419. * Gets the current depth scale used in ESM.
  76420. * @returns The scale
  76421. */
  76422. getDepthScale(): number;
  76423. /**
  76424. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  76425. * @returns true if a cube texture needs to be use
  76426. */
  76427. needCube(): boolean;
  76428. /**
  76429. * Detects if the projection matrix requires to be recomputed this frame.
  76430. * @returns true if it requires to be recomputed otherwise, false.
  76431. */
  76432. needProjectionMatrixCompute(): boolean;
  76433. /**
  76434. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  76435. */
  76436. forceProjectionMatrixCompute(): void;
  76437. /**
  76438. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  76439. * @param faceIndex The index of the face we are computed the direction to generate shadow
  76440. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  76441. */
  76442. getShadowDirection(faceIndex?: number): Vector3;
  76443. /**
  76444. * Gets the minZ used for shadow according to both the scene and the light.
  76445. * @param activeCamera The camera we are returning the min for
  76446. * @returns the depth min z
  76447. */
  76448. getDepthMinZ(activeCamera: Camera): number;
  76449. /**
  76450. * Gets the maxZ used for shadow according to both the scene and the light.
  76451. * @param activeCamera The camera we are returning the max for
  76452. * @returns the depth max z
  76453. */
  76454. getDepthMaxZ(activeCamera: Camera): number;
  76455. }
  76456. /**
  76457. * Base implementation IShadowLight
  76458. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  76459. */
  76460. export abstract class ShadowLight extends Light implements IShadowLight {
  76461. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  76462. protected _position: Vector3;
  76463. protected _setPosition(value: Vector3): void;
  76464. /**
  76465. * Sets the position the shadow will be casted from. Also use as the light position for both
  76466. * point and spot lights.
  76467. */
  76468. /**
  76469. * Sets the position the shadow will be casted from. Also use as the light position for both
  76470. * point and spot lights.
  76471. */
  76472. position: Vector3;
  76473. protected _direction: Vector3;
  76474. protected _setDirection(value: Vector3): void;
  76475. /**
  76476. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  76477. * Also use as the light direction on spot and directional lights.
  76478. */
  76479. /**
  76480. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  76481. * Also use as the light direction on spot and directional lights.
  76482. */
  76483. direction: Vector3;
  76484. private _shadowMinZ;
  76485. /**
  76486. * Gets the shadow projection clipping minimum z value.
  76487. */
  76488. /**
  76489. * Sets the shadow projection clipping minimum z value.
  76490. */
  76491. shadowMinZ: number;
  76492. private _shadowMaxZ;
  76493. /**
  76494. * Sets the shadow projection clipping maximum z value.
  76495. */
  76496. /**
  76497. * Gets the shadow projection clipping maximum z value.
  76498. */
  76499. shadowMaxZ: number;
  76500. /**
  76501. * Callback defining a custom Projection Matrix Builder.
  76502. * This can be used to override the default projection matrix computation.
  76503. */
  76504. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  76505. /**
  76506. * The transformed position. Position of the light in world space taking parenting in account.
  76507. */
  76508. transformedPosition: Vector3;
  76509. /**
  76510. * The transformed direction. Direction of the light in world space taking parenting in account.
  76511. */
  76512. transformedDirection: Vector3;
  76513. private _needProjectionMatrixCompute;
  76514. /**
  76515. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  76516. * @returns true if the information has been computed, false if it does not need to (no parenting)
  76517. */
  76518. computeTransformedInformation(): boolean;
  76519. /**
  76520. * Return the depth scale used for the shadow map.
  76521. * @returns the depth scale.
  76522. */
  76523. getDepthScale(): number;
  76524. /**
  76525. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  76526. * @param faceIndex The index of the face we are computed the direction to generate shadow
  76527. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  76528. */
  76529. getShadowDirection(faceIndex?: number): Vector3;
  76530. /**
  76531. * Returns the ShadowLight absolute position in the World.
  76532. * @returns the position vector in world space
  76533. */
  76534. getAbsolutePosition(): Vector3;
  76535. /**
  76536. * Sets the ShadowLight direction toward the passed target.
  76537. * @param target The point to target in local space
  76538. * @returns the updated ShadowLight direction
  76539. */
  76540. setDirectionToTarget(target: Vector3): Vector3;
  76541. /**
  76542. * Returns the light rotation in euler definition.
  76543. * @returns the x y z rotation in local space.
  76544. */
  76545. getRotation(): Vector3;
  76546. /**
  76547. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  76548. * @returns true if a cube texture needs to be use
  76549. */
  76550. needCube(): boolean;
  76551. /**
  76552. * Detects if the projection matrix requires to be recomputed this frame.
  76553. * @returns true if it requires to be recomputed otherwise, false.
  76554. */
  76555. needProjectionMatrixCompute(): boolean;
  76556. /**
  76557. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  76558. */
  76559. forceProjectionMatrixCompute(): void;
  76560. /** @hidden */
  76561. _initCache(): void;
  76562. /** @hidden */
  76563. _isSynchronized(): boolean;
  76564. /**
  76565. * Computes the world matrix of the node
  76566. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  76567. * @returns the world matrix
  76568. */
  76569. computeWorldMatrix(force?: boolean): Matrix;
  76570. /**
  76571. * Gets the minZ used for shadow according to both the scene and the light.
  76572. * @param activeCamera The camera we are returning the min for
  76573. * @returns the depth min z
  76574. */
  76575. getDepthMinZ(activeCamera: Camera): number;
  76576. /**
  76577. * Gets the maxZ used for shadow according to both the scene and the light.
  76578. * @param activeCamera The camera we are returning the max for
  76579. * @returns the depth max z
  76580. */
  76581. getDepthMaxZ(activeCamera: Camera): number;
  76582. /**
  76583. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  76584. * @param matrix The materix to updated with the projection information
  76585. * @param viewMatrix The transform matrix of the light
  76586. * @param renderList The list of mesh to render in the map
  76587. * @returns The current light
  76588. */
  76589. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  76590. }
  76591. }
  76592. declare module BABYLON {
  76593. /**
  76594. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  76595. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  76596. */
  76597. export class EffectFallbacks implements IEffectFallbacks {
  76598. private _defines;
  76599. private _currentRank;
  76600. private _maxRank;
  76601. private _mesh;
  76602. /**
  76603. * Removes the fallback from the bound mesh.
  76604. */
  76605. unBindMesh(): void;
  76606. /**
  76607. * Adds a fallback on the specified property.
  76608. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  76609. * @param define The name of the define in the shader
  76610. */
  76611. addFallback(rank: number, define: string): void;
  76612. /**
  76613. * Sets the mesh to use CPU skinning when needing to fallback.
  76614. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  76615. * @param mesh The mesh to use the fallbacks.
  76616. */
  76617. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  76618. /**
  76619. * Checks to see if more fallbacks are still availible.
  76620. */
  76621. readonly hasMoreFallbacks: boolean;
  76622. /**
  76623. * Removes the defines that should be removed when falling back.
  76624. * @param currentDefines defines the current define statements for the shader.
  76625. * @param effect defines the current effect we try to compile
  76626. * @returns The resulting defines with defines of the current rank removed.
  76627. */
  76628. reduce(currentDefines: string, effect: Effect): string;
  76629. }
  76630. }
  76631. declare module BABYLON {
  76632. /**
  76633. * "Static Class" containing the most commonly used helper while dealing with material for
  76634. * rendering purpose.
  76635. *
  76636. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  76637. *
  76638. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  76639. */
  76640. export class MaterialHelper {
  76641. /**
  76642. * Bind the current view position to an effect.
  76643. * @param effect The effect to be bound
  76644. * @param scene The scene the eyes position is used from
  76645. */
  76646. static BindEyePosition(effect: Effect, scene: Scene): void;
  76647. /**
  76648. * Helps preparing the defines values about the UVs in used in the effect.
  76649. * UVs are shared as much as we can accross channels in the shaders.
  76650. * @param texture The texture we are preparing the UVs for
  76651. * @param defines The defines to update
  76652. * @param key The channel key "diffuse", "specular"... used in the shader
  76653. */
  76654. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  76655. /**
  76656. * Binds a texture matrix value to its corrsponding uniform
  76657. * @param texture The texture to bind the matrix for
  76658. * @param uniformBuffer The uniform buffer receivin the data
  76659. * @param key The channel key "diffuse", "specular"... used in the shader
  76660. */
  76661. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  76662. /**
  76663. * Gets the current status of the fog (should it be enabled?)
  76664. * @param mesh defines the mesh to evaluate for fog support
  76665. * @param scene defines the hosting scene
  76666. * @returns true if fog must be enabled
  76667. */
  76668. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  76669. /**
  76670. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  76671. * @param mesh defines the current mesh
  76672. * @param scene defines the current scene
  76673. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  76674. * @param pointsCloud defines if point cloud rendering has to be turned on
  76675. * @param fogEnabled defines if fog has to be turned on
  76676. * @param alphaTest defines if alpha testing has to be turned on
  76677. * @param defines defines the current list of defines
  76678. */
  76679. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  76680. /**
  76681. * Helper used to prepare the list of defines associated with frame values for shader compilation
  76682. * @param scene defines the current scene
  76683. * @param engine defines the current engine
  76684. * @param defines specifies the list of active defines
  76685. * @param useInstances defines if instances have to be turned on
  76686. * @param useClipPlane defines if clip plane have to be turned on
  76687. */
  76688. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  76689. /**
  76690. * Prepares the defines for bones
  76691. * @param mesh The mesh containing the geometry data we will draw
  76692. * @param defines The defines to update
  76693. */
  76694. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  76695. /**
  76696. * Prepares the defines for morph targets
  76697. * @param mesh The mesh containing the geometry data we will draw
  76698. * @param defines The defines to update
  76699. */
  76700. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  76701. /**
  76702. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  76703. * @param mesh The mesh containing the geometry data we will draw
  76704. * @param defines The defines to update
  76705. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  76706. * @param useBones Precise whether bones should be used or not (override mesh info)
  76707. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  76708. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  76709. * @returns false if defines are considered not dirty and have not been checked
  76710. */
  76711. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  76712. /**
  76713. * Prepares the defines related to multiview
  76714. * @param scene The scene we are intending to draw
  76715. * @param defines The defines to update
  76716. */
  76717. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  76718. /**
  76719. * Prepares the defines related to the light information passed in parameter
  76720. * @param scene The scene we are intending to draw
  76721. * @param mesh The mesh the effect is compiling for
  76722. * @param light The light the effect is compiling for
  76723. * @param lightIndex The index of the light
  76724. * @param defines The defines to update
  76725. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  76726. * @param state Defines the current state regarding what is needed (normals, etc...)
  76727. */
  76728. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  76729. needNormals: boolean;
  76730. needRebuild: boolean;
  76731. shadowEnabled: boolean;
  76732. specularEnabled: boolean;
  76733. lightmapMode: boolean;
  76734. }): void;
  76735. /**
  76736. * Prepares the defines related to the light information passed in parameter
  76737. * @param scene The scene we are intending to draw
  76738. * @param mesh The mesh the effect is compiling for
  76739. * @param defines The defines to update
  76740. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  76741. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  76742. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  76743. * @returns true if normals will be required for the rest of the effect
  76744. */
  76745. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  76746. /**
  76747. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  76748. * @param lightIndex defines the light index
  76749. * @param uniformsList The uniform list
  76750. * @param samplersList The sampler list
  76751. * @param projectedLightTexture defines if projected texture must be used
  76752. * @param uniformBuffersList defines an optional list of uniform buffers
  76753. */
  76754. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  76755. /**
  76756. * Prepares the uniforms and samplers list to be used in the effect
  76757. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  76758. * @param samplersList The sampler list
  76759. * @param defines The defines helping in the list generation
  76760. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  76761. */
  76762. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  76763. /**
  76764. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  76765. * @param defines The defines to update while falling back
  76766. * @param fallbacks The authorized effect fallbacks
  76767. * @param maxSimultaneousLights The maximum number of lights allowed
  76768. * @param rank the current rank of the Effect
  76769. * @returns The newly affected rank
  76770. */
  76771. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  76772. private static _TmpMorphInfluencers;
  76773. /**
  76774. * Prepares the list of attributes required for morph targets according to the effect defines.
  76775. * @param attribs The current list of supported attribs
  76776. * @param mesh The mesh to prepare the morph targets attributes for
  76777. * @param influencers The number of influencers
  76778. */
  76779. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  76780. /**
  76781. * Prepares the list of attributes required for morph targets according to the effect defines.
  76782. * @param attribs The current list of supported attribs
  76783. * @param mesh The mesh to prepare the morph targets attributes for
  76784. * @param defines The current Defines of the effect
  76785. */
  76786. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  76787. /**
  76788. * Prepares the list of attributes required for bones according to the effect defines.
  76789. * @param attribs The current list of supported attribs
  76790. * @param mesh The mesh to prepare the bones attributes for
  76791. * @param defines The current Defines of the effect
  76792. * @param fallbacks The current efffect fallback strategy
  76793. */
  76794. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  76795. /**
  76796. * Check and prepare the list of attributes required for instances according to the effect defines.
  76797. * @param attribs The current list of supported attribs
  76798. * @param defines The current MaterialDefines of the effect
  76799. */
  76800. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  76801. /**
  76802. * Add the list of attributes required for instances to the attribs array.
  76803. * @param attribs The current list of supported attribs
  76804. */
  76805. static PushAttributesForInstances(attribs: string[]): void;
  76806. /**
  76807. * Binds the light information to the effect.
  76808. * @param light The light containing the generator
  76809. * @param effect The effect we are binding the data to
  76810. * @param lightIndex The light index in the effect used to render
  76811. */
  76812. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  76813. /**
  76814. * Binds the lights information from the scene to the effect for the given mesh.
  76815. * @param light Light to bind
  76816. * @param lightIndex Light index
  76817. * @param scene The scene where the light belongs to
  76818. * @param effect The effect we are binding the data to
  76819. * @param useSpecular Defines if specular is supported
  76820. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  76821. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  76822. */
  76823. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  76824. /**
  76825. * Binds the lights information from the scene to the effect for the given mesh.
  76826. * @param scene The scene the lights belongs to
  76827. * @param mesh The mesh we are binding the information to render
  76828. * @param effect The effect we are binding the data to
  76829. * @param defines The generated defines for the effect
  76830. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  76831. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  76832. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  76833. */
  76834. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  76835. private static _tempFogColor;
  76836. /**
  76837. * Binds the fog information from the scene to the effect for the given mesh.
  76838. * @param scene The scene the lights belongs to
  76839. * @param mesh The mesh we are binding the information to render
  76840. * @param effect The effect we are binding the data to
  76841. * @param linearSpace Defines if the fog effect is applied in linear space
  76842. */
  76843. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  76844. /**
  76845. * Binds the bones information from the mesh to the effect.
  76846. * @param mesh The mesh we are binding the information to render
  76847. * @param effect The effect we are binding the data to
  76848. */
  76849. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  76850. /**
  76851. * Binds the morph targets information from the mesh to the effect.
  76852. * @param abstractMesh The mesh we are binding the information to render
  76853. * @param effect The effect we are binding the data to
  76854. */
  76855. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  76856. /**
  76857. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  76858. * @param defines The generated defines used in the effect
  76859. * @param effect The effect we are binding the data to
  76860. * @param scene The scene we are willing to render with logarithmic scale for
  76861. */
  76862. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  76863. /**
  76864. * Binds the clip plane information from the scene to the effect.
  76865. * @param scene The scene the clip plane information are extracted from
  76866. * @param effect The effect we are binding the data to
  76867. */
  76868. static BindClipPlane(effect: Effect, scene: Scene): void;
  76869. }
  76870. }
  76871. declare module BABYLON {
  76872. /** @hidden */
  76873. export var packingFunctions: {
  76874. name: string;
  76875. shader: string;
  76876. };
  76877. }
  76878. declare module BABYLON {
  76879. /** @hidden */
  76880. export var shadowMapPixelShader: {
  76881. name: string;
  76882. shader: string;
  76883. };
  76884. }
  76885. declare module BABYLON {
  76886. /** @hidden */
  76887. export var bonesDeclaration: {
  76888. name: string;
  76889. shader: string;
  76890. };
  76891. }
  76892. declare module BABYLON {
  76893. /** @hidden */
  76894. export var morphTargetsVertexGlobalDeclaration: {
  76895. name: string;
  76896. shader: string;
  76897. };
  76898. }
  76899. declare module BABYLON {
  76900. /** @hidden */
  76901. export var morphTargetsVertexDeclaration: {
  76902. name: string;
  76903. shader: string;
  76904. };
  76905. }
  76906. declare module BABYLON {
  76907. /** @hidden */
  76908. export var instancesDeclaration: {
  76909. name: string;
  76910. shader: string;
  76911. };
  76912. }
  76913. declare module BABYLON {
  76914. /** @hidden */
  76915. export var helperFunctions: {
  76916. name: string;
  76917. shader: string;
  76918. };
  76919. }
  76920. declare module BABYLON {
  76921. /** @hidden */
  76922. export var morphTargetsVertex: {
  76923. name: string;
  76924. shader: string;
  76925. };
  76926. }
  76927. declare module BABYLON {
  76928. /** @hidden */
  76929. export var instancesVertex: {
  76930. name: string;
  76931. shader: string;
  76932. };
  76933. }
  76934. declare module BABYLON {
  76935. /** @hidden */
  76936. export var bonesVertex: {
  76937. name: string;
  76938. shader: string;
  76939. };
  76940. }
  76941. declare module BABYLON {
  76942. /** @hidden */
  76943. export var shadowMapVertexShader: {
  76944. name: string;
  76945. shader: string;
  76946. };
  76947. }
  76948. declare module BABYLON {
  76949. /** @hidden */
  76950. export var depthBoxBlurPixelShader: {
  76951. name: string;
  76952. shader: string;
  76953. };
  76954. }
  76955. declare module BABYLON {
  76956. /**
  76957. * Defines the options associated with the creation of a custom shader for a shadow generator.
  76958. */
  76959. export interface ICustomShaderOptions {
  76960. /**
  76961. * Gets or sets the custom shader name to use
  76962. */
  76963. shaderName: string;
  76964. /**
  76965. * The list of attribute names used in the shader
  76966. */
  76967. attributes?: string[];
  76968. /**
  76969. * The list of unifrom names used in the shader
  76970. */
  76971. uniforms?: string[];
  76972. /**
  76973. * The list of sampler names used in the shader
  76974. */
  76975. samplers?: string[];
  76976. /**
  76977. * The list of defines used in the shader
  76978. */
  76979. defines?: string[];
  76980. }
  76981. /**
  76982. * Interface to implement to create a shadow generator compatible with BJS.
  76983. */
  76984. export interface IShadowGenerator {
  76985. /**
  76986. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  76987. * @returns The render target texture if present otherwise, null
  76988. */
  76989. getShadowMap(): Nullable<RenderTargetTexture>;
  76990. /**
  76991. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  76992. * @returns The render target texture if the shadow map is present otherwise, null
  76993. */
  76994. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  76995. /**
  76996. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  76997. * @param subMesh The submesh we want to render in the shadow map
  76998. * @param useInstances Defines wether will draw in the map using instances
  76999. * @returns true if ready otherwise, false
  77000. */
  77001. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  77002. /**
  77003. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  77004. * @param defines Defines of the material we want to update
  77005. * @param lightIndex Index of the light in the enabled light list of the material
  77006. */
  77007. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  77008. /**
  77009. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  77010. * defined in the generator but impacting the effect).
  77011. * It implies the unifroms available on the materials are the standard BJS ones.
  77012. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  77013. * @param effect The effect we are binfing the information for
  77014. */
  77015. bindShadowLight(lightIndex: string, effect: Effect): void;
  77016. /**
  77017. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  77018. * (eq to shadow prjection matrix * light transform matrix)
  77019. * @returns The transform matrix used to create the shadow map
  77020. */
  77021. getTransformMatrix(): Matrix;
  77022. /**
  77023. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  77024. * Cube and 2D textures for instance.
  77025. */
  77026. recreateShadowMap(): void;
  77027. /**
  77028. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77029. * @param onCompiled Callback triggered at the and of the effects compilation
  77030. * @param options Sets of optional options forcing the compilation with different modes
  77031. */
  77032. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  77033. useInstances: boolean;
  77034. }>): void;
  77035. /**
  77036. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77037. * @param options Sets of optional options forcing the compilation with different modes
  77038. * @returns A promise that resolves when the compilation completes
  77039. */
  77040. forceCompilationAsync(options?: Partial<{
  77041. useInstances: boolean;
  77042. }>): Promise<void>;
  77043. /**
  77044. * Serializes the shadow generator setup to a json object.
  77045. * @returns The serialized JSON object
  77046. */
  77047. serialize(): any;
  77048. /**
  77049. * Disposes the Shadow map and related Textures and effects.
  77050. */
  77051. dispose(): void;
  77052. }
  77053. /**
  77054. * Default implementation IShadowGenerator.
  77055. * This is the main object responsible of generating shadows in the framework.
  77056. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  77057. */
  77058. export class ShadowGenerator implements IShadowGenerator {
  77059. /**
  77060. * Shadow generator mode None: no filtering applied.
  77061. */
  77062. static readonly FILTER_NONE: number;
  77063. /**
  77064. * Shadow generator mode ESM: Exponential Shadow Mapping.
  77065. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77066. */
  77067. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  77068. /**
  77069. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  77070. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  77071. */
  77072. static readonly FILTER_POISSONSAMPLING: number;
  77073. /**
  77074. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  77075. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77076. */
  77077. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  77078. /**
  77079. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  77080. * edge artifacts on steep falloff.
  77081. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77082. */
  77083. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  77084. /**
  77085. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  77086. * edge artifacts on steep falloff.
  77087. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77088. */
  77089. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  77090. /**
  77091. * Shadow generator mode PCF: Percentage Closer Filtering
  77092. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  77093. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  77094. */
  77095. static readonly FILTER_PCF: number;
  77096. /**
  77097. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  77098. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  77099. * Contact Hardening
  77100. */
  77101. static readonly FILTER_PCSS: number;
  77102. /**
  77103. * Reserved for PCF and PCSS
  77104. * Highest Quality.
  77105. *
  77106. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  77107. *
  77108. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  77109. */
  77110. static readonly QUALITY_HIGH: number;
  77111. /**
  77112. * Reserved for PCF and PCSS
  77113. * Good tradeoff for quality/perf cross devices
  77114. *
  77115. * Execute PCF on a 3*3 kernel.
  77116. *
  77117. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  77118. */
  77119. static readonly QUALITY_MEDIUM: number;
  77120. /**
  77121. * Reserved for PCF and PCSS
  77122. * The lowest quality but the fastest.
  77123. *
  77124. * Execute PCF on a 1*1 kernel.
  77125. *
  77126. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  77127. */
  77128. static readonly QUALITY_LOW: number;
  77129. /** Gets or sets the custom shader name to use */
  77130. customShaderOptions: ICustomShaderOptions;
  77131. /**
  77132. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  77133. */
  77134. onBeforeShadowMapRenderObservable: Observable<Effect>;
  77135. /**
  77136. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  77137. */
  77138. onAfterShadowMapRenderObservable: Observable<Effect>;
  77139. /**
  77140. * Observable triggered before a mesh is rendered in the shadow map.
  77141. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  77142. */
  77143. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  77144. /**
  77145. * Observable triggered after a mesh is rendered in the shadow map.
  77146. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  77147. */
  77148. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  77149. private _bias;
  77150. /**
  77151. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  77152. */
  77153. /**
  77154. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  77155. */
  77156. bias: number;
  77157. private _normalBias;
  77158. /**
  77159. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  77160. */
  77161. /**
  77162. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  77163. */
  77164. normalBias: number;
  77165. private _blurBoxOffset;
  77166. /**
  77167. * Gets the blur box offset: offset applied during the blur pass.
  77168. * Only useful if useKernelBlur = false
  77169. */
  77170. /**
  77171. * Sets the blur box offset: offset applied during the blur pass.
  77172. * Only useful if useKernelBlur = false
  77173. */
  77174. blurBoxOffset: number;
  77175. private _blurScale;
  77176. /**
  77177. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  77178. * 2 means half of the size.
  77179. */
  77180. /**
  77181. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  77182. * 2 means half of the size.
  77183. */
  77184. blurScale: number;
  77185. private _blurKernel;
  77186. /**
  77187. * Gets the blur kernel: kernel size of the blur pass.
  77188. * Only useful if useKernelBlur = true
  77189. */
  77190. /**
  77191. * Sets the blur kernel: kernel size of the blur pass.
  77192. * Only useful if useKernelBlur = true
  77193. */
  77194. blurKernel: number;
  77195. private _useKernelBlur;
  77196. /**
  77197. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  77198. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  77199. */
  77200. /**
  77201. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  77202. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  77203. */
  77204. useKernelBlur: boolean;
  77205. private _depthScale;
  77206. /**
  77207. * Gets the depth scale used in ESM mode.
  77208. */
  77209. /**
  77210. * Sets the depth scale used in ESM mode.
  77211. * This can override the scale stored on the light.
  77212. */
  77213. depthScale: number;
  77214. private _filter;
  77215. /**
  77216. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  77217. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  77218. */
  77219. /**
  77220. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  77221. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  77222. */
  77223. filter: number;
  77224. /**
  77225. * Gets if the current filter is set to Poisson Sampling.
  77226. */
  77227. /**
  77228. * Sets the current filter to Poisson Sampling.
  77229. */
  77230. usePoissonSampling: boolean;
  77231. /**
  77232. * Gets if the current filter is set to ESM.
  77233. */
  77234. /**
  77235. * Sets the current filter is to ESM.
  77236. */
  77237. useExponentialShadowMap: boolean;
  77238. /**
  77239. * Gets if the current filter is set to filtered ESM.
  77240. */
  77241. /**
  77242. * Gets if the current filter is set to filtered ESM.
  77243. */
  77244. useBlurExponentialShadowMap: boolean;
  77245. /**
  77246. * Gets if the current filter is set to "close ESM" (using the inverse of the
  77247. * exponential to prevent steep falloff artifacts).
  77248. */
  77249. /**
  77250. * Sets the current filter to "close ESM" (using the inverse of the
  77251. * exponential to prevent steep falloff artifacts).
  77252. */
  77253. useCloseExponentialShadowMap: boolean;
  77254. /**
  77255. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  77256. * exponential to prevent steep falloff artifacts).
  77257. */
  77258. /**
  77259. * Sets the current filter to filtered "close ESM" (using the inverse of the
  77260. * exponential to prevent steep falloff artifacts).
  77261. */
  77262. useBlurCloseExponentialShadowMap: boolean;
  77263. /**
  77264. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  77265. */
  77266. /**
  77267. * Sets the current filter to "PCF" (percentage closer filtering).
  77268. */
  77269. usePercentageCloserFiltering: boolean;
  77270. private _filteringQuality;
  77271. /**
  77272. * Gets the PCF or PCSS Quality.
  77273. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  77274. */
  77275. /**
  77276. * Sets the PCF or PCSS Quality.
  77277. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  77278. */
  77279. filteringQuality: number;
  77280. /**
  77281. * Gets if the current filter is set to "PCSS" (contact hardening).
  77282. */
  77283. /**
  77284. * Sets the current filter to "PCSS" (contact hardening).
  77285. */
  77286. useContactHardeningShadow: boolean;
  77287. private _contactHardeningLightSizeUVRatio;
  77288. /**
  77289. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  77290. * Using a ratio helps keeping shape stability independently of the map size.
  77291. *
  77292. * It does not account for the light projection as it was having too much
  77293. * instability during the light setup or during light position changes.
  77294. *
  77295. * Only valid if useContactHardeningShadow is true.
  77296. */
  77297. /**
  77298. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  77299. * Using a ratio helps keeping shape stability independently of the map size.
  77300. *
  77301. * It does not account for the light projection as it was having too much
  77302. * instability during the light setup or during light position changes.
  77303. *
  77304. * Only valid if useContactHardeningShadow is true.
  77305. */
  77306. contactHardeningLightSizeUVRatio: number;
  77307. private _darkness;
  77308. /** Gets or sets the actual darkness of a shadow */
  77309. darkness: number;
  77310. /**
  77311. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  77312. * 0 means strongest and 1 would means no shadow.
  77313. * @returns the darkness.
  77314. */
  77315. getDarkness(): number;
  77316. /**
  77317. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  77318. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  77319. * @returns the shadow generator allowing fluent coding.
  77320. */
  77321. setDarkness(darkness: number): ShadowGenerator;
  77322. private _transparencyShadow;
  77323. /** Gets or sets the ability to have transparent shadow */
  77324. transparencyShadow: boolean;
  77325. /**
  77326. * Sets the ability to have transparent shadow (boolean).
  77327. * @param transparent True if transparent else False
  77328. * @returns the shadow generator allowing fluent coding
  77329. */
  77330. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  77331. private _shadowMap;
  77332. private _shadowMap2;
  77333. /**
  77334. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  77335. * @returns The render target texture if present otherwise, null
  77336. */
  77337. getShadowMap(): Nullable<RenderTargetTexture>;
  77338. /**
  77339. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  77340. * @returns The render target texture if the shadow map is present otherwise, null
  77341. */
  77342. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  77343. /**
  77344. * Gets the class name of that object
  77345. * @returns "ShadowGenerator"
  77346. */
  77347. getClassName(): string;
  77348. /**
  77349. * Helper function to add a mesh and its descendants to the list of shadow casters.
  77350. * @param mesh Mesh to add
  77351. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  77352. * @returns the Shadow Generator itself
  77353. */
  77354. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  77355. /**
  77356. * Helper function to remove a mesh and its descendants from the list of shadow casters
  77357. * @param mesh Mesh to remove
  77358. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  77359. * @returns the Shadow Generator itself
  77360. */
  77361. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  77362. /**
  77363. * Controls the extent to which the shadows fade out at the edge of the frustum
  77364. * Used only by directionals and spots
  77365. */
  77366. frustumEdgeFalloff: number;
  77367. private _light;
  77368. /**
  77369. * Returns the associated light object.
  77370. * @returns the light generating the shadow
  77371. */
  77372. getLight(): IShadowLight;
  77373. /**
  77374. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  77375. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  77376. * It might on the other hand introduce peter panning.
  77377. */
  77378. forceBackFacesOnly: boolean;
  77379. private _scene;
  77380. private _lightDirection;
  77381. private _effect;
  77382. private _viewMatrix;
  77383. private _projectionMatrix;
  77384. private _transformMatrix;
  77385. private _cachedPosition;
  77386. private _cachedDirection;
  77387. private _cachedDefines;
  77388. private _currentRenderID;
  77389. private _boxBlurPostprocess;
  77390. private _kernelBlurXPostprocess;
  77391. private _kernelBlurYPostprocess;
  77392. private _blurPostProcesses;
  77393. private _mapSize;
  77394. private _currentFaceIndex;
  77395. private _currentFaceIndexCache;
  77396. private _textureType;
  77397. private _defaultTextureMatrix;
  77398. private _storedUniqueId;
  77399. /** @hidden */
  77400. static _SceneComponentInitialization: (scene: Scene) => void;
  77401. /**
  77402. * Creates a ShadowGenerator object.
  77403. * A ShadowGenerator is the required tool to use the shadows.
  77404. * Each light casting shadows needs to use its own ShadowGenerator.
  77405. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  77406. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  77407. * @param light The light object generating the shadows.
  77408. * @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.
  77409. */
  77410. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  77411. private _initializeGenerator;
  77412. private _initializeShadowMap;
  77413. private _initializeBlurRTTAndPostProcesses;
  77414. private _renderForShadowMap;
  77415. private _renderSubMeshForShadowMap;
  77416. private _applyFilterValues;
  77417. /**
  77418. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77419. * @param onCompiled Callback triggered at the and of the effects compilation
  77420. * @param options Sets of optional options forcing the compilation with different modes
  77421. */
  77422. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  77423. useInstances: boolean;
  77424. }>): void;
  77425. /**
  77426. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77427. * @param options Sets of optional options forcing the compilation with different modes
  77428. * @returns A promise that resolves when the compilation completes
  77429. */
  77430. forceCompilationAsync(options?: Partial<{
  77431. useInstances: boolean;
  77432. }>): Promise<void>;
  77433. /**
  77434. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  77435. * @param subMesh The submesh we want to render in the shadow map
  77436. * @param useInstances Defines wether will draw in the map using instances
  77437. * @returns true if ready otherwise, false
  77438. */
  77439. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  77440. /**
  77441. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  77442. * @param defines Defines of the material we want to update
  77443. * @param lightIndex Index of the light in the enabled light list of the material
  77444. */
  77445. prepareDefines(defines: any, lightIndex: number): void;
  77446. /**
  77447. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  77448. * defined in the generator but impacting the effect).
  77449. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  77450. * @param effect The effect we are binfing the information for
  77451. */
  77452. bindShadowLight(lightIndex: string, effect: Effect): void;
  77453. /**
  77454. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  77455. * (eq to shadow prjection matrix * light transform matrix)
  77456. * @returns The transform matrix used to create the shadow map
  77457. */
  77458. getTransformMatrix(): Matrix;
  77459. /**
  77460. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  77461. * Cube and 2D textures for instance.
  77462. */
  77463. recreateShadowMap(): void;
  77464. private _disposeBlurPostProcesses;
  77465. private _disposeRTTandPostProcesses;
  77466. /**
  77467. * Disposes the ShadowGenerator.
  77468. * Returns nothing.
  77469. */
  77470. dispose(): void;
  77471. /**
  77472. * Serializes the shadow generator setup to a json object.
  77473. * @returns The serialized JSON object
  77474. */
  77475. serialize(): any;
  77476. /**
  77477. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  77478. * @param parsedShadowGenerator The JSON object to parse
  77479. * @param scene The scene to create the shadow map for
  77480. * @returns The parsed shadow generator
  77481. */
  77482. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  77483. }
  77484. }
  77485. declare module BABYLON {
  77486. /**
  77487. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  77488. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  77489. * 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.
  77490. */
  77491. export abstract class Light extends Node {
  77492. /**
  77493. * Falloff Default: light is falling off following the material specification:
  77494. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  77495. */
  77496. static readonly FALLOFF_DEFAULT: number;
  77497. /**
  77498. * Falloff Physical: light is falling off following the inverse squared distance law.
  77499. */
  77500. static readonly FALLOFF_PHYSICAL: number;
  77501. /**
  77502. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  77503. * to enhance interoperability with other engines.
  77504. */
  77505. static readonly FALLOFF_GLTF: number;
  77506. /**
  77507. * Falloff Standard: light is falling off like in the standard material
  77508. * to enhance interoperability with other materials.
  77509. */
  77510. static readonly FALLOFF_STANDARD: number;
  77511. /**
  77512. * If every light affecting the material is in this lightmapMode,
  77513. * material.lightmapTexture adds or multiplies
  77514. * (depends on material.useLightmapAsShadowmap)
  77515. * after every other light calculations.
  77516. */
  77517. static readonly LIGHTMAP_DEFAULT: number;
  77518. /**
  77519. * material.lightmapTexture as only diffuse lighting from this light
  77520. * adds only specular lighting from this light
  77521. * adds dynamic shadows
  77522. */
  77523. static readonly LIGHTMAP_SPECULAR: number;
  77524. /**
  77525. * material.lightmapTexture as only lighting
  77526. * no light calculation from this light
  77527. * only adds dynamic shadows from this light
  77528. */
  77529. static readonly LIGHTMAP_SHADOWSONLY: number;
  77530. /**
  77531. * Each light type uses the default quantity according to its type:
  77532. * point/spot lights use luminous intensity
  77533. * directional lights use illuminance
  77534. */
  77535. static readonly INTENSITYMODE_AUTOMATIC: number;
  77536. /**
  77537. * lumen (lm)
  77538. */
  77539. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  77540. /**
  77541. * candela (lm/sr)
  77542. */
  77543. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  77544. /**
  77545. * lux (lm/m^2)
  77546. */
  77547. static readonly INTENSITYMODE_ILLUMINANCE: number;
  77548. /**
  77549. * nit (cd/m^2)
  77550. */
  77551. static readonly INTENSITYMODE_LUMINANCE: number;
  77552. /**
  77553. * Light type const id of the point light.
  77554. */
  77555. static readonly LIGHTTYPEID_POINTLIGHT: number;
  77556. /**
  77557. * Light type const id of the directional light.
  77558. */
  77559. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  77560. /**
  77561. * Light type const id of the spot light.
  77562. */
  77563. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  77564. /**
  77565. * Light type const id of the hemispheric light.
  77566. */
  77567. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  77568. /**
  77569. * Diffuse gives the basic color to an object.
  77570. */
  77571. diffuse: Color3;
  77572. /**
  77573. * Specular produces a highlight color on an object.
  77574. * Note: This is note affecting PBR materials.
  77575. */
  77576. specular: Color3;
  77577. /**
  77578. * Defines the falloff type for this light. This lets overrriding how punctual light are
  77579. * falling off base on range or angle.
  77580. * This can be set to any values in Light.FALLOFF_x.
  77581. *
  77582. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  77583. * other types of materials.
  77584. */
  77585. falloffType: number;
  77586. /**
  77587. * Strength of the light.
  77588. * Note: By default it is define in the framework own unit.
  77589. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  77590. */
  77591. intensity: number;
  77592. private _range;
  77593. protected _inverseSquaredRange: number;
  77594. /**
  77595. * Defines how far from the source the light is impacting in scene units.
  77596. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  77597. */
  77598. /**
  77599. * Defines how far from the source the light is impacting in scene units.
  77600. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  77601. */
  77602. range: number;
  77603. /**
  77604. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  77605. * of light.
  77606. */
  77607. private _photometricScale;
  77608. private _intensityMode;
  77609. /**
  77610. * Gets the photometric scale used to interpret the intensity.
  77611. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  77612. */
  77613. /**
  77614. * Sets the photometric scale used to interpret the intensity.
  77615. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  77616. */
  77617. intensityMode: number;
  77618. private _radius;
  77619. /**
  77620. * Gets the light radius used by PBR Materials to simulate soft area lights.
  77621. */
  77622. /**
  77623. * sets the light radius used by PBR Materials to simulate soft area lights.
  77624. */
  77625. radius: number;
  77626. private _renderPriority;
  77627. /**
  77628. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  77629. * exceeding the number allowed of the materials.
  77630. */
  77631. renderPriority: number;
  77632. private _shadowEnabled;
  77633. /**
  77634. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  77635. * the current shadow generator.
  77636. */
  77637. /**
  77638. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  77639. * the current shadow generator.
  77640. */
  77641. shadowEnabled: boolean;
  77642. private _includedOnlyMeshes;
  77643. /**
  77644. * Gets the only meshes impacted by this light.
  77645. */
  77646. /**
  77647. * Sets the only meshes impacted by this light.
  77648. */
  77649. includedOnlyMeshes: AbstractMesh[];
  77650. private _excludedMeshes;
  77651. /**
  77652. * Gets the meshes not impacted by this light.
  77653. */
  77654. /**
  77655. * Sets the meshes not impacted by this light.
  77656. */
  77657. excludedMeshes: AbstractMesh[];
  77658. private _excludeWithLayerMask;
  77659. /**
  77660. * Gets the layer id use to find what meshes are not impacted by the light.
  77661. * Inactive if 0
  77662. */
  77663. /**
  77664. * Sets the layer id use to find what meshes are not impacted by the light.
  77665. * Inactive if 0
  77666. */
  77667. excludeWithLayerMask: number;
  77668. private _includeOnlyWithLayerMask;
  77669. /**
  77670. * Gets the layer id use to find what meshes are impacted by the light.
  77671. * Inactive if 0
  77672. */
  77673. /**
  77674. * Sets the layer id use to find what meshes are impacted by the light.
  77675. * Inactive if 0
  77676. */
  77677. includeOnlyWithLayerMask: number;
  77678. private _lightmapMode;
  77679. /**
  77680. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  77681. */
  77682. /**
  77683. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  77684. */
  77685. lightmapMode: number;
  77686. /**
  77687. * Shadow generator associted to the light.
  77688. * @hidden Internal use only.
  77689. */
  77690. _shadowGenerator: Nullable<IShadowGenerator>;
  77691. /**
  77692. * @hidden Internal use only.
  77693. */
  77694. _excludedMeshesIds: string[];
  77695. /**
  77696. * @hidden Internal use only.
  77697. */
  77698. _includedOnlyMeshesIds: string[];
  77699. /**
  77700. * The current light unifom buffer.
  77701. * @hidden Internal use only.
  77702. */
  77703. _uniformBuffer: UniformBuffer;
  77704. /** @hidden */
  77705. _renderId: number;
  77706. /**
  77707. * Creates a Light object in the scene.
  77708. * Documentation : https://doc.babylonjs.com/babylon101/lights
  77709. * @param name The firendly name of the light
  77710. * @param scene The scene the light belongs too
  77711. */
  77712. constructor(name: string, scene: Scene);
  77713. protected abstract _buildUniformLayout(): void;
  77714. /**
  77715. * Sets the passed Effect "effect" with the Light information.
  77716. * @param effect The effect to update
  77717. * @param lightIndex The index of the light in the effect to update
  77718. * @returns The light
  77719. */
  77720. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  77721. /**
  77722. * Sets the passed Effect "effect" with the Light information.
  77723. * @param effect The effect to update
  77724. * @param lightDataUniformName The uniform used to store light data (position or direction)
  77725. * @returns The light
  77726. */
  77727. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  77728. /**
  77729. * Returns the string "Light".
  77730. * @returns the class name
  77731. */
  77732. getClassName(): string;
  77733. /** @hidden */
  77734. readonly _isLight: boolean;
  77735. /**
  77736. * Converts the light information to a readable string for debug purpose.
  77737. * @param fullDetails Supports for multiple levels of logging within scene loading
  77738. * @returns the human readable light info
  77739. */
  77740. toString(fullDetails?: boolean): string;
  77741. /** @hidden */
  77742. protected _syncParentEnabledState(): void;
  77743. /**
  77744. * Set the enabled state of this node.
  77745. * @param value - the new enabled state
  77746. */
  77747. setEnabled(value: boolean): void;
  77748. /**
  77749. * Returns the Light associated shadow generator if any.
  77750. * @return the associated shadow generator.
  77751. */
  77752. getShadowGenerator(): Nullable<IShadowGenerator>;
  77753. /**
  77754. * Returns a Vector3, the absolute light position in the World.
  77755. * @returns the world space position of the light
  77756. */
  77757. getAbsolutePosition(): Vector3;
  77758. /**
  77759. * Specifies if the light will affect the passed mesh.
  77760. * @param mesh The mesh to test against the light
  77761. * @return true the mesh is affected otherwise, false.
  77762. */
  77763. canAffectMesh(mesh: AbstractMesh): boolean;
  77764. /**
  77765. * Sort function to order lights for rendering.
  77766. * @param a First Light object to compare to second.
  77767. * @param b Second Light object to compare first.
  77768. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  77769. */
  77770. static CompareLightsPriority(a: Light, b: Light): number;
  77771. /**
  77772. * Releases resources associated with this node.
  77773. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  77774. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  77775. */
  77776. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  77777. /**
  77778. * Returns the light type ID (integer).
  77779. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  77780. */
  77781. getTypeID(): number;
  77782. /**
  77783. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  77784. * @returns the scaled intensity in intensity mode unit
  77785. */
  77786. getScaledIntensity(): number;
  77787. /**
  77788. * Returns a new Light object, named "name", from the current one.
  77789. * @param name The name of the cloned light
  77790. * @returns the new created light
  77791. */
  77792. clone(name: string): Nullable<Light>;
  77793. /**
  77794. * Serializes the current light into a Serialization object.
  77795. * @returns the serialized object.
  77796. */
  77797. serialize(): any;
  77798. /**
  77799. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  77800. * This new light is named "name" and added to the passed scene.
  77801. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  77802. * @param name The friendly name of the light
  77803. * @param scene The scene the new light will belong to
  77804. * @returns the constructor function
  77805. */
  77806. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  77807. /**
  77808. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  77809. * @param parsedLight The JSON representation of the light
  77810. * @param scene The scene to create the parsed light in
  77811. * @returns the created light after parsing
  77812. */
  77813. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  77814. private _hookArrayForExcluded;
  77815. private _hookArrayForIncludedOnly;
  77816. private _resyncMeshes;
  77817. /**
  77818. * Forces the meshes to update their light related information in their rendering used effects
  77819. * @hidden Internal Use Only
  77820. */
  77821. _markMeshesAsLightDirty(): void;
  77822. /**
  77823. * Recomputes the cached photometric scale if needed.
  77824. */
  77825. private _computePhotometricScale;
  77826. /**
  77827. * Returns the Photometric Scale according to the light type and intensity mode.
  77828. */
  77829. private _getPhotometricScale;
  77830. /**
  77831. * Reorder the light in the scene according to their defined priority.
  77832. * @hidden Internal Use Only
  77833. */
  77834. _reorderLightsInScene(): void;
  77835. /**
  77836. * Prepares the list of defines specific to the light type.
  77837. * @param defines the list of defines
  77838. * @param lightIndex defines the index of the light for the effect
  77839. */
  77840. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  77841. }
  77842. }
  77843. declare module BABYLON {
  77844. /**
  77845. * Interface used to define Action
  77846. */
  77847. export interface IAction {
  77848. /**
  77849. * Trigger for the action
  77850. */
  77851. trigger: number;
  77852. /** Options of the trigger */
  77853. triggerOptions: any;
  77854. /**
  77855. * Gets the trigger parameters
  77856. * @returns the trigger parameters
  77857. */
  77858. getTriggerParameter(): any;
  77859. /**
  77860. * Internal only - executes current action event
  77861. * @hidden
  77862. */
  77863. _executeCurrent(evt?: ActionEvent): void;
  77864. /**
  77865. * Serialize placeholder for child classes
  77866. * @param parent of child
  77867. * @returns the serialized object
  77868. */
  77869. serialize(parent: any): any;
  77870. /**
  77871. * Internal only
  77872. * @hidden
  77873. */
  77874. _prepare(): void;
  77875. /**
  77876. * Internal only - manager for action
  77877. * @hidden
  77878. */
  77879. _actionManager: AbstractActionManager;
  77880. /**
  77881. * Adds action to chain of actions, may be a DoNothingAction
  77882. * @param action defines the next action to execute
  77883. * @returns The action passed in
  77884. * @see https://www.babylonjs-playground.com/#1T30HR#0
  77885. */
  77886. then(action: IAction): IAction;
  77887. }
  77888. /**
  77889. * The action to be carried out following a trigger
  77890. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  77891. */
  77892. export class Action implements IAction {
  77893. /** the trigger, with or without parameters, for the action */
  77894. triggerOptions: any;
  77895. /**
  77896. * Trigger for the action
  77897. */
  77898. trigger: number;
  77899. /**
  77900. * Internal only - manager for action
  77901. * @hidden
  77902. */
  77903. _actionManager: ActionManager;
  77904. private _nextActiveAction;
  77905. private _child;
  77906. private _condition?;
  77907. private _triggerParameter;
  77908. /**
  77909. * An event triggered prior to action being executed.
  77910. */
  77911. onBeforeExecuteObservable: Observable<Action>;
  77912. /**
  77913. * Creates a new Action
  77914. * @param triggerOptions the trigger, with or without parameters, for the action
  77915. * @param condition an optional determinant of action
  77916. */
  77917. constructor(
  77918. /** the trigger, with or without parameters, for the action */
  77919. triggerOptions: any, condition?: Condition);
  77920. /**
  77921. * Internal only
  77922. * @hidden
  77923. */
  77924. _prepare(): void;
  77925. /**
  77926. * Gets the trigger parameters
  77927. * @returns the trigger parameters
  77928. */
  77929. getTriggerParameter(): any;
  77930. /**
  77931. * Internal only - executes current action event
  77932. * @hidden
  77933. */
  77934. _executeCurrent(evt?: ActionEvent): void;
  77935. /**
  77936. * Execute placeholder for child classes
  77937. * @param evt optional action event
  77938. */
  77939. execute(evt?: ActionEvent): void;
  77940. /**
  77941. * Skips to next active action
  77942. */
  77943. skipToNextActiveAction(): void;
  77944. /**
  77945. * Adds action to chain of actions, may be a DoNothingAction
  77946. * @param action defines the next action to execute
  77947. * @returns The action passed in
  77948. * @see https://www.babylonjs-playground.com/#1T30HR#0
  77949. */
  77950. then(action: Action): Action;
  77951. /**
  77952. * Internal only
  77953. * @hidden
  77954. */
  77955. _getProperty(propertyPath: string): string;
  77956. /**
  77957. * Internal only
  77958. * @hidden
  77959. */
  77960. _getEffectiveTarget(target: any, propertyPath: string): any;
  77961. /**
  77962. * Serialize placeholder for child classes
  77963. * @param parent of child
  77964. * @returns the serialized object
  77965. */
  77966. serialize(parent: any): any;
  77967. /**
  77968. * Internal only called by serialize
  77969. * @hidden
  77970. */
  77971. protected _serialize(serializedAction: any, parent?: any): any;
  77972. /**
  77973. * Internal only
  77974. * @hidden
  77975. */
  77976. static _SerializeValueAsString: (value: any) => string;
  77977. /**
  77978. * Internal only
  77979. * @hidden
  77980. */
  77981. static _GetTargetProperty: (target: Node | Scene) => {
  77982. name: string;
  77983. targetType: string;
  77984. value: string;
  77985. };
  77986. }
  77987. }
  77988. declare module BABYLON {
  77989. /**
  77990. * A Condition applied to an Action
  77991. */
  77992. export class Condition {
  77993. /**
  77994. * Internal only - manager for action
  77995. * @hidden
  77996. */
  77997. _actionManager: ActionManager;
  77998. /**
  77999. * Internal only
  78000. * @hidden
  78001. */
  78002. _evaluationId: number;
  78003. /**
  78004. * Internal only
  78005. * @hidden
  78006. */
  78007. _currentResult: boolean;
  78008. /**
  78009. * Creates a new Condition
  78010. * @param actionManager the manager of the action the condition is applied to
  78011. */
  78012. constructor(actionManager: ActionManager);
  78013. /**
  78014. * Check if the current condition is valid
  78015. * @returns a boolean
  78016. */
  78017. isValid(): boolean;
  78018. /**
  78019. * Internal only
  78020. * @hidden
  78021. */
  78022. _getProperty(propertyPath: string): string;
  78023. /**
  78024. * Internal only
  78025. * @hidden
  78026. */
  78027. _getEffectiveTarget(target: any, propertyPath: string): any;
  78028. /**
  78029. * Serialize placeholder for child classes
  78030. * @returns the serialized object
  78031. */
  78032. serialize(): any;
  78033. /**
  78034. * Internal only
  78035. * @hidden
  78036. */
  78037. protected _serialize(serializedCondition: any): any;
  78038. }
  78039. /**
  78040. * Defines specific conditional operators as extensions of Condition
  78041. */
  78042. export class ValueCondition extends Condition {
  78043. /** path to specify the property of the target the conditional operator uses */
  78044. propertyPath: string;
  78045. /** the value compared by the conditional operator against the current value of the property */
  78046. value: any;
  78047. /** the conditional operator, default ValueCondition.IsEqual */
  78048. operator: number;
  78049. /**
  78050. * Internal only
  78051. * @hidden
  78052. */
  78053. private static _IsEqual;
  78054. /**
  78055. * Internal only
  78056. * @hidden
  78057. */
  78058. private static _IsDifferent;
  78059. /**
  78060. * Internal only
  78061. * @hidden
  78062. */
  78063. private static _IsGreater;
  78064. /**
  78065. * Internal only
  78066. * @hidden
  78067. */
  78068. private static _IsLesser;
  78069. /**
  78070. * returns the number for IsEqual
  78071. */
  78072. static readonly IsEqual: number;
  78073. /**
  78074. * Returns the number for IsDifferent
  78075. */
  78076. static readonly IsDifferent: number;
  78077. /**
  78078. * Returns the number for IsGreater
  78079. */
  78080. static readonly IsGreater: number;
  78081. /**
  78082. * Returns the number for IsLesser
  78083. */
  78084. static readonly IsLesser: number;
  78085. /**
  78086. * Internal only The action manager for the condition
  78087. * @hidden
  78088. */
  78089. _actionManager: ActionManager;
  78090. /**
  78091. * Internal only
  78092. * @hidden
  78093. */
  78094. private _target;
  78095. /**
  78096. * Internal only
  78097. * @hidden
  78098. */
  78099. private _effectiveTarget;
  78100. /**
  78101. * Internal only
  78102. * @hidden
  78103. */
  78104. private _property;
  78105. /**
  78106. * Creates a new ValueCondition
  78107. * @param actionManager manager for the action the condition applies to
  78108. * @param target for the action
  78109. * @param propertyPath path to specify the property of the target the conditional operator uses
  78110. * @param value the value compared by the conditional operator against the current value of the property
  78111. * @param operator the conditional operator, default ValueCondition.IsEqual
  78112. */
  78113. constructor(actionManager: ActionManager, target: any,
  78114. /** path to specify the property of the target the conditional operator uses */
  78115. propertyPath: string,
  78116. /** the value compared by the conditional operator against the current value of the property */
  78117. value: any,
  78118. /** the conditional operator, default ValueCondition.IsEqual */
  78119. operator?: number);
  78120. /**
  78121. * Compares the given value with the property value for the specified conditional operator
  78122. * @returns the result of the comparison
  78123. */
  78124. isValid(): boolean;
  78125. /**
  78126. * Serialize the ValueCondition into a JSON compatible object
  78127. * @returns serialization object
  78128. */
  78129. serialize(): any;
  78130. /**
  78131. * Gets the name of the conditional operator for the ValueCondition
  78132. * @param operator the conditional operator
  78133. * @returns the name
  78134. */
  78135. static GetOperatorName(operator: number): string;
  78136. }
  78137. /**
  78138. * Defines a predicate condition as an extension of Condition
  78139. */
  78140. export class PredicateCondition extends Condition {
  78141. /** defines the predicate function used to validate the condition */
  78142. predicate: () => boolean;
  78143. /**
  78144. * Internal only - manager for action
  78145. * @hidden
  78146. */
  78147. _actionManager: ActionManager;
  78148. /**
  78149. * Creates a new PredicateCondition
  78150. * @param actionManager manager for the action the condition applies to
  78151. * @param predicate defines the predicate function used to validate the condition
  78152. */
  78153. constructor(actionManager: ActionManager,
  78154. /** defines the predicate function used to validate the condition */
  78155. predicate: () => boolean);
  78156. /**
  78157. * @returns the validity of the predicate condition
  78158. */
  78159. isValid(): boolean;
  78160. }
  78161. /**
  78162. * Defines a state condition as an extension of Condition
  78163. */
  78164. export class StateCondition extends Condition {
  78165. /** Value to compare with target state */
  78166. value: string;
  78167. /**
  78168. * Internal only - manager for action
  78169. * @hidden
  78170. */
  78171. _actionManager: ActionManager;
  78172. /**
  78173. * Internal only
  78174. * @hidden
  78175. */
  78176. private _target;
  78177. /**
  78178. * Creates a new StateCondition
  78179. * @param actionManager manager for the action the condition applies to
  78180. * @param target of the condition
  78181. * @param value to compare with target state
  78182. */
  78183. constructor(actionManager: ActionManager, target: any,
  78184. /** Value to compare with target state */
  78185. value: string);
  78186. /**
  78187. * Gets a boolean indicating if the current condition is met
  78188. * @returns the validity of the state
  78189. */
  78190. isValid(): boolean;
  78191. /**
  78192. * Serialize the StateCondition into a JSON compatible object
  78193. * @returns serialization object
  78194. */
  78195. serialize(): any;
  78196. }
  78197. }
  78198. declare module BABYLON {
  78199. /**
  78200. * This defines an action responsible to toggle a boolean once triggered.
  78201. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78202. */
  78203. export class SwitchBooleanAction extends Action {
  78204. /**
  78205. * The path to the boolean property in the target object
  78206. */
  78207. propertyPath: string;
  78208. private _target;
  78209. private _effectiveTarget;
  78210. private _property;
  78211. /**
  78212. * Instantiate the action
  78213. * @param triggerOptions defines the trigger options
  78214. * @param target defines the object containing the boolean
  78215. * @param propertyPath defines the path to the boolean property in the target object
  78216. * @param condition defines the trigger related conditions
  78217. */
  78218. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  78219. /** @hidden */
  78220. _prepare(): void;
  78221. /**
  78222. * Execute the action toggle the boolean value.
  78223. */
  78224. execute(): void;
  78225. /**
  78226. * Serializes the actions and its related information.
  78227. * @param parent defines the object to serialize in
  78228. * @returns the serialized object
  78229. */
  78230. serialize(parent: any): any;
  78231. }
  78232. /**
  78233. * This defines an action responsible to set a the state field of the target
  78234. * to a desired value once triggered.
  78235. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78236. */
  78237. export class SetStateAction extends Action {
  78238. /**
  78239. * The value to store in the state field.
  78240. */
  78241. value: string;
  78242. private _target;
  78243. /**
  78244. * Instantiate the action
  78245. * @param triggerOptions defines the trigger options
  78246. * @param target defines the object containing the state property
  78247. * @param value defines the value to store in the state field
  78248. * @param condition defines the trigger related conditions
  78249. */
  78250. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  78251. /**
  78252. * Execute the action and store the value on the target state property.
  78253. */
  78254. execute(): void;
  78255. /**
  78256. * Serializes the actions and its related information.
  78257. * @param parent defines the object to serialize in
  78258. * @returns the serialized object
  78259. */
  78260. serialize(parent: any): any;
  78261. }
  78262. /**
  78263. * This defines an action responsible to set a property of the target
  78264. * to a desired value once triggered.
  78265. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78266. */
  78267. export class SetValueAction extends Action {
  78268. /**
  78269. * The path of the property to set in the target.
  78270. */
  78271. propertyPath: string;
  78272. /**
  78273. * The value to set in the property
  78274. */
  78275. value: any;
  78276. private _target;
  78277. private _effectiveTarget;
  78278. private _property;
  78279. /**
  78280. * Instantiate the action
  78281. * @param triggerOptions defines the trigger options
  78282. * @param target defines the object containing the property
  78283. * @param propertyPath defines the path of the property to set in the target
  78284. * @param value defines the value to set in the property
  78285. * @param condition defines the trigger related conditions
  78286. */
  78287. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  78288. /** @hidden */
  78289. _prepare(): void;
  78290. /**
  78291. * Execute the action and set the targetted property to the desired value.
  78292. */
  78293. execute(): void;
  78294. /**
  78295. * Serializes the actions and its related information.
  78296. * @param parent defines the object to serialize in
  78297. * @returns the serialized object
  78298. */
  78299. serialize(parent: any): any;
  78300. }
  78301. /**
  78302. * This defines an action responsible to increment the target value
  78303. * to a desired value once triggered.
  78304. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78305. */
  78306. export class IncrementValueAction extends Action {
  78307. /**
  78308. * The path of the property to increment in the target.
  78309. */
  78310. propertyPath: string;
  78311. /**
  78312. * The value we should increment the property by.
  78313. */
  78314. value: any;
  78315. private _target;
  78316. private _effectiveTarget;
  78317. private _property;
  78318. /**
  78319. * Instantiate the action
  78320. * @param triggerOptions defines the trigger options
  78321. * @param target defines the object containing the property
  78322. * @param propertyPath defines the path of the property to increment in the target
  78323. * @param value defines the value value we should increment the property by
  78324. * @param condition defines the trigger related conditions
  78325. */
  78326. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  78327. /** @hidden */
  78328. _prepare(): void;
  78329. /**
  78330. * Execute the action and increment the target of the value amount.
  78331. */
  78332. execute(): void;
  78333. /**
  78334. * Serializes the actions and its related information.
  78335. * @param parent defines the object to serialize in
  78336. * @returns the serialized object
  78337. */
  78338. serialize(parent: any): any;
  78339. }
  78340. /**
  78341. * This defines an action responsible to start an animation once triggered.
  78342. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78343. */
  78344. export class PlayAnimationAction extends Action {
  78345. /**
  78346. * Where the animation should start (animation frame)
  78347. */
  78348. from: number;
  78349. /**
  78350. * Where the animation should stop (animation frame)
  78351. */
  78352. to: number;
  78353. /**
  78354. * Define if the animation should loop or stop after the first play.
  78355. */
  78356. loop?: boolean;
  78357. private _target;
  78358. /**
  78359. * Instantiate the action
  78360. * @param triggerOptions defines the trigger options
  78361. * @param target defines the target animation or animation name
  78362. * @param from defines from where the animation should start (animation frame)
  78363. * @param end defines where the animation should stop (animation frame)
  78364. * @param loop defines if the animation should loop or stop after the first play
  78365. * @param condition defines the trigger related conditions
  78366. */
  78367. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  78368. /** @hidden */
  78369. _prepare(): void;
  78370. /**
  78371. * Execute the action and play the animation.
  78372. */
  78373. execute(): void;
  78374. /**
  78375. * Serializes the actions and its related information.
  78376. * @param parent defines the object to serialize in
  78377. * @returns the serialized object
  78378. */
  78379. serialize(parent: any): any;
  78380. }
  78381. /**
  78382. * This defines an action responsible to stop an animation once triggered.
  78383. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78384. */
  78385. export class StopAnimationAction extends Action {
  78386. private _target;
  78387. /**
  78388. * Instantiate the action
  78389. * @param triggerOptions defines the trigger options
  78390. * @param target defines the target animation or animation name
  78391. * @param condition defines the trigger related conditions
  78392. */
  78393. constructor(triggerOptions: any, target: any, condition?: Condition);
  78394. /** @hidden */
  78395. _prepare(): void;
  78396. /**
  78397. * Execute the action and stop the animation.
  78398. */
  78399. execute(): void;
  78400. /**
  78401. * Serializes the actions and its related information.
  78402. * @param parent defines the object to serialize in
  78403. * @returns the serialized object
  78404. */
  78405. serialize(parent: any): any;
  78406. }
  78407. /**
  78408. * This defines an action responsible that does nothing once triggered.
  78409. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78410. */
  78411. export class DoNothingAction extends Action {
  78412. /**
  78413. * Instantiate the action
  78414. * @param triggerOptions defines the trigger options
  78415. * @param condition defines the trigger related conditions
  78416. */
  78417. constructor(triggerOptions?: any, condition?: Condition);
  78418. /**
  78419. * Execute the action and do nothing.
  78420. */
  78421. execute(): void;
  78422. /**
  78423. * Serializes the actions and its related information.
  78424. * @param parent defines the object to serialize in
  78425. * @returns the serialized object
  78426. */
  78427. serialize(parent: any): any;
  78428. }
  78429. /**
  78430. * This defines an action responsible to trigger several actions once triggered.
  78431. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78432. */
  78433. export class CombineAction extends Action {
  78434. /**
  78435. * The list of aggregated animations to run.
  78436. */
  78437. children: Action[];
  78438. /**
  78439. * Instantiate the action
  78440. * @param triggerOptions defines the trigger options
  78441. * @param children defines the list of aggregated animations to run
  78442. * @param condition defines the trigger related conditions
  78443. */
  78444. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  78445. /** @hidden */
  78446. _prepare(): void;
  78447. /**
  78448. * Execute the action and executes all the aggregated actions.
  78449. */
  78450. execute(evt: ActionEvent): void;
  78451. /**
  78452. * Serializes the actions and its related information.
  78453. * @param parent defines the object to serialize in
  78454. * @returns the serialized object
  78455. */
  78456. serialize(parent: any): any;
  78457. }
  78458. /**
  78459. * This defines an action responsible to run code (external event) once triggered.
  78460. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78461. */
  78462. export class ExecuteCodeAction extends Action {
  78463. /**
  78464. * The callback function to run.
  78465. */
  78466. func: (evt: ActionEvent) => void;
  78467. /**
  78468. * Instantiate the action
  78469. * @param triggerOptions defines the trigger options
  78470. * @param func defines the callback function to run
  78471. * @param condition defines the trigger related conditions
  78472. */
  78473. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  78474. /**
  78475. * Execute the action and run the attached code.
  78476. */
  78477. execute(evt: ActionEvent): void;
  78478. }
  78479. /**
  78480. * This defines an action responsible to set the parent property of the target once triggered.
  78481. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78482. */
  78483. export class SetParentAction extends Action {
  78484. private _parent;
  78485. private _target;
  78486. /**
  78487. * Instantiate the action
  78488. * @param triggerOptions defines the trigger options
  78489. * @param target defines the target containing the parent property
  78490. * @param parent defines from where the animation should start (animation frame)
  78491. * @param condition defines the trigger related conditions
  78492. */
  78493. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  78494. /** @hidden */
  78495. _prepare(): void;
  78496. /**
  78497. * Execute the action and set the parent property.
  78498. */
  78499. execute(): void;
  78500. /**
  78501. * Serializes the actions and its related information.
  78502. * @param parent defines the object to serialize in
  78503. * @returns the serialized object
  78504. */
  78505. serialize(parent: any): any;
  78506. }
  78507. }
  78508. declare module BABYLON {
  78509. /**
  78510. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  78511. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  78512. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78513. */
  78514. export class ActionManager extends AbstractActionManager {
  78515. /**
  78516. * Nothing
  78517. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78518. */
  78519. static readonly NothingTrigger: number;
  78520. /**
  78521. * On pick
  78522. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78523. */
  78524. static readonly OnPickTrigger: number;
  78525. /**
  78526. * On left pick
  78527. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78528. */
  78529. static readonly OnLeftPickTrigger: number;
  78530. /**
  78531. * On right pick
  78532. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78533. */
  78534. static readonly OnRightPickTrigger: number;
  78535. /**
  78536. * On center pick
  78537. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78538. */
  78539. static readonly OnCenterPickTrigger: number;
  78540. /**
  78541. * On pick down
  78542. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78543. */
  78544. static readonly OnPickDownTrigger: number;
  78545. /**
  78546. * On double pick
  78547. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78548. */
  78549. static readonly OnDoublePickTrigger: number;
  78550. /**
  78551. * On pick up
  78552. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78553. */
  78554. static readonly OnPickUpTrigger: number;
  78555. /**
  78556. * On pick out.
  78557. * This trigger will only be raised if you also declared a OnPickDown
  78558. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78559. */
  78560. static readonly OnPickOutTrigger: number;
  78561. /**
  78562. * On long press
  78563. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78564. */
  78565. static readonly OnLongPressTrigger: number;
  78566. /**
  78567. * On pointer over
  78568. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78569. */
  78570. static readonly OnPointerOverTrigger: number;
  78571. /**
  78572. * On pointer out
  78573. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78574. */
  78575. static readonly OnPointerOutTrigger: number;
  78576. /**
  78577. * On every frame
  78578. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78579. */
  78580. static readonly OnEveryFrameTrigger: number;
  78581. /**
  78582. * On intersection enter
  78583. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78584. */
  78585. static readonly OnIntersectionEnterTrigger: number;
  78586. /**
  78587. * On intersection exit
  78588. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78589. */
  78590. static readonly OnIntersectionExitTrigger: number;
  78591. /**
  78592. * On key down
  78593. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78594. */
  78595. static readonly OnKeyDownTrigger: number;
  78596. /**
  78597. * On key up
  78598. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78599. */
  78600. static readonly OnKeyUpTrigger: number;
  78601. private _scene;
  78602. /**
  78603. * Creates a new action manager
  78604. * @param scene defines the hosting scene
  78605. */
  78606. constructor(scene: Scene);
  78607. /**
  78608. * Releases all associated resources
  78609. */
  78610. dispose(): void;
  78611. /**
  78612. * Gets hosting scene
  78613. * @returns the hosting scene
  78614. */
  78615. getScene(): Scene;
  78616. /**
  78617. * Does this action manager handles actions of any of the given triggers
  78618. * @param triggers defines the triggers to be tested
  78619. * @return a boolean indicating whether one (or more) of the triggers is handled
  78620. */
  78621. hasSpecificTriggers(triggers: number[]): boolean;
  78622. /**
  78623. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  78624. * speed.
  78625. * @param triggerA defines the trigger to be tested
  78626. * @param triggerB defines the trigger to be tested
  78627. * @return a boolean indicating whether one (or more) of the triggers is handled
  78628. */
  78629. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  78630. /**
  78631. * Does this action manager handles actions of a given trigger
  78632. * @param trigger defines the trigger to be tested
  78633. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  78634. * @return whether the trigger is handled
  78635. */
  78636. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  78637. /**
  78638. * Does this action manager has pointer triggers
  78639. */
  78640. readonly hasPointerTriggers: boolean;
  78641. /**
  78642. * Does this action manager has pick triggers
  78643. */
  78644. readonly hasPickTriggers: boolean;
  78645. /**
  78646. * Registers an action to this action manager
  78647. * @param action defines the action to be registered
  78648. * @return the action amended (prepared) after registration
  78649. */
  78650. registerAction(action: IAction): Nullable<IAction>;
  78651. /**
  78652. * Unregisters an action to this action manager
  78653. * @param action defines the action to be unregistered
  78654. * @return a boolean indicating whether the action has been unregistered
  78655. */
  78656. unregisterAction(action: IAction): Boolean;
  78657. /**
  78658. * Process a specific trigger
  78659. * @param trigger defines the trigger to process
  78660. * @param evt defines the event details to be processed
  78661. */
  78662. processTrigger(trigger: number, evt?: IActionEvent): void;
  78663. /** @hidden */
  78664. _getEffectiveTarget(target: any, propertyPath: string): any;
  78665. /** @hidden */
  78666. _getProperty(propertyPath: string): string;
  78667. /**
  78668. * Serialize this manager to a JSON object
  78669. * @param name defines the property name to store this manager
  78670. * @returns a JSON representation of this manager
  78671. */
  78672. serialize(name: string): any;
  78673. /**
  78674. * Creates a new ActionManager from a JSON data
  78675. * @param parsedActions defines the JSON data to read from
  78676. * @param object defines the hosting mesh
  78677. * @param scene defines the hosting scene
  78678. */
  78679. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  78680. /**
  78681. * Get a trigger name by index
  78682. * @param trigger defines the trigger index
  78683. * @returns a trigger name
  78684. */
  78685. static GetTriggerName(trigger: number): string;
  78686. }
  78687. }
  78688. declare module BABYLON {
  78689. /**
  78690. * Class representing a ray with position and direction
  78691. */
  78692. export class Ray {
  78693. /** origin point */
  78694. origin: Vector3;
  78695. /** direction */
  78696. direction: Vector3;
  78697. /** length of the ray */
  78698. length: number;
  78699. private static readonly TmpVector3;
  78700. private _tmpRay;
  78701. /**
  78702. * Creates a new ray
  78703. * @param origin origin point
  78704. * @param direction direction
  78705. * @param length length of the ray
  78706. */
  78707. constructor(
  78708. /** origin point */
  78709. origin: Vector3,
  78710. /** direction */
  78711. direction: Vector3,
  78712. /** length of the ray */
  78713. length?: number);
  78714. /**
  78715. * Checks if the ray intersects a box
  78716. * @param minimum bound of the box
  78717. * @param maximum bound of the box
  78718. * @param intersectionTreshold extra extend to be added to the box in all direction
  78719. * @returns if the box was hit
  78720. */
  78721. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  78722. /**
  78723. * Checks if the ray intersects a box
  78724. * @param box the bounding box to check
  78725. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  78726. * @returns if the box was hit
  78727. */
  78728. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  78729. /**
  78730. * If the ray hits a sphere
  78731. * @param sphere the bounding sphere to check
  78732. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  78733. * @returns true if it hits the sphere
  78734. */
  78735. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  78736. /**
  78737. * If the ray hits a triange
  78738. * @param vertex0 triangle vertex
  78739. * @param vertex1 triangle vertex
  78740. * @param vertex2 triangle vertex
  78741. * @returns intersection information if hit
  78742. */
  78743. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  78744. /**
  78745. * Checks if ray intersects a plane
  78746. * @param plane the plane to check
  78747. * @returns the distance away it was hit
  78748. */
  78749. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  78750. /**
  78751. * Calculate the intercept of a ray on a given axis
  78752. * @param axis to check 'x' | 'y' | 'z'
  78753. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  78754. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  78755. */
  78756. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  78757. /**
  78758. * Checks if ray intersects a mesh
  78759. * @param mesh the mesh to check
  78760. * @param fastCheck if only the bounding box should checked
  78761. * @returns picking info of the intersecton
  78762. */
  78763. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  78764. /**
  78765. * Checks if ray intersects a mesh
  78766. * @param meshes the meshes to check
  78767. * @param fastCheck if only the bounding box should checked
  78768. * @param results array to store result in
  78769. * @returns Array of picking infos
  78770. */
  78771. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  78772. private _comparePickingInfo;
  78773. private static smallnum;
  78774. private static rayl;
  78775. /**
  78776. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  78777. * @param sega the first point of the segment to test the intersection against
  78778. * @param segb the second point of the segment to test the intersection against
  78779. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  78780. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  78781. */
  78782. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  78783. /**
  78784. * Update the ray from viewport position
  78785. * @param x position
  78786. * @param y y position
  78787. * @param viewportWidth viewport width
  78788. * @param viewportHeight viewport height
  78789. * @param world world matrix
  78790. * @param view view matrix
  78791. * @param projection projection matrix
  78792. * @returns this ray updated
  78793. */
  78794. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  78795. /**
  78796. * Creates a ray with origin and direction of 0,0,0
  78797. * @returns the new ray
  78798. */
  78799. static Zero(): Ray;
  78800. /**
  78801. * Creates a new ray from screen space and viewport
  78802. * @param x position
  78803. * @param y y position
  78804. * @param viewportWidth viewport width
  78805. * @param viewportHeight viewport height
  78806. * @param world world matrix
  78807. * @param view view matrix
  78808. * @param projection projection matrix
  78809. * @returns new ray
  78810. */
  78811. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  78812. /**
  78813. * 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
  78814. * transformed to the given world matrix.
  78815. * @param origin The origin point
  78816. * @param end The end point
  78817. * @param world a matrix to transform the ray to. Default is the identity matrix.
  78818. * @returns the new ray
  78819. */
  78820. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  78821. /**
  78822. * Transforms a ray by a matrix
  78823. * @param ray ray to transform
  78824. * @param matrix matrix to apply
  78825. * @returns the resulting new ray
  78826. */
  78827. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  78828. /**
  78829. * Transforms a ray by a matrix
  78830. * @param ray ray to transform
  78831. * @param matrix matrix to apply
  78832. * @param result ray to store result in
  78833. */
  78834. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  78835. /**
  78836. * Unproject a ray from screen space to object space
  78837. * @param sourceX defines the screen space x coordinate to use
  78838. * @param sourceY defines the screen space y coordinate to use
  78839. * @param viewportWidth defines the current width of the viewport
  78840. * @param viewportHeight defines the current height of the viewport
  78841. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  78842. * @param view defines the view matrix to use
  78843. * @param projection defines the projection matrix to use
  78844. */
  78845. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  78846. }
  78847. /**
  78848. * Type used to define predicate used to select faces when a mesh intersection is detected
  78849. */
  78850. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  78851. interface Scene {
  78852. /** @hidden */
  78853. _tempPickingRay: Nullable<Ray>;
  78854. /** @hidden */
  78855. _cachedRayForTransform: Ray;
  78856. /** @hidden */
  78857. _pickWithRayInverseMatrix: Matrix;
  78858. /** @hidden */
  78859. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  78860. /** @hidden */
  78861. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  78862. }
  78863. }
  78864. declare module BABYLON {
  78865. /**
  78866. * Groups all the scene component constants in one place to ease maintenance.
  78867. * @hidden
  78868. */
  78869. export class SceneComponentConstants {
  78870. static readonly NAME_EFFECTLAYER: string;
  78871. static readonly NAME_LAYER: string;
  78872. static readonly NAME_LENSFLARESYSTEM: string;
  78873. static readonly NAME_BOUNDINGBOXRENDERER: string;
  78874. static readonly NAME_PARTICLESYSTEM: string;
  78875. static readonly NAME_GAMEPAD: string;
  78876. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  78877. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  78878. static readonly NAME_DEPTHRENDERER: string;
  78879. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  78880. static readonly NAME_SPRITE: string;
  78881. static readonly NAME_OUTLINERENDERER: string;
  78882. static readonly NAME_PROCEDURALTEXTURE: string;
  78883. static readonly NAME_SHADOWGENERATOR: string;
  78884. static readonly NAME_OCTREE: string;
  78885. static readonly NAME_PHYSICSENGINE: string;
  78886. static readonly NAME_AUDIO: string;
  78887. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  78888. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  78889. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  78890. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  78891. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  78892. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  78893. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  78894. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  78895. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  78896. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  78897. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  78898. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  78899. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  78900. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  78901. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  78902. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  78903. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  78904. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  78905. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  78906. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  78907. static readonly STEP_AFTERRENDER_AUDIO: number;
  78908. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  78909. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  78910. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  78911. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  78912. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  78913. static readonly STEP_POINTERMOVE_SPRITE: number;
  78914. static readonly STEP_POINTERDOWN_SPRITE: number;
  78915. static readonly STEP_POINTERUP_SPRITE: number;
  78916. }
  78917. /**
  78918. * This represents a scene component.
  78919. *
  78920. * This is used to decouple the dependency the scene is having on the different workloads like
  78921. * layers, post processes...
  78922. */
  78923. export interface ISceneComponent {
  78924. /**
  78925. * The name of the component. Each component must have a unique name.
  78926. */
  78927. name: string;
  78928. /**
  78929. * The scene the component belongs to.
  78930. */
  78931. scene: Scene;
  78932. /**
  78933. * Register the component to one instance of a scene.
  78934. */
  78935. register(): void;
  78936. /**
  78937. * Rebuilds the elements related to this component in case of
  78938. * context lost for instance.
  78939. */
  78940. rebuild(): void;
  78941. /**
  78942. * Disposes the component and the associated ressources.
  78943. */
  78944. dispose(): void;
  78945. }
  78946. /**
  78947. * This represents a SERIALIZABLE scene component.
  78948. *
  78949. * This extends Scene Component to add Serialization methods on top.
  78950. */
  78951. export interface ISceneSerializableComponent extends ISceneComponent {
  78952. /**
  78953. * Adds all the elements from the container to the scene
  78954. * @param container the container holding the elements
  78955. */
  78956. addFromContainer(container: AbstractScene): void;
  78957. /**
  78958. * Removes all the elements in the container from the scene
  78959. * @param container contains the elements to remove
  78960. * @param dispose if the removed element should be disposed (default: false)
  78961. */
  78962. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  78963. /**
  78964. * Serializes the component data to the specified json object
  78965. * @param serializationObject The object to serialize to
  78966. */
  78967. serialize(serializationObject: any): void;
  78968. }
  78969. /**
  78970. * Strong typing of a Mesh related stage step action
  78971. */
  78972. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  78973. /**
  78974. * Strong typing of a Evaluate Sub Mesh related stage step action
  78975. */
  78976. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  78977. /**
  78978. * Strong typing of a Active Mesh related stage step action
  78979. */
  78980. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  78981. /**
  78982. * Strong typing of a Camera related stage step action
  78983. */
  78984. export type CameraStageAction = (camera: Camera) => void;
  78985. /**
  78986. * Strong typing of a Camera Frame buffer related stage step action
  78987. */
  78988. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  78989. /**
  78990. * Strong typing of a Render Target related stage step action
  78991. */
  78992. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  78993. /**
  78994. * Strong typing of a RenderingGroup related stage step action
  78995. */
  78996. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  78997. /**
  78998. * Strong typing of a Mesh Render related stage step action
  78999. */
  79000. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  79001. /**
  79002. * Strong typing of a simple stage step action
  79003. */
  79004. export type SimpleStageAction = () => void;
  79005. /**
  79006. * Strong typing of a render target action.
  79007. */
  79008. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  79009. /**
  79010. * Strong typing of a pointer move action.
  79011. */
  79012. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, canvas: HTMLCanvasElement) => Nullable<PickingInfo>;
  79013. /**
  79014. * Strong typing of a pointer up/down action.
  79015. */
  79016. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  79017. /**
  79018. * Representation of a stage in the scene (Basically a list of ordered steps)
  79019. * @hidden
  79020. */
  79021. export class Stage<T extends Function> extends Array<{
  79022. index: number;
  79023. component: ISceneComponent;
  79024. action: T;
  79025. }> {
  79026. /**
  79027. * Hide ctor from the rest of the world.
  79028. * @param items The items to add.
  79029. */
  79030. private constructor();
  79031. /**
  79032. * Creates a new Stage.
  79033. * @returns A new instance of a Stage
  79034. */
  79035. static Create<T extends Function>(): Stage<T>;
  79036. /**
  79037. * Registers a step in an ordered way in the targeted stage.
  79038. * @param index Defines the position to register the step in
  79039. * @param component Defines the component attached to the step
  79040. * @param action Defines the action to launch during the step
  79041. */
  79042. registerStep(index: number, component: ISceneComponent, action: T): void;
  79043. /**
  79044. * Clears all the steps from the stage.
  79045. */
  79046. clear(): void;
  79047. }
  79048. }
  79049. declare module BABYLON {
  79050. interface Scene {
  79051. /** @hidden */
  79052. _pointerOverSprite: Nullable<Sprite>;
  79053. /** @hidden */
  79054. _pickedDownSprite: Nullable<Sprite>;
  79055. /** @hidden */
  79056. _tempSpritePickingRay: Nullable<Ray>;
  79057. /**
  79058. * All of the sprite managers added to this scene
  79059. * @see http://doc.babylonjs.com/babylon101/sprites
  79060. */
  79061. spriteManagers: Array<ISpriteManager>;
  79062. /**
  79063. * An event triggered when sprites rendering is about to start
  79064. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  79065. */
  79066. onBeforeSpritesRenderingObservable: Observable<Scene>;
  79067. /**
  79068. * An event triggered when sprites rendering is done
  79069. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  79070. */
  79071. onAfterSpritesRenderingObservable: Observable<Scene>;
  79072. /** @hidden */
  79073. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79074. /** Launch a ray to try to pick a sprite in the scene
  79075. * @param x position on screen
  79076. * @param y position on screen
  79077. * @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
  79078. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  79079. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  79080. * @returns a PickingInfo
  79081. */
  79082. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79083. /** Use the given ray to pick a sprite in the scene
  79084. * @param ray The ray (in world space) to use to pick meshes
  79085. * @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
  79086. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  79087. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  79088. * @returns a PickingInfo
  79089. */
  79090. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79091. /** @hidden */
  79092. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79093. /** Launch a ray to try to pick sprites in the scene
  79094. * @param x position on screen
  79095. * @param y position on screen
  79096. * @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
  79097. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  79098. * @returns a PickingInfo array
  79099. */
  79100. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79101. /** Use the given ray to pick sprites in the scene
  79102. * @param ray The ray (in world space) to use to pick meshes
  79103. * @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
  79104. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  79105. * @returns a PickingInfo array
  79106. */
  79107. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79108. /**
  79109. * Force the sprite under the pointer
  79110. * @param sprite defines the sprite to use
  79111. */
  79112. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  79113. /**
  79114. * Gets the sprite under the pointer
  79115. * @returns a Sprite or null if no sprite is under the pointer
  79116. */
  79117. getPointerOverSprite(): Nullable<Sprite>;
  79118. }
  79119. /**
  79120. * Defines the sprite scene component responsible to manage sprites
  79121. * in a given scene.
  79122. */
  79123. export class SpriteSceneComponent implements ISceneComponent {
  79124. /**
  79125. * The component name helpfull to identify the component in the list of scene components.
  79126. */
  79127. readonly name: string;
  79128. /**
  79129. * The scene the component belongs to.
  79130. */
  79131. scene: Scene;
  79132. /** @hidden */
  79133. private _spritePredicate;
  79134. /**
  79135. * Creates a new instance of the component for the given scene
  79136. * @param scene Defines the scene to register the component in
  79137. */
  79138. constructor(scene: Scene);
  79139. /**
  79140. * Registers the component in a given scene
  79141. */
  79142. register(): void;
  79143. /**
  79144. * Rebuilds the elements related to this component in case of
  79145. * context lost for instance.
  79146. */
  79147. rebuild(): void;
  79148. /**
  79149. * Disposes the component and the associated ressources.
  79150. */
  79151. dispose(): void;
  79152. private _pickSpriteButKeepRay;
  79153. private _pointerMove;
  79154. private _pointerDown;
  79155. private _pointerUp;
  79156. }
  79157. }
  79158. declare module BABYLON {
  79159. /** @hidden */
  79160. export var fogFragmentDeclaration: {
  79161. name: string;
  79162. shader: string;
  79163. };
  79164. }
  79165. declare module BABYLON {
  79166. /** @hidden */
  79167. export var fogFragment: {
  79168. name: string;
  79169. shader: string;
  79170. };
  79171. }
  79172. declare module BABYLON {
  79173. /** @hidden */
  79174. export var spritesPixelShader: {
  79175. name: string;
  79176. shader: string;
  79177. };
  79178. }
  79179. declare module BABYLON {
  79180. /** @hidden */
  79181. export var fogVertexDeclaration: {
  79182. name: string;
  79183. shader: string;
  79184. };
  79185. }
  79186. declare module BABYLON {
  79187. /** @hidden */
  79188. export var spritesVertexShader: {
  79189. name: string;
  79190. shader: string;
  79191. };
  79192. }
  79193. declare module BABYLON {
  79194. /**
  79195. * Defines the minimum interface to fullfil in order to be a sprite manager.
  79196. */
  79197. export interface ISpriteManager extends IDisposable {
  79198. /**
  79199. * Restricts the camera to viewing objects with the same layerMask.
  79200. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  79201. */
  79202. layerMask: number;
  79203. /**
  79204. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  79205. */
  79206. isPickable: boolean;
  79207. /**
  79208. * Specifies the rendering group id for this mesh (0 by default)
  79209. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  79210. */
  79211. renderingGroupId: number;
  79212. /**
  79213. * Defines the list of sprites managed by the manager.
  79214. */
  79215. sprites: Array<Sprite>;
  79216. /**
  79217. * Tests the intersection of a sprite with a specific ray.
  79218. * @param ray The ray we are sending to test the collision
  79219. * @param camera The camera space we are sending rays in
  79220. * @param predicate A predicate allowing excluding sprites from the list of object to test
  79221. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  79222. * @returns picking info or null.
  79223. */
  79224. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  79225. /**
  79226. * Intersects the sprites with a ray
  79227. * @param ray defines the ray to intersect with
  79228. * @param camera defines the current active camera
  79229. * @param predicate defines a predicate used to select candidate sprites
  79230. * @returns null if no hit or a PickingInfo array
  79231. */
  79232. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  79233. /**
  79234. * Renders the list of sprites on screen.
  79235. */
  79236. render(): void;
  79237. }
  79238. /**
  79239. * Class used to manage multiple sprites on the same spritesheet
  79240. * @see http://doc.babylonjs.com/babylon101/sprites
  79241. */
  79242. export class SpriteManager implements ISpriteManager {
  79243. /** defines the manager's name */
  79244. name: string;
  79245. /** Gets the list of sprites */
  79246. sprites: Sprite[];
  79247. /** Gets or sets the rendering group id (0 by default) */
  79248. renderingGroupId: number;
  79249. /** Gets or sets camera layer mask */
  79250. layerMask: number;
  79251. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  79252. fogEnabled: boolean;
  79253. /** Gets or sets a boolean indicating if the sprites are pickable */
  79254. isPickable: boolean;
  79255. /** Defines the default width of a cell in the spritesheet */
  79256. cellWidth: number;
  79257. /** Defines the default height of a cell in the spritesheet */
  79258. cellHeight: number;
  79259. /** Associative array from JSON sprite data file */
  79260. private _cellData;
  79261. /** Array of sprite names from JSON sprite data file */
  79262. private _spriteMap;
  79263. /** True when packed cell data from JSON file is ready*/
  79264. private _packedAndReady;
  79265. /**
  79266. * An event triggered when the manager is disposed.
  79267. */
  79268. onDisposeObservable: Observable<SpriteManager>;
  79269. private _onDisposeObserver;
  79270. /**
  79271. * Callback called when the manager is disposed
  79272. */
  79273. onDispose: () => void;
  79274. private _capacity;
  79275. private _fromPacked;
  79276. private _spriteTexture;
  79277. private _epsilon;
  79278. private _scene;
  79279. private _vertexData;
  79280. private _buffer;
  79281. private _vertexBuffers;
  79282. private _indexBuffer;
  79283. private _effectBase;
  79284. private _effectFog;
  79285. /**
  79286. * Gets or sets the spritesheet texture
  79287. */
  79288. texture: Texture;
  79289. /**
  79290. * Creates a new sprite manager
  79291. * @param name defines the manager's name
  79292. * @param imgUrl defines the sprite sheet url
  79293. * @param capacity defines the maximum allowed number of sprites
  79294. * @param cellSize defines the size of a sprite cell
  79295. * @param scene defines the hosting scene
  79296. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  79297. * @param samplingMode defines the smapling mode to use with spritesheet
  79298. * @param fromPacked set to false; do not alter
  79299. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  79300. */
  79301. constructor(
  79302. /** defines the manager's name */
  79303. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  79304. private _makePacked;
  79305. private _appendSpriteVertex;
  79306. /**
  79307. * Intersects the sprites with a ray
  79308. * @param ray defines the ray to intersect with
  79309. * @param camera defines the current active camera
  79310. * @param predicate defines a predicate used to select candidate sprites
  79311. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  79312. * @returns null if no hit or a PickingInfo
  79313. */
  79314. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  79315. /**
  79316. * Intersects the sprites with a ray
  79317. * @param ray defines the ray to intersect with
  79318. * @param camera defines the current active camera
  79319. * @param predicate defines a predicate used to select candidate sprites
  79320. * @returns null if no hit or a PickingInfo array
  79321. */
  79322. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  79323. /**
  79324. * Render all child sprites
  79325. */
  79326. render(): void;
  79327. /**
  79328. * Release associated resources
  79329. */
  79330. dispose(): void;
  79331. }
  79332. }
  79333. declare module BABYLON {
  79334. /**
  79335. * Class used to represent a sprite
  79336. * @see http://doc.babylonjs.com/babylon101/sprites
  79337. */
  79338. export class Sprite {
  79339. /** defines the name */
  79340. name: string;
  79341. /** Gets or sets the current world position */
  79342. position: Vector3;
  79343. /** Gets or sets the main color */
  79344. color: Color4;
  79345. /** Gets or sets the width */
  79346. width: number;
  79347. /** Gets or sets the height */
  79348. height: number;
  79349. /** Gets or sets rotation angle */
  79350. angle: number;
  79351. /** Gets or sets the cell index in the sprite sheet */
  79352. cellIndex: number;
  79353. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  79354. cellRef: string;
  79355. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  79356. invertU: number;
  79357. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  79358. invertV: number;
  79359. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  79360. disposeWhenFinishedAnimating: boolean;
  79361. /** Gets the list of attached animations */
  79362. animations: Animation[];
  79363. /** Gets or sets a boolean indicating if the sprite can be picked */
  79364. isPickable: boolean;
  79365. /**
  79366. * Gets or sets the associated action manager
  79367. */
  79368. actionManager: Nullable<ActionManager>;
  79369. private _animationStarted;
  79370. private _loopAnimation;
  79371. private _fromIndex;
  79372. private _toIndex;
  79373. private _delay;
  79374. private _direction;
  79375. private _manager;
  79376. private _time;
  79377. private _onAnimationEnd;
  79378. /**
  79379. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  79380. */
  79381. isVisible: boolean;
  79382. /**
  79383. * Gets or sets the sprite size
  79384. */
  79385. size: number;
  79386. /**
  79387. * Creates a new Sprite
  79388. * @param name defines the name
  79389. * @param manager defines the manager
  79390. */
  79391. constructor(
  79392. /** defines the name */
  79393. name: string, manager: ISpriteManager);
  79394. /**
  79395. * Starts an animation
  79396. * @param from defines the initial key
  79397. * @param to defines the end key
  79398. * @param loop defines if the animation must loop
  79399. * @param delay defines the start delay (in ms)
  79400. * @param onAnimationEnd defines a callback to call when animation ends
  79401. */
  79402. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  79403. /** Stops current animation (if any) */
  79404. stopAnimation(): void;
  79405. /** @hidden */
  79406. _animate(deltaTime: number): void;
  79407. /** Release associated resources */
  79408. dispose(): void;
  79409. }
  79410. }
  79411. declare module BABYLON {
  79412. /**
  79413. * Information about the result of picking within a scene
  79414. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  79415. */
  79416. export class PickingInfo {
  79417. /** @hidden */
  79418. _pickingUnavailable: boolean;
  79419. /**
  79420. * If the pick collided with an object
  79421. */
  79422. hit: boolean;
  79423. /**
  79424. * Distance away where the pick collided
  79425. */
  79426. distance: number;
  79427. /**
  79428. * The location of pick collision
  79429. */
  79430. pickedPoint: Nullable<Vector3>;
  79431. /**
  79432. * The mesh corresponding the the pick collision
  79433. */
  79434. pickedMesh: Nullable<AbstractMesh>;
  79435. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  79436. bu: number;
  79437. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  79438. bv: number;
  79439. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  79440. faceId: number;
  79441. /** Id of the the submesh that was picked */
  79442. subMeshId: number;
  79443. /** If a sprite was picked, this will be the sprite the pick collided with */
  79444. pickedSprite: Nullable<Sprite>;
  79445. /**
  79446. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  79447. */
  79448. originMesh: Nullable<AbstractMesh>;
  79449. /**
  79450. * The ray that was used to perform the picking.
  79451. */
  79452. ray: Nullable<Ray>;
  79453. /**
  79454. * Gets the normal correspodning to the face the pick collided with
  79455. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  79456. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  79457. * @returns The normal correspodning to the face the pick collided with
  79458. */
  79459. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  79460. /**
  79461. * Gets the texture coordinates of where the pick occured
  79462. * @returns the vector containing the coordnates of the texture
  79463. */
  79464. getTextureCoordinates(): Nullable<Vector2>;
  79465. }
  79466. }
  79467. declare module BABYLON {
  79468. /**
  79469. * Gather the list of pointer event types as constants.
  79470. */
  79471. export class PointerEventTypes {
  79472. /**
  79473. * 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.
  79474. */
  79475. static readonly POINTERDOWN: number;
  79476. /**
  79477. * The pointerup event is fired when a pointer is no longer active.
  79478. */
  79479. static readonly POINTERUP: number;
  79480. /**
  79481. * The pointermove event is fired when a pointer changes coordinates.
  79482. */
  79483. static readonly POINTERMOVE: number;
  79484. /**
  79485. * The pointerwheel event is fired when a mouse wheel has been rotated.
  79486. */
  79487. static readonly POINTERWHEEL: number;
  79488. /**
  79489. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  79490. */
  79491. static readonly POINTERPICK: number;
  79492. /**
  79493. * The pointertap event is fired when a the object has been touched and released without drag.
  79494. */
  79495. static readonly POINTERTAP: number;
  79496. /**
  79497. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  79498. */
  79499. static readonly POINTERDOUBLETAP: number;
  79500. }
  79501. /**
  79502. * Base class of pointer info types.
  79503. */
  79504. export class PointerInfoBase {
  79505. /**
  79506. * Defines the type of event (PointerEventTypes)
  79507. */
  79508. type: number;
  79509. /**
  79510. * Defines the related dom event
  79511. */
  79512. event: PointerEvent | MouseWheelEvent;
  79513. /**
  79514. * Instantiates the base class of pointers info.
  79515. * @param type Defines the type of event (PointerEventTypes)
  79516. * @param event Defines the related dom event
  79517. */
  79518. constructor(
  79519. /**
  79520. * Defines the type of event (PointerEventTypes)
  79521. */
  79522. type: number,
  79523. /**
  79524. * Defines the related dom event
  79525. */
  79526. event: PointerEvent | MouseWheelEvent);
  79527. }
  79528. /**
  79529. * This class is used to store pointer related info for the onPrePointerObservable event.
  79530. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  79531. */
  79532. export class PointerInfoPre extends PointerInfoBase {
  79533. /**
  79534. * Ray from a pointer if availible (eg. 6dof controller)
  79535. */
  79536. ray: Nullable<Ray>;
  79537. /**
  79538. * Defines the local position of the pointer on the canvas.
  79539. */
  79540. localPosition: Vector2;
  79541. /**
  79542. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  79543. */
  79544. skipOnPointerObservable: boolean;
  79545. /**
  79546. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  79547. * @param type Defines the type of event (PointerEventTypes)
  79548. * @param event Defines the related dom event
  79549. * @param localX Defines the local x coordinates of the pointer when the event occured
  79550. * @param localY Defines the local y coordinates of the pointer when the event occured
  79551. */
  79552. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  79553. }
  79554. /**
  79555. * This type contains all the data related to a pointer event in Babylon.js.
  79556. * 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.
  79557. */
  79558. export class PointerInfo extends PointerInfoBase {
  79559. /**
  79560. * Defines the picking info associated to the info (if any)\
  79561. */
  79562. pickInfo: Nullable<PickingInfo>;
  79563. /**
  79564. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  79565. * @param type Defines the type of event (PointerEventTypes)
  79566. * @param event Defines the related dom event
  79567. * @param pickInfo Defines the picking info associated to the info (if any)\
  79568. */
  79569. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  79570. /**
  79571. * Defines the picking info associated to the info (if any)\
  79572. */
  79573. pickInfo: Nullable<PickingInfo>);
  79574. }
  79575. /**
  79576. * Data relating to a touch event on the screen.
  79577. */
  79578. export interface PointerTouch {
  79579. /**
  79580. * X coordinate of touch.
  79581. */
  79582. x: number;
  79583. /**
  79584. * Y coordinate of touch.
  79585. */
  79586. y: number;
  79587. /**
  79588. * Id of touch. Unique for each finger.
  79589. */
  79590. pointerId: number;
  79591. /**
  79592. * Event type passed from DOM.
  79593. */
  79594. type: any;
  79595. }
  79596. }
  79597. declare module BABYLON {
  79598. /**
  79599. * Manage the mouse inputs to control the movement of a free camera.
  79600. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  79601. */
  79602. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  79603. /**
  79604. * Define if touch is enabled in the mouse input
  79605. */
  79606. touchEnabled: boolean;
  79607. /**
  79608. * Defines the camera the input is attached to.
  79609. */
  79610. camera: FreeCamera;
  79611. /**
  79612. * Defines the buttons associated with the input to handle camera move.
  79613. */
  79614. buttons: number[];
  79615. /**
  79616. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  79617. */
  79618. angularSensibility: number;
  79619. private _pointerInput;
  79620. private _onMouseMove;
  79621. private _observer;
  79622. private previousPosition;
  79623. /**
  79624. * Observable for when a pointer move event occurs containing the move offset
  79625. */
  79626. onPointerMovedObservable: Observable<{
  79627. offsetX: number;
  79628. offsetY: number;
  79629. }>;
  79630. /**
  79631. * @hidden
  79632. * If the camera should be rotated automatically based on pointer movement
  79633. */
  79634. _allowCameraRotation: boolean;
  79635. /**
  79636. * Manage the mouse inputs to control the movement of a free camera.
  79637. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  79638. * @param touchEnabled Defines if touch is enabled or not
  79639. */
  79640. constructor(
  79641. /**
  79642. * Define if touch is enabled in the mouse input
  79643. */
  79644. touchEnabled?: boolean);
  79645. /**
  79646. * Attach the input controls to a specific dom element to get the input from.
  79647. * @param element Defines the element the controls should be listened from
  79648. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  79649. */
  79650. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  79651. /**
  79652. * Called on JS contextmenu event.
  79653. * Override this method to provide functionality.
  79654. */
  79655. protected onContextMenu(evt: PointerEvent): void;
  79656. /**
  79657. * Detach the current controls from the specified dom element.
  79658. * @param element Defines the element to stop listening the inputs from
  79659. */
  79660. detachControl(element: Nullable<HTMLElement>): void;
  79661. /**
  79662. * Gets the class name of the current intput.
  79663. * @returns the class name
  79664. */
  79665. getClassName(): string;
  79666. /**
  79667. * Get the friendly name associated with the input class.
  79668. * @returns the input friendly name
  79669. */
  79670. getSimpleName(): string;
  79671. }
  79672. }
  79673. declare module BABYLON {
  79674. /**
  79675. * Manage the touch inputs to control the movement of a free camera.
  79676. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  79677. */
  79678. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  79679. /**
  79680. * Defines the camera the input is attached to.
  79681. */
  79682. camera: FreeCamera;
  79683. /**
  79684. * Defines the touch sensibility for rotation.
  79685. * The higher the faster.
  79686. */
  79687. touchAngularSensibility: number;
  79688. /**
  79689. * Defines the touch sensibility for move.
  79690. * The higher the faster.
  79691. */
  79692. touchMoveSensibility: number;
  79693. private _offsetX;
  79694. private _offsetY;
  79695. private _pointerPressed;
  79696. private _pointerInput;
  79697. private _observer;
  79698. private _onLostFocus;
  79699. /**
  79700. * Attach the input controls to a specific dom element to get the input from.
  79701. * @param element Defines the element the controls should be listened from
  79702. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  79703. */
  79704. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  79705. /**
  79706. * Detach the current controls from the specified dom element.
  79707. * @param element Defines the element to stop listening the inputs from
  79708. */
  79709. detachControl(element: Nullable<HTMLElement>): void;
  79710. /**
  79711. * Update the current camera state depending on the inputs that have been used this frame.
  79712. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  79713. */
  79714. checkInputs(): void;
  79715. /**
  79716. * Gets the class name of the current intput.
  79717. * @returns the class name
  79718. */
  79719. getClassName(): string;
  79720. /**
  79721. * Get the friendly name associated with the input class.
  79722. * @returns the input friendly name
  79723. */
  79724. getSimpleName(): string;
  79725. }
  79726. }
  79727. declare module BABYLON {
  79728. /**
  79729. * Default Inputs manager for the FreeCamera.
  79730. * It groups all the default supported inputs for ease of use.
  79731. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  79732. */
  79733. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  79734. /**
  79735. * @hidden
  79736. */
  79737. _mouseInput: Nullable<FreeCameraMouseInput>;
  79738. /**
  79739. * Instantiates a new FreeCameraInputsManager.
  79740. * @param camera Defines the camera the inputs belong to
  79741. */
  79742. constructor(camera: FreeCamera);
  79743. /**
  79744. * Add keyboard input support to the input manager.
  79745. * @returns the current input manager
  79746. */
  79747. addKeyboard(): FreeCameraInputsManager;
  79748. /**
  79749. * Add mouse input support to the input manager.
  79750. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  79751. * @returns the current input manager
  79752. */
  79753. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  79754. /**
  79755. * Removes the mouse input support from the manager
  79756. * @returns the current input manager
  79757. */
  79758. removeMouse(): FreeCameraInputsManager;
  79759. /**
  79760. * Add touch input support to the input manager.
  79761. * @returns the current input manager
  79762. */
  79763. addTouch(): FreeCameraInputsManager;
  79764. /**
  79765. * Remove all attached input methods from a camera
  79766. */
  79767. clear(): void;
  79768. }
  79769. }
  79770. declare module BABYLON {
  79771. /**
  79772. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  79773. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  79774. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  79775. */
  79776. export class FreeCamera extends TargetCamera {
  79777. /**
  79778. * Define the collision ellipsoid of the camera.
  79779. * This is helpful to simulate a camera body like the player body around the camera
  79780. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  79781. */
  79782. ellipsoid: Vector3;
  79783. /**
  79784. * Define an offset for the position of the ellipsoid around the camera.
  79785. * This can be helpful to determine the center of the body near the gravity center of the body
  79786. * instead of its head.
  79787. */
  79788. ellipsoidOffset: Vector3;
  79789. /**
  79790. * Enable or disable collisions of the camera with the rest of the scene objects.
  79791. */
  79792. checkCollisions: boolean;
  79793. /**
  79794. * Enable or disable gravity on the camera.
  79795. */
  79796. applyGravity: boolean;
  79797. /**
  79798. * Define the input manager associated to the camera.
  79799. */
  79800. inputs: FreeCameraInputsManager;
  79801. /**
  79802. * Gets the input sensibility for a mouse input. (default is 2000.0)
  79803. * Higher values reduce sensitivity.
  79804. */
  79805. /**
  79806. * Sets the input sensibility for a mouse input. (default is 2000.0)
  79807. * Higher values reduce sensitivity.
  79808. */
  79809. angularSensibility: number;
  79810. /**
  79811. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  79812. */
  79813. keysUp: number[];
  79814. /**
  79815. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  79816. */
  79817. keysDown: number[];
  79818. /**
  79819. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  79820. */
  79821. keysLeft: number[];
  79822. /**
  79823. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  79824. */
  79825. keysRight: number[];
  79826. /**
  79827. * Event raised when the camera collide with a mesh in the scene.
  79828. */
  79829. onCollide: (collidedMesh: AbstractMesh) => void;
  79830. private _collider;
  79831. private _needMoveForGravity;
  79832. private _oldPosition;
  79833. private _diffPosition;
  79834. private _newPosition;
  79835. /** @hidden */
  79836. _localDirection: Vector3;
  79837. /** @hidden */
  79838. _transformedDirection: Vector3;
  79839. /**
  79840. * Instantiates a Free Camera.
  79841. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  79842. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  79843. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  79844. * @param name Define the name of the camera in the scene
  79845. * @param position Define the start position of the camera in the scene
  79846. * @param scene Define the scene the camera belongs to
  79847. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  79848. */
  79849. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  79850. /**
  79851. * Attached controls to the current camera.
  79852. * @param element Defines the element the controls should be listened from
  79853. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  79854. */
  79855. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  79856. /**
  79857. * Detach the current controls from the camera.
  79858. * The camera will stop reacting to inputs.
  79859. * @param element Defines the element to stop listening the inputs from
  79860. */
  79861. detachControl(element: HTMLElement): void;
  79862. private _collisionMask;
  79863. /**
  79864. * Define a collision mask to limit the list of object the camera can collide with
  79865. */
  79866. collisionMask: number;
  79867. /** @hidden */
  79868. _collideWithWorld(displacement: Vector3): void;
  79869. private _onCollisionPositionChange;
  79870. /** @hidden */
  79871. _checkInputs(): void;
  79872. /** @hidden */
  79873. _decideIfNeedsToMove(): boolean;
  79874. /** @hidden */
  79875. _updatePosition(): void;
  79876. /**
  79877. * Destroy the camera and release the current resources hold by it.
  79878. */
  79879. dispose(): void;
  79880. /**
  79881. * Gets the current object class name.
  79882. * @return the class name
  79883. */
  79884. getClassName(): string;
  79885. }
  79886. }
  79887. declare module BABYLON {
  79888. /**
  79889. * Represents a gamepad control stick position
  79890. */
  79891. export class StickValues {
  79892. /**
  79893. * The x component of the control stick
  79894. */
  79895. x: number;
  79896. /**
  79897. * The y component of the control stick
  79898. */
  79899. y: number;
  79900. /**
  79901. * Initializes the gamepad x and y control stick values
  79902. * @param x The x component of the gamepad control stick value
  79903. * @param y The y component of the gamepad control stick value
  79904. */
  79905. constructor(
  79906. /**
  79907. * The x component of the control stick
  79908. */
  79909. x: number,
  79910. /**
  79911. * The y component of the control stick
  79912. */
  79913. y: number);
  79914. }
  79915. /**
  79916. * An interface which manages callbacks for gamepad button changes
  79917. */
  79918. export interface GamepadButtonChanges {
  79919. /**
  79920. * Called when a gamepad has been changed
  79921. */
  79922. changed: boolean;
  79923. /**
  79924. * Called when a gamepad press event has been triggered
  79925. */
  79926. pressChanged: boolean;
  79927. /**
  79928. * Called when a touch event has been triggered
  79929. */
  79930. touchChanged: boolean;
  79931. /**
  79932. * Called when a value has changed
  79933. */
  79934. valueChanged: boolean;
  79935. }
  79936. /**
  79937. * Represents a gamepad
  79938. */
  79939. export class Gamepad {
  79940. /**
  79941. * The id of the gamepad
  79942. */
  79943. id: string;
  79944. /**
  79945. * The index of the gamepad
  79946. */
  79947. index: number;
  79948. /**
  79949. * The browser gamepad
  79950. */
  79951. browserGamepad: any;
  79952. /**
  79953. * Specifies what type of gamepad this represents
  79954. */
  79955. type: number;
  79956. private _leftStick;
  79957. private _rightStick;
  79958. /** @hidden */
  79959. _isConnected: boolean;
  79960. private _leftStickAxisX;
  79961. private _leftStickAxisY;
  79962. private _rightStickAxisX;
  79963. private _rightStickAxisY;
  79964. /**
  79965. * Triggered when the left control stick has been changed
  79966. */
  79967. private _onleftstickchanged;
  79968. /**
  79969. * Triggered when the right control stick has been changed
  79970. */
  79971. private _onrightstickchanged;
  79972. /**
  79973. * Represents a gamepad controller
  79974. */
  79975. static GAMEPAD: number;
  79976. /**
  79977. * Represents a generic controller
  79978. */
  79979. static GENERIC: number;
  79980. /**
  79981. * Represents an XBox controller
  79982. */
  79983. static XBOX: number;
  79984. /**
  79985. * Represents a pose-enabled controller
  79986. */
  79987. static POSE_ENABLED: number;
  79988. /**
  79989. * Represents an Dual Shock controller
  79990. */
  79991. static DUALSHOCK: number;
  79992. /**
  79993. * Specifies whether the left control stick should be Y-inverted
  79994. */
  79995. protected _invertLeftStickY: boolean;
  79996. /**
  79997. * Specifies if the gamepad has been connected
  79998. */
  79999. readonly isConnected: boolean;
  80000. /**
  80001. * Initializes the gamepad
  80002. * @param id The id of the gamepad
  80003. * @param index The index of the gamepad
  80004. * @param browserGamepad The browser gamepad
  80005. * @param leftStickX The x component of the left joystick
  80006. * @param leftStickY The y component of the left joystick
  80007. * @param rightStickX The x component of the right joystick
  80008. * @param rightStickY The y component of the right joystick
  80009. */
  80010. constructor(
  80011. /**
  80012. * The id of the gamepad
  80013. */
  80014. id: string,
  80015. /**
  80016. * The index of the gamepad
  80017. */
  80018. index: number,
  80019. /**
  80020. * The browser gamepad
  80021. */
  80022. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  80023. /**
  80024. * Callback triggered when the left joystick has changed
  80025. * @param callback
  80026. */
  80027. onleftstickchanged(callback: (values: StickValues) => void): void;
  80028. /**
  80029. * Callback triggered when the right joystick has changed
  80030. * @param callback
  80031. */
  80032. onrightstickchanged(callback: (values: StickValues) => void): void;
  80033. /**
  80034. * Gets the left joystick
  80035. */
  80036. /**
  80037. * Sets the left joystick values
  80038. */
  80039. leftStick: StickValues;
  80040. /**
  80041. * Gets the right joystick
  80042. */
  80043. /**
  80044. * Sets the right joystick value
  80045. */
  80046. rightStick: StickValues;
  80047. /**
  80048. * Updates the gamepad joystick positions
  80049. */
  80050. update(): void;
  80051. /**
  80052. * Disposes the gamepad
  80053. */
  80054. dispose(): void;
  80055. }
  80056. /**
  80057. * Represents a generic gamepad
  80058. */
  80059. export class GenericPad extends Gamepad {
  80060. private _buttons;
  80061. private _onbuttondown;
  80062. private _onbuttonup;
  80063. /**
  80064. * Observable triggered when a button has been pressed
  80065. */
  80066. onButtonDownObservable: Observable<number>;
  80067. /**
  80068. * Observable triggered when a button has been released
  80069. */
  80070. onButtonUpObservable: Observable<number>;
  80071. /**
  80072. * Callback triggered when a button has been pressed
  80073. * @param callback Called when a button has been pressed
  80074. */
  80075. onbuttondown(callback: (buttonPressed: number) => void): void;
  80076. /**
  80077. * Callback triggered when a button has been released
  80078. * @param callback Called when a button has been released
  80079. */
  80080. onbuttonup(callback: (buttonReleased: number) => void): void;
  80081. /**
  80082. * Initializes the generic gamepad
  80083. * @param id The id of the generic gamepad
  80084. * @param index The index of the generic gamepad
  80085. * @param browserGamepad The browser gamepad
  80086. */
  80087. constructor(id: string, index: number, browserGamepad: any);
  80088. private _setButtonValue;
  80089. /**
  80090. * Updates the generic gamepad
  80091. */
  80092. update(): void;
  80093. /**
  80094. * Disposes the generic gamepad
  80095. */
  80096. dispose(): void;
  80097. }
  80098. }
  80099. declare module BABYLON {
  80100. interface Engine {
  80101. /**
  80102. * Creates a raw texture
  80103. * @param data defines the data to store in the texture
  80104. * @param width defines the width of the texture
  80105. * @param height defines the height of the texture
  80106. * @param format defines the format of the data
  80107. * @param generateMipMaps defines if the engine should generate the mip levels
  80108. * @param invertY defines if data must be stored with Y axis inverted
  80109. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  80110. * @param compression defines the compression used (null by default)
  80111. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80112. * @returns the raw texture inside an InternalTexture
  80113. */
  80114. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  80115. /**
  80116. * Update a raw texture
  80117. * @param texture defines the texture to update
  80118. * @param data defines the data to store in the texture
  80119. * @param format defines the format of the data
  80120. * @param invertY defines if data must be stored with Y axis inverted
  80121. */
  80122. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80123. /**
  80124. * Update a raw texture
  80125. * @param texture defines the texture to update
  80126. * @param data defines the data to store in the texture
  80127. * @param format defines the format of the data
  80128. * @param invertY defines if data must be stored with Y axis inverted
  80129. * @param compression defines the compression used (null by default)
  80130. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80131. */
  80132. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  80133. /**
  80134. * Creates a new raw cube texture
  80135. * @param data defines the array of data to use to create each face
  80136. * @param size defines the size of the textures
  80137. * @param format defines the format of the data
  80138. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80139. * @param generateMipMaps defines if the engine should generate the mip levels
  80140. * @param invertY defines if data must be stored with Y axis inverted
  80141. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80142. * @param compression defines the compression used (null by default)
  80143. * @returns the cube texture as an InternalTexture
  80144. */
  80145. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  80146. /**
  80147. * Update a raw cube texture
  80148. * @param texture defines the texture to udpdate
  80149. * @param data defines the data to store
  80150. * @param format defines the data format
  80151. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80152. * @param invertY defines if data must be stored with Y axis inverted
  80153. */
  80154. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  80155. /**
  80156. * Update a raw cube texture
  80157. * @param texture defines the texture to udpdate
  80158. * @param data defines the data to store
  80159. * @param format defines the data format
  80160. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80161. * @param invertY defines if data must be stored with Y axis inverted
  80162. * @param compression defines the compression used (null by default)
  80163. */
  80164. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  80165. /**
  80166. * Update a raw cube texture
  80167. * @param texture defines the texture to udpdate
  80168. * @param data defines the data to store
  80169. * @param format defines the data format
  80170. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80171. * @param invertY defines if data must be stored with Y axis inverted
  80172. * @param compression defines the compression used (null by default)
  80173. * @param level defines which level of the texture to update
  80174. */
  80175. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  80176. /**
  80177. * Creates a new raw cube texture from a specified url
  80178. * @param url defines the url where the data is located
  80179. * @param scene defines the current scene
  80180. * @param size defines the size of the textures
  80181. * @param format defines the format of the data
  80182. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80183. * @param noMipmap defines if the engine should avoid generating the mip levels
  80184. * @param callback defines a callback used to extract texture data from loaded data
  80185. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  80186. * @param onLoad defines a callback called when texture is loaded
  80187. * @param onError defines a callback called if there is an error
  80188. * @returns the cube texture as an InternalTexture
  80189. */
  80190. createRawCubeTextureFromUrl(url: string, scene: 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;
  80191. /**
  80192. * Creates a new raw cube texture from a specified url
  80193. * @param url defines the url where the data is located
  80194. * @param scene defines the current scene
  80195. * @param size defines the size of the textures
  80196. * @param format defines the format of the data
  80197. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80198. * @param noMipmap defines if the engine should avoid generating the mip levels
  80199. * @param callback defines a callback used to extract texture data from loaded data
  80200. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  80201. * @param onLoad defines a callback called when texture is loaded
  80202. * @param onError defines a callback called if there is an error
  80203. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80204. * @param invertY defines if data must be stored with Y axis inverted
  80205. * @returns the cube texture as an InternalTexture
  80206. */
  80207. createRawCubeTextureFromUrl(url: string, scene: 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;
  80208. /**
  80209. * Creates a new raw 3D texture
  80210. * @param data defines the data used to create the texture
  80211. * @param width defines the width of the texture
  80212. * @param height defines the height of the texture
  80213. * @param depth defines the depth of the texture
  80214. * @param format defines the format of the texture
  80215. * @param generateMipMaps defines if the engine must generate mip levels
  80216. * @param invertY defines if data must be stored with Y axis inverted
  80217. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80218. * @param compression defines the compressed used (can be null)
  80219. * @param textureType defines the compressed used (can be null)
  80220. * @returns a new raw 3D texture (stored in an InternalTexture)
  80221. */
  80222. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  80223. /**
  80224. * Update a raw 3D texture
  80225. * @param texture defines the texture to update
  80226. * @param data defines the data to store
  80227. * @param format defines the data format
  80228. * @param invertY defines if data must be stored with Y axis inverted
  80229. */
  80230. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80231. /**
  80232. * Update a raw 3D texture
  80233. * @param texture defines the texture to update
  80234. * @param data defines the data to store
  80235. * @param format defines the data format
  80236. * @param invertY defines if data must be stored with Y axis inverted
  80237. * @param compression defines the used compression (can be null)
  80238. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  80239. */
  80240. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  80241. }
  80242. }
  80243. declare module BABYLON {
  80244. /**
  80245. * Raw texture can help creating a texture directly from an array of data.
  80246. * This can be super useful if you either get the data from an uncompressed source or
  80247. * if you wish to create your texture pixel by pixel.
  80248. */
  80249. export class RawTexture extends Texture {
  80250. /**
  80251. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80252. */
  80253. format: number;
  80254. private _engine;
  80255. /**
  80256. * Instantiates a new RawTexture.
  80257. * Raw texture can help creating a texture directly from an array of data.
  80258. * This can be super useful if you either get the data from an uncompressed source or
  80259. * if you wish to create your texture pixel by pixel.
  80260. * @param data define the array of data to use to create the texture
  80261. * @param width define the width of the texture
  80262. * @param height define the height of the texture
  80263. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80264. * @param scene define the scene the texture belongs to
  80265. * @param generateMipMaps define whether mip maps should be generated or not
  80266. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80267. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80268. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80269. */
  80270. constructor(data: ArrayBufferView, width: number, height: number,
  80271. /**
  80272. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80273. */
  80274. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  80275. /**
  80276. * Updates the texture underlying data.
  80277. * @param data Define the new data of the texture
  80278. */
  80279. update(data: ArrayBufferView): void;
  80280. /**
  80281. * Creates a luminance texture from some data.
  80282. * @param data Define the texture data
  80283. * @param width Define the width of the texture
  80284. * @param height Define the height of the texture
  80285. * @param scene Define the scene the texture belongs to
  80286. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80287. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80288. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80289. * @returns the luminance texture
  80290. */
  80291. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80292. /**
  80293. * Creates a luminance alpha texture from some data.
  80294. * @param data Define the texture data
  80295. * @param width Define the width of the texture
  80296. * @param height Define the height of the texture
  80297. * @param scene Define the scene the texture belongs to
  80298. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80299. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80300. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80301. * @returns the luminance alpha texture
  80302. */
  80303. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80304. /**
  80305. * Creates an alpha texture from some data.
  80306. * @param data Define the texture data
  80307. * @param width Define the width of the texture
  80308. * @param height Define the height of the texture
  80309. * @param scene Define the scene the texture belongs to
  80310. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80311. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80312. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80313. * @returns the alpha texture
  80314. */
  80315. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80316. /**
  80317. * Creates a RGB texture from some data.
  80318. * @param data Define the texture data
  80319. * @param width Define the width of the texture
  80320. * @param height Define the height of the texture
  80321. * @param scene Define the scene the texture belongs to
  80322. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80323. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80324. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80325. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80326. * @returns the RGB alpha texture
  80327. */
  80328. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  80329. /**
  80330. * Creates a RGBA texture from some data.
  80331. * @param data Define the texture data
  80332. * @param width Define the width of the texture
  80333. * @param height Define the height of the texture
  80334. * @param scene Define the scene the texture belongs to
  80335. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80336. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80337. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80338. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80339. * @returns the RGBA texture
  80340. */
  80341. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  80342. /**
  80343. * Creates a R texture from some data.
  80344. * @param data Define the texture data
  80345. * @param width Define the width of the texture
  80346. * @param height Define the height of the texture
  80347. * @param scene Define the scene the texture belongs to
  80348. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80349. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80350. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80351. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80352. * @returns the R texture
  80353. */
  80354. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  80355. }
  80356. }
  80357. declare module BABYLON {
  80358. /**
  80359. * Interface for the size containing width and height
  80360. */
  80361. export interface ISize {
  80362. /**
  80363. * Width
  80364. */
  80365. width: number;
  80366. /**
  80367. * Heighht
  80368. */
  80369. height: number;
  80370. }
  80371. /**
  80372. * Size containing widht and height
  80373. */
  80374. export class Size implements ISize {
  80375. /**
  80376. * Width
  80377. */
  80378. width: number;
  80379. /**
  80380. * Height
  80381. */
  80382. height: number;
  80383. /**
  80384. * Creates a Size object from the given width and height (floats).
  80385. * @param width width of the new size
  80386. * @param height height of the new size
  80387. */
  80388. constructor(width: number, height: number);
  80389. /**
  80390. * Returns a string with the Size width and height
  80391. * @returns a string with the Size width and height
  80392. */
  80393. toString(): string;
  80394. /**
  80395. * "Size"
  80396. * @returns the string "Size"
  80397. */
  80398. getClassName(): string;
  80399. /**
  80400. * Returns the Size hash code.
  80401. * @returns a hash code for a unique width and height
  80402. */
  80403. getHashCode(): number;
  80404. /**
  80405. * Updates the current size from the given one.
  80406. * @param src the given size
  80407. */
  80408. copyFrom(src: Size): void;
  80409. /**
  80410. * Updates in place the current Size from the given floats.
  80411. * @param width width of the new size
  80412. * @param height height of the new size
  80413. * @returns the updated Size.
  80414. */
  80415. copyFromFloats(width: number, height: number): Size;
  80416. /**
  80417. * Updates in place the current Size from the given floats.
  80418. * @param width width to set
  80419. * @param height height to set
  80420. * @returns the updated Size.
  80421. */
  80422. set(width: number, height: number): Size;
  80423. /**
  80424. * Multiplies the width and height by numbers
  80425. * @param w factor to multiple the width by
  80426. * @param h factor to multiple the height by
  80427. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  80428. */
  80429. multiplyByFloats(w: number, h: number): Size;
  80430. /**
  80431. * Clones the size
  80432. * @returns a new Size copied from the given one.
  80433. */
  80434. clone(): Size;
  80435. /**
  80436. * True if the current Size and the given one width and height are strictly equal.
  80437. * @param other the other size to compare against
  80438. * @returns True if the current Size and the given one width and height are strictly equal.
  80439. */
  80440. equals(other: Size): boolean;
  80441. /**
  80442. * The surface of the Size : width * height (float).
  80443. */
  80444. readonly surface: number;
  80445. /**
  80446. * Create a new size of zero
  80447. * @returns a new Size set to (0.0, 0.0)
  80448. */
  80449. static Zero(): Size;
  80450. /**
  80451. * Sums the width and height of two sizes
  80452. * @param otherSize size to add to this size
  80453. * @returns a new Size set as the addition result of the current Size and the given one.
  80454. */
  80455. add(otherSize: Size): Size;
  80456. /**
  80457. * Subtracts the width and height of two
  80458. * @param otherSize size to subtract to this size
  80459. * @returns a new Size set as the subtraction result of the given one from the current Size.
  80460. */
  80461. subtract(otherSize: Size): Size;
  80462. /**
  80463. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  80464. * @param start starting size to lerp between
  80465. * @param end end size to lerp between
  80466. * @param amount amount to lerp between the start and end values
  80467. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  80468. */
  80469. static Lerp(start: Size, end: Size, amount: number): Size;
  80470. }
  80471. }
  80472. declare module BABYLON {
  80473. /**
  80474. * Defines a runtime animation
  80475. */
  80476. export class RuntimeAnimation {
  80477. private _events;
  80478. /**
  80479. * The current frame of the runtime animation
  80480. */
  80481. private _currentFrame;
  80482. /**
  80483. * The animation used by the runtime animation
  80484. */
  80485. private _animation;
  80486. /**
  80487. * The target of the runtime animation
  80488. */
  80489. private _target;
  80490. /**
  80491. * The initiating animatable
  80492. */
  80493. private _host;
  80494. /**
  80495. * The original value of the runtime animation
  80496. */
  80497. private _originalValue;
  80498. /**
  80499. * The original blend value of the runtime animation
  80500. */
  80501. private _originalBlendValue;
  80502. /**
  80503. * The offsets cache of the runtime animation
  80504. */
  80505. private _offsetsCache;
  80506. /**
  80507. * The high limits cache of the runtime animation
  80508. */
  80509. private _highLimitsCache;
  80510. /**
  80511. * Specifies if the runtime animation has been stopped
  80512. */
  80513. private _stopped;
  80514. /**
  80515. * The blending factor of the runtime animation
  80516. */
  80517. private _blendingFactor;
  80518. /**
  80519. * The BabylonJS scene
  80520. */
  80521. private _scene;
  80522. /**
  80523. * The current value of the runtime animation
  80524. */
  80525. private _currentValue;
  80526. /** @hidden */
  80527. _animationState: _IAnimationState;
  80528. /**
  80529. * The active target of the runtime animation
  80530. */
  80531. private _activeTargets;
  80532. private _currentActiveTarget;
  80533. private _directTarget;
  80534. /**
  80535. * The target path of the runtime animation
  80536. */
  80537. private _targetPath;
  80538. /**
  80539. * The weight of the runtime animation
  80540. */
  80541. private _weight;
  80542. /**
  80543. * The ratio offset of the runtime animation
  80544. */
  80545. private _ratioOffset;
  80546. /**
  80547. * The previous delay of the runtime animation
  80548. */
  80549. private _previousDelay;
  80550. /**
  80551. * The previous ratio of the runtime animation
  80552. */
  80553. private _previousRatio;
  80554. private _enableBlending;
  80555. private _keys;
  80556. private _minFrame;
  80557. private _maxFrame;
  80558. private _minValue;
  80559. private _maxValue;
  80560. private _targetIsArray;
  80561. /**
  80562. * Gets the current frame of the runtime animation
  80563. */
  80564. readonly currentFrame: number;
  80565. /**
  80566. * Gets the weight of the runtime animation
  80567. */
  80568. readonly weight: number;
  80569. /**
  80570. * Gets the current value of the runtime animation
  80571. */
  80572. readonly currentValue: any;
  80573. /**
  80574. * Gets the target path of the runtime animation
  80575. */
  80576. readonly targetPath: string;
  80577. /**
  80578. * Gets the actual target of the runtime animation
  80579. */
  80580. readonly target: any;
  80581. /** @hidden */
  80582. _onLoop: () => void;
  80583. /**
  80584. * Create a new RuntimeAnimation object
  80585. * @param target defines the target of the animation
  80586. * @param animation defines the source animation object
  80587. * @param scene defines the hosting scene
  80588. * @param host defines the initiating Animatable
  80589. */
  80590. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  80591. private _preparePath;
  80592. /**
  80593. * Gets the animation from the runtime animation
  80594. */
  80595. readonly animation: Animation;
  80596. /**
  80597. * Resets the runtime animation to the beginning
  80598. * @param restoreOriginal defines whether to restore the target property to the original value
  80599. */
  80600. reset(restoreOriginal?: boolean): void;
  80601. /**
  80602. * Specifies if the runtime animation is stopped
  80603. * @returns Boolean specifying if the runtime animation is stopped
  80604. */
  80605. isStopped(): boolean;
  80606. /**
  80607. * Disposes of the runtime animation
  80608. */
  80609. dispose(): void;
  80610. /**
  80611. * Apply the interpolated value to the target
  80612. * @param currentValue defines the value computed by the animation
  80613. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  80614. */
  80615. setValue(currentValue: any, weight: number): void;
  80616. private _getOriginalValues;
  80617. private _setValue;
  80618. /**
  80619. * Gets the loop pmode of the runtime animation
  80620. * @returns Loop Mode
  80621. */
  80622. private _getCorrectLoopMode;
  80623. /**
  80624. * Move the current animation to a given frame
  80625. * @param frame defines the frame to move to
  80626. */
  80627. goToFrame(frame: number): void;
  80628. /**
  80629. * @hidden Internal use only
  80630. */
  80631. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  80632. /**
  80633. * Execute the current animation
  80634. * @param delay defines the delay to add to the current frame
  80635. * @param from defines the lower bound of the animation range
  80636. * @param to defines the upper bound of the animation range
  80637. * @param loop defines if the current animation must loop
  80638. * @param speedRatio defines the current speed ratio
  80639. * @param weight defines the weight of the animation (default is -1 so no weight)
  80640. * @param onLoop optional callback called when animation loops
  80641. * @returns a boolean indicating if the animation is running
  80642. */
  80643. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  80644. }
  80645. }
  80646. declare module BABYLON {
  80647. /**
  80648. * Class used to store an actual running animation
  80649. */
  80650. export class Animatable {
  80651. /** defines the target object */
  80652. target: any;
  80653. /** defines the starting frame number (default is 0) */
  80654. fromFrame: number;
  80655. /** defines the ending frame number (default is 100) */
  80656. toFrame: number;
  80657. /** defines if the animation must loop (default is false) */
  80658. loopAnimation: boolean;
  80659. /** defines a callback to call when animation ends if it is not looping */
  80660. onAnimationEnd?: (() => void) | null | undefined;
  80661. /** defines a callback to call when animation loops */
  80662. onAnimationLoop?: (() => void) | null | undefined;
  80663. private _localDelayOffset;
  80664. private _pausedDelay;
  80665. private _runtimeAnimations;
  80666. private _paused;
  80667. private _scene;
  80668. private _speedRatio;
  80669. private _weight;
  80670. private _syncRoot;
  80671. /**
  80672. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  80673. * This will only apply for non looping animation (default is true)
  80674. */
  80675. disposeOnEnd: boolean;
  80676. /**
  80677. * Gets a boolean indicating if the animation has started
  80678. */
  80679. animationStarted: boolean;
  80680. /**
  80681. * Observer raised when the animation ends
  80682. */
  80683. onAnimationEndObservable: Observable<Animatable>;
  80684. /**
  80685. * Observer raised when the animation loops
  80686. */
  80687. onAnimationLoopObservable: Observable<Animatable>;
  80688. /**
  80689. * Gets the root Animatable used to synchronize and normalize animations
  80690. */
  80691. readonly syncRoot: Nullable<Animatable>;
  80692. /**
  80693. * Gets the current frame of the first RuntimeAnimation
  80694. * Used to synchronize Animatables
  80695. */
  80696. readonly masterFrame: number;
  80697. /**
  80698. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  80699. */
  80700. weight: number;
  80701. /**
  80702. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  80703. */
  80704. speedRatio: number;
  80705. /**
  80706. * Creates a new Animatable
  80707. * @param scene defines the hosting scene
  80708. * @param target defines the target object
  80709. * @param fromFrame defines the starting frame number (default is 0)
  80710. * @param toFrame defines the ending frame number (default is 100)
  80711. * @param loopAnimation defines if the animation must loop (default is false)
  80712. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  80713. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  80714. * @param animations defines a group of animation to add to the new Animatable
  80715. * @param onAnimationLoop defines a callback to call when animation loops
  80716. */
  80717. constructor(scene: Scene,
  80718. /** defines the target object */
  80719. target: any,
  80720. /** defines the starting frame number (default is 0) */
  80721. fromFrame?: number,
  80722. /** defines the ending frame number (default is 100) */
  80723. toFrame?: number,
  80724. /** defines if the animation must loop (default is false) */
  80725. loopAnimation?: boolean, speedRatio?: number,
  80726. /** defines a callback to call when animation ends if it is not looping */
  80727. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  80728. /** defines a callback to call when animation loops */
  80729. onAnimationLoop?: (() => void) | null | undefined);
  80730. /**
  80731. * Synchronize and normalize current Animatable with a source Animatable
  80732. * This is useful when using animation weights and when animations are not of the same length
  80733. * @param root defines the root Animatable to synchronize with
  80734. * @returns the current Animatable
  80735. */
  80736. syncWith(root: Animatable): Animatable;
  80737. /**
  80738. * Gets the list of runtime animations
  80739. * @returns an array of RuntimeAnimation
  80740. */
  80741. getAnimations(): RuntimeAnimation[];
  80742. /**
  80743. * Adds more animations to the current animatable
  80744. * @param target defines the target of the animations
  80745. * @param animations defines the new animations to add
  80746. */
  80747. appendAnimations(target: any, animations: Animation[]): void;
  80748. /**
  80749. * Gets the source animation for a specific property
  80750. * @param property defines the propertyu to look for
  80751. * @returns null or the source animation for the given property
  80752. */
  80753. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  80754. /**
  80755. * Gets the runtime animation for a specific property
  80756. * @param property defines the propertyu to look for
  80757. * @returns null or the runtime animation for the given property
  80758. */
  80759. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  80760. /**
  80761. * Resets the animatable to its original state
  80762. */
  80763. reset(): void;
  80764. /**
  80765. * Allows the animatable to blend with current running animations
  80766. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  80767. * @param blendingSpeed defines the blending speed to use
  80768. */
  80769. enableBlending(blendingSpeed: number): void;
  80770. /**
  80771. * Disable animation blending
  80772. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  80773. */
  80774. disableBlending(): void;
  80775. /**
  80776. * Jump directly to a given frame
  80777. * @param frame defines the frame to jump to
  80778. */
  80779. goToFrame(frame: number): void;
  80780. /**
  80781. * Pause the animation
  80782. */
  80783. pause(): void;
  80784. /**
  80785. * Restart the animation
  80786. */
  80787. restart(): void;
  80788. private _raiseOnAnimationEnd;
  80789. /**
  80790. * Stop and delete the current animation
  80791. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  80792. * @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)
  80793. */
  80794. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  80795. /**
  80796. * Wait asynchronously for the animation to end
  80797. * @returns a promise which will be fullfilled when the animation ends
  80798. */
  80799. waitAsync(): Promise<Animatable>;
  80800. /** @hidden */
  80801. _animate(delay: number): boolean;
  80802. }
  80803. interface Scene {
  80804. /** @hidden */
  80805. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  80806. /** @hidden */
  80807. _processLateAnimationBindingsForMatrices(holder: {
  80808. totalWeight: number;
  80809. animations: RuntimeAnimation[];
  80810. originalValue: Matrix;
  80811. }): any;
  80812. /** @hidden */
  80813. _processLateAnimationBindingsForQuaternions(holder: {
  80814. totalWeight: number;
  80815. animations: RuntimeAnimation[];
  80816. originalValue: Quaternion;
  80817. }, refQuaternion: Quaternion): Quaternion;
  80818. /** @hidden */
  80819. _processLateAnimationBindings(): void;
  80820. /**
  80821. * Will start the animation sequence of a given target
  80822. * @param target defines the target
  80823. * @param from defines from which frame should animation start
  80824. * @param to defines until which frame should animation run.
  80825. * @param weight defines the weight to apply to the animation (1.0 by default)
  80826. * @param loop defines if the animation loops
  80827. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  80828. * @param onAnimationEnd defines the function to be executed when the animation ends
  80829. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  80830. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  80831. * @param onAnimationLoop defines the callback to call when an animation loops
  80832. * @returns the animatable object created for this animation
  80833. */
  80834. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  80835. /**
  80836. * Will start the animation sequence of a given target
  80837. * @param target defines the target
  80838. * @param from defines from which frame should animation start
  80839. * @param to defines until which frame should animation run.
  80840. * @param loop defines if the animation loops
  80841. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  80842. * @param onAnimationEnd defines the function to be executed when the animation ends
  80843. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  80844. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  80845. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  80846. * @param onAnimationLoop defines the callback to call when an animation loops
  80847. * @returns the animatable object created for this animation
  80848. */
  80849. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  80850. /**
  80851. * Will start the animation sequence of a given target and its hierarchy
  80852. * @param target defines the target
  80853. * @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.
  80854. * @param from defines from which frame should animation start
  80855. * @param to defines until which frame should animation run.
  80856. * @param loop defines if the animation loops
  80857. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  80858. * @param onAnimationEnd defines the function to be executed when the animation ends
  80859. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  80860. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  80861. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  80862. * @param onAnimationLoop defines the callback to call when an animation loops
  80863. * @returns the list of created animatables
  80864. */
  80865. 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): Animatable[];
  80866. /**
  80867. * Begin a new animation on a given node
  80868. * @param target defines the target where the animation will take place
  80869. * @param animations defines the list of animations to start
  80870. * @param from defines the initial value
  80871. * @param to defines the final value
  80872. * @param loop defines if you want animation to loop (off by default)
  80873. * @param speedRatio defines the speed ratio to apply to all animations
  80874. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  80875. * @param onAnimationLoop defines the callback to call when an animation loops
  80876. * @returns the list of created animatables
  80877. */
  80878. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  80879. /**
  80880. * Begin a new animation on a given node and its hierarchy
  80881. * @param target defines the root node where the animation will take place
  80882. * @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.
  80883. * @param animations defines the list of animations to start
  80884. * @param from defines the initial value
  80885. * @param to defines the final value
  80886. * @param loop defines if you want animation to loop (off by default)
  80887. * @param speedRatio defines the speed ratio to apply to all animations
  80888. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  80889. * @param onAnimationLoop defines the callback to call when an animation loops
  80890. * @returns the list of animatables created for all nodes
  80891. */
  80892. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  80893. /**
  80894. * Gets the animatable associated with a specific target
  80895. * @param target defines the target of the animatable
  80896. * @returns the required animatable if found
  80897. */
  80898. getAnimatableByTarget(target: any): Nullable<Animatable>;
  80899. /**
  80900. * Gets all animatables associated with a given target
  80901. * @param target defines the target to look animatables for
  80902. * @returns an array of Animatables
  80903. */
  80904. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  80905. /**
  80906. * Stops and removes all animations that have been applied to the scene
  80907. */
  80908. stopAllAnimations(): void;
  80909. /**
  80910. * Gets the current delta time used by animation engine
  80911. */
  80912. deltaTime: number;
  80913. }
  80914. interface Bone {
  80915. /**
  80916. * Copy an animation range from another bone
  80917. * @param source defines the source bone
  80918. * @param rangeName defines the range name to copy
  80919. * @param frameOffset defines the frame offset
  80920. * @param rescaleAsRequired defines if rescaling must be applied if required
  80921. * @param skelDimensionsRatio defines the scaling ratio
  80922. * @returns true if operation was successful
  80923. */
  80924. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  80925. }
  80926. }
  80927. declare module BABYLON {
  80928. /**
  80929. * Class used to override all child animations of a given target
  80930. */
  80931. export class AnimationPropertiesOverride {
  80932. /**
  80933. * Gets or sets a value indicating if animation blending must be used
  80934. */
  80935. enableBlending: boolean;
  80936. /**
  80937. * Gets or sets the blending speed to use when enableBlending is true
  80938. */
  80939. blendingSpeed: number;
  80940. /**
  80941. * Gets or sets the default loop mode to use
  80942. */
  80943. loopMode: number;
  80944. }
  80945. }
  80946. declare module BABYLON {
  80947. /**
  80948. * Class used to handle skinning animations
  80949. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  80950. */
  80951. export class Skeleton implements IAnimatable {
  80952. /** defines the skeleton name */
  80953. name: string;
  80954. /** defines the skeleton Id */
  80955. id: string;
  80956. /**
  80957. * Defines the list of child bones
  80958. */
  80959. bones: Bone[];
  80960. /**
  80961. * Defines an estimate of the dimension of the skeleton at rest
  80962. */
  80963. dimensionsAtRest: Vector3;
  80964. /**
  80965. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  80966. */
  80967. needInitialSkinMatrix: boolean;
  80968. /**
  80969. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  80970. */
  80971. overrideMesh: Nullable<AbstractMesh>;
  80972. /**
  80973. * Gets the list of animations attached to this skeleton
  80974. */
  80975. animations: Array<Animation>;
  80976. private _scene;
  80977. private _isDirty;
  80978. private _transformMatrices;
  80979. private _transformMatrixTexture;
  80980. private _meshesWithPoseMatrix;
  80981. private _animatables;
  80982. private _identity;
  80983. private _synchronizedWithMesh;
  80984. private _ranges;
  80985. private _lastAbsoluteTransformsUpdateId;
  80986. private _canUseTextureForBones;
  80987. private _uniqueId;
  80988. /** @hidden */
  80989. _numBonesWithLinkedTransformNode: number;
  80990. /** @hidden */
  80991. _hasWaitingData: Nullable<boolean>;
  80992. /**
  80993. * Specifies if the skeleton should be serialized
  80994. */
  80995. doNotSerialize: boolean;
  80996. private _useTextureToStoreBoneMatrices;
  80997. /**
  80998. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  80999. * Please note that this option is not available if the hardware does not support it
  81000. */
  81001. useTextureToStoreBoneMatrices: boolean;
  81002. private _animationPropertiesOverride;
  81003. /**
  81004. * Gets or sets the animation properties override
  81005. */
  81006. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  81007. /**
  81008. * List of inspectable custom properties (used by the Inspector)
  81009. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  81010. */
  81011. inspectableCustomProperties: IInspectable[];
  81012. /**
  81013. * An observable triggered before computing the skeleton's matrices
  81014. */
  81015. onBeforeComputeObservable: Observable<Skeleton>;
  81016. /**
  81017. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  81018. */
  81019. readonly isUsingTextureForMatrices: boolean;
  81020. /**
  81021. * Gets the unique ID of this skeleton
  81022. */
  81023. readonly uniqueId: number;
  81024. /**
  81025. * Creates a new skeleton
  81026. * @param name defines the skeleton name
  81027. * @param id defines the skeleton Id
  81028. * @param scene defines the hosting scene
  81029. */
  81030. constructor(
  81031. /** defines the skeleton name */
  81032. name: string,
  81033. /** defines the skeleton Id */
  81034. id: string, scene: Scene);
  81035. /**
  81036. * Gets the current object class name.
  81037. * @return the class name
  81038. */
  81039. getClassName(): string;
  81040. /**
  81041. * Returns an array containing the root bones
  81042. * @returns an array containing the root bones
  81043. */
  81044. getChildren(): Array<Bone>;
  81045. /**
  81046. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  81047. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  81048. * @returns a Float32Array containing matrices data
  81049. */
  81050. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  81051. /**
  81052. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  81053. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  81054. * @returns a raw texture containing the data
  81055. */
  81056. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  81057. /**
  81058. * Gets the current hosting scene
  81059. * @returns a scene object
  81060. */
  81061. getScene(): Scene;
  81062. /**
  81063. * Gets a string representing the current skeleton data
  81064. * @param fullDetails defines a boolean indicating if we want a verbose version
  81065. * @returns a string representing the current skeleton data
  81066. */
  81067. toString(fullDetails?: boolean): string;
  81068. /**
  81069. * Get bone's index searching by name
  81070. * @param name defines bone's name to search for
  81071. * @return the indice of the bone. Returns -1 if not found
  81072. */
  81073. getBoneIndexByName(name: string): number;
  81074. /**
  81075. * Creater a new animation range
  81076. * @param name defines the name of the range
  81077. * @param from defines the start key
  81078. * @param to defines the end key
  81079. */
  81080. createAnimationRange(name: string, from: number, to: number): void;
  81081. /**
  81082. * Delete a specific animation range
  81083. * @param name defines the name of the range
  81084. * @param deleteFrames defines if frames must be removed as well
  81085. */
  81086. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  81087. /**
  81088. * Gets a specific animation range
  81089. * @param name defines the name of the range to look for
  81090. * @returns the requested animation range or null if not found
  81091. */
  81092. getAnimationRange(name: string): Nullable<AnimationRange>;
  81093. /**
  81094. * Gets the list of all animation ranges defined on this skeleton
  81095. * @returns an array
  81096. */
  81097. getAnimationRanges(): Nullable<AnimationRange>[];
  81098. /**
  81099. * Copy animation range from a source skeleton.
  81100. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  81101. * @param source defines the source skeleton
  81102. * @param name defines the name of the range to copy
  81103. * @param rescaleAsRequired defines if rescaling must be applied if required
  81104. * @returns true if operation was successful
  81105. */
  81106. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  81107. /**
  81108. * Forces the skeleton to go to rest pose
  81109. */
  81110. returnToRest(): void;
  81111. private _getHighestAnimationFrame;
  81112. /**
  81113. * Begin a specific animation range
  81114. * @param name defines the name of the range to start
  81115. * @param loop defines if looping must be turned on (false by default)
  81116. * @param speedRatio defines the speed ratio to apply (1 by default)
  81117. * @param onAnimationEnd defines a callback which will be called when animation will end
  81118. * @returns a new animatable
  81119. */
  81120. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  81121. /** @hidden */
  81122. _markAsDirty(): void;
  81123. /** @hidden */
  81124. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  81125. /** @hidden */
  81126. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  81127. private _computeTransformMatrices;
  81128. /**
  81129. * Build all resources required to render a skeleton
  81130. */
  81131. prepare(): void;
  81132. /**
  81133. * Gets the list of animatables currently running for this skeleton
  81134. * @returns an array of animatables
  81135. */
  81136. getAnimatables(): IAnimatable[];
  81137. /**
  81138. * Clone the current skeleton
  81139. * @param name defines the name of the new skeleton
  81140. * @param id defines the id of the new skeleton
  81141. * @returns the new skeleton
  81142. */
  81143. clone(name: string, id?: string): Skeleton;
  81144. /**
  81145. * Enable animation blending for this skeleton
  81146. * @param blendingSpeed defines the blending speed to apply
  81147. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  81148. */
  81149. enableBlending(blendingSpeed?: number): void;
  81150. /**
  81151. * Releases all resources associated with the current skeleton
  81152. */
  81153. dispose(): void;
  81154. /**
  81155. * Serialize the skeleton in a JSON object
  81156. * @returns a JSON object
  81157. */
  81158. serialize(): any;
  81159. /**
  81160. * Creates a new skeleton from serialized data
  81161. * @param parsedSkeleton defines the serialized data
  81162. * @param scene defines the hosting scene
  81163. * @returns a new skeleton
  81164. */
  81165. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  81166. /**
  81167. * Compute all node absolute transforms
  81168. * @param forceUpdate defines if computation must be done even if cache is up to date
  81169. */
  81170. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  81171. /**
  81172. * Gets the root pose matrix
  81173. * @returns a matrix
  81174. */
  81175. getPoseMatrix(): Nullable<Matrix>;
  81176. /**
  81177. * Sorts bones per internal index
  81178. */
  81179. sortBones(): void;
  81180. private _sortBones;
  81181. }
  81182. }
  81183. declare module BABYLON {
  81184. /**
  81185. * Class used to store bone information
  81186. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  81187. */
  81188. export class Bone extends Node {
  81189. /**
  81190. * defines the bone name
  81191. */
  81192. name: string;
  81193. private static _tmpVecs;
  81194. private static _tmpQuat;
  81195. private static _tmpMats;
  81196. /**
  81197. * Gets the list of child bones
  81198. */
  81199. children: Bone[];
  81200. /** Gets the animations associated with this bone */
  81201. animations: Animation[];
  81202. /**
  81203. * Gets or sets bone length
  81204. */
  81205. length: number;
  81206. /**
  81207. * @hidden Internal only
  81208. * Set this value to map this bone to a different index in the transform matrices
  81209. * Set this value to -1 to exclude the bone from the transform matrices
  81210. */
  81211. _index: Nullable<number>;
  81212. private _skeleton;
  81213. private _localMatrix;
  81214. private _restPose;
  81215. private _baseMatrix;
  81216. private _absoluteTransform;
  81217. private _invertedAbsoluteTransform;
  81218. private _parent;
  81219. private _scalingDeterminant;
  81220. private _worldTransform;
  81221. private _localScaling;
  81222. private _localRotation;
  81223. private _localPosition;
  81224. private _needToDecompose;
  81225. private _needToCompose;
  81226. /** @hidden */
  81227. _linkedTransformNode: Nullable<TransformNode>;
  81228. /** @hidden */
  81229. _waitingTransformNodeId: Nullable<string>;
  81230. /** @hidden */
  81231. /** @hidden */
  81232. _matrix: Matrix;
  81233. /**
  81234. * Create a new bone
  81235. * @param name defines the bone name
  81236. * @param skeleton defines the parent skeleton
  81237. * @param parentBone defines the parent (can be null if the bone is the root)
  81238. * @param localMatrix defines the local matrix
  81239. * @param restPose defines the rest pose matrix
  81240. * @param baseMatrix defines the base matrix
  81241. * @param index defines index of the bone in the hiearchy
  81242. */
  81243. constructor(
  81244. /**
  81245. * defines the bone name
  81246. */
  81247. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  81248. /**
  81249. * Gets the current object class name.
  81250. * @return the class name
  81251. */
  81252. getClassName(): string;
  81253. /**
  81254. * Gets the parent skeleton
  81255. * @returns a skeleton
  81256. */
  81257. getSkeleton(): Skeleton;
  81258. /**
  81259. * Gets parent bone
  81260. * @returns a bone or null if the bone is the root of the bone hierarchy
  81261. */
  81262. getParent(): Nullable<Bone>;
  81263. /**
  81264. * Returns an array containing the root bones
  81265. * @returns an array containing the root bones
  81266. */
  81267. getChildren(): Array<Bone>;
  81268. /**
  81269. * Gets the node index in matrix array generated for rendering
  81270. * @returns the node index
  81271. */
  81272. getIndex(): number;
  81273. /**
  81274. * Sets the parent bone
  81275. * @param parent defines the parent (can be null if the bone is the root)
  81276. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  81277. */
  81278. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  81279. /**
  81280. * Gets the local matrix
  81281. * @returns a matrix
  81282. */
  81283. getLocalMatrix(): Matrix;
  81284. /**
  81285. * Gets the base matrix (initial matrix which remains unchanged)
  81286. * @returns a matrix
  81287. */
  81288. getBaseMatrix(): Matrix;
  81289. /**
  81290. * Gets the rest pose matrix
  81291. * @returns a matrix
  81292. */
  81293. getRestPose(): Matrix;
  81294. /**
  81295. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  81296. */
  81297. getWorldMatrix(): Matrix;
  81298. /**
  81299. * Sets the local matrix to rest pose matrix
  81300. */
  81301. returnToRest(): void;
  81302. /**
  81303. * Gets the inverse of the absolute transform matrix.
  81304. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  81305. * @returns a matrix
  81306. */
  81307. getInvertedAbsoluteTransform(): Matrix;
  81308. /**
  81309. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  81310. * @returns a matrix
  81311. */
  81312. getAbsoluteTransform(): Matrix;
  81313. /**
  81314. * Links with the given transform node.
  81315. * The local matrix of this bone is copied from the transform node every frame.
  81316. * @param transformNode defines the transform node to link to
  81317. */
  81318. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  81319. /**
  81320. * Gets the node used to drive the bone's transformation
  81321. * @returns a transform node or null
  81322. */
  81323. getTransformNode(): Nullable<TransformNode>;
  81324. /** Gets or sets current position (in local space) */
  81325. position: Vector3;
  81326. /** Gets or sets current rotation (in local space) */
  81327. rotation: Vector3;
  81328. /** Gets or sets current rotation quaternion (in local space) */
  81329. rotationQuaternion: Quaternion;
  81330. /** Gets or sets current scaling (in local space) */
  81331. scaling: Vector3;
  81332. /**
  81333. * Gets the animation properties override
  81334. */
  81335. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  81336. private _decompose;
  81337. private _compose;
  81338. /**
  81339. * Update the base and local matrices
  81340. * @param matrix defines the new base or local matrix
  81341. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  81342. * @param updateLocalMatrix defines if the local matrix should be updated
  81343. */
  81344. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  81345. /** @hidden */
  81346. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  81347. /**
  81348. * Flag the bone as dirty (Forcing it to update everything)
  81349. */
  81350. markAsDirty(): void;
  81351. /** @hidden */
  81352. _markAsDirtyAndCompose(): void;
  81353. private _markAsDirtyAndDecompose;
  81354. /**
  81355. * Translate the bone in local or world space
  81356. * @param vec The amount to translate the bone
  81357. * @param space The space that the translation is in
  81358. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81359. */
  81360. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  81361. /**
  81362. * Set the postion of the bone in local or world space
  81363. * @param position The position to set the bone
  81364. * @param space The space that the position is in
  81365. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81366. */
  81367. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  81368. /**
  81369. * Set the absolute position of the bone (world space)
  81370. * @param position The position to set the bone
  81371. * @param mesh The mesh that this bone is attached to
  81372. */
  81373. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  81374. /**
  81375. * Scale the bone on the x, y and z axes (in local space)
  81376. * @param x The amount to scale the bone on the x axis
  81377. * @param y The amount to scale the bone on the y axis
  81378. * @param z The amount to scale the bone on the z axis
  81379. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  81380. */
  81381. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  81382. /**
  81383. * Set the bone scaling in local space
  81384. * @param scale defines the scaling vector
  81385. */
  81386. setScale(scale: Vector3): void;
  81387. /**
  81388. * Gets the current scaling in local space
  81389. * @returns the current scaling vector
  81390. */
  81391. getScale(): Vector3;
  81392. /**
  81393. * Gets the current scaling in local space and stores it in a target vector
  81394. * @param result defines the target vector
  81395. */
  81396. getScaleToRef(result: Vector3): void;
  81397. /**
  81398. * Set the yaw, pitch, and roll of the bone in local or world space
  81399. * @param yaw The rotation of the bone on the y axis
  81400. * @param pitch The rotation of the bone on the x axis
  81401. * @param roll The rotation of the bone on the z axis
  81402. * @param space The space that the axes of rotation are in
  81403. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81404. */
  81405. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  81406. /**
  81407. * Add a rotation to the bone on an axis in local or world space
  81408. * @param axis The axis to rotate the bone on
  81409. * @param amount The amount to rotate the bone
  81410. * @param space The space that the axis is in
  81411. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81412. */
  81413. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  81414. /**
  81415. * Set the rotation of the bone to a particular axis angle in local or world space
  81416. * @param axis The axis to rotate the bone on
  81417. * @param angle The angle that the bone should be rotated to
  81418. * @param space The space that the axis is in
  81419. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81420. */
  81421. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  81422. /**
  81423. * Set the euler rotation of the bone in local of world space
  81424. * @param rotation The euler rotation that the bone should be set to
  81425. * @param space The space that the rotation is in
  81426. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81427. */
  81428. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  81429. /**
  81430. * Set the quaternion rotation of the bone in local of world space
  81431. * @param quat The quaternion rotation that the bone should be set to
  81432. * @param space The space that the rotation is in
  81433. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81434. */
  81435. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  81436. /**
  81437. * Set the rotation matrix of the bone in local of world space
  81438. * @param rotMat The rotation matrix that the bone should be set to
  81439. * @param space The space that the rotation is in
  81440. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81441. */
  81442. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  81443. private _rotateWithMatrix;
  81444. private _getNegativeRotationToRef;
  81445. /**
  81446. * Get the position of the bone in local or world space
  81447. * @param space The space that the returned position is in
  81448. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81449. * @returns The position of the bone
  81450. */
  81451. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  81452. /**
  81453. * Copy the position of the bone to a vector3 in local or world space
  81454. * @param space The space that the returned position is in
  81455. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81456. * @param result The vector3 to copy the position to
  81457. */
  81458. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  81459. /**
  81460. * Get the absolute position of the bone (world space)
  81461. * @param mesh The mesh that this bone is attached to
  81462. * @returns The absolute position of the bone
  81463. */
  81464. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  81465. /**
  81466. * Copy the absolute position of the bone (world space) to the result param
  81467. * @param mesh The mesh that this bone is attached to
  81468. * @param result The vector3 to copy the absolute position to
  81469. */
  81470. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  81471. /**
  81472. * Compute the absolute transforms of this bone and its children
  81473. */
  81474. computeAbsoluteTransforms(): void;
  81475. /**
  81476. * Get the world direction from an axis that is in the local space of the bone
  81477. * @param localAxis The local direction that is used to compute the world direction
  81478. * @param mesh The mesh that this bone is attached to
  81479. * @returns The world direction
  81480. */
  81481. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  81482. /**
  81483. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  81484. * @param localAxis The local direction that is used to compute the world direction
  81485. * @param mesh The mesh that this bone is attached to
  81486. * @param result The vector3 that the world direction will be copied to
  81487. */
  81488. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81489. /**
  81490. * Get the euler rotation of the bone in local or world space
  81491. * @param space The space that the rotation should be in
  81492. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81493. * @returns The euler rotation
  81494. */
  81495. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  81496. /**
  81497. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  81498. * @param space The space that the rotation should be in
  81499. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81500. * @param result The vector3 that the rotation should be copied to
  81501. */
  81502. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81503. /**
  81504. * Get the quaternion rotation of the bone in either local or world space
  81505. * @param space The space that the rotation should be in
  81506. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81507. * @returns The quaternion rotation
  81508. */
  81509. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  81510. /**
  81511. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  81512. * @param space The space that the rotation should be in
  81513. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81514. * @param result The quaternion that the rotation should be copied to
  81515. */
  81516. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  81517. /**
  81518. * Get the rotation matrix of the bone in local or world space
  81519. * @param space The space that the rotation should be in
  81520. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81521. * @returns The rotation matrix
  81522. */
  81523. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  81524. /**
  81525. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  81526. * @param space The space that the rotation should be in
  81527. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81528. * @param result The quaternion that the rotation should be copied to
  81529. */
  81530. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  81531. /**
  81532. * Get the world position of a point that is in the local space of the bone
  81533. * @param position The local position
  81534. * @param mesh The mesh that this bone is attached to
  81535. * @returns The world position
  81536. */
  81537. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  81538. /**
  81539. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  81540. * @param position The local position
  81541. * @param mesh The mesh that this bone is attached to
  81542. * @param result The vector3 that the world position should be copied to
  81543. */
  81544. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81545. /**
  81546. * Get the local position of a point that is in world space
  81547. * @param position The world position
  81548. * @param mesh The mesh that this bone is attached to
  81549. * @returns The local position
  81550. */
  81551. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  81552. /**
  81553. * Get the local position of a point that is in world space and copy it to the result param
  81554. * @param position The world position
  81555. * @param mesh The mesh that this bone is attached to
  81556. * @param result The vector3 that the local position should be copied to
  81557. */
  81558. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81559. }
  81560. }
  81561. declare module BABYLON {
  81562. /**
  81563. * 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.
  81564. * @see https://doc.babylonjs.com/how_to/transformnode
  81565. */
  81566. export class TransformNode extends Node {
  81567. /**
  81568. * Object will not rotate to face the camera
  81569. */
  81570. static BILLBOARDMODE_NONE: number;
  81571. /**
  81572. * Object will rotate to face the camera but only on the x axis
  81573. */
  81574. static BILLBOARDMODE_X: number;
  81575. /**
  81576. * Object will rotate to face the camera but only on the y axis
  81577. */
  81578. static BILLBOARDMODE_Y: number;
  81579. /**
  81580. * Object will rotate to face the camera but only on the z axis
  81581. */
  81582. static BILLBOARDMODE_Z: number;
  81583. /**
  81584. * Object will rotate to face the camera
  81585. */
  81586. static BILLBOARDMODE_ALL: number;
  81587. /**
  81588. * Object will rotate to face the camera's position instead of orientation
  81589. */
  81590. static BILLBOARDMODE_USE_POSITION: number;
  81591. private _forward;
  81592. private _forwardInverted;
  81593. private _up;
  81594. private _right;
  81595. private _rightInverted;
  81596. private _position;
  81597. private _rotation;
  81598. private _rotationQuaternion;
  81599. protected _scaling: Vector3;
  81600. protected _isDirty: boolean;
  81601. private _transformToBoneReferal;
  81602. private _isAbsoluteSynced;
  81603. private _billboardMode;
  81604. /**
  81605. * Gets or sets the billboard mode. Default is 0.
  81606. *
  81607. * | Value | Type | Description |
  81608. * | --- | --- | --- |
  81609. * | 0 | BILLBOARDMODE_NONE | |
  81610. * | 1 | BILLBOARDMODE_X | |
  81611. * | 2 | BILLBOARDMODE_Y | |
  81612. * | 4 | BILLBOARDMODE_Z | |
  81613. * | 7 | BILLBOARDMODE_ALL | |
  81614. *
  81615. */
  81616. billboardMode: number;
  81617. private _preserveParentRotationForBillboard;
  81618. /**
  81619. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  81620. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  81621. */
  81622. preserveParentRotationForBillboard: boolean;
  81623. /**
  81624. * 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
  81625. */
  81626. scalingDeterminant: number;
  81627. private _infiniteDistance;
  81628. /**
  81629. * Gets or sets the distance of the object to max, often used by skybox
  81630. */
  81631. infiniteDistance: boolean;
  81632. /**
  81633. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  81634. * By default the system will update normals to compensate
  81635. */
  81636. ignoreNonUniformScaling: boolean;
  81637. /**
  81638. * 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
  81639. */
  81640. reIntegrateRotationIntoRotationQuaternion: boolean;
  81641. /** @hidden */
  81642. _poseMatrix: Nullable<Matrix>;
  81643. /** @hidden */
  81644. _localMatrix: Matrix;
  81645. private _usePivotMatrix;
  81646. private _absolutePosition;
  81647. private _absoluteScaling;
  81648. private _absoluteRotationQuaternion;
  81649. private _pivotMatrix;
  81650. private _pivotMatrixInverse;
  81651. protected _postMultiplyPivotMatrix: boolean;
  81652. protected _isWorldMatrixFrozen: boolean;
  81653. /** @hidden */
  81654. _indexInSceneTransformNodesArray: number;
  81655. /**
  81656. * An event triggered after the world matrix is updated
  81657. */
  81658. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  81659. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  81660. /**
  81661. * Gets a string identifying the name of the class
  81662. * @returns "TransformNode" string
  81663. */
  81664. getClassName(): string;
  81665. /**
  81666. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  81667. */
  81668. position: Vector3;
  81669. /**
  81670. * 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)).
  81671. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  81672. */
  81673. rotation: Vector3;
  81674. /**
  81675. * 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)).
  81676. */
  81677. scaling: Vector3;
  81678. /**
  81679. * 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).
  81680. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  81681. */
  81682. rotationQuaternion: Nullable<Quaternion>;
  81683. /**
  81684. * The forward direction of that transform in world space.
  81685. */
  81686. readonly forward: Vector3;
  81687. /**
  81688. * The up direction of that transform in world space.
  81689. */
  81690. readonly up: Vector3;
  81691. /**
  81692. * The right direction of that transform in world space.
  81693. */
  81694. readonly right: Vector3;
  81695. /**
  81696. * Copies the parameter passed Matrix into the mesh Pose matrix.
  81697. * @param matrix the matrix to copy the pose from
  81698. * @returns this TransformNode.
  81699. */
  81700. updatePoseMatrix(matrix: Matrix): TransformNode;
  81701. /**
  81702. * Returns the mesh Pose matrix.
  81703. * @returns the pose matrix
  81704. */
  81705. getPoseMatrix(): Matrix;
  81706. /** @hidden */
  81707. _isSynchronized(): boolean;
  81708. /** @hidden */
  81709. _initCache(): void;
  81710. /**
  81711. * Flag the transform node as dirty (Forcing it to update everything)
  81712. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  81713. * @returns this transform node
  81714. */
  81715. markAsDirty(property: string): TransformNode;
  81716. /**
  81717. * Returns the current mesh absolute position.
  81718. * Returns a Vector3.
  81719. */
  81720. readonly absolutePosition: Vector3;
  81721. /**
  81722. * Returns the current mesh absolute scaling.
  81723. * Returns a Vector3.
  81724. */
  81725. readonly absoluteScaling: Vector3;
  81726. /**
  81727. * Returns the current mesh absolute rotation.
  81728. * Returns a Quaternion.
  81729. */
  81730. readonly absoluteRotationQuaternion: Quaternion;
  81731. /**
  81732. * Sets a new matrix to apply before all other transformation
  81733. * @param matrix defines the transform matrix
  81734. * @returns the current TransformNode
  81735. */
  81736. setPreTransformMatrix(matrix: Matrix): TransformNode;
  81737. /**
  81738. * Sets a new pivot matrix to the current node
  81739. * @param matrix defines the new pivot matrix to use
  81740. * @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
  81741. * @returns the current TransformNode
  81742. */
  81743. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  81744. /**
  81745. * Returns the mesh pivot matrix.
  81746. * Default : Identity.
  81747. * @returns the matrix
  81748. */
  81749. getPivotMatrix(): Matrix;
  81750. /**
  81751. * Instantiate (when possible) or clone that node with its hierarchy
  81752. * @param newParent defines the new parent to use for the instance (or clone)
  81753. * @param options defines options to configure how copy is done
  81754. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  81755. * @returns an instance (or a clone) of the current node with its hiearchy
  81756. */
  81757. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  81758. doNotInstantiate: boolean;
  81759. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  81760. /**
  81761. * Prevents the World matrix to be computed any longer
  81762. * @param newWorldMatrix defines an optional matrix to use as world matrix
  81763. * @returns the TransformNode.
  81764. */
  81765. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  81766. /**
  81767. * Allows back the World matrix computation.
  81768. * @returns the TransformNode.
  81769. */
  81770. unfreezeWorldMatrix(): this;
  81771. /**
  81772. * True if the World matrix has been frozen.
  81773. */
  81774. readonly isWorldMatrixFrozen: boolean;
  81775. /**
  81776. * Retuns the mesh absolute position in the World.
  81777. * @returns a Vector3.
  81778. */
  81779. getAbsolutePosition(): Vector3;
  81780. /**
  81781. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  81782. * @param absolutePosition the absolute position to set
  81783. * @returns the TransformNode.
  81784. */
  81785. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  81786. /**
  81787. * Sets the mesh position in its local space.
  81788. * @param vector3 the position to set in localspace
  81789. * @returns the TransformNode.
  81790. */
  81791. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  81792. /**
  81793. * Returns the mesh position in the local space from the current World matrix values.
  81794. * @returns a new Vector3.
  81795. */
  81796. getPositionExpressedInLocalSpace(): Vector3;
  81797. /**
  81798. * Translates the mesh along the passed Vector3 in its local space.
  81799. * @param vector3 the distance to translate in localspace
  81800. * @returns the TransformNode.
  81801. */
  81802. locallyTranslate(vector3: Vector3): TransformNode;
  81803. private static _lookAtVectorCache;
  81804. /**
  81805. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  81806. * @param targetPoint the position (must be in same space as current mesh) to look at
  81807. * @param yawCor optional yaw (y-axis) correction in radians
  81808. * @param pitchCor optional pitch (x-axis) correction in radians
  81809. * @param rollCor optional roll (z-axis) correction in radians
  81810. * @param space the choosen space of the target
  81811. * @returns the TransformNode.
  81812. */
  81813. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  81814. /**
  81815. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  81816. * This Vector3 is expressed in the World space.
  81817. * @param localAxis axis to rotate
  81818. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  81819. */
  81820. getDirection(localAxis: Vector3): Vector3;
  81821. /**
  81822. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  81823. * localAxis is expressed in the mesh local space.
  81824. * result is computed in the Wordl space from the mesh World matrix.
  81825. * @param localAxis axis to rotate
  81826. * @param result the resulting transformnode
  81827. * @returns this TransformNode.
  81828. */
  81829. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  81830. /**
  81831. * Sets this transform node rotation to the given local axis.
  81832. * @param localAxis the axis in local space
  81833. * @param yawCor optional yaw (y-axis) correction in radians
  81834. * @param pitchCor optional pitch (x-axis) correction in radians
  81835. * @param rollCor optional roll (z-axis) correction in radians
  81836. * @returns this TransformNode
  81837. */
  81838. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  81839. /**
  81840. * Sets a new pivot point to the current node
  81841. * @param point defines the new pivot point to use
  81842. * @param space defines if the point is in world or local space (local by default)
  81843. * @returns the current TransformNode
  81844. */
  81845. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  81846. /**
  81847. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  81848. * @returns the pivot point
  81849. */
  81850. getPivotPoint(): Vector3;
  81851. /**
  81852. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  81853. * @param result the vector3 to store the result
  81854. * @returns this TransformNode.
  81855. */
  81856. getPivotPointToRef(result: Vector3): TransformNode;
  81857. /**
  81858. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  81859. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  81860. */
  81861. getAbsolutePivotPoint(): Vector3;
  81862. /**
  81863. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  81864. * @param result vector3 to store the result
  81865. * @returns this TransformNode.
  81866. */
  81867. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  81868. /**
  81869. * Defines the passed node as the parent of the current node.
  81870. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  81871. * @see https://doc.babylonjs.com/how_to/parenting
  81872. * @param node the node ot set as the parent
  81873. * @returns this TransformNode.
  81874. */
  81875. setParent(node: Nullable<Node>): TransformNode;
  81876. private _nonUniformScaling;
  81877. /**
  81878. * True if the scaling property of this object is non uniform eg. (1,2,1)
  81879. */
  81880. readonly nonUniformScaling: boolean;
  81881. /** @hidden */
  81882. _updateNonUniformScalingState(value: boolean): boolean;
  81883. /**
  81884. * Attach the current TransformNode to another TransformNode associated with a bone
  81885. * @param bone Bone affecting the TransformNode
  81886. * @param affectedTransformNode TransformNode associated with the bone
  81887. * @returns this object
  81888. */
  81889. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  81890. /**
  81891. * Detach the transform node if its associated with a bone
  81892. * @returns this object
  81893. */
  81894. detachFromBone(): TransformNode;
  81895. private static _rotationAxisCache;
  81896. /**
  81897. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  81898. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  81899. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  81900. * The passed axis is also normalized.
  81901. * @param axis the axis to rotate around
  81902. * @param amount the amount to rotate in radians
  81903. * @param space Space to rotate in (Default: local)
  81904. * @returns the TransformNode.
  81905. */
  81906. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  81907. /**
  81908. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  81909. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  81910. * The passed axis is also normalized. .
  81911. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  81912. * @param point the point to rotate around
  81913. * @param axis the axis to rotate around
  81914. * @param amount the amount to rotate in radians
  81915. * @returns the TransformNode
  81916. */
  81917. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  81918. /**
  81919. * Translates the mesh along the axis vector for the passed distance in the given space.
  81920. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  81921. * @param axis the axis to translate in
  81922. * @param distance the distance to translate
  81923. * @param space Space to rotate in (Default: local)
  81924. * @returns the TransformNode.
  81925. */
  81926. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  81927. /**
  81928. * Adds a rotation step to the mesh current rotation.
  81929. * x, y, z are Euler angles expressed in radians.
  81930. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  81931. * This means this rotation is made in the mesh local space only.
  81932. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  81933. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  81934. * ```javascript
  81935. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  81936. * ```
  81937. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  81938. * 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.
  81939. * @param x Rotation to add
  81940. * @param y Rotation to add
  81941. * @param z Rotation to add
  81942. * @returns the TransformNode.
  81943. */
  81944. addRotation(x: number, y: number, z: number): TransformNode;
  81945. /**
  81946. * @hidden
  81947. */
  81948. protected _getEffectiveParent(): Nullable<Node>;
  81949. /**
  81950. * Computes the world matrix of the node
  81951. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  81952. * @returns the world matrix
  81953. */
  81954. computeWorldMatrix(force?: boolean): Matrix;
  81955. protected _afterComputeWorldMatrix(): void;
  81956. /**
  81957. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  81958. * @param func callback function to add
  81959. *
  81960. * @returns the TransformNode.
  81961. */
  81962. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  81963. /**
  81964. * Removes a registered callback function.
  81965. * @param func callback function to remove
  81966. * @returns the TransformNode.
  81967. */
  81968. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  81969. /**
  81970. * Gets the position of the current mesh in camera space
  81971. * @param camera defines the camera to use
  81972. * @returns a position
  81973. */
  81974. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  81975. /**
  81976. * Returns the distance from the mesh to the active camera
  81977. * @param camera defines the camera to use
  81978. * @returns the distance
  81979. */
  81980. getDistanceToCamera(camera?: Nullable<Camera>): number;
  81981. /**
  81982. * Clone the current transform node
  81983. * @param name Name of the new clone
  81984. * @param newParent New parent for the clone
  81985. * @param doNotCloneChildren Do not clone children hierarchy
  81986. * @returns the new transform node
  81987. */
  81988. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  81989. /**
  81990. * Serializes the objects information.
  81991. * @param currentSerializationObject defines the object to serialize in
  81992. * @returns the serialized object
  81993. */
  81994. serialize(currentSerializationObject?: any): any;
  81995. /**
  81996. * Returns a new TransformNode object parsed from the source provided.
  81997. * @param parsedTransformNode is the source.
  81998. * @param scene the scne the object belongs to
  81999. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  82000. * @returns a new TransformNode object parsed from the source provided.
  82001. */
  82002. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  82003. /**
  82004. * Get all child-transformNodes of this node
  82005. * @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
  82006. * @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
  82007. * @returns an array of TransformNode
  82008. */
  82009. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  82010. /**
  82011. * Releases resources associated with this transform node.
  82012. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  82013. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  82014. */
  82015. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  82016. /**
  82017. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  82018. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  82019. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  82020. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  82021. * @returns the current mesh
  82022. */
  82023. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  82024. private _syncAbsoluteScalingAndRotation;
  82025. }
  82026. }
  82027. declare module BABYLON {
  82028. /**
  82029. * Defines the types of pose enabled controllers that are supported
  82030. */
  82031. export enum PoseEnabledControllerType {
  82032. /**
  82033. * HTC Vive
  82034. */
  82035. VIVE = 0,
  82036. /**
  82037. * Oculus Rift
  82038. */
  82039. OCULUS = 1,
  82040. /**
  82041. * Windows mixed reality
  82042. */
  82043. WINDOWS = 2,
  82044. /**
  82045. * Samsung gear VR
  82046. */
  82047. GEAR_VR = 3,
  82048. /**
  82049. * Google Daydream
  82050. */
  82051. DAYDREAM = 4,
  82052. /**
  82053. * Generic
  82054. */
  82055. GENERIC = 5
  82056. }
  82057. /**
  82058. * Defines the MutableGamepadButton interface for the state of a gamepad button
  82059. */
  82060. export interface MutableGamepadButton {
  82061. /**
  82062. * Value of the button/trigger
  82063. */
  82064. value: number;
  82065. /**
  82066. * If the button/trigger is currently touched
  82067. */
  82068. touched: boolean;
  82069. /**
  82070. * If the button/trigger is currently pressed
  82071. */
  82072. pressed: boolean;
  82073. }
  82074. /**
  82075. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  82076. * @hidden
  82077. */
  82078. export interface ExtendedGamepadButton extends GamepadButton {
  82079. /**
  82080. * If the button/trigger is currently pressed
  82081. */
  82082. readonly pressed: boolean;
  82083. /**
  82084. * If the button/trigger is currently touched
  82085. */
  82086. readonly touched: boolean;
  82087. /**
  82088. * Value of the button/trigger
  82089. */
  82090. readonly value: number;
  82091. }
  82092. /** @hidden */
  82093. export interface _GamePadFactory {
  82094. /**
  82095. * Returns wether or not the current gamepad can be created for this type of controller.
  82096. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  82097. * @returns true if it can be created, otherwise false
  82098. */
  82099. canCreate(gamepadInfo: any): boolean;
  82100. /**
  82101. * Creates a new instance of the Gamepad.
  82102. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  82103. * @returns the new gamepad instance
  82104. */
  82105. create(gamepadInfo: any): Gamepad;
  82106. }
  82107. /**
  82108. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  82109. */
  82110. export class PoseEnabledControllerHelper {
  82111. /** @hidden */
  82112. static _ControllerFactories: _GamePadFactory[];
  82113. /** @hidden */
  82114. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  82115. /**
  82116. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  82117. * @param vrGamepad the gamepad to initialized
  82118. * @returns a vr controller of the type the gamepad identified as
  82119. */
  82120. static InitiateController(vrGamepad: any): Gamepad;
  82121. }
  82122. /**
  82123. * Defines the PoseEnabledController object that contains state of a vr capable controller
  82124. */
  82125. export class PoseEnabledController extends Gamepad implements PoseControlled {
  82126. /**
  82127. * If the controller is used in a webXR session
  82128. */
  82129. isXR: boolean;
  82130. private _deviceRoomPosition;
  82131. private _deviceRoomRotationQuaternion;
  82132. /**
  82133. * The device position in babylon space
  82134. */
  82135. devicePosition: Vector3;
  82136. /**
  82137. * The device rotation in babylon space
  82138. */
  82139. deviceRotationQuaternion: Quaternion;
  82140. /**
  82141. * The scale factor of the device in babylon space
  82142. */
  82143. deviceScaleFactor: number;
  82144. /**
  82145. * (Likely devicePosition should be used instead) The device position in its room space
  82146. */
  82147. position: Vector3;
  82148. /**
  82149. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  82150. */
  82151. rotationQuaternion: Quaternion;
  82152. /**
  82153. * The type of controller (Eg. Windows mixed reality)
  82154. */
  82155. controllerType: PoseEnabledControllerType;
  82156. protected _calculatedPosition: Vector3;
  82157. private _calculatedRotation;
  82158. /**
  82159. * The raw pose from the device
  82160. */
  82161. rawPose: DevicePose;
  82162. private _trackPosition;
  82163. private _maxRotationDistFromHeadset;
  82164. private _draggedRoomRotation;
  82165. /**
  82166. * @hidden
  82167. */
  82168. _disableTrackPosition(fixedPosition: Vector3): void;
  82169. /**
  82170. * Internal, the mesh attached to the controller
  82171. * @hidden
  82172. */
  82173. _mesh: Nullable<AbstractMesh>;
  82174. private _poseControlledCamera;
  82175. private _leftHandSystemQuaternion;
  82176. /**
  82177. * Internal, matrix used to convert room space to babylon space
  82178. * @hidden
  82179. */
  82180. _deviceToWorld: Matrix;
  82181. /**
  82182. * Node to be used when casting a ray from the controller
  82183. * @hidden
  82184. */
  82185. _pointingPoseNode: Nullable<TransformNode>;
  82186. /**
  82187. * Name of the child mesh that can be used to cast a ray from the controller
  82188. */
  82189. static readonly POINTING_POSE: string;
  82190. /**
  82191. * Creates a new PoseEnabledController from a gamepad
  82192. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  82193. */
  82194. constructor(browserGamepad: any);
  82195. private _workingMatrix;
  82196. /**
  82197. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  82198. */
  82199. update(): void;
  82200. /**
  82201. * Updates only the pose device and mesh without doing any button event checking
  82202. */
  82203. protected _updatePoseAndMesh(): void;
  82204. /**
  82205. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  82206. * @param poseData raw pose fromthe device
  82207. */
  82208. updateFromDevice(poseData: DevicePose): void;
  82209. /**
  82210. * @hidden
  82211. */
  82212. _meshAttachedObservable: Observable<AbstractMesh>;
  82213. /**
  82214. * Attaches a mesh to the controller
  82215. * @param mesh the mesh to be attached
  82216. */
  82217. attachToMesh(mesh: AbstractMesh): void;
  82218. /**
  82219. * Attaches the controllers mesh to a camera
  82220. * @param camera the camera the mesh should be attached to
  82221. */
  82222. attachToPoseControlledCamera(camera: TargetCamera): void;
  82223. /**
  82224. * Disposes of the controller
  82225. */
  82226. dispose(): void;
  82227. /**
  82228. * The mesh that is attached to the controller
  82229. */
  82230. readonly mesh: Nullable<AbstractMesh>;
  82231. /**
  82232. * Gets the ray of the controller in the direction the controller is pointing
  82233. * @param length the length the resulting ray should be
  82234. * @returns a ray in the direction the controller is pointing
  82235. */
  82236. getForwardRay(length?: number): Ray;
  82237. }
  82238. }
  82239. declare module BABYLON {
  82240. /**
  82241. * Defines the WebVRController object that represents controllers tracked in 3D space
  82242. */
  82243. export abstract class WebVRController extends PoseEnabledController {
  82244. /**
  82245. * Internal, the default controller model for the controller
  82246. */
  82247. protected _defaultModel: Nullable<AbstractMesh>;
  82248. /**
  82249. * Fired when the trigger state has changed
  82250. */
  82251. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  82252. /**
  82253. * Fired when the main button state has changed
  82254. */
  82255. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  82256. /**
  82257. * Fired when the secondary button state has changed
  82258. */
  82259. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  82260. /**
  82261. * Fired when the pad state has changed
  82262. */
  82263. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  82264. /**
  82265. * Fired when controllers stick values have changed
  82266. */
  82267. onPadValuesChangedObservable: Observable<StickValues>;
  82268. /**
  82269. * Array of button availible on the controller
  82270. */
  82271. protected _buttons: Array<MutableGamepadButton>;
  82272. private _onButtonStateChange;
  82273. /**
  82274. * Fired when a controller button's state has changed
  82275. * @param callback the callback containing the button that was modified
  82276. */
  82277. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  82278. /**
  82279. * X and Y axis corresponding to the controllers joystick
  82280. */
  82281. pad: StickValues;
  82282. /**
  82283. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  82284. */
  82285. hand: string;
  82286. /**
  82287. * The default controller model for the controller
  82288. */
  82289. readonly defaultModel: Nullable<AbstractMesh>;
  82290. /**
  82291. * Creates a new WebVRController from a gamepad
  82292. * @param vrGamepad the gamepad that the WebVRController should be created from
  82293. */
  82294. constructor(vrGamepad: any);
  82295. /**
  82296. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  82297. */
  82298. update(): void;
  82299. /**
  82300. * Function to be called when a button is modified
  82301. */
  82302. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  82303. /**
  82304. * Loads a mesh and attaches it to the controller
  82305. * @param scene the scene the mesh should be added to
  82306. * @param meshLoaded callback for when the mesh has been loaded
  82307. */
  82308. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  82309. private _setButtonValue;
  82310. private _changes;
  82311. private _checkChanges;
  82312. /**
  82313. * Disposes of th webVRCOntroller
  82314. */
  82315. dispose(): void;
  82316. }
  82317. }
  82318. declare module BABYLON {
  82319. /**
  82320. * The HemisphericLight simulates the ambient environment light,
  82321. * so the passed direction is the light reflection direction, not the incoming direction.
  82322. */
  82323. export class HemisphericLight extends Light {
  82324. /**
  82325. * The groundColor is the light in the opposite direction to the one specified during creation.
  82326. * 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.
  82327. */
  82328. groundColor: Color3;
  82329. /**
  82330. * The light reflection direction, not the incoming direction.
  82331. */
  82332. direction: Vector3;
  82333. /**
  82334. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  82335. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  82336. * The HemisphericLight can't cast shadows.
  82337. * Documentation : https://doc.babylonjs.com/babylon101/lights
  82338. * @param name The friendly name of the light
  82339. * @param direction The direction of the light reflection
  82340. * @param scene The scene the light belongs to
  82341. */
  82342. constructor(name: string, direction: Vector3, scene: Scene);
  82343. protected _buildUniformLayout(): void;
  82344. /**
  82345. * Returns the string "HemisphericLight".
  82346. * @return The class name
  82347. */
  82348. getClassName(): string;
  82349. /**
  82350. * Sets the HemisphericLight direction towards the passed target (Vector3).
  82351. * Returns the updated direction.
  82352. * @param target The target the direction should point to
  82353. * @return The computed direction
  82354. */
  82355. setDirectionToTarget(target: Vector3): Vector3;
  82356. /**
  82357. * Returns the shadow generator associated to the light.
  82358. * @returns Always null for hemispheric lights because it does not support shadows.
  82359. */
  82360. getShadowGenerator(): Nullable<IShadowGenerator>;
  82361. /**
  82362. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  82363. * @param effect The effect to update
  82364. * @param lightIndex The index of the light in the effect to update
  82365. * @returns The hemispheric light
  82366. */
  82367. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  82368. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  82369. /**
  82370. * Computes the world matrix of the node
  82371. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  82372. * @param useWasUpdatedFlag defines a reserved property
  82373. * @returns the world matrix
  82374. */
  82375. computeWorldMatrix(): Matrix;
  82376. /**
  82377. * Returns the integer 3.
  82378. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  82379. */
  82380. getTypeID(): number;
  82381. /**
  82382. * Prepares the list of defines specific to the light type.
  82383. * @param defines the list of defines
  82384. * @param lightIndex defines the index of the light for the effect
  82385. */
  82386. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  82387. }
  82388. }
  82389. declare module BABYLON {
  82390. /** @hidden */
  82391. export var vrMultiviewToSingleviewPixelShader: {
  82392. name: string;
  82393. shader: string;
  82394. };
  82395. }
  82396. declare module BABYLON {
  82397. /**
  82398. * Renders to multiple views with a single draw call
  82399. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  82400. */
  82401. export class MultiviewRenderTarget extends RenderTargetTexture {
  82402. /**
  82403. * Creates a multiview render target
  82404. * @param scene scene used with the render target
  82405. * @param size the size of the render target (used for each view)
  82406. */
  82407. constructor(scene: Scene, size?: number | {
  82408. width: number;
  82409. height: number;
  82410. } | {
  82411. ratio: number;
  82412. });
  82413. /**
  82414. * @hidden
  82415. * @param faceIndex the face index, if its a cube texture
  82416. */
  82417. _bindFrameBuffer(faceIndex?: number): void;
  82418. /**
  82419. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  82420. * @returns the view count
  82421. */
  82422. getViewCount(): number;
  82423. }
  82424. }
  82425. declare module BABYLON {
  82426. /**
  82427. * Represents a camera frustum
  82428. */
  82429. export class Frustum {
  82430. /**
  82431. * Gets the planes representing the frustum
  82432. * @param transform matrix to be applied to the returned planes
  82433. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  82434. */
  82435. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  82436. /**
  82437. * Gets the near frustum plane transformed by the transform matrix
  82438. * @param transform transformation matrix to be applied to the resulting frustum plane
  82439. * @param frustumPlane the resuling frustum plane
  82440. */
  82441. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82442. /**
  82443. * Gets the far frustum plane transformed by the transform matrix
  82444. * @param transform transformation matrix to be applied to the resulting frustum plane
  82445. * @param frustumPlane the resuling frustum plane
  82446. */
  82447. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82448. /**
  82449. * Gets the left frustum plane transformed by the transform matrix
  82450. * @param transform transformation matrix to be applied to the resulting frustum plane
  82451. * @param frustumPlane the resuling frustum plane
  82452. */
  82453. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82454. /**
  82455. * Gets the right frustum plane transformed by the transform matrix
  82456. * @param transform transformation matrix to be applied to the resulting frustum plane
  82457. * @param frustumPlane the resuling frustum plane
  82458. */
  82459. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82460. /**
  82461. * Gets the top frustum plane transformed by the transform matrix
  82462. * @param transform transformation matrix to be applied to the resulting frustum plane
  82463. * @param frustumPlane the resuling frustum plane
  82464. */
  82465. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82466. /**
  82467. * Gets the bottom frustum plane transformed by the transform matrix
  82468. * @param transform transformation matrix to be applied to the resulting frustum plane
  82469. * @param frustumPlane the resuling frustum plane
  82470. */
  82471. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82472. /**
  82473. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  82474. * @param transform transformation matrix to be applied to the resulting frustum planes
  82475. * @param frustumPlanes the resuling frustum planes
  82476. */
  82477. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  82478. }
  82479. }
  82480. declare module BABYLON {
  82481. interface Engine {
  82482. /**
  82483. * Creates a new multiview render target
  82484. * @param width defines the width of the texture
  82485. * @param height defines the height of the texture
  82486. * @returns the created multiview texture
  82487. */
  82488. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  82489. /**
  82490. * Binds a multiview framebuffer to be drawn to
  82491. * @param multiviewTexture texture to bind
  82492. */
  82493. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  82494. }
  82495. interface Camera {
  82496. /**
  82497. * @hidden
  82498. * 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)
  82499. */
  82500. _useMultiviewToSingleView: boolean;
  82501. /**
  82502. * @hidden
  82503. * 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)
  82504. */
  82505. _multiviewTexture: Nullable<RenderTargetTexture>;
  82506. /**
  82507. * @hidden
  82508. * ensures the multiview texture of the camera exists and has the specified width/height
  82509. * @param width height to set on the multiview texture
  82510. * @param height width to set on the multiview texture
  82511. */
  82512. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  82513. }
  82514. interface Scene {
  82515. /** @hidden */
  82516. _transformMatrixR: Matrix;
  82517. /** @hidden */
  82518. _multiviewSceneUbo: Nullable<UniformBuffer>;
  82519. /** @hidden */
  82520. _createMultiviewUbo(): void;
  82521. /** @hidden */
  82522. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  82523. /** @hidden */
  82524. _renderMultiviewToSingleView(camera: Camera): void;
  82525. }
  82526. }
  82527. declare module BABYLON {
  82528. /**
  82529. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  82530. * This will not be used for webXR as it supports displaying texture arrays directly
  82531. */
  82532. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  82533. /**
  82534. * Initializes a VRMultiviewToSingleview
  82535. * @param name name of the post process
  82536. * @param camera camera to be applied to
  82537. * @param scaleFactor scaling factor to the size of the output texture
  82538. */
  82539. constructor(name: string, camera: Camera, scaleFactor: number);
  82540. }
  82541. }
  82542. declare module BABYLON {
  82543. /**
  82544. * Interface used to define additional presentation attributes
  82545. */
  82546. export interface IVRPresentationAttributes {
  82547. /**
  82548. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  82549. */
  82550. highRefreshRate: boolean;
  82551. /**
  82552. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  82553. */
  82554. foveationLevel: number;
  82555. }
  82556. interface Engine {
  82557. /** @hidden */
  82558. _vrDisplay: any;
  82559. /** @hidden */
  82560. _vrSupported: boolean;
  82561. /** @hidden */
  82562. _oldSize: Size;
  82563. /** @hidden */
  82564. _oldHardwareScaleFactor: number;
  82565. /** @hidden */
  82566. _vrExclusivePointerMode: boolean;
  82567. /** @hidden */
  82568. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  82569. /** @hidden */
  82570. _onVRDisplayPointerRestricted: () => void;
  82571. /** @hidden */
  82572. _onVRDisplayPointerUnrestricted: () => void;
  82573. /** @hidden */
  82574. _onVrDisplayConnect: Nullable<(display: any) => void>;
  82575. /** @hidden */
  82576. _onVrDisplayDisconnect: Nullable<() => void>;
  82577. /** @hidden */
  82578. _onVrDisplayPresentChange: Nullable<() => void>;
  82579. /**
  82580. * Observable signaled when VR display mode changes
  82581. */
  82582. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  82583. /**
  82584. * Observable signaled when VR request present is complete
  82585. */
  82586. onVRRequestPresentComplete: Observable<boolean>;
  82587. /**
  82588. * Observable signaled when VR request present starts
  82589. */
  82590. onVRRequestPresentStart: Observable<Engine>;
  82591. /**
  82592. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  82593. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  82594. */
  82595. isInVRExclusivePointerMode: boolean;
  82596. /**
  82597. * Gets a boolean indicating if a webVR device was detected
  82598. * @returns true if a webVR device was detected
  82599. */
  82600. isVRDevicePresent(): boolean;
  82601. /**
  82602. * Gets the current webVR device
  82603. * @returns the current webVR device (or null)
  82604. */
  82605. getVRDevice(): any;
  82606. /**
  82607. * Initializes a webVR display and starts listening to display change events
  82608. * The onVRDisplayChangedObservable will be notified upon these changes
  82609. * @returns A promise containing a VRDisplay and if vr is supported
  82610. */
  82611. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  82612. /** @hidden */
  82613. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  82614. /**
  82615. * Gets or sets the presentation attributes used to configure VR rendering
  82616. */
  82617. vrPresentationAttributes?: IVRPresentationAttributes;
  82618. /**
  82619. * Call this function to switch to webVR mode
  82620. * Will do nothing if webVR is not supported or if there is no webVR device
  82621. * @see http://doc.babylonjs.com/how_to/webvr_camera
  82622. */
  82623. enableVR(): void;
  82624. /** @hidden */
  82625. _onVRFullScreenTriggered(): void;
  82626. }
  82627. }
  82628. declare module BABYLON {
  82629. /**
  82630. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  82631. * IMPORTANT!! The data is right-hand data.
  82632. * @export
  82633. * @interface DevicePose
  82634. */
  82635. export interface DevicePose {
  82636. /**
  82637. * The position of the device, values in array are [x,y,z].
  82638. */
  82639. readonly position: Nullable<Float32Array>;
  82640. /**
  82641. * The linearVelocity of the device, values in array are [x,y,z].
  82642. */
  82643. readonly linearVelocity: Nullable<Float32Array>;
  82644. /**
  82645. * The linearAcceleration of the device, values in array are [x,y,z].
  82646. */
  82647. readonly linearAcceleration: Nullable<Float32Array>;
  82648. /**
  82649. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  82650. */
  82651. readonly orientation: Nullable<Float32Array>;
  82652. /**
  82653. * The angularVelocity of the device, values in array are [x,y,z].
  82654. */
  82655. readonly angularVelocity: Nullable<Float32Array>;
  82656. /**
  82657. * The angularAcceleration of the device, values in array are [x,y,z].
  82658. */
  82659. readonly angularAcceleration: Nullable<Float32Array>;
  82660. }
  82661. /**
  82662. * Interface representing a pose controlled object in Babylon.
  82663. * A pose controlled object has both regular pose values as well as pose values
  82664. * from an external device such as a VR head mounted display
  82665. */
  82666. export interface PoseControlled {
  82667. /**
  82668. * The position of the object in babylon space.
  82669. */
  82670. position: Vector3;
  82671. /**
  82672. * The rotation quaternion of the object in babylon space.
  82673. */
  82674. rotationQuaternion: Quaternion;
  82675. /**
  82676. * The position of the device in babylon space.
  82677. */
  82678. devicePosition?: Vector3;
  82679. /**
  82680. * The rotation quaternion of the device in babylon space.
  82681. */
  82682. deviceRotationQuaternion: Quaternion;
  82683. /**
  82684. * The raw pose coming from the device.
  82685. */
  82686. rawPose: Nullable<DevicePose>;
  82687. /**
  82688. * The scale of the device to be used when translating from device space to babylon space.
  82689. */
  82690. deviceScaleFactor: number;
  82691. /**
  82692. * Updates the poseControlled values based on the input device pose.
  82693. * @param poseData the pose data to update the object with
  82694. */
  82695. updateFromDevice(poseData: DevicePose): void;
  82696. }
  82697. /**
  82698. * Set of options to customize the webVRCamera
  82699. */
  82700. export interface WebVROptions {
  82701. /**
  82702. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  82703. */
  82704. trackPosition?: boolean;
  82705. /**
  82706. * Sets the scale of the vrDevice in babylon space. (default: 1)
  82707. */
  82708. positionScale?: number;
  82709. /**
  82710. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  82711. */
  82712. displayName?: string;
  82713. /**
  82714. * Should the native controller meshes be initialized. (default: true)
  82715. */
  82716. controllerMeshes?: boolean;
  82717. /**
  82718. * Creating a default HemiLight only on controllers. (default: true)
  82719. */
  82720. defaultLightingOnControllers?: boolean;
  82721. /**
  82722. * If you don't want to use the default VR button of the helper. (default: false)
  82723. */
  82724. useCustomVRButton?: boolean;
  82725. /**
  82726. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  82727. */
  82728. customVRButton?: HTMLButtonElement;
  82729. /**
  82730. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  82731. */
  82732. rayLength?: number;
  82733. /**
  82734. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  82735. */
  82736. defaultHeight?: number;
  82737. /**
  82738. * If multiview should be used if availible (default: false)
  82739. */
  82740. useMultiview?: boolean;
  82741. }
  82742. /**
  82743. * This represents a WebVR camera.
  82744. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  82745. * @example http://doc.babylonjs.com/how_to/webvr_camera
  82746. */
  82747. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  82748. private webVROptions;
  82749. /**
  82750. * @hidden
  82751. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  82752. */
  82753. _vrDevice: any;
  82754. /**
  82755. * The rawPose of the vrDevice.
  82756. */
  82757. rawPose: Nullable<DevicePose>;
  82758. private _onVREnabled;
  82759. private _specsVersion;
  82760. private _attached;
  82761. private _frameData;
  82762. protected _descendants: Array<Node>;
  82763. private _deviceRoomPosition;
  82764. /** @hidden */
  82765. _deviceRoomRotationQuaternion: Quaternion;
  82766. private _standingMatrix;
  82767. /**
  82768. * Represents device position in babylon space.
  82769. */
  82770. devicePosition: Vector3;
  82771. /**
  82772. * Represents device rotation in babylon space.
  82773. */
  82774. deviceRotationQuaternion: Quaternion;
  82775. /**
  82776. * The scale of the device to be used when translating from device space to babylon space.
  82777. */
  82778. deviceScaleFactor: number;
  82779. private _deviceToWorld;
  82780. private _worldToDevice;
  82781. /**
  82782. * References to the webVR controllers for the vrDevice.
  82783. */
  82784. controllers: Array<WebVRController>;
  82785. /**
  82786. * Emits an event when a controller is attached.
  82787. */
  82788. onControllersAttachedObservable: Observable<WebVRController[]>;
  82789. /**
  82790. * Emits an event when a controller's mesh has been loaded;
  82791. */
  82792. onControllerMeshLoadedObservable: Observable<WebVRController>;
  82793. /**
  82794. * Emits an event when the HMD's pose has been updated.
  82795. */
  82796. onPoseUpdatedFromDeviceObservable: Observable<any>;
  82797. private _poseSet;
  82798. /**
  82799. * If the rig cameras be used as parent instead of this camera.
  82800. */
  82801. rigParenting: boolean;
  82802. private _lightOnControllers;
  82803. private _defaultHeight?;
  82804. /**
  82805. * Instantiates a WebVRFreeCamera.
  82806. * @param name The name of the WebVRFreeCamera
  82807. * @param position The starting anchor position for the camera
  82808. * @param scene The scene the camera belongs to
  82809. * @param webVROptions a set of customizable options for the webVRCamera
  82810. */
  82811. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  82812. /**
  82813. * Gets the device distance from the ground in meters.
  82814. * @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.
  82815. */
  82816. deviceDistanceToRoomGround(): number;
  82817. /**
  82818. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  82819. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  82820. */
  82821. useStandingMatrix(callback?: (bool: boolean) => void): void;
  82822. /**
  82823. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  82824. * @returns A promise with a boolean set to if the standing matrix is supported.
  82825. */
  82826. useStandingMatrixAsync(): Promise<boolean>;
  82827. /**
  82828. * Disposes the camera
  82829. */
  82830. dispose(): void;
  82831. /**
  82832. * Gets a vrController by name.
  82833. * @param name The name of the controller to retreive
  82834. * @returns the controller matching the name specified or null if not found
  82835. */
  82836. getControllerByName(name: string): Nullable<WebVRController>;
  82837. private _leftController;
  82838. /**
  82839. * The controller corresponding to the users left hand.
  82840. */
  82841. readonly leftController: Nullable<WebVRController>;
  82842. private _rightController;
  82843. /**
  82844. * The controller corresponding to the users right hand.
  82845. */
  82846. readonly rightController: Nullable<WebVRController>;
  82847. /**
  82848. * Casts a ray forward from the vrCamera's gaze.
  82849. * @param length Length of the ray (default: 100)
  82850. * @returns the ray corresponding to the gaze
  82851. */
  82852. getForwardRay(length?: number): Ray;
  82853. /**
  82854. * @hidden
  82855. * Updates the camera based on device's frame data
  82856. */
  82857. _checkInputs(): void;
  82858. /**
  82859. * Updates the poseControlled values based on the input device pose.
  82860. * @param poseData Pose coming from the device
  82861. */
  82862. updateFromDevice(poseData: DevicePose): void;
  82863. private _htmlElementAttached;
  82864. private _detachIfAttached;
  82865. /**
  82866. * WebVR's attach control will start broadcasting frames to the device.
  82867. * Note that in certain browsers (chrome for example) this function must be called
  82868. * within a user-interaction callback. Example:
  82869. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  82870. *
  82871. * @param element html element to attach the vrDevice to
  82872. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  82873. */
  82874. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  82875. /**
  82876. * Detaches the camera from the html element and disables VR
  82877. *
  82878. * @param element html element to detach from
  82879. */
  82880. detachControl(element: HTMLElement): void;
  82881. /**
  82882. * @returns the name of this class
  82883. */
  82884. getClassName(): string;
  82885. /**
  82886. * Calls resetPose on the vrDisplay
  82887. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  82888. */
  82889. resetToCurrentRotation(): void;
  82890. /**
  82891. * @hidden
  82892. * Updates the rig cameras (left and right eye)
  82893. */
  82894. _updateRigCameras(): void;
  82895. private _workingVector;
  82896. private _oneVector;
  82897. private _workingMatrix;
  82898. private updateCacheCalled;
  82899. private _correctPositionIfNotTrackPosition;
  82900. /**
  82901. * @hidden
  82902. * Updates the cached values of the camera
  82903. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  82904. */
  82905. _updateCache(ignoreParentClass?: boolean): void;
  82906. /**
  82907. * @hidden
  82908. * Get current device position in babylon world
  82909. */
  82910. _computeDevicePosition(): void;
  82911. /**
  82912. * Updates the current device position and rotation in the babylon world
  82913. */
  82914. update(): void;
  82915. /**
  82916. * @hidden
  82917. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  82918. * @returns an identity matrix
  82919. */
  82920. _getViewMatrix(): Matrix;
  82921. private _tmpMatrix;
  82922. /**
  82923. * This function is called by the two RIG cameras.
  82924. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  82925. * @hidden
  82926. */
  82927. _getWebVRViewMatrix(): Matrix;
  82928. /** @hidden */
  82929. _getWebVRProjectionMatrix(): Matrix;
  82930. private _onGamepadConnectedObserver;
  82931. private _onGamepadDisconnectedObserver;
  82932. private _updateCacheWhenTrackingDisabledObserver;
  82933. /**
  82934. * Initializes the controllers and their meshes
  82935. */
  82936. initControllers(): void;
  82937. }
  82938. }
  82939. declare module BABYLON {
  82940. /**
  82941. * Size options for a post process
  82942. */
  82943. export type PostProcessOptions = {
  82944. width: number;
  82945. height: number;
  82946. };
  82947. /**
  82948. * PostProcess can be used to apply a shader to a texture after it has been rendered
  82949. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  82950. */
  82951. export class PostProcess {
  82952. /** Name of the PostProcess. */
  82953. name: string;
  82954. /**
  82955. * Gets or sets the unique id of the post process
  82956. */
  82957. uniqueId: number;
  82958. /**
  82959. * Width of the texture to apply the post process on
  82960. */
  82961. width: number;
  82962. /**
  82963. * Height of the texture to apply the post process on
  82964. */
  82965. height: number;
  82966. /**
  82967. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  82968. * @hidden
  82969. */
  82970. _outputTexture: Nullable<InternalTexture>;
  82971. /**
  82972. * Sampling mode used by the shader
  82973. * See https://doc.babylonjs.com/classes/3.1/texture
  82974. */
  82975. renderTargetSamplingMode: number;
  82976. /**
  82977. * Clear color to use when screen clearing
  82978. */
  82979. clearColor: Color4;
  82980. /**
  82981. * If the buffer needs to be cleared before applying the post process. (default: true)
  82982. * Should be set to false if shader will overwrite all previous pixels.
  82983. */
  82984. autoClear: boolean;
  82985. /**
  82986. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  82987. */
  82988. alphaMode: number;
  82989. /**
  82990. * Sets the setAlphaBlendConstants of the babylon engine
  82991. */
  82992. alphaConstants: Color4;
  82993. /**
  82994. * Animations to be used for the post processing
  82995. */
  82996. animations: Animation[];
  82997. /**
  82998. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  82999. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  83000. */
  83001. enablePixelPerfectMode: boolean;
  83002. /**
  83003. * Force the postprocess to be applied without taking in account viewport
  83004. */
  83005. forceFullscreenViewport: boolean;
  83006. /**
  83007. * List of inspectable custom properties (used by the Inspector)
  83008. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  83009. */
  83010. inspectableCustomProperties: IInspectable[];
  83011. /**
  83012. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  83013. *
  83014. * | Value | Type | Description |
  83015. * | ----- | ----------------------------------- | ----------- |
  83016. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  83017. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  83018. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  83019. *
  83020. */
  83021. scaleMode: number;
  83022. /**
  83023. * Force textures to be a power of two (default: false)
  83024. */
  83025. alwaysForcePOT: boolean;
  83026. private _samples;
  83027. /**
  83028. * Number of sample textures (default: 1)
  83029. */
  83030. samples: number;
  83031. /**
  83032. * Modify the scale of the post process to be the same as the viewport (default: false)
  83033. */
  83034. adaptScaleToCurrentViewport: boolean;
  83035. private _camera;
  83036. private _scene;
  83037. private _engine;
  83038. private _options;
  83039. private _reusable;
  83040. private _textureType;
  83041. /**
  83042. * Smart array of input and output textures for the post process.
  83043. * @hidden
  83044. */
  83045. _textures: SmartArray<InternalTexture>;
  83046. /**
  83047. * The index in _textures that corresponds to the output texture.
  83048. * @hidden
  83049. */
  83050. _currentRenderTextureInd: number;
  83051. private _effect;
  83052. private _samplers;
  83053. private _fragmentUrl;
  83054. private _vertexUrl;
  83055. private _parameters;
  83056. private _scaleRatio;
  83057. protected _indexParameters: any;
  83058. private _shareOutputWithPostProcess;
  83059. private _texelSize;
  83060. private _forcedOutputTexture;
  83061. /**
  83062. * Returns the fragment url or shader name used in the post process.
  83063. * @returns the fragment url or name in the shader store.
  83064. */
  83065. getEffectName(): string;
  83066. /**
  83067. * An event triggered when the postprocess is activated.
  83068. */
  83069. onActivateObservable: Observable<Camera>;
  83070. private _onActivateObserver;
  83071. /**
  83072. * A function that is added to the onActivateObservable
  83073. */
  83074. onActivate: Nullable<(camera: Camera) => void>;
  83075. /**
  83076. * An event triggered when the postprocess changes its size.
  83077. */
  83078. onSizeChangedObservable: Observable<PostProcess>;
  83079. private _onSizeChangedObserver;
  83080. /**
  83081. * A function that is added to the onSizeChangedObservable
  83082. */
  83083. onSizeChanged: (postProcess: PostProcess) => void;
  83084. /**
  83085. * An event triggered when the postprocess applies its effect.
  83086. */
  83087. onApplyObservable: Observable<Effect>;
  83088. private _onApplyObserver;
  83089. /**
  83090. * A function that is added to the onApplyObservable
  83091. */
  83092. onApply: (effect: Effect) => void;
  83093. /**
  83094. * An event triggered before rendering the postprocess
  83095. */
  83096. onBeforeRenderObservable: Observable<Effect>;
  83097. private _onBeforeRenderObserver;
  83098. /**
  83099. * A function that is added to the onBeforeRenderObservable
  83100. */
  83101. onBeforeRender: (effect: Effect) => void;
  83102. /**
  83103. * An event triggered after rendering the postprocess
  83104. */
  83105. onAfterRenderObservable: Observable<Effect>;
  83106. private _onAfterRenderObserver;
  83107. /**
  83108. * A function that is added to the onAfterRenderObservable
  83109. */
  83110. onAfterRender: (efect: Effect) => void;
  83111. /**
  83112. * 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
  83113. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  83114. */
  83115. inputTexture: InternalTexture;
  83116. /**
  83117. * Gets the camera which post process is applied to.
  83118. * @returns The camera the post process is applied to.
  83119. */
  83120. getCamera(): Camera;
  83121. /**
  83122. * Gets the texel size of the postprocess.
  83123. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  83124. */
  83125. readonly texelSize: Vector2;
  83126. /**
  83127. * Creates a new instance PostProcess
  83128. * @param name The name of the PostProcess.
  83129. * @param fragmentUrl The url of the fragment shader to be used.
  83130. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  83131. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  83132. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  83133. * @param camera The camera to apply the render pass to.
  83134. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  83135. * @param engine The engine which the post process will be applied. (default: current engine)
  83136. * @param reusable If the post process can be reused on the same frame. (default: false)
  83137. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  83138. * @param textureType Type of textures used when performing the post process. (default: 0)
  83139. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  83140. * @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
  83141. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  83142. */
  83143. constructor(
  83144. /** Name of the PostProcess. */
  83145. 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);
  83146. /**
  83147. * Gets a string idenfifying the name of the class
  83148. * @returns "PostProcess" string
  83149. */
  83150. getClassName(): string;
  83151. /**
  83152. * Gets the engine which this post process belongs to.
  83153. * @returns The engine the post process was enabled with.
  83154. */
  83155. getEngine(): Engine;
  83156. /**
  83157. * The effect that is created when initializing the post process.
  83158. * @returns The created effect corresponding the the postprocess.
  83159. */
  83160. getEffect(): Effect;
  83161. /**
  83162. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  83163. * @param postProcess The post process to share the output with.
  83164. * @returns This post process.
  83165. */
  83166. shareOutputWith(postProcess: PostProcess): PostProcess;
  83167. /**
  83168. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  83169. * This should be called if the post process that shares output with this post process is disabled/disposed.
  83170. */
  83171. useOwnOutput(): void;
  83172. /**
  83173. * Updates the effect with the current post process compile time values and recompiles the shader.
  83174. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  83175. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  83176. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  83177. * @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
  83178. * @param onCompiled Called when the shader has been compiled.
  83179. * @param onError Called if there is an error when compiling a shader.
  83180. */
  83181. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83182. /**
  83183. * The post process is reusable if it can be used multiple times within one frame.
  83184. * @returns If the post process is reusable
  83185. */
  83186. isReusable(): boolean;
  83187. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  83188. markTextureDirty(): void;
  83189. /**
  83190. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  83191. * 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.
  83192. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  83193. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  83194. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  83195. * @returns The target texture that was bound to be written to.
  83196. */
  83197. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  83198. /**
  83199. * If the post process is supported.
  83200. */
  83201. readonly isSupported: boolean;
  83202. /**
  83203. * The aspect ratio of the output texture.
  83204. */
  83205. readonly aspectRatio: number;
  83206. /**
  83207. * Get a value indicating if the post-process is ready to be used
  83208. * @returns true if the post-process is ready (shader is compiled)
  83209. */
  83210. isReady(): boolean;
  83211. /**
  83212. * Binds all textures and uniforms to the shader, this will be run on every pass.
  83213. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  83214. */
  83215. apply(): Nullable<Effect>;
  83216. private _disposeTextures;
  83217. /**
  83218. * Disposes the post process.
  83219. * @param camera The camera to dispose the post process on.
  83220. */
  83221. dispose(camera?: Camera): void;
  83222. }
  83223. }
  83224. declare module BABYLON {
  83225. /** @hidden */
  83226. export var kernelBlurVaryingDeclaration: {
  83227. name: string;
  83228. shader: string;
  83229. };
  83230. }
  83231. declare module BABYLON {
  83232. /** @hidden */
  83233. export var kernelBlurFragment: {
  83234. name: string;
  83235. shader: string;
  83236. };
  83237. }
  83238. declare module BABYLON {
  83239. /** @hidden */
  83240. export var kernelBlurFragment2: {
  83241. name: string;
  83242. shader: string;
  83243. };
  83244. }
  83245. declare module BABYLON {
  83246. /** @hidden */
  83247. export var kernelBlurPixelShader: {
  83248. name: string;
  83249. shader: string;
  83250. };
  83251. }
  83252. declare module BABYLON {
  83253. /** @hidden */
  83254. export var kernelBlurVertex: {
  83255. name: string;
  83256. shader: string;
  83257. };
  83258. }
  83259. declare module BABYLON {
  83260. /** @hidden */
  83261. export var kernelBlurVertexShader: {
  83262. name: string;
  83263. shader: string;
  83264. };
  83265. }
  83266. declare module BABYLON {
  83267. /**
  83268. * The Blur Post Process which blurs an image based on a kernel and direction.
  83269. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  83270. */
  83271. export class BlurPostProcess extends PostProcess {
  83272. /** The direction in which to blur the image. */
  83273. direction: Vector2;
  83274. private blockCompilation;
  83275. protected _kernel: number;
  83276. protected _idealKernel: number;
  83277. protected _packedFloat: boolean;
  83278. private _staticDefines;
  83279. /**
  83280. * Sets the length in pixels of the blur sample region
  83281. */
  83282. /**
  83283. * Gets the length in pixels of the blur sample region
  83284. */
  83285. kernel: number;
  83286. /**
  83287. * Sets wether or not the blur needs to unpack/repack floats
  83288. */
  83289. /**
  83290. * Gets wether or not the blur is unpacking/repacking floats
  83291. */
  83292. packedFloat: boolean;
  83293. /**
  83294. * Creates a new instance BlurPostProcess
  83295. * @param name The name of the effect.
  83296. * @param direction The direction in which to blur the image.
  83297. * @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.
  83298. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  83299. * @param camera The camera to apply the render pass to.
  83300. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  83301. * @param engine The engine which the post process will be applied. (default: current engine)
  83302. * @param reusable If the post process can be reused on the same frame. (default: false)
  83303. * @param textureType Type of textures used when performing the post process. (default: 0)
  83304. * @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)
  83305. */
  83306. constructor(name: string,
  83307. /** The direction in which to blur the image. */
  83308. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  83309. /**
  83310. * Updates the effect with the current post process compile time values and recompiles the shader.
  83311. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  83312. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  83313. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  83314. * @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
  83315. * @param onCompiled Called when the shader has been compiled.
  83316. * @param onError Called if there is an error when compiling a shader.
  83317. */
  83318. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83319. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83320. /**
  83321. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  83322. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  83323. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  83324. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  83325. * The gaps between physical kernels are compensated for in the weighting of the samples
  83326. * @param idealKernel Ideal blur kernel.
  83327. * @return Nearest best kernel.
  83328. */
  83329. protected _nearestBestKernel(idealKernel: number): number;
  83330. /**
  83331. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  83332. * @param x The point on the Gaussian distribution to sample.
  83333. * @return the value of the Gaussian function at x.
  83334. */
  83335. protected _gaussianWeight(x: number): number;
  83336. /**
  83337. * Generates a string that can be used as a floating point number in GLSL.
  83338. * @param x Value to print.
  83339. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  83340. * @return GLSL float string.
  83341. */
  83342. protected _glslFloat(x: number, decimalFigures?: number): string;
  83343. }
  83344. }
  83345. declare module BABYLON {
  83346. /**
  83347. * Mirror texture can be used to simulate the view from a mirror in a scene.
  83348. * It will dynamically be rendered every frame to adapt to the camera point of view.
  83349. * You can then easily use it as a reflectionTexture on a flat surface.
  83350. * In case the surface is not a plane, please consider relying on reflection probes.
  83351. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  83352. */
  83353. export class MirrorTexture extends RenderTargetTexture {
  83354. private scene;
  83355. /**
  83356. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  83357. * 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.
  83358. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  83359. */
  83360. mirrorPlane: Plane;
  83361. /**
  83362. * Define the blur ratio used to blur the reflection if needed.
  83363. */
  83364. blurRatio: number;
  83365. /**
  83366. * Define the adaptive blur kernel used to blur the reflection if needed.
  83367. * This will autocompute the closest best match for the `blurKernel`
  83368. */
  83369. adaptiveBlurKernel: number;
  83370. /**
  83371. * Define the blur kernel used to blur the reflection if needed.
  83372. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  83373. */
  83374. blurKernel: number;
  83375. /**
  83376. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  83377. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  83378. */
  83379. blurKernelX: number;
  83380. /**
  83381. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  83382. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  83383. */
  83384. blurKernelY: number;
  83385. private _autoComputeBlurKernel;
  83386. protected _onRatioRescale(): void;
  83387. private _updateGammaSpace;
  83388. private _imageProcessingConfigChangeObserver;
  83389. private _transformMatrix;
  83390. private _mirrorMatrix;
  83391. private _savedViewMatrix;
  83392. private _blurX;
  83393. private _blurY;
  83394. private _adaptiveBlurKernel;
  83395. private _blurKernelX;
  83396. private _blurKernelY;
  83397. private _blurRatio;
  83398. /**
  83399. * Instantiates a Mirror Texture.
  83400. * Mirror texture can be used to simulate the view from a mirror in a scene.
  83401. * It will dynamically be rendered every frame to adapt to the camera point of view.
  83402. * You can then easily use it as a reflectionTexture on a flat surface.
  83403. * In case the surface is not a plane, please consider relying on reflection probes.
  83404. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  83405. * @param name
  83406. * @param size
  83407. * @param scene
  83408. * @param generateMipMaps
  83409. * @param type
  83410. * @param samplingMode
  83411. * @param generateDepthBuffer
  83412. */
  83413. constructor(name: string, size: number | {
  83414. width: number;
  83415. height: number;
  83416. } | {
  83417. ratio: number;
  83418. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  83419. private _preparePostProcesses;
  83420. /**
  83421. * Clone the mirror texture.
  83422. * @returns the cloned texture
  83423. */
  83424. clone(): MirrorTexture;
  83425. /**
  83426. * Serialize the texture to a JSON representation you could use in Parse later on
  83427. * @returns the serialized JSON representation
  83428. */
  83429. serialize(): any;
  83430. /**
  83431. * Dispose the texture and release its associated resources.
  83432. */
  83433. dispose(): void;
  83434. }
  83435. }
  83436. declare module BABYLON {
  83437. /**
  83438. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  83439. * @see http://doc.babylonjs.com/babylon101/materials#texture
  83440. */
  83441. export class Texture extends BaseTexture {
  83442. /**
  83443. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  83444. */
  83445. static SerializeBuffers: boolean;
  83446. /** @hidden */
  83447. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  83448. /** @hidden */
  83449. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  83450. /** @hidden */
  83451. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  83452. /** nearest is mag = nearest and min = nearest and mip = linear */
  83453. static readonly NEAREST_SAMPLINGMODE: number;
  83454. /** nearest is mag = nearest and min = nearest and mip = linear */
  83455. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  83456. /** Bilinear is mag = linear and min = linear and mip = nearest */
  83457. static readonly BILINEAR_SAMPLINGMODE: number;
  83458. /** Bilinear is mag = linear and min = linear and mip = nearest */
  83459. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  83460. /** Trilinear is mag = linear and min = linear and mip = linear */
  83461. static readonly TRILINEAR_SAMPLINGMODE: number;
  83462. /** Trilinear is mag = linear and min = linear and mip = linear */
  83463. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  83464. /** mag = nearest and min = nearest and mip = nearest */
  83465. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  83466. /** mag = nearest and min = linear and mip = nearest */
  83467. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  83468. /** mag = nearest and min = linear and mip = linear */
  83469. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  83470. /** mag = nearest and min = linear and mip = none */
  83471. static readonly NEAREST_LINEAR: number;
  83472. /** mag = nearest and min = nearest and mip = none */
  83473. static readonly NEAREST_NEAREST: number;
  83474. /** mag = linear and min = nearest and mip = nearest */
  83475. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  83476. /** mag = linear and min = nearest and mip = linear */
  83477. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  83478. /** mag = linear and min = linear and mip = none */
  83479. static readonly LINEAR_LINEAR: number;
  83480. /** mag = linear and min = nearest and mip = none */
  83481. static readonly LINEAR_NEAREST: number;
  83482. /** Explicit coordinates mode */
  83483. static readonly EXPLICIT_MODE: number;
  83484. /** Spherical coordinates mode */
  83485. static readonly SPHERICAL_MODE: number;
  83486. /** Planar coordinates mode */
  83487. static readonly PLANAR_MODE: number;
  83488. /** Cubic coordinates mode */
  83489. static readonly CUBIC_MODE: number;
  83490. /** Projection coordinates mode */
  83491. static readonly PROJECTION_MODE: number;
  83492. /** Inverse Cubic coordinates mode */
  83493. static readonly SKYBOX_MODE: number;
  83494. /** Inverse Cubic coordinates mode */
  83495. static readonly INVCUBIC_MODE: number;
  83496. /** Equirectangular coordinates mode */
  83497. static readonly EQUIRECTANGULAR_MODE: number;
  83498. /** Equirectangular Fixed coordinates mode */
  83499. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  83500. /** Equirectangular Fixed Mirrored coordinates mode */
  83501. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  83502. /** Texture is not repeating outside of 0..1 UVs */
  83503. static readonly CLAMP_ADDRESSMODE: number;
  83504. /** Texture is repeating outside of 0..1 UVs */
  83505. static readonly WRAP_ADDRESSMODE: number;
  83506. /** Texture is repeating and mirrored */
  83507. static readonly MIRROR_ADDRESSMODE: number;
  83508. /**
  83509. * 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
  83510. */
  83511. static UseSerializedUrlIfAny: boolean;
  83512. /**
  83513. * Define the url of the texture.
  83514. */
  83515. url: Nullable<string>;
  83516. /**
  83517. * Define an offset on the texture to offset the u coordinates of the UVs
  83518. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  83519. */
  83520. uOffset: number;
  83521. /**
  83522. * Define an offset on the texture to offset the v coordinates of the UVs
  83523. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  83524. */
  83525. vOffset: number;
  83526. /**
  83527. * Define an offset on the texture to scale the u coordinates of the UVs
  83528. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  83529. */
  83530. uScale: number;
  83531. /**
  83532. * Define an offset on the texture to scale the v coordinates of the UVs
  83533. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  83534. */
  83535. vScale: number;
  83536. /**
  83537. * Define an offset on the texture to rotate around the u coordinates of the UVs
  83538. * @see http://doc.babylonjs.com/how_to/more_materials
  83539. */
  83540. uAng: number;
  83541. /**
  83542. * Define an offset on the texture to rotate around the v coordinates of the UVs
  83543. * @see http://doc.babylonjs.com/how_to/more_materials
  83544. */
  83545. vAng: number;
  83546. /**
  83547. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  83548. * @see http://doc.babylonjs.com/how_to/more_materials
  83549. */
  83550. wAng: number;
  83551. /**
  83552. * Defines the center of rotation (U)
  83553. */
  83554. uRotationCenter: number;
  83555. /**
  83556. * Defines the center of rotation (V)
  83557. */
  83558. vRotationCenter: number;
  83559. /**
  83560. * Defines the center of rotation (W)
  83561. */
  83562. wRotationCenter: number;
  83563. /**
  83564. * Are mip maps generated for this texture or not.
  83565. */
  83566. readonly noMipmap: boolean;
  83567. /**
  83568. * List of inspectable custom properties (used by the Inspector)
  83569. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  83570. */
  83571. inspectableCustomProperties: Nullable<IInspectable[]>;
  83572. private _noMipmap;
  83573. /** @hidden */
  83574. _invertY: boolean;
  83575. private _rowGenerationMatrix;
  83576. private _cachedTextureMatrix;
  83577. private _projectionModeMatrix;
  83578. private _t0;
  83579. private _t1;
  83580. private _t2;
  83581. private _cachedUOffset;
  83582. private _cachedVOffset;
  83583. private _cachedUScale;
  83584. private _cachedVScale;
  83585. private _cachedUAng;
  83586. private _cachedVAng;
  83587. private _cachedWAng;
  83588. private _cachedProjectionMatrixId;
  83589. private _cachedCoordinatesMode;
  83590. /** @hidden */
  83591. protected _initialSamplingMode: number;
  83592. /** @hidden */
  83593. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  83594. private _deleteBuffer;
  83595. protected _format: Nullable<number>;
  83596. private _delayedOnLoad;
  83597. private _delayedOnError;
  83598. private _mimeType?;
  83599. /**
  83600. * Observable triggered once the texture has been loaded.
  83601. */
  83602. onLoadObservable: Observable<Texture>;
  83603. protected _isBlocking: boolean;
  83604. /**
  83605. * Is the texture preventing material to render while loading.
  83606. * If false, a default texture will be used instead of the loading one during the preparation step.
  83607. */
  83608. isBlocking: boolean;
  83609. /**
  83610. * Get the current sampling mode associated with the texture.
  83611. */
  83612. readonly samplingMode: number;
  83613. /**
  83614. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  83615. */
  83616. readonly invertY: boolean;
  83617. /**
  83618. * Instantiates a new texture.
  83619. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  83620. * @see http://doc.babylonjs.com/babylon101/materials#texture
  83621. * @param url defines the url of the picture to load as a texture
  83622. * @param scene defines the scene or engine the texture will belong to
  83623. * @param noMipmap defines if the texture will require mip maps or not
  83624. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  83625. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  83626. * @param onLoad defines a callback triggered when the texture has been loaded
  83627. * @param onError defines a callback triggered when an error occurred during the loading session
  83628. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  83629. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  83630. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  83631. * @param mimeType defines an optional mime type information
  83632. */
  83633. 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);
  83634. /**
  83635. * Update the url (and optional buffer) of this texture if url was null during construction.
  83636. * @param url the url of the texture
  83637. * @param buffer the buffer of the texture (defaults to null)
  83638. * @param onLoad callback called when the texture is loaded (defaults to null)
  83639. */
  83640. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  83641. /**
  83642. * Finish the loading sequence of a texture flagged as delayed load.
  83643. * @hidden
  83644. */
  83645. delayLoad(): void;
  83646. private _prepareRowForTextureGeneration;
  83647. /**
  83648. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  83649. * @returns the transform matrix of the texture.
  83650. */
  83651. getTextureMatrix(): Matrix;
  83652. /**
  83653. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  83654. * @returns The reflection texture transform
  83655. */
  83656. getReflectionTextureMatrix(): Matrix;
  83657. /**
  83658. * Clones the texture.
  83659. * @returns the cloned texture
  83660. */
  83661. clone(): Texture;
  83662. /**
  83663. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  83664. * @returns The JSON representation of the texture
  83665. */
  83666. serialize(): any;
  83667. /**
  83668. * Get the current class name of the texture useful for serialization or dynamic coding.
  83669. * @returns "Texture"
  83670. */
  83671. getClassName(): string;
  83672. /**
  83673. * Dispose the texture and release its associated resources.
  83674. */
  83675. dispose(): void;
  83676. /**
  83677. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  83678. * @param parsedTexture Define the JSON representation of the texture
  83679. * @param scene Define the scene the parsed texture should be instantiated in
  83680. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  83681. * @returns The parsed texture if successful
  83682. */
  83683. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  83684. /**
  83685. * Creates a texture from its base 64 representation.
  83686. * @param data Define the base64 payload without the data: prefix
  83687. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  83688. * @param scene Define the scene the texture should belong to
  83689. * @param noMipmap Forces the texture to not create mip map information if true
  83690. * @param invertY define if the texture needs to be inverted on the y axis during loading
  83691. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  83692. * @param onLoad define a callback triggered when the texture has been loaded
  83693. * @param onError define a callback triggered when an error occurred during the loading session
  83694. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  83695. * @returns the created texture
  83696. */
  83697. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  83698. /**
  83699. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  83700. * @param data Define the base64 payload without the data: prefix
  83701. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  83702. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  83703. * @param scene Define the scene the texture should belong to
  83704. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  83705. * @param noMipmap Forces the texture to not create mip map information if true
  83706. * @param invertY define if the texture needs to be inverted on the y axis during loading
  83707. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  83708. * @param onLoad define a callback triggered when the texture has been loaded
  83709. * @param onError define a callback triggered when an error occurred during the loading session
  83710. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  83711. * @returns the created texture
  83712. */
  83713. 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;
  83714. }
  83715. }
  83716. declare module BABYLON {
  83717. /**
  83718. * PostProcessManager is used to manage one or more post processes or post process pipelines
  83719. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  83720. */
  83721. export class PostProcessManager {
  83722. private _scene;
  83723. private _indexBuffer;
  83724. private _vertexBuffers;
  83725. /**
  83726. * Creates a new instance PostProcess
  83727. * @param scene The scene that the post process is associated with.
  83728. */
  83729. constructor(scene: Scene);
  83730. private _prepareBuffers;
  83731. private _buildIndexBuffer;
  83732. /**
  83733. * Rebuilds the vertex buffers of the manager.
  83734. * @hidden
  83735. */
  83736. _rebuild(): void;
  83737. /**
  83738. * Prepares a frame to be run through a post process.
  83739. * @param sourceTexture The input texture to the post procesess. (default: null)
  83740. * @param postProcesses An array of post processes to be run. (default: null)
  83741. * @returns True if the post processes were able to be run.
  83742. * @hidden
  83743. */
  83744. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  83745. /**
  83746. * Manually render a set of post processes to a texture.
  83747. * @param postProcesses An array of post processes to be run.
  83748. * @param targetTexture The target texture to render to.
  83749. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  83750. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  83751. * @param lodLevel defines which lod of the texture to render to
  83752. */
  83753. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  83754. /**
  83755. * Finalize the result of the output of the postprocesses.
  83756. * @param doNotPresent If true the result will not be displayed to the screen.
  83757. * @param targetTexture The target texture to render to.
  83758. * @param faceIndex The index of the face to bind the target texture to.
  83759. * @param postProcesses The array of post processes to render.
  83760. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  83761. * @hidden
  83762. */
  83763. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  83764. /**
  83765. * Disposes of the post process manager.
  83766. */
  83767. dispose(): void;
  83768. }
  83769. }
  83770. declare module BABYLON {
  83771. /** Interface used by value gradients (color, factor, ...) */
  83772. export interface IValueGradient {
  83773. /**
  83774. * Gets or sets the gradient value (between 0 and 1)
  83775. */
  83776. gradient: number;
  83777. }
  83778. /** Class used to store color4 gradient */
  83779. export class ColorGradient implements IValueGradient {
  83780. /**
  83781. * Gets or sets the gradient value (between 0 and 1)
  83782. */
  83783. gradient: number;
  83784. /**
  83785. * Gets or sets first associated color
  83786. */
  83787. color1: Color4;
  83788. /**
  83789. * Gets or sets second associated color
  83790. */
  83791. color2?: Color4;
  83792. /**
  83793. * Will get a color picked randomly between color1 and color2.
  83794. * If color2 is undefined then color1 will be used
  83795. * @param result defines the target Color4 to store the result in
  83796. */
  83797. getColorToRef(result: Color4): void;
  83798. }
  83799. /** Class used to store color 3 gradient */
  83800. export class Color3Gradient implements IValueGradient {
  83801. /**
  83802. * Gets or sets the gradient value (between 0 and 1)
  83803. */
  83804. gradient: number;
  83805. /**
  83806. * Gets or sets the associated color
  83807. */
  83808. color: Color3;
  83809. }
  83810. /** Class used to store factor gradient */
  83811. export class FactorGradient implements IValueGradient {
  83812. /**
  83813. * Gets or sets the gradient value (between 0 and 1)
  83814. */
  83815. gradient: number;
  83816. /**
  83817. * Gets or sets first associated factor
  83818. */
  83819. factor1: number;
  83820. /**
  83821. * Gets or sets second associated factor
  83822. */
  83823. factor2?: number;
  83824. /**
  83825. * Will get a number picked randomly between factor1 and factor2.
  83826. * If factor2 is undefined then factor1 will be used
  83827. * @returns the picked number
  83828. */
  83829. getFactor(): number;
  83830. }
  83831. /**
  83832. * Helper used to simplify some generic gradient tasks
  83833. */
  83834. export class GradientHelper {
  83835. /**
  83836. * Gets the current gradient from an array of IValueGradient
  83837. * @param ratio defines the current ratio to get
  83838. * @param gradients defines the array of IValueGradient
  83839. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  83840. */
  83841. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  83842. }
  83843. }
  83844. declare module BABYLON {
  83845. interface ThinEngine {
  83846. /**
  83847. * Creates a dynamic texture
  83848. * @param width defines the width of the texture
  83849. * @param height defines the height of the texture
  83850. * @param generateMipMaps defines if the engine should generate the mip levels
  83851. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  83852. * @returns the dynamic texture inside an InternalTexture
  83853. */
  83854. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  83855. /**
  83856. * Update the content of a dynamic texture
  83857. * @param texture defines the texture to update
  83858. * @param canvas defines the canvas containing the source
  83859. * @param invertY defines if data must be stored with Y axis inverted
  83860. * @param premulAlpha defines if alpha is stored as premultiplied
  83861. * @param format defines the format of the data
  83862. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  83863. */
  83864. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  83865. }
  83866. }
  83867. declare module BABYLON {
  83868. /**
  83869. * Helper class used to generate a canvas to manipulate images
  83870. */
  83871. export class CanvasGenerator {
  83872. /**
  83873. * Create a new canvas (or offscreen canvas depending on the context)
  83874. * @param width defines the expected width
  83875. * @param height defines the expected height
  83876. * @return a new canvas or offscreen canvas
  83877. */
  83878. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  83879. }
  83880. }
  83881. declare module BABYLON {
  83882. /**
  83883. * A class extending Texture allowing drawing on a texture
  83884. * @see http://doc.babylonjs.com/how_to/dynamictexture
  83885. */
  83886. export class DynamicTexture extends Texture {
  83887. private _generateMipMaps;
  83888. private _canvas;
  83889. private _context;
  83890. private _engine;
  83891. /**
  83892. * Creates a DynamicTexture
  83893. * @param name defines the name of the texture
  83894. * @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
  83895. * @param scene defines the scene where you want the texture
  83896. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  83897. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  83898. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  83899. */
  83900. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  83901. /**
  83902. * Get the current class name of the texture useful for serialization or dynamic coding.
  83903. * @returns "DynamicTexture"
  83904. */
  83905. getClassName(): string;
  83906. /**
  83907. * Gets the current state of canRescale
  83908. */
  83909. readonly canRescale: boolean;
  83910. private _recreate;
  83911. /**
  83912. * Scales the texture
  83913. * @param ratio the scale factor to apply to both width and height
  83914. */
  83915. scale(ratio: number): void;
  83916. /**
  83917. * Resizes the texture
  83918. * @param width the new width
  83919. * @param height the new height
  83920. */
  83921. scaleTo(width: number, height: number): void;
  83922. /**
  83923. * Gets the context of the canvas used by the texture
  83924. * @returns the canvas context of the dynamic texture
  83925. */
  83926. getContext(): CanvasRenderingContext2D;
  83927. /**
  83928. * Clears the texture
  83929. */
  83930. clear(): void;
  83931. /**
  83932. * Updates the texture
  83933. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  83934. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  83935. */
  83936. update(invertY?: boolean, premulAlpha?: boolean): void;
  83937. /**
  83938. * Draws text onto the texture
  83939. * @param text defines the text to be drawn
  83940. * @param x defines the placement of the text from the left
  83941. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  83942. * @param font defines the font to be used with font-style, font-size, font-name
  83943. * @param color defines the color used for the text
  83944. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  83945. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  83946. * @param update defines whether texture is immediately update (default is true)
  83947. */
  83948. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  83949. /**
  83950. * Clones the texture
  83951. * @returns the clone of the texture.
  83952. */
  83953. clone(): DynamicTexture;
  83954. /**
  83955. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  83956. * @returns a serialized dynamic texture object
  83957. */
  83958. serialize(): any;
  83959. /** @hidden */
  83960. _rebuild(): void;
  83961. }
  83962. }
  83963. declare module BABYLON {
  83964. interface AbstractScene {
  83965. /**
  83966. * The list of procedural textures added to the scene
  83967. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  83968. */
  83969. proceduralTextures: Array<ProceduralTexture>;
  83970. }
  83971. /**
  83972. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  83973. * in a given scene.
  83974. */
  83975. export class ProceduralTextureSceneComponent implements ISceneComponent {
  83976. /**
  83977. * The component name helpfull to identify the component in the list of scene components.
  83978. */
  83979. readonly name: string;
  83980. /**
  83981. * The scene the component belongs to.
  83982. */
  83983. scene: Scene;
  83984. /**
  83985. * Creates a new instance of the component for the given scene
  83986. * @param scene Defines the scene to register the component in
  83987. */
  83988. constructor(scene: Scene);
  83989. /**
  83990. * Registers the component in a given scene
  83991. */
  83992. register(): void;
  83993. /**
  83994. * Rebuilds the elements related to this component in case of
  83995. * context lost for instance.
  83996. */
  83997. rebuild(): void;
  83998. /**
  83999. * Disposes the component and the associated ressources.
  84000. */
  84001. dispose(): void;
  84002. private _beforeClear;
  84003. }
  84004. }
  84005. declare module BABYLON {
  84006. interface ThinEngine {
  84007. /**
  84008. * Creates a new render target cube texture
  84009. * @param size defines the size of the texture
  84010. * @param options defines the options used to create the texture
  84011. * @returns a new render target cube texture stored in an InternalTexture
  84012. */
  84013. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  84014. }
  84015. }
  84016. declare module BABYLON {
  84017. /** @hidden */
  84018. export var proceduralVertexShader: {
  84019. name: string;
  84020. shader: string;
  84021. };
  84022. }
  84023. declare module BABYLON {
  84024. /**
  84025. * 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.
  84026. * This is the base class of any Procedural texture and contains most of the shareable code.
  84027. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84028. */
  84029. export class ProceduralTexture extends Texture {
  84030. isCube: boolean;
  84031. /**
  84032. * Define if the texture is enabled or not (disabled texture will not render)
  84033. */
  84034. isEnabled: boolean;
  84035. /**
  84036. * Define if the texture must be cleared before rendering (default is true)
  84037. */
  84038. autoClear: boolean;
  84039. /**
  84040. * Callback called when the texture is generated
  84041. */
  84042. onGenerated: () => void;
  84043. /**
  84044. * Event raised when the texture is generated
  84045. */
  84046. onGeneratedObservable: Observable<ProceduralTexture>;
  84047. /** @hidden */
  84048. _generateMipMaps: boolean;
  84049. /** @hidden **/
  84050. _effect: Effect;
  84051. /** @hidden */
  84052. _textures: {
  84053. [key: string]: Texture;
  84054. };
  84055. private _size;
  84056. private _currentRefreshId;
  84057. private _refreshRate;
  84058. private _vertexBuffers;
  84059. private _indexBuffer;
  84060. private _uniforms;
  84061. private _samplers;
  84062. private _fragment;
  84063. private _floats;
  84064. private _ints;
  84065. private _floatsArrays;
  84066. private _colors3;
  84067. private _colors4;
  84068. private _vectors2;
  84069. private _vectors3;
  84070. private _matrices;
  84071. private _fallbackTexture;
  84072. private _fallbackTextureUsed;
  84073. private _engine;
  84074. private _cachedDefines;
  84075. private _contentUpdateId;
  84076. private _contentData;
  84077. /**
  84078. * Instantiates a new procedural texture.
  84079. * 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.
  84080. * This is the base class of any Procedural texture and contains most of the shareable code.
  84081. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84082. * @param name Define the name of the texture
  84083. * @param size Define the size of the texture to create
  84084. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  84085. * @param scene Define the scene the texture belongs to
  84086. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  84087. * @param generateMipMaps Define if the texture should creates mip maps or not
  84088. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  84089. */
  84090. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  84091. /**
  84092. * The effect that is created when initializing the post process.
  84093. * @returns The created effect corresponding the the postprocess.
  84094. */
  84095. getEffect(): Effect;
  84096. /**
  84097. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  84098. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  84099. */
  84100. getContent(): Nullable<ArrayBufferView>;
  84101. private _createIndexBuffer;
  84102. /** @hidden */
  84103. _rebuild(): void;
  84104. /**
  84105. * Resets the texture in order to recreate its associated resources.
  84106. * This can be called in case of context loss
  84107. */
  84108. reset(): void;
  84109. protected _getDefines(): string;
  84110. /**
  84111. * Is the texture ready to be used ? (rendered at least once)
  84112. * @returns true if ready, otherwise, false.
  84113. */
  84114. isReady(): boolean;
  84115. /**
  84116. * Resets the refresh counter of the texture and start bak from scratch.
  84117. * Could be useful to regenerate the texture if it is setup to render only once.
  84118. */
  84119. resetRefreshCounter(): void;
  84120. /**
  84121. * Set the fragment shader to use in order to render the texture.
  84122. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  84123. */
  84124. setFragment(fragment: any): void;
  84125. /**
  84126. * Define the refresh rate of the texture or the rendering frequency.
  84127. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  84128. */
  84129. refreshRate: number;
  84130. /** @hidden */
  84131. _shouldRender(): boolean;
  84132. /**
  84133. * Get the size the texture is rendering at.
  84134. * @returns the size (texture is always squared)
  84135. */
  84136. getRenderSize(): number;
  84137. /**
  84138. * Resize the texture to new value.
  84139. * @param size Define the new size the texture should have
  84140. * @param generateMipMaps Define whether the new texture should create mip maps
  84141. */
  84142. resize(size: number, generateMipMaps: boolean): void;
  84143. private _checkUniform;
  84144. /**
  84145. * Set a texture in the shader program used to render.
  84146. * @param name Define the name of the uniform samplers as defined in the shader
  84147. * @param texture Define the texture to bind to this sampler
  84148. * @return the texture itself allowing "fluent" like uniform updates
  84149. */
  84150. setTexture(name: string, texture: Texture): ProceduralTexture;
  84151. /**
  84152. * Set a float in the shader.
  84153. * @param name Define the name of the uniform as defined in the shader
  84154. * @param value Define the value to give to the uniform
  84155. * @return the texture itself allowing "fluent" like uniform updates
  84156. */
  84157. setFloat(name: string, value: number): ProceduralTexture;
  84158. /**
  84159. * Set a int in the shader.
  84160. * @param name Define the name of the uniform as defined in the shader
  84161. * @param value Define the value to give to the uniform
  84162. * @return the texture itself allowing "fluent" like uniform updates
  84163. */
  84164. setInt(name: string, value: number): ProceduralTexture;
  84165. /**
  84166. * Set an array of floats in the shader.
  84167. * @param name Define the name of the uniform as defined in the shader
  84168. * @param value Define the value to give to the uniform
  84169. * @return the texture itself allowing "fluent" like uniform updates
  84170. */
  84171. setFloats(name: string, value: number[]): ProceduralTexture;
  84172. /**
  84173. * Set a vec3 in the shader from a Color3.
  84174. * @param name Define the name of the uniform as defined in the shader
  84175. * @param value Define the value to give to the uniform
  84176. * @return the texture itself allowing "fluent" like uniform updates
  84177. */
  84178. setColor3(name: string, value: Color3): ProceduralTexture;
  84179. /**
  84180. * Set a vec4 in the shader from a Color4.
  84181. * @param name Define the name of the uniform as defined in the shader
  84182. * @param value Define the value to give to the uniform
  84183. * @return the texture itself allowing "fluent" like uniform updates
  84184. */
  84185. setColor4(name: string, value: Color4): ProceduralTexture;
  84186. /**
  84187. * Set a vec2 in the shader from a Vector2.
  84188. * @param name Define the name of the uniform as defined in the shader
  84189. * @param value Define the value to give to the uniform
  84190. * @return the texture itself allowing "fluent" like uniform updates
  84191. */
  84192. setVector2(name: string, value: Vector2): ProceduralTexture;
  84193. /**
  84194. * Set a vec3 in the shader from a Vector3.
  84195. * @param name Define the name of the uniform as defined in the shader
  84196. * @param value Define the value to give to the uniform
  84197. * @return the texture itself allowing "fluent" like uniform updates
  84198. */
  84199. setVector3(name: string, value: Vector3): ProceduralTexture;
  84200. /**
  84201. * Set a mat4 in the shader from a MAtrix.
  84202. * @param name Define the name of the uniform as defined in the shader
  84203. * @param value Define the value to give to the uniform
  84204. * @return the texture itself allowing "fluent" like uniform updates
  84205. */
  84206. setMatrix(name: string, value: Matrix): ProceduralTexture;
  84207. /**
  84208. * Render the texture to its associated render target.
  84209. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  84210. */
  84211. render(useCameraPostProcess?: boolean): void;
  84212. /**
  84213. * Clone the texture.
  84214. * @returns the cloned texture
  84215. */
  84216. clone(): ProceduralTexture;
  84217. /**
  84218. * Dispose the texture and release its asoociated resources.
  84219. */
  84220. dispose(): void;
  84221. }
  84222. }
  84223. declare module BABYLON {
  84224. /**
  84225. * This represents the base class for particle system in Babylon.
  84226. * 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.
  84227. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  84228. * @example https://doc.babylonjs.com/babylon101/particles
  84229. */
  84230. export class BaseParticleSystem {
  84231. /**
  84232. * Source color is added to the destination color without alpha affecting the result
  84233. */
  84234. static BLENDMODE_ONEONE: number;
  84235. /**
  84236. * Blend current color and particle color using particle’s alpha
  84237. */
  84238. static BLENDMODE_STANDARD: number;
  84239. /**
  84240. * Add current color and particle color multiplied by particle’s alpha
  84241. */
  84242. static BLENDMODE_ADD: number;
  84243. /**
  84244. * Multiply current color with particle color
  84245. */
  84246. static BLENDMODE_MULTIPLY: number;
  84247. /**
  84248. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  84249. */
  84250. static BLENDMODE_MULTIPLYADD: number;
  84251. /**
  84252. * List of animations used by the particle system.
  84253. */
  84254. animations: Animation[];
  84255. /**
  84256. * The id of the Particle system.
  84257. */
  84258. id: string;
  84259. /**
  84260. * The friendly name of the Particle system.
  84261. */
  84262. name: string;
  84263. /**
  84264. * The rendering group used by the Particle system to chose when to render.
  84265. */
  84266. renderingGroupId: number;
  84267. /**
  84268. * The emitter represents the Mesh or position we are attaching the particle system to.
  84269. */
  84270. emitter: Nullable<AbstractMesh | Vector3>;
  84271. /**
  84272. * The maximum number of particles to emit per frame
  84273. */
  84274. emitRate: number;
  84275. /**
  84276. * If you want to launch only a few particles at once, that can be done, as well.
  84277. */
  84278. manualEmitCount: number;
  84279. /**
  84280. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  84281. */
  84282. updateSpeed: number;
  84283. /**
  84284. * The amount of time the particle system is running (depends of the overall update speed).
  84285. */
  84286. targetStopDuration: number;
  84287. /**
  84288. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  84289. */
  84290. disposeOnStop: boolean;
  84291. /**
  84292. * Minimum power of emitting particles.
  84293. */
  84294. minEmitPower: number;
  84295. /**
  84296. * Maximum power of emitting particles.
  84297. */
  84298. maxEmitPower: number;
  84299. /**
  84300. * Minimum life time of emitting particles.
  84301. */
  84302. minLifeTime: number;
  84303. /**
  84304. * Maximum life time of emitting particles.
  84305. */
  84306. maxLifeTime: number;
  84307. /**
  84308. * Minimum Size of emitting particles.
  84309. */
  84310. minSize: number;
  84311. /**
  84312. * Maximum Size of emitting particles.
  84313. */
  84314. maxSize: number;
  84315. /**
  84316. * Minimum scale of emitting particles on X axis.
  84317. */
  84318. minScaleX: number;
  84319. /**
  84320. * Maximum scale of emitting particles on X axis.
  84321. */
  84322. maxScaleX: number;
  84323. /**
  84324. * Minimum scale of emitting particles on Y axis.
  84325. */
  84326. minScaleY: number;
  84327. /**
  84328. * Maximum scale of emitting particles on Y axis.
  84329. */
  84330. maxScaleY: number;
  84331. /**
  84332. * Gets or sets the minimal initial rotation in radians.
  84333. */
  84334. minInitialRotation: number;
  84335. /**
  84336. * Gets or sets the maximal initial rotation in radians.
  84337. */
  84338. maxInitialRotation: number;
  84339. /**
  84340. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  84341. */
  84342. minAngularSpeed: number;
  84343. /**
  84344. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  84345. */
  84346. maxAngularSpeed: number;
  84347. /**
  84348. * The texture used to render each particle. (this can be a spritesheet)
  84349. */
  84350. particleTexture: Nullable<Texture>;
  84351. /**
  84352. * The layer mask we are rendering the particles through.
  84353. */
  84354. layerMask: number;
  84355. /**
  84356. * This can help using your own shader to render the particle system.
  84357. * The according effect will be created
  84358. */
  84359. customShader: any;
  84360. /**
  84361. * By default particle system starts as soon as they are created. This prevents the
  84362. * automatic start to happen and let you decide when to start emitting particles.
  84363. */
  84364. preventAutoStart: boolean;
  84365. private _noiseTexture;
  84366. /**
  84367. * Gets or sets a texture used to add random noise to particle positions
  84368. */
  84369. noiseTexture: Nullable<ProceduralTexture>;
  84370. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  84371. noiseStrength: Vector3;
  84372. /**
  84373. * Callback triggered when the particle animation is ending.
  84374. */
  84375. onAnimationEnd: Nullable<() => void>;
  84376. /**
  84377. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  84378. */
  84379. blendMode: number;
  84380. /**
  84381. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  84382. * to override the particles.
  84383. */
  84384. forceDepthWrite: boolean;
  84385. /** 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 */
  84386. preWarmCycles: number;
  84387. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  84388. preWarmStepOffset: number;
  84389. /**
  84390. * 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)
  84391. */
  84392. spriteCellChangeSpeed: number;
  84393. /**
  84394. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  84395. */
  84396. startSpriteCellID: number;
  84397. /**
  84398. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  84399. */
  84400. endSpriteCellID: number;
  84401. /**
  84402. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  84403. */
  84404. spriteCellWidth: number;
  84405. /**
  84406. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  84407. */
  84408. spriteCellHeight: number;
  84409. /**
  84410. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  84411. */
  84412. spriteRandomStartCell: boolean;
  84413. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  84414. translationPivot: Vector2;
  84415. /** @hidden */
  84416. protected _isAnimationSheetEnabled: boolean;
  84417. /**
  84418. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  84419. */
  84420. beginAnimationOnStart: boolean;
  84421. /**
  84422. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  84423. */
  84424. beginAnimationFrom: number;
  84425. /**
  84426. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  84427. */
  84428. beginAnimationTo: number;
  84429. /**
  84430. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  84431. */
  84432. beginAnimationLoop: boolean;
  84433. /**
  84434. * Gets or sets a world offset applied to all particles
  84435. */
  84436. worldOffset: Vector3;
  84437. /**
  84438. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  84439. */
  84440. isAnimationSheetEnabled: boolean;
  84441. /**
  84442. * Get hosting scene
  84443. * @returns the scene
  84444. */
  84445. getScene(): Scene;
  84446. /**
  84447. * You can use gravity if you want to give an orientation to your particles.
  84448. */
  84449. gravity: Vector3;
  84450. protected _colorGradients: Nullable<Array<ColorGradient>>;
  84451. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  84452. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  84453. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  84454. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  84455. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  84456. protected _dragGradients: Nullable<Array<FactorGradient>>;
  84457. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  84458. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  84459. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  84460. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  84461. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  84462. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  84463. /**
  84464. * Defines the delay in milliseconds before starting the system (0 by default)
  84465. */
  84466. startDelay: number;
  84467. /**
  84468. * Gets the current list of drag gradients.
  84469. * You must use addDragGradient and removeDragGradient to udpate this list
  84470. * @returns the list of drag gradients
  84471. */
  84472. getDragGradients(): Nullable<Array<FactorGradient>>;
  84473. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  84474. limitVelocityDamping: number;
  84475. /**
  84476. * Gets the current list of limit velocity gradients.
  84477. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  84478. * @returns the list of limit velocity gradients
  84479. */
  84480. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  84481. /**
  84482. * Gets the current list of color gradients.
  84483. * You must use addColorGradient and removeColorGradient to udpate this list
  84484. * @returns the list of color gradients
  84485. */
  84486. getColorGradients(): Nullable<Array<ColorGradient>>;
  84487. /**
  84488. * Gets the current list of size gradients.
  84489. * You must use addSizeGradient and removeSizeGradient to udpate this list
  84490. * @returns the list of size gradients
  84491. */
  84492. getSizeGradients(): Nullable<Array<FactorGradient>>;
  84493. /**
  84494. * Gets the current list of color remap gradients.
  84495. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  84496. * @returns the list of color remap gradients
  84497. */
  84498. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  84499. /**
  84500. * Gets the current list of alpha remap gradients.
  84501. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  84502. * @returns the list of alpha remap gradients
  84503. */
  84504. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  84505. /**
  84506. * Gets the current list of life time gradients.
  84507. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  84508. * @returns the list of life time gradients
  84509. */
  84510. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  84511. /**
  84512. * Gets the current list of angular speed gradients.
  84513. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  84514. * @returns the list of angular speed gradients
  84515. */
  84516. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  84517. /**
  84518. * Gets the current list of velocity gradients.
  84519. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  84520. * @returns the list of velocity gradients
  84521. */
  84522. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  84523. /**
  84524. * Gets the current list of start size gradients.
  84525. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  84526. * @returns the list of start size gradients
  84527. */
  84528. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  84529. /**
  84530. * Gets the current list of emit rate gradients.
  84531. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  84532. * @returns the list of emit rate gradients
  84533. */
  84534. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  84535. /**
  84536. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  84537. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84538. */
  84539. direction1: Vector3;
  84540. /**
  84541. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  84542. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84543. */
  84544. direction2: Vector3;
  84545. /**
  84546. * 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.
  84547. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84548. */
  84549. minEmitBox: Vector3;
  84550. /**
  84551. * 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.
  84552. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84553. */
  84554. maxEmitBox: Vector3;
  84555. /**
  84556. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  84557. */
  84558. color1: Color4;
  84559. /**
  84560. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  84561. */
  84562. color2: Color4;
  84563. /**
  84564. * Color the particle will have at the end of its lifetime
  84565. */
  84566. colorDead: Color4;
  84567. /**
  84568. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  84569. */
  84570. textureMask: Color4;
  84571. /**
  84572. * The particle emitter type defines the emitter used by the particle system.
  84573. * It can be for example box, sphere, or cone...
  84574. */
  84575. particleEmitterType: IParticleEmitterType;
  84576. /** @hidden */
  84577. _isSubEmitter: boolean;
  84578. /**
  84579. * Gets or sets the billboard mode to use when isBillboardBased = true.
  84580. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  84581. */
  84582. billboardMode: number;
  84583. protected _isBillboardBased: boolean;
  84584. /**
  84585. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  84586. */
  84587. isBillboardBased: boolean;
  84588. /**
  84589. * The scene the particle system belongs to.
  84590. */
  84591. protected _scene: Scene;
  84592. /**
  84593. * Local cache of defines for image processing.
  84594. */
  84595. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  84596. /**
  84597. * Default configuration related to image processing available in the standard Material.
  84598. */
  84599. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  84600. /**
  84601. * Gets the image processing configuration used either in this material.
  84602. */
  84603. /**
  84604. * Sets the Default image processing configuration used either in the this material.
  84605. *
  84606. * If sets to null, the scene one is in use.
  84607. */
  84608. imageProcessingConfiguration: ImageProcessingConfiguration;
  84609. /**
  84610. * Attaches a new image processing configuration to the Standard Material.
  84611. * @param configuration
  84612. */
  84613. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  84614. /** @hidden */
  84615. protected _reset(): void;
  84616. /** @hidden */
  84617. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  84618. /**
  84619. * Instantiates a particle system.
  84620. * 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.
  84621. * @param name The name of the particle system
  84622. */
  84623. constructor(name: string);
  84624. /**
  84625. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  84626. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  84627. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  84628. * @returns the emitter
  84629. */
  84630. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  84631. /**
  84632. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  84633. * @param radius The radius of the hemisphere to emit from
  84634. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  84635. * @returns the emitter
  84636. */
  84637. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  84638. /**
  84639. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  84640. * @param radius The radius of the sphere to emit from
  84641. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  84642. * @returns the emitter
  84643. */
  84644. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  84645. /**
  84646. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  84647. * @param radius The radius of the sphere to emit from
  84648. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  84649. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  84650. * @returns the emitter
  84651. */
  84652. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  84653. /**
  84654. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  84655. * @param radius The radius of the emission cylinder
  84656. * @param height The height of the emission cylinder
  84657. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  84658. * @param directionRandomizer How much to randomize the particle direction [0-1]
  84659. * @returns the emitter
  84660. */
  84661. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  84662. /**
  84663. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  84664. * @param radius The radius of the cylinder to emit from
  84665. * @param height The height of the emission cylinder
  84666. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  84667. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  84668. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  84669. * @returns the emitter
  84670. */
  84671. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  84672. /**
  84673. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  84674. * @param radius The radius of the cone to emit from
  84675. * @param angle The base angle of the cone
  84676. * @returns the emitter
  84677. */
  84678. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  84679. /**
  84680. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  84681. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  84682. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  84683. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  84684. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  84685. * @returns the emitter
  84686. */
  84687. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  84688. }
  84689. }
  84690. declare module BABYLON {
  84691. /**
  84692. * Type of sub emitter
  84693. */
  84694. export enum SubEmitterType {
  84695. /**
  84696. * Attached to the particle over it's lifetime
  84697. */
  84698. ATTACHED = 0,
  84699. /**
  84700. * Created when the particle dies
  84701. */
  84702. END = 1
  84703. }
  84704. /**
  84705. * Sub emitter class used to emit particles from an existing particle
  84706. */
  84707. export class SubEmitter {
  84708. /**
  84709. * the particle system to be used by the sub emitter
  84710. */
  84711. particleSystem: ParticleSystem;
  84712. /**
  84713. * Type of the submitter (Default: END)
  84714. */
  84715. type: SubEmitterType;
  84716. /**
  84717. * 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)
  84718. * Note: This only is supported when using an emitter of type Mesh
  84719. */
  84720. inheritDirection: boolean;
  84721. /**
  84722. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  84723. */
  84724. inheritedVelocityAmount: number;
  84725. /**
  84726. * Creates a sub emitter
  84727. * @param particleSystem the particle system to be used by the sub emitter
  84728. */
  84729. constructor(
  84730. /**
  84731. * the particle system to be used by the sub emitter
  84732. */
  84733. particleSystem: ParticleSystem);
  84734. /**
  84735. * Clones the sub emitter
  84736. * @returns the cloned sub emitter
  84737. */
  84738. clone(): SubEmitter;
  84739. /**
  84740. * Serialize current object to a JSON object
  84741. * @returns the serialized object
  84742. */
  84743. serialize(): any;
  84744. /** @hidden */
  84745. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  84746. /**
  84747. * Creates a new SubEmitter from a serialized JSON version
  84748. * @param serializationObject defines the JSON object to read from
  84749. * @param scene defines the hosting scene
  84750. * @param rootUrl defines the rootUrl for data loading
  84751. * @returns a new SubEmitter
  84752. */
  84753. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  84754. /** Release associated resources */
  84755. dispose(): void;
  84756. }
  84757. }
  84758. declare module BABYLON {
  84759. /** @hidden */
  84760. export var clipPlaneFragmentDeclaration: {
  84761. name: string;
  84762. shader: string;
  84763. };
  84764. }
  84765. declare module BABYLON {
  84766. /** @hidden */
  84767. export var imageProcessingDeclaration: {
  84768. name: string;
  84769. shader: string;
  84770. };
  84771. }
  84772. declare module BABYLON {
  84773. /** @hidden */
  84774. export var imageProcessingFunctions: {
  84775. name: string;
  84776. shader: string;
  84777. };
  84778. }
  84779. declare module BABYLON {
  84780. /** @hidden */
  84781. export var clipPlaneFragment: {
  84782. name: string;
  84783. shader: string;
  84784. };
  84785. }
  84786. declare module BABYLON {
  84787. /** @hidden */
  84788. export var particlesPixelShader: {
  84789. name: string;
  84790. shader: string;
  84791. };
  84792. }
  84793. declare module BABYLON {
  84794. /** @hidden */
  84795. export var clipPlaneVertexDeclaration: {
  84796. name: string;
  84797. shader: string;
  84798. };
  84799. }
  84800. declare module BABYLON {
  84801. /** @hidden */
  84802. export var clipPlaneVertex: {
  84803. name: string;
  84804. shader: string;
  84805. };
  84806. }
  84807. declare module BABYLON {
  84808. /** @hidden */
  84809. export var particlesVertexShader: {
  84810. name: string;
  84811. shader: string;
  84812. };
  84813. }
  84814. declare module BABYLON {
  84815. /**
  84816. * This represents a particle system in Babylon.
  84817. * 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.
  84818. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  84819. * @example https://doc.babylonjs.com/babylon101/particles
  84820. */
  84821. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  84822. /**
  84823. * Billboard mode will only apply to Y axis
  84824. */
  84825. static readonly BILLBOARDMODE_Y: number;
  84826. /**
  84827. * Billboard mode will apply to all axes
  84828. */
  84829. static readonly BILLBOARDMODE_ALL: number;
  84830. /**
  84831. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  84832. */
  84833. static readonly BILLBOARDMODE_STRETCHED: number;
  84834. /**
  84835. * This function can be defined to provide custom update for active particles.
  84836. * This function will be called instead of regular update (age, position, color, etc.).
  84837. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  84838. */
  84839. updateFunction: (particles: Particle[]) => void;
  84840. private _emitterWorldMatrix;
  84841. /**
  84842. * This function can be defined to specify initial direction for every new particle.
  84843. * It by default use the emitterType defined function
  84844. */
  84845. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  84846. /**
  84847. * This function can be defined to specify initial position for every new particle.
  84848. * It by default use the emitterType defined function
  84849. */
  84850. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  84851. /**
  84852. * @hidden
  84853. */
  84854. _inheritedVelocityOffset: Vector3;
  84855. /**
  84856. * An event triggered when the system is disposed
  84857. */
  84858. onDisposeObservable: Observable<ParticleSystem>;
  84859. private _onDisposeObserver;
  84860. /**
  84861. * Sets a callback that will be triggered when the system is disposed
  84862. */
  84863. onDispose: () => void;
  84864. private _particles;
  84865. private _epsilon;
  84866. private _capacity;
  84867. private _stockParticles;
  84868. private _newPartsExcess;
  84869. private _vertexData;
  84870. private _vertexBuffer;
  84871. private _vertexBuffers;
  84872. private _spriteBuffer;
  84873. private _indexBuffer;
  84874. private _effect;
  84875. private _customEffect;
  84876. private _cachedDefines;
  84877. private _scaledColorStep;
  84878. private _colorDiff;
  84879. private _scaledDirection;
  84880. private _scaledGravity;
  84881. private _currentRenderId;
  84882. private _alive;
  84883. private _useInstancing;
  84884. private _started;
  84885. private _stopped;
  84886. private _actualFrame;
  84887. private _scaledUpdateSpeed;
  84888. private _vertexBufferSize;
  84889. /** @hidden */
  84890. _currentEmitRateGradient: Nullable<FactorGradient>;
  84891. /** @hidden */
  84892. _currentEmitRate1: number;
  84893. /** @hidden */
  84894. _currentEmitRate2: number;
  84895. /** @hidden */
  84896. _currentStartSizeGradient: Nullable<FactorGradient>;
  84897. /** @hidden */
  84898. _currentStartSize1: number;
  84899. /** @hidden */
  84900. _currentStartSize2: number;
  84901. private readonly _rawTextureWidth;
  84902. private _rampGradientsTexture;
  84903. private _useRampGradients;
  84904. /** Gets or sets a boolean indicating that ramp gradients must be used
  84905. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  84906. */
  84907. useRampGradients: boolean;
  84908. /**
  84909. * 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.
  84910. * 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: [])
  84911. */
  84912. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  84913. private _subEmitters;
  84914. /**
  84915. * @hidden
  84916. * If the particle systems emitter should be disposed when the particle system is disposed
  84917. */
  84918. _disposeEmitterOnDispose: boolean;
  84919. /**
  84920. * The current active Sub-systems, this property is used by the root particle system only.
  84921. */
  84922. activeSubSystems: Array<ParticleSystem>;
  84923. private _rootParticleSystem;
  84924. /**
  84925. * Gets the current list of active particles
  84926. */
  84927. readonly particles: Particle[];
  84928. /**
  84929. * Returns the string "ParticleSystem"
  84930. * @returns a string containing the class name
  84931. */
  84932. getClassName(): string;
  84933. /**
  84934. * Instantiates a particle system.
  84935. * 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.
  84936. * @param name The name of the particle system
  84937. * @param capacity The max number of particles alive at the same time
  84938. * @param scene The scene the particle system belongs to
  84939. * @param customEffect a custom effect used to change the way particles are rendered by default
  84940. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  84941. * @param epsilon Offset used to render the particles
  84942. */
  84943. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  84944. private _addFactorGradient;
  84945. private _removeFactorGradient;
  84946. /**
  84947. * Adds a new life time gradient
  84948. * @param gradient defines the gradient to use (between 0 and 1)
  84949. * @param factor defines the life time factor to affect to the specified gradient
  84950. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84951. * @returns the current particle system
  84952. */
  84953. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84954. /**
  84955. * Remove a specific life time gradient
  84956. * @param gradient defines the gradient to remove
  84957. * @returns the current particle system
  84958. */
  84959. removeLifeTimeGradient(gradient: number): IParticleSystem;
  84960. /**
  84961. * Adds a new size gradient
  84962. * @param gradient defines the gradient to use (between 0 and 1)
  84963. * @param factor defines the size factor to affect to the specified gradient
  84964. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84965. * @returns the current particle system
  84966. */
  84967. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84968. /**
  84969. * Remove a specific size gradient
  84970. * @param gradient defines the gradient to remove
  84971. * @returns the current particle system
  84972. */
  84973. removeSizeGradient(gradient: number): IParticleSystem;
  84974. /**
  84975. * Adds a new color remap gradient
  84976. * @param gradient defines the gradient to use (between 0 and 1)
  84977. * @param min defines the color remap minimal range
  84978. * @param max defines the color remap maximal range
  84979. * @returns the current particle system
  84980. */
  84981. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  84982. /**
  84983. * Remove a specific color remap gradient
  84984. * @param gradient defines the gradient to remove
  84985. * @returns the current particle system
  84986. */
  84987. removeColorRemapGradient(gradient: number): IParticleSystem;
  84988. /**
  84989. * Adds a new alpha remap gradient
  84990. * @param gradient defines the gradient to use (between 0 and 1)
  84991. * @param min defines the alpha remap minimal range
  84992. * @param max defines the alpha remap maximal range
  84993. * @returns the current particle system
  84994. */
  84995. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  84996. /**
  84997. * Remove a specific alpha remap gradient
  84998. * @param gradient defines the gradient to remove
  84999. * @returns the current particle system
  85000. */
  85001. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  85002. /**
  85003. * Adds a new angular speed gradient
  85004. * @param gradient defines the gradient to use (between 0 and 1)
  85005. * @param factor defines the angular speed to affect to the specified gradient
  85006. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85007. * @returns the current particle system
  85008. */
  85009. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85010. /**
  85011. * Remove a specific angular speed gradient
  85012. * @param gradient defines the gradient to remove
  85013. * @returns the current particle system
  85014. */
  85015. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  85016. /**
  85017. * Adds a new velocity gradient
  85018. * @param gradient defines the gradient to use (between 0 and 1)
  85019. * @param factor defines the velocity to affect to the specified gradient
  85020. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85021. * @returns the current particle system
  85022. */
  85023. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85024. /**
  85025. * Remove a specific velocity gradient
  85026. * @param gradient defines the gradient to remove
  85027. * @returns the current particle system
  85028. */
  85029. removeVelocityGradient(gradient: number): IParticleSystem;
  85030. /**
  85031. * Adds a new limit velocity gradient
  85032. * @param gradient defines the gradient to use (between 0 and 1)
  85033. * @param factor defines the limit velocity value to affect to the specified gradient
  85034. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85035. * @returns the current particle system
  85036. */
  85037. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85038. /**
  85039. * Remove a specific limit velocity gradient
  85040. * @param gradient defines the gradient to remove
  85041. * @returns the current particle system
  85042. */
  85043. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  85044. /**
  85045. * Adds a new drag gradient
  85046. * @param gradient defines the gradient to use (between 0 and 1)
  85047. * @param factor defines the drag value to affect to the specified gradient
  85048. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85049. * @returns the current particle system
  85050. */
  85051. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85052. /**
  85053. * Remove a specific drag gradient
  85054. * @param gradient defines the gradient to remove
  85055. * @returns the current particle system
  85056. */
  85057. removeDragGradient(gradient: number): IParticleSystem;
  85058. /**
  85059. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  85060. * @param gradient defines the gradient to use (between 0 and 1)
  85061. * @param factor defines the emit rate value to affect to the specified gradient
  85062. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85063. * @returns the current particle system
  85064. */
  85065. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85066. /**
  85067. * Remove a specific emit rate gradient
  85068. * @param gradient defines the gradient to remove
  85069. * @returns the current particle system
  85070. */
  85071. removeEmitRateGradient(gradient: number): IParticleSystem;
  85072. /**
  85073. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  85074. * @param gradient defines the gradient to use (between 0 and 1)
  85075. * @param factor defines the start size value to affect to the specified gradient
  85076. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85077. * @returns the current particle system
  85078. */
  85079. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85080. /**
  85081. * Remove a specific start size gradient
  85082. * @param gradient defines the gradient to remove
  85083. * @returns the current particle system
  85084. */
  85085. removeStartSizeGradient(gradient: number): IParticleSystem;
  85086. private _createRampGradientTexture;
  85087. /**
  85088. * Gets the current list of ramp gradients.
  85089. * You must use addRampGradient and removeRampGradient to udpate this list
  85090. * @returns the list of ramp gradients
  85091. */
  85092. getRampGradients(): Nullable<Array<Color3Gradient>>;
  85093. /**
  85094. * Adds a new ramp gradient used to remap particle colors
  85095. * @param gradient defines the gradient to use (between 0 and 1)
  85096. * @param color defines the color to affect to the specified gradient
  85097. * @returns the current particle system
  85098. */
  85099. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  85100. /**
  85101. * Remove a specific ramp gradient
  85102. * @param gradient defines the gradient to remove
  85103. * @returns the current particle system
  85104. */
  85105. removeRampGradient(gradient: number): ParticleSystem;
  85106. /**
  85107. * Adds a new color gradient
  85108. * @param gradient defines the gradient to use (between 0 and 1)
  85109. * @param color1 defines the color to affect to the specified gradient
  85110. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  85111. * @returns this particle system
  85112. */
  85113. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  85114. /**
  85115. * Remove a specific color gradient
  85116. * @param gradient defines the gradient to remove
  85117. * @returns this particle system
  85118. */
  85119. removeColorGradient(gradient: number): IParticleSystem;
  85120. private _fetchR;
  85121. protected _reset(): void;
  85122. private _resetEffect;
  85123. private _createVertexBuffers;
  85124. private _createIndexBuffer;
  85125. /**
  85126. * Gets the maximum number of particles active at the same time.
  85127. * @returns The max number of active particles.
  85128. */
  85129. getCapacity(): number;
  85130. /**
  85131. * Gets whether there are still active particles in the system.
  85132. * @returns True if it is alive, otherwise false.
  85133. */
  85134. isAlive(): boolean;
  85135. /**
  85136. * Gets if the system has been started. (Note: this will still be true after stop is called)
  85137. * @returns True if it has been started, otherwise false.
  85138. */
  85139. isStarted(): boolean;
  85140. private _prepareSubEmitterInternalArray;
  85141. /**
  85142. * Starts the particle system and begins to emit
  85143. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  85144. */
  85145. start(delay?: number): void;
  85146. /**
  85147. * Stops the particle system.
  85148. * @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.
  85149. */
  85150. stop(stopSubEmitters?: boolean): void;
  85151. /**
  85152. * Remove all active particles
  85153. */
  85154. reset(): void;
  85155. /**
  85156. * @hidden (for internal use only)
  85157. */
  85158. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  85159. /**
  85160. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  85161. * Its lifetime will start back at 0.
  85162. */
  85163. recycleParticle: (particle: Particle) => void;
  85164. private _stopSubEmitters;
  85165. private _createParticle;
  85166. private _removeFromRoot;
  85167. private _emitFromParticle;
  85168. private _update;
  85169. /** @hidden */
  85170. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  85171. /** @hidden */
  85172. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  85173. /** @hidden */
  85174. private _getEffect;
  85175. /**
  85176. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  85177. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  85178. */
  85179. animate(preWarmOnly?: boolean): void;
  85180. private _appendParticleVertices;
  85181. /**
  85182. * Rebuilds the particle system.
  85183. */
  85184. rebuild(): void;
  85185. /**
  85186. * Is this system ready to be used/rendered
  85187. * @return true if the system is ready
  85188. */
  85189. isReady(): boolean;
  85190. private _render;
  85191. /**
  85192. * Renders the particle system in its current state.
  85193. * @returns the current number of particles
  85194. */
  85195. render(): number;
  85196. /**
  85197. * Disposes the particle system and free the associated resources
  85198. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  85199. */
  85200. dispose(disposeTexture?: boolean): void;
  85201. /**
  85202. * Clones the particle system.
  85203. * @param name The name of the cloned object
  85204. * @param newEmitter The new emitter to use
  85205. * @returns the cloned particle system
  85206. */
  85207. clone(name: string, newEmitter: any): ParticleSystem;
  85208. /**
  85209. * Serializes the particle system to a JSON object.
  85210. * @returns the JSON object
  85211. */
  85212. serialize(): any;
  85213. /** @hidden */
  85214. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  85215. /** @hidden */
  85216. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  85217. /**
  85218. * Parses a JSON object to create a particle system.
  85219. * @param parsedParticleSystem The JSON object to parse
  85220. * @param scene The scene to create the particle system in
  85221. * @param rootUrl The root url to use to load external dependencies like texture
  85222. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  85223. * @returns the Parsed particle system
  85224. */
  85225. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  85226. }
  85227. }
  85228. declare module BABYLON {
  85229. /**
  85230. * A particle represents one of the element emitted by a particle system.
  85231. * This is mainly define by its coordinates, direction, velocity and age.
  85232. */
  85233. export class Particle {
  85234. /**
  85235. * The particle system the particle belongs to.
  85236. */
  85237. particleSystem: ParticleSystem;
  85238. private static _Count;
  85239. /**
  85240. * Unique ID of the particle
  85241. */
  85242. id: number;
  85243. /**
  85244. * The world position of the particle in the scene.
  85245. */
  85246. position: Vector3;
  85247. /**
  85248. * The world direction of the particle in the scene.
  85249. */
  85250. direction: Vector3;
  85251. /**
  85252. * The color of the particle.
  85253. */
  85254. color: Color4;
  85255. /**
  85256. * The color change of the particle per step.
  85257. */
  85258. colorStep: Color4;
  85259. /**
  85260. * Defines how long will the life of the particle be.
  85261. */
  85262. lifeTime: number;
  85263. /**
  85264. * The current age of the particle.
  85265. */
  85266. age: number;
  85267. /**
  85268. * The current size of the particle.
  85269. */
  85270. size: number;
  85271. /**
  85272. * The current scale of the particle.
  85273. */
  85274. scale: Vector2;
  85275. /**
  85276. * The current angle of the particle.
  85277. */
  85278. angle: number;
  85279. /**
  85280. * Defines how fast is the angle changing.
  85281. */
  85282. angularSpeed: number;
  85283. /**
  85284. * Defines the cell index used by the particle to be rendered from a sprite.
  85285. */
  85286. cellIndex: number;
  85287. /**
  85288. * The information required to support color remapping
  85289. */
  85290. remapData: Vector4;
  85291. /** @hidden */
  85292. _randomCellOffset?: number;
  85293. /** @hidden */
  85294. _initialDirection: Nullable<Vector3>;
  85295. /** @hidden */
  85296. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  85297. /** @hidden */
  85298. _initialStartSpriteCellID: number;
  85299. /** @hidden */
  85300. _initialEndSpriteCellID: number;
  85301. /** @hidden */
  85302. _currentColorGradient: Nullable<ColorGradient>;
  85303. /** @hidden */
  85304. _currentColor1: Color4;
  85305. /** @hidden */
  85306. _currentColor2: Color4;
  85307. /** @hidden */
  85308. _currentSizeGradient: Nullable<FactorGradient>;
  85309. /** @hidden */
  85310. _currentSize1: number;
  85311. /** @hidden */
  85312. _currentSize2: number;
  85313. /** @hidden */
  85314. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  85315. /** @hidden */
  85316. _currentAngularSpeed1: number;
  85317. /** @hidden */
  85318. _currentAngularSpeed2: number;
  85319. /** @hidden */
  85320. _currentVelocityGradient: Nullable<FactorGradient>;
  85321. /** @hidden */
  85322. _currentVelocity1: number;
  85323. /** @hidden */
  85324. _currentVelocity2: number;
  85325. /** @hidden */
  85326. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  85327. /** @hidden */
  85328. _currentLimitVelocity1: number;
  85329. /** @hidden */
  85330. _currentLimitVelocity2: number;
  85331. /** @hidden */
  85332. _currentDragGradient: Nullable<FactorGradient>;
  85333. /** @hidden */
  85334. _currentDrag1: number;
  85335. /** @hidden */
  85336. _currentDrag2: number;
  85337. /** @hidden */
  85338. _randomNoiseCoordinates1: Vector3;
  85339. /** @hidden */
  85340. _randomNoiseCoordinates2: Vector3;
  85341. /**
  85342. * Creates a new instance Particle
  85343. * @param particleSystem the particle system the particle belongs to
  85344. */
  85345. constructor(
  85346. /**
  85347. * The particle system the particle belongs to.
  85348. */
  85349. particleSystem: ParticleSystem);
  85350. private updateCellInfoFromSystem;
  85351. /**
  85352. * Defines how the sprite cell index is updated for the particle
  85353. */
  85354. updateCellIndex(): void;
  85355. /** @hidden */
  85356. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  85357. /** @hidden */
  85358. _inheritParticleInfoToSubEmitters(): void;
  85359. /** @hidden */
  85360. _reset(): void;
  85361. /**
  85362. * Copy the properties of particle to another one.
  85363. * @param other the particle to copy the information to.
  85364. */
  85365. copyTo(other: Particle): void;
  85366. }
  85367. }
  85368. declare module BABYLON {
  85369. /**
  85370. * Particle emitter represents a volume emitting particles.
  85371. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  85372. */
  85373. export interface IParticleEmitterType {
  85374. /**
  85375. * Called by the particle System when the direction is computed for the created particle.
  85376. * @param worldMatrix is the world matrix of the particle system
  85377. * @param directionToUpdate is the direction vector to update with the result
  85378. * @param particle is the particle we are computed the direction for
  85379. */
  85380. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85381. /**
  85382. * Called by the particle System when the position is computed for the created particle.
  85383. * @param worldMatrix is the world matrix of the particle system
  85384. * @param positionToUpdate is the position vector to update with the result
  85385. * @param particle is the particle we are computed the position for
  85386. */
  85387. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85388. /**
  85389. * Clones the current emitter and returns a copy of it
  85390. * @returns the new emitter
  85391. */
  85392. clone(): IParticleEmitterType;
  85393. /**
  85394. * Called by the GPUParticleSystem to setup the update shader
  85395. * @param effect defines the update shader
  85396. */
  85397. applyToShader(effect: Effect): void;
  85398. /**
  85399. * Returns a string to use to update the GPU particles update shader
  85400. * @returns the effect defines string
  85401. */
  85402. getEffectDefines(): string;
  85403. /**
  85404. * Returns a string representing the class name
  85405. * @returns a string containing the class name
  85406. */
  85407. getClassName(): string;
  85408. /**
  85409. * Serializes the particle system to a JSON object.
  85410. * @returns the JSON object
  85411. */
  85412. serialize(): any;
  85413. /**
  85414. * Parse properties from a JSON object
  85415. * @param serializationObject defines the JSON object
  85416. */
  85417. parse(serializationObject: any): void;
  85418. }
  85419. }
  85420. declare module BABYLON {
  85421. /**
  85422. * Particle emitter emitting particles from the inside of a box.
  85423. * It emits the particles randomly between 2 given directions.
  85424. */
  85425. export class BoxParticleEmitter implements IParticleEmitterType {
  85426. /**
  85427. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85428. */
  85429. direction1: Vector3;
  85430. /**
  85431. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85432. */
  85433. direction2: Vector3;
  85434. /**
  85435. * 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.
  85436. */
  85437. minEmitBox: Vector3;
  85438. /**
  85439. * 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.
  85440. */
  85441. maxEmitBox: Vector3;
  85442. /**
  85443. * Creates a new instance BoxParticleEmitter
  85444. */
  85445. constructor();
  85446. /**
  85447. * Called by the particle System when the direction is computed for the created particle.
  85448. * @param worldMatrix is the world matrix of the particle system
  85449. * @param directionToUpdate is the direction vector to update with the result
  85450. * @param particle is the particle we are computed the direction for
  85451. */
  85452. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85453. /**
  85454. * Called by the particle System when the position is computed for the created particle.
  85455. * @param worldMatrix is the world matrix of the particle system
  85456. * @param positionToUpdate is the position vector to update with the result
  85457. * @param particle is the particle we are computed the position for
  85458. */
  85459. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85460. /**
  85461. * Clones the current emitter and returns a copy of it
  85462. * @returns the new emitter
  85463. */
  85464. clone(): BoxParticleEmitter;
  85465. /**
  85466. * Called by the GPUParticleSystem to setup the update shader
  85467. * @param effect defines the update shader
  85468. */
  85469. applyToShader(effect: Effect): void;
  85470. /**
  85471. * Returns a string to use to update the GPU particles update shader
  85472. * @returns a string containng the defines string
  85473. */
  85474. getEffectDefines(): string;
  85475. /**
  85476. * Returns the string "BoxParticleEmitter"
  85477. * @returns a string containing the class name
  85478. */
  85479. getClassName(): string;
  85480. /**
  85481. * Serializes the particle system to a JSON object.
  85482. * @returns the JSON object
  85483. */
  85484. serialize(): any;
  85485. /**
  85486. * Parse properties from a JSON object
  85487. * @param serializationObject defines the JSON object
  85488. */
  85489. parse(serializationObject: any): void;
  85490. }
  85491. }
  85492. declare module BABYLON {
  85493. /**
  85494. * Particle emitter emitting particles from the inside of a cone.
  85495. * It emits the particles alongside the cone volume from the base to the particle.
  85496. * The emission direction might be randomized.
  85497. */
  85498. export class ConeParticleEmitter implements IParticleEmitterType {
  85499. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  85500. directionRandomizer: number;
  85501. private _radius;
  85502. private _angle;
  85503. private _height;
  85504. /**
  85505. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  85506. */
  85507. radiusRange: number;
  85508. /**
  85509. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  85510. */
  85511. heightRange: number;
  85512. /**
  85513. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  85514. */
  85515. emitFromSpawnPointOnly: boolean;
  85516. /**
  85517. * Gets or sets the radius of the emission cone
  85518. */
  85519. radius: number;
  85520. /**
  85521. * Gets or sets the angle of the emission cone
  85522. */
  85523. angle: number;
  85524. private _buildHeight;
  85525. /**
  85526. * Creates a new instance ConeParticleEmitter
  85527. * @param radius the radius of the emission cone (1 by default)
  85528. * @param angle the cone base angle (PI by default)
  85529. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  85530. */
  85531. constructor(radius?: number, angle?: number,
  85532. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  85533. directionRandomizer?: number);
  85534. /**
  85535. * Called by the particle System when the direction is computed for the created particle.
  85536. * @param worldMatrix is the world matrix of the particle system
  85537. * @param directionToUpdate is the direction vector to update with the result
  85538. * @param particle is the particle we are computed the direction for
  85539. */
  85540. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85541. /**
  85542. * Called by the particle System when the position is computed for the created particle.
  85543. * @param worldMatrix is the world matrix of the particle system
  85544. * @param positionToUpdate is the position vector to update with the result
  85545. * @param particle is the particle we are computed the position for
  85546. */
  85547. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85548. /**
  85549. * Clones the current emitter and returns a copy of it
  85550. * @returns the new emitter
  85551. */
  85552. clone(): ConeParticleEmitter;
  85553. /**
  85554. * Called by the GPUParticleSystem to setup the update shader
  85555. * @param effect defines the update shader
  85556. */
  85557. applyToShader(effect: Effect): void;
  85558. /**
  85559. * Returns a string to use to update the GPU particles update shader
  85560. * @returns a string containng the defines string
  85561. */
  85562. getEffectDefines(): string;
  85563. /**
  85564. * Returns the string "ConeParticleEmitter"
  85565. * @returns a string containing the class name
  85566. */
  85567. getClassName(): string;
  85568. /**
  85569. * Serializes the particle system to a JSON object.
  85570. * @returns the JSON object
  85571. */
  85572. serialize(): any;
  85573. /**
  85574. * Parse properties from a JSON object
  85575. * @param serializationObject defines the JSON object
  85576. */
  85577. parse(serializationObject: any): void;
  85578. }
  85579. }
  85580. declare module BABYLON {
  85581. /**
  85582. * Particle emitter emitting particles from the inside of a cylinder.
  85583. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  85584. */
  85585. export class CylinderParticleEmitter implements IParticleEmitterType {
  85586. /**
  85587. * The radius of the emission cylinder.
  85588. */
  85589. radius: number;
  85590. /**
  85591. * The height of the emission cylinder.
  85592. */
  85593. height: number;
  85594. /**
  85595. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85596. */
  85597. radiusRange: number;
  85598. /**
  85599. * How much to randomize the particle direction [0-1].
  85600. */
  85601. directionRandomizer: number;
  85602. /**
  85603. * Creates a new instance CylinderParticleEmitter
  85604. * @param radius the radius of the emission cylinder (1 by default)
  85605. * @param height the height of the emission cylinder (1 by default)
  85606. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  85607. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  85608. */
  85609. constructor(
  85610. /**
  85611. * The radius of the emission cylinder.
  85612. */
  85613. radius?: number,
  85614. /**
  85615. * The height of the emission cylinder.
  85616. */
  85617. height?: number,
  85618. /**
  85619. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85620. */
  85621. radiusRange?: number,
  85622. /**
  85623. * How much to randomize the particle direction [0-1].
  85624. */
  85625. directionRandomizer?: number);
  85626. /**
  85627. * Called by the particle System when the direction is computed for the created particle.
  85628. * @param worldMatrix is the world matrix of the particle system
  85629. * @param directionToUpdate is the direction vector to update with the result
  85630. * @param particle is the particle we are computed the direction for
  85631. */
  85632. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85633. /**
  85634. * Called by the particle System when the position is computed for the created particle.
  85635. * @param worldMatrix is the world matrix of the particle system
  85636. * @param positionToUpdate is the position vector to update with the result
  85637. * @param particle is the particle we are computed the position for
  85638. */
  85639. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85640. /**
  85641. * Clones the current emitter and returns a copy of it
  85642. * @returns the new emitter
  85643. */
  85644. clone(): CylinderParticleEmitter;
  85645. /**
  85646. * Called by the GPUParticleSystem to setup the update shader
  85647. * @param effect defines the update shader
  85648. */
  85649. applyToShader(effect: Effect): void;
  85650. /**
  85651. * Returns a string to use to update the GPU particles update shader
  85652. * @returns a string containng the defines string
  85653. */
  85654. getEffectDefines(): string;
  85655. /**
  85656. * Returns the string "CylinderParticleEmitter"
  85657. * @returns a string containing the class name
  85658. */
  85659. getClassName(): string;
  85660. /**
  85661. * Serializes the particle system to a JSON object.
  85662. * @returns the JSON object
  85663. */
  85664. serialize(): any;
  85665. /**
  85666. * Parse properties from a JSON object
  85667. * @param serializationObject defines the JSON object
  85668. */
  85669. parse(serializationObject: any): void;
  85670. }
  85671. /**
  85672. * Particle emitter emitting particles from the inside of a cylinder.
  85673. * It emits the particles randomly between two vectors.
  85674. */
  85675. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  85676. /**
  85677. * The min limit of the emission direction.
  85678. */
  85679. direction1: Vector3;
  85680. /**
  85681. * The max limit of the emission direction.
  85682. */
  85683. direction2: Vector3;
  85684. /**
  85685. * Creates a new instance CylinderDirectedParticleEmitter
  85686. * @param radius the radius of the emission cylinder (1 by default)
  85687. * @param height the height of the emission cylinder (1 by default)
  85688. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  85689. * @param direction1 the min limit of the emission direction (up vector by default)
  85690. * @param direction2 the max limit of the emission direction (up vector by default)
  85691. */
  85692. constructor(radius?: number, height?: number, radiusRange?: number,
  85693. /**
  85694. * The min limit of the emission direction.
  85695. */
  85696. direction1?: Vector3,
  85697. /**
  85698. * The max limit of the emission direction.
  85699. */
  85700. direction2?: Vector3);
  85701. /**
  85702. * Called by the particle System when the direction is computed for the created particle.
  85703. * @param worldMatrix is the world matrix of the particle system
  85704. * @param directionToUpdate is the direction vector to update with the result
  85705. * @param particle is the particle we are computed the direction for
  85706. */
  85707. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85708. /**
  85709. * Clones the current emitter and returns a copy of it
  85710. * @returns the new emitter
  85711. */
  85712. clone(): CylinderDirectedParticleEmitter;
  85713. /**
  85714. * Called by the GPUParticleSystem to setup the update shader
  85715. * @param effect defines the update shader
  85716. */
  85717. applyToShader(effect: Effect): void;
  85718. /**
  85719. * Returns a string to use to update the GPU particles update shader
  85720. * @returns a string containng the defines string
  85721. */
  85722. getEffectDefines(): string;
  85723. /**
  85724. * Returns the string "CylinderDirectedParticleEmitter"
  85725. * @returns a string containing the class name
  85726. */
  85727. getClassName(): string;
  85728. /**
  85729. * Serializes the particle system to a JSON object.
  85730. * @returns the JSON object
  85731. */
  85732. serialize(): any;
  85733. /**
  85734. * Parse properties from a JSON object
  85735. * @param serializationObject defines the JSON object
  85736. */
  85737. parse(serializationObject: any): void;
  85738. }
  85739. }
  85740. declare module BABYLON {
  85741. /**
  85742. * Particle emitter emitting particles from the inside of a hemisphere.
  85743. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  85744. */
  85745. export class HemisphericParticleEmitter implements IParticleEmitterType {
  85746. /**
  85747. * The radius of the emission hemisphere.
  85748. */
  85749. radius: number;
  85750. /**
  85751. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85752. */
  85753. radiusRange: number;
  85754. /**
  85755. * How much to randomize the particle direction [0-1].
  85756. */
  85757. directionRandomizer: number;
  85758. /**
  85759. * Creates a new instance HemisphericParticleEmitter
  85760. * @param radius the radius of the emission hemisphere (1 by default)
  85761. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  85762. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  85763. */
  85764. constructor(
  85765. /**
  85766. * The radius of the emission hemisphere.
  85767. */
  85768. radius?: number,
  85769. /**
  85770. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85771. */
  85772. radiusRange?: number,
  85773. /**
  85774. * How much to randomize the particle direction [0-1].
  85775. */
  85776. directionRandomizer?: number);
  85777. /**
  85778. * Called by the particle System when the direction is computed for the created particle.
  85779. * @param worldMatrix is the world matrix of the particle system
  85780. * @param directionToUpdate is the direction vector to update with the result
  85781. * @param particle is the particle we are computed the direction for
  85782. */
  85783. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85784. /**
  85785. * Called by the particle System when the position is computed for the created particle.
  85786. * @param worldMatrix is the world matrix of the particle system
  85787. * @param positionToUpdate is the position vector to update with the result
  85788. * @param particle is the particle we are computed the position for
  85789. */
  85790. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85791. /**
  85792. * Clones the current emitter and returns a copy of it
  85793. * @returns the new emitter
  85794. */
  85795. clone(): HemisphericParticleEmitter;
  85796. /**
  85797. * Called by the GPUParticleSystem to setup the update shader
  85798. * @param effect defines the update shader
  85799. */
  85800. applyToShader(effect: Effect): void;
  85801. /**
  85802. * Returns a string to use to update the GPU particles update shader
  85803. * @returns a string containng the defines string
  85804. */
  85805. getEffectDefines(): string;
  85806. /**
  85807. * Returns the string "HemisphericParticleEmitter"
  85808. * @returns a string containing the class name
  85809. */
  85810. getClassName(): string;
  85811. /**
  85812. * Serializes the particle system to a JSON object.
  85813. * @returns the JSON object
  85814. */
  85815. serialize(): any;
  85816. /**
  85817. * Parse properties from a JSON object
  85818. * @param serializationObject defines the JSON object
  85819. */
  85820. parse(serializationObject: any): void;
  85821. }
  85822. }
  85823. declare module BABYLON {
  85824. /**
  85825. * Particle emitter emitting particles from a point.
  85826. * It emits the particles randomly between 2 given directions.
  85827. */
  85828. export class PointParticleEmitter implements IParticleEmitterType {
  85829. /**
  85830. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85831. */
  85832. direction1: Vector3;
  85833. /**
  85834. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85835. */
  85836. direction2: Vector3;
  85837. /**
  85838. * Creates a new instance PointParticleEmitter
  85839. */
  85840. constructor();
  85841. /**
  85842. * Called by the particle System when the direction is computed for the created particle.
  85843. * @param worldMatrix is the world matrix of the particle system
  85844. * @param directionToUpdate is the direction vector to update with the result
  85845. * @param particle is the particle we are computed the direction for
  85846. */
  85847. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85848. /**
  85849. * Called by the particle System when the position is computed for the created particle.
  85850. * @param worldMatrix is the world matrix of the particle system
  85851. * @param positionToUpdate is the position vector to update with the result
  85852. * @param particle is the particle we are computed the position for
  85853. */
  85854. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85855. /**
  85856. * Clones the current emitter and returns a copy of it
  85857. * @returns the new emitter
  85858. */
  85859. clone(): PointParticleEmitter;
  85860. /**
  85861. * Called by the GPUParticleSystem to setup the update shader
  85862. * @param effect defines the update shader
  85863. */
  85864. applyToShader(effect: Effect): void;
  85865. /**
  85866. * Returns a string to use to update the GPU particles update shader
  85867. * @returns a string containng the defines string
  85868. */
  85869. getEffectDefines(): string;
  85870. /**
  85871. * Returns the string "PointParticleEmitter"
  85872. * @returns a string containing the class name
  85873. */
  85874. getClassName(): string;
  85875. /**
  85876. * Serializes the particle system to a JSON object.
  85877. * @returns the JSON object
  85878. */
  85879. serialize(): any;
  85880. /**
  85881. * Parse properties from a JSON object
  85882. * @param serializationObject defines the JSON object
  85883. */
  85884. parse(serializationObject: any): void;
  85885. }
  85886. }
  85887. declare module BABYLON {
  85888. /**
  85889. * Particle emitter emitting particles from the inside of a sphere.
  85890. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  85891. */
  85892. export class SphereParticleEmitter implements IParticleEmitterType {
  85893. /**
  85894. * The radius of the emission sphere.
  85895. */
  85896. radius: number;
  85897. /**
  85898. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85899. */
  85900. radiusRange: number;
  85901. /**
  85902. * How much to randomize the particle direction [0-1].
  85903. */
  85904. directionRandomizer: number;
  85905. /**
  85906. * Creates a new instance SphereParticleEmitter
  85907. * @param radius the radius of the emission sphere (1 by default)
  85908. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  85909. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  85910. */
  85911. constructor(
  85912. /**
  85913. * The radius of the emission sphere.
  85914. */
  85915. radius?: number,
  85916. /**
  85917. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85918. */
  85919. radiusRange?: number,
  85920. /**
  85921. * How much to randomize the particle direction [0-1].
  85922. */
  85923. directionRandomizer?: number);
  85924. /**
  85925. * Called by the particle System when the direction is computed for the created particle.
  85926. * @param worldMatrix is the world matrix of the particle system
  85927. * @param directionToUpdate is the direction vector to update with the result
  85928. * @param particle is the particle we are computed the direction for
  85929. */
  85930. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85931. /**
  85932. * Called by the particle System when the position is computed for the created particle.
  85933. * @param worldMatrix is the world matrix of the particle system
  85934. * @param positionToUpdate is the position vector to update with the result
  85935. * @param particle is the particle we are computed the position for
  85936. */
  85937. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85938. /**
  85939. * Clones the current emitter and returns a copy of it
  85940. * @returns the new emitter
  85941. */
  85942. clone(): SphereParticleEmitter;
  85943. /**
  85944. * Called by the GPUParticleSystem to setup the update shader
  85945. * @param effect defines the update shader
  85946. */
  85947. applyToShader(effect: Effect): void;
  85948. /**
  85949. * Returns a string to use to update the GPU particles update shader
  85950. * @returns a string containng the defines string
  85951. */
  85952. getEffectDefines(): string;
  85953. /**
  85954. * Returns the string "SphereParticleEmitter"
  85955. * @returns a string containing the class name
  85956. */
  85957. getClassName(): string;
  85958. /**
  85959. * Serializes the particle system to a JSON object.
  85960. * @returns the JSON object
  85961. */
  85962. serialize(): any;
  85963. /**
  85964. * Parse properties from a JSON object
  85965. * @param serializationObject defines the JSON object
  85966. */
  85967. parse(serializationObject: any): void;
  85968. }
  85969. /**
  85970. * Particle emitter emitting particles from the inside of a sphere.
  85971. * It emits the particles randomly between two vectors.
  85972. */
  85973. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  85974. /**
  85975. * The min limit of the emission direction.
  85976. */
  85977. direction1: Vector3;
  85978. /**
  85979. * The max limit of the emission direction.
  85980. */
  85981. direction2: Vector3;
  85982. /**
  85983. * Creates a new instance SphereDirectedParticleEmitter
  85984. * @param radius the radius of the emission sphere (1 by default)
  85985. * @param direction1 the min limit of the emission direction (up vector by default)
  85986. * @param direction2 the max limit of the emission direction (up vector by default)
  85987. */
  85988. constructor(radius?: number,
  85989. /**
  85990. * The min limit of the emission direction.
  85991. */
  85992. direction1?: Vector3,
  85993. /**
  85994. * The max limit of the emission direction.
  85995. */
  85996. direction2?: Vector3);
  85997. /**
  85998. * Called by the particle System when the direction is computed for the created particle.
  85999. * @param worldMatrix is the world matrix of the particle system
  86000. * @param directionToUpdate is the direction vector to update with the result
  86001. * @param particle is the particle we are computed the direction for
  86002. */
  86003. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86004. /**
  86005. * Clones the current emitter and returns a copy of it
  86006. * @returns the new emitter
  86007. */
  86008. clone(): SphereDirectedParticleEmitter;
  86009. /**
  86010. * Called by the GPUParticleSystem to setup the update shader
  86011. * @param effect defines the update shader
  86012. */
  86013. applyToShader(effect: Effect): void;
  86014. /**
  86015. * Returns a string to use to update the GPU particles update shader
  86016. * @returns a string containng the defines string
  86017. */
  86018. getEffectDefines(): string;
  86019. /**
  86020. * Returns the string "SphereDirectedParticleEmitter"
  86021. * @returns a string containing the class name
  86022. */
  86023. getClassName(): string;
  86024. /**
  86025. * Serializes the particle system to a JSON object.
  86026. * @returns the JSON object
  86027. */
  86028. serialize(): any;
  86029. /**
  86030. * Parse properties from a JSON object
  86031. * @param serializationObject defines the JSON object
  86032. */
  86033. parse(serializationObject: any): void;
  86034. }
  86035. }
  86036. declare module BABYLON {
  86037. /**
  86038. * Interface representing a particle system in Babylon.js.
  86039. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  86040. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  86041. */
  86042. export interface IParticleSystem {
  86043. /**
  86044. * List of animations used by the particle system.
  86045. */
  86046. animations: Animation[];
  86047. /**
  86048. * The id of the Particle system.
  86049. */
  86050. id: string;
  86051. /**
  86052. * The name of the Particle system.
  86053. */
  86054. name: string;
  86055. /**
  86056. * The emitter represents the Mesh or position we are attaching the particle system to.
  86057. */
  86058. emitter: Nullable<AbstractMesh | Vector3>;
  86059. /**
  86060. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  86061. */
  86062. isBillboardBased: boolean;
  86063. /**
  86064. * The rendering group used by the Particle system to chose when to render.
  86065. */
  86066. renderingGroupId: number;
  86067. /**
  86068. * The layer mask we are rendering the particles through.
  86069. */
  86070. layerMask: number;
  86071. /**
  86072. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  86073. */
  86074. updateSpeed: number;
  86075. /**
  86076. * The amount of time the particle system is running (depends of the overall update speed).
  86077. */
  86078. targetStopDuration: number;
  86079. /**
  86080. * The texture used to render each particle. (this can be a spritesheet)
  86081. */
  86082. particleTexture: Nullable<Texture>;
  86083. /**
  86084. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  86085. */
  86086. blendMode: number;
  86087. /**
  86088. * Minimum life time of emitting particles.
  86089. */
  86090. minLifeTime: number;
  86091. /**
  86092. * Maximum life time of emitting particles.
  86093. */
  86094. maxLifeTime: number;
  86095. /**
  86096. * Minimum Size of emitting particles.
  86097. */
  86098. minSize: number;
  86099. /**
  86100. * Maximum Size of emitting particles.
  86101. */
  86102. maxSize: number;
  86103. /**
  86104. * Minimum scale of emitting particles on X axis.
  86105. */
  86106. minScaleX: number;
  86107. /**
  86108. * Maximum scale of emitting particles on X axis.
  86109. */
  86110. maxScaleX: number;
  86111. /**
  86112. * Minimum scale of emitting particles on Y axis.
  86113. */
  86114. minScaleY: number;
  86115. /**
  86116. * Maximum scale of emitting particles on Y axis.
  86117. */
  86118. maxScaleY: number;
  86119. /**
  86120. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  86121. */
  86122. color1: Color4;
  86123. /**
  86124. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  86125. */
  86126. color2: Color4;
  86127. /**
  86128. * Color the particle will have at the end of its lifetime.
  86129. */
  86130. colorDead: Color4;
  86131. /**
  86132. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  86133. */
  86134. emitRate: number;
  86135. /**
  86136. * You can use gravity if you want to give an orientation to your particles.
  86137. */
  86138. gravity: Vector3;
  86139. /**
  86140. * Minimum power of emitting particles.
  86141. */
  86142. minEmitPower: number;
  86143. /**
  86144. * Maximum power of emitting particles.
  86145. */
  86146. maxEmitPower: number;
  86147. /**
  86148. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  86149. */
  86150. minAngularSpeed: number;
  86151. /**
  86152. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  86153. */
  86154. maxAngularSpeed: number;
  86155. /**
  86156. * Gets or sets the minimal initial rotation in radians.
  86157. */
  86158. minInitialRotation: number;
  86159. /**
  86160. * Gets or sets the maximal initial rotation in radians.
  86161. */
  86162. maxInitialRotation: number;
  86163. /**
  86164. * The particle emitter type defines the emitter used by the particle system.
  86165. * It can be for example box, sphere, or cone...
  86166. */
  86167. particleEmitterType: Nullable<IParticleEmitterType>;
  86168. /**
  86169. * Defines the delay in milliseconds before starting the system (0 by default)
  86170. */
  86171. startDelay: number;
  86172. /**
  86173. * 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
  86174. */
  86175. preWarmCycles: number;
  86176. /**
  86177. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  86178. */
  86179. preWarmStepOffset: number;
  86180. /**
  86181. * 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)
  86182. */
  86183. spriteCellChangeSpeed: number;
  86184. /**
  86185. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  86186. */
  86187. startSpriteCellID: number;
  86188. /**
  86189. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  86190. */
  86191. endSpriteCellID: number;
  86192. /**
  86193. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  86194. */
  86195. spriteCellWidth: number;
  86196. /**
  86197. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  86198. */
  86199. spriteCellHeight: number;
  86200. /**
  86201. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  86202. */
  86203. spriteRandomStartCell: boolean;
  86204. /**
  86205. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  86206. */
  86207. isAnimationSheetEnabled: boolean;
  86208. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  86209. translationPivot: Vector2;
  86210. /**
  86211. * Gets or sets a texture used to add random noise to particle positions
  86212. */
  86213. noiseTexture: Nullable<BaseTexture>;
  86214. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  86215. noiseStrength: Vector3;
  86216. /**
  86217. * Gets or sets the billboard mode to use when isBillboardBased = true.
  86218. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  86219. */
  86220. billboardMode: number;
  86221. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  86222. limitVelocityDamping: number;
  86223. /**
  86224. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  86225. */
  86226. beginAnimationOnStart: boolean;
  86227. /**
  86228. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  86229. */
  86230. beginAnimationFrom: number;
  86231. /**
  86232. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  86233. */
  86234. beginAnimationTo: number;
  86235. /**
  86236. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  86237. */
  86238. beginAnimationLoop: boolean;
  86239. /**
  86240. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  86241. */
  86242. disposeOnStop: boolean;
  86243. /**
  86244. * Gets the maximum number of particles active at the same time.
  86245. * @returns The max number of active particles.
  86246. */
  86247. getCapacity(): number;
  86248. /**
  86249. * Gets if the system has been started. (Note: this will still be true after stop is called)
  86250. * @returns True if it has been started, otherwise false.
  86251. */
  86252. isStarted(): boolean;
  86253. /**
  86254. * Animates the particle system for this frame.
  86255. */
  86256. animate(): void;
  86257. /**
  86258. * Renders the particle system in its current state.
  86259. * @returns the current number of particles
  86260. */
  86261. render(): number;
  86262. /**
  86263. * Dispose the particle system and frees its associated resources.
  86264. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  86265. */
  86266. dispose(disposeTexture?: boolean): void;
  86267. /**
  86268. * Clones the particle system.
  86269. * @param name The name of the cloned object
  86270. * @param newEmitter The new emitter to use
  86271. * @returns the cloned particle system
  86272. */
  86273. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  86274. /**
  86275. * Serializes the particle system to a JSON object.
  86276. * @returns the JSON object
  86277. */
  86278. serialize(): any;
  86279. /**
  86280. * Rebuild the particle system
  86281. */
  86282. rebuild(): void;
  86283. /**
  86284. * Starts the particle system and begins to emit
  86285. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  86286. */
  86287. start(delay?: number): void;
  86288. /**
  86289. * Stops the particle system.
  86290. */
  86291. stop(): void;
  86292. /**
  86293. * Remove all active particles
  86294. */
  86295. reset(): void;
  86296. /**
  86297. * Is this system ready to be used/rendered
  86298. * @return true if the system is ready
  86299. */
  86300. isReady(): boolean;
  86301. /**
  86302. * Adds a new color gradient
  86303. * @param gradient defines the gradient to use (between 0 and 1)
  86304. * @param color1 defines the color to affect to the specified gradient
  86305. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  86306. * @returns the current particle system
  86307. */
  86308. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  86309. /**
  86310. * Remove a specific color gradient
  86311. * @param gradient defines the gradient to remove
  86312. * @returns the current particle system
  86313. */
  86314. removeColorGradient(gradient: number): IParticleSystem;
  86315. /**
  86316. * Adds a new size gradient
  86317. * @param gradient defines the gradient to use (between 0 and 1)
  86318. * @param factor defines the size factor to affect to the specified gradient
  86319. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86320. * @returns the current particle system
  86321. */
  86322. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86323. /**
  86324. * Remove a specific size gradient
  86325. * @param gradient defines the gradient to remove
  86326. * @returns the current particle system
  86327. */
  86328. removeSizeGradient(gradient: number): IParticleSystem;
  86329. /**
  86330. * Gets the current list of color gradients.
  86331. * You must use addColorGradient and removeColorGradient to udpate this list
  86332. * @returns the list of color gradients
  86333. */
  86334. getColorGradients(): Nullable<Array<ColorGradient>>;
  86335. /**
  86336. * Gets the current list of size gradients.
  86337. * You must use addSizeGradient and removeSizeGradient to udpate this list
  86338. * @returns the list of size gradients
  86339. */
  86340. getSizeGradients(): Nullable<Array<FactorGradient>>;
  86341. /**
  86342. * Gets the current list of angular speed gradients.
  86343. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  86344. * @returns the list of angular speed gradients
  86345. */
  86346. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  86347. /**
  86348. * Adds a new angular speed gradient
  86349. * @param gradient defines the gradient to use (between 0 and 1)
  86350. * @param factor defines the angular speed to affect to the specified gradient
  86351. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86352. * @returns the current particle system
  86353. */
  86354. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86355. /**
  86356. * Remove a specific angular speed gradient
  86357. * @param gradient defines the gradient to remove
  86358. * @returns the current particle system
  86359. */
  86360. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  86361. /**
  86362. * Gets the current list of velocity gradients.
  86363. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  86364. * @returns the list of velocity gradients
  86365. */
  86366. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  86367. /**
  86368. * Adds a new velocity gradient
  86369. * @param gradient defines the gradient to use (between 0 and 1)
  86370. * @param factor defines the velocity to affect to the specified gradient
  86371. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86372. * @returns the current particle system
  86373. */
  86374. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86375. /**
  86376. * Remove a specific velocity gradient
  86377. * @param gradient defines the gradient to remove
  86378. * @returns the current particle system
  86379. */
  86380. removeVelocityGradient(gradient: number): IParticleSystem;
  86381. /**
  86382. * Gets the current list of limit velocity gradients.
  86383. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  86384. * @returns the list of limit velocity gradients
  86385. */
  86386. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  86387. /**
  86388. * Adds a new limit velocity gradient
  86389. * @param gradient defines the gradient to use (between 0 and 1)
  86390. * @param factor defines the limit velocity to affect to the specified gradient
  86391. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86392. * @returns the current particle system
  86393. */
  86394. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86395. /**
  86396. * Remove a specific limit velocity gradient
  86397. * @param gradient defines the gradient to remove
  86398. * @returns the current particle system
  86399. */
  86400. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  86401. /**
  86402. * Adds a new drag gradient
  86403. * @param gradient defines the gradient to use (between 0 and 1)
  86404. * @param factor defines the drag to affect to the specified gradient
  86405. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86406. * @returns the current particle system
  86407. */
  86408. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86409. /**
  86410. * Remove a specific drag gradient
  86411. * @param gradient defines the gradient to remove
  86412. * @returns the current particle system
  86413. */
  86414. removeDragGradient(gradient: number): IParticleSystem;
  86415. /**
  86416. * Gets the current list of drag gradients.
  86417. * You must use addDragGradient and removeDragGradient to udpate this list
  86418. * @returns the list of drag gradients
  86419. */
  86420. getDragGradients(): Nullable<Array<FactorGradient>>;
  86421. /**
  86422. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  86423. * @param gradient defines the gradient to use (between 0 and 1)
  86424. * @param factor defines the emit rate to affect to the specified gradient
  86425. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86426. * @returns the current particle system
  86427. */
  86428. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86429. /**
  86430. * Remove a specific emit rate gradient
  86431. * @param gradient defines the gradient to remove
  86432. * @returns the current particle system
  86433. */
  86434. removeEmitRateGradient(gradient: number): IParticleSystem;
  86435. /**
  86436. * Gets the current list of emit rate gradients.
  86437. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  86438. * @returns the list of emit rate gradients
  86439. */
  86440. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  86441. /**
  86442. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  86443. * @param gradient defines the gradient to use (between 0 and 1)
  86444. * @param factor defines the start size to affect to the specified gradient
  86445. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86446. * @returns the current particle system
  86447. */
  86448. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86449. /**
  86450. * Remove a specific start size gradient
  86451. * @param gradient defines the gradient to remove
  86452. * @returns the current particle system
  86453. */
  86454. removeStartSizeGradient(gradient: number): IParticleSystem;
  86455. /**
  86456. * Gets the current list of start size gradients.
  86457. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  86458. * @returns the list of start size gradients
  86459. */
  86460. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  86461. /**
  86462. * Adds a new life time gradient
  86463. * @param gradient defines the gradient to use (between 0 and 1)
  86464. * @param factor defines the life time factor to affect to the specified gradient
  86465. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86466. * @returns the current particle system
  86467. */
  86468. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86469. /**
  86470. * Remove a specific life time gradient
  86471. * @param gradient defines the gradient to remove
  86472. * @returns the current particle system
  86473. */
  86474. removeLifeTimeGradient(gradient: number): IParticleSystem;
  86475. /**
  86476. * Gets the current list of life time gradients.
  86477. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  86478. * @returns the list of life time gradients
  86479. */
  86480. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  86481. /**
  86482. * Gets the current list of color gradients.
  86483. * You must use addColorGradient and removeColorGradient to udpate this list
  86484. * @returns the list of color gradients
  86485. */
  86486. getColorGradients(): Nullable<Array<ColorGradient>>;
  86487. /**
  86488. * Adds a new ramp gradient used to remap particle colors
  86489. * @param gradient defines the gradient to use (between 0 and 1)
  86490. * @param color defines the color to affect to the specified gradient
  86491. * @returns the current particle system
  86492. */
  86493. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  86494. /**
  86495. * Gets the current list of ramp gradients.
  86496. * You must use addRampGradient and removeRampGradient to udpate this list
  86497. * @returns the list of ramp gradients
  86498. */
  86499. getRampGradients(): Nullable<Array<Color3Gradient>>;
  86500. /** Gets or sets a boolean indicating that ramp gradients must be used
  86501. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  86502. */
  86503. useRampGradients: boolean;
  86504. /**
  86505. * Adds a new color remap gradient
  86506. * @param gradient defines the gradient to use (between 0 and 1)
  86507. * @param min defines the color remap minimal range
  86508. * @param max defines the color remap maximal range
  86509. * @returns the current particle system
  86510. */
  86511. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  86512. /**
  86513. * Gets the current list of color remap gradients.
  86514. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  86515. * @returns the list of color remap gradients
  86516. */
  86517. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  86518. /**
  86519. * Adds a new alpha remap gradient
  86520. * @param gradient defines the gradient to use (between 0 and 1)
  86521. * @param min defines the alpha remap minimal range
  86522. * @param max defines the alpha remap maximal range
  86523. * @returns the current particle system
  86524. */
  86525. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  86526. /**
  86527. * Gets the current list of alpha remap gradients.
  86528. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  86529. * @returns the list of alpha remap gradients
  86530. */
  86531. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  86532. /**
  86533. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  86534. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  86535. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  86536. * @returns the emitter
  86537. */
  86538. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  86539. /**
  86540. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  86541. * @param radius The radius of the hemisphere to emit from
  86542. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  86543. * @returns the emitter
  86544. */
  86545. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  86546. /**
  86547. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  86548. * @param radius The radius of the sphere to emit from
  86549. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  86550. * @returns the emitter
  86551. */
  86552. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  86553. /**
  86554. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  86555. * @param radius The radius of the sphere to emit from
  86556. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  86557. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  86558. * @returns the emitter
  86559. */
  86560. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  86561. /**
  86562. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  86563. * @param radius The radius of the emission cylinder
  86564. * @param height The height of the emission cylinder
  86565. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  86566. * @param directionRandomizer How much to randomize the particle direction [0-1]
  86567. * @returns the emitter
  86568. */
  86569. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  86570. /**
  86571. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  86572. * @param radius The radius of the cylinder to emit from
  86573. * @param height The height of the emission cylinder
  86574. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86575. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  86576. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  86577. * @returns the emitter
  86578. */
  86579. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  86580. /**
  86581. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  86582. * @param radius The radius of the cone to emit from
  86583. * @param angle The base angle of the cone
  86584. * @returns the emitter
  86585. */
  86586. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  86587. /**
  86588. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  86589. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  86590. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  86591. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  86592. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  86593. * @returns the emitter
  86594. */
  86595. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  86596. /**
  86597. * Get hosting scene
  86598. * @returns the scene
  86599. */
  86600. getScene(): Scene;
  86601. }
  86602. }
  86603. declare module BABYLON {
  86604. /**
  86605. * Creates an instance based on a source mesh.
  86606. */
  86607. export class InstancedMesh extends AbstractMesh {
  86608. private _sourceMesh;
  86609. private _currentLOD;
  86610. /** @hidden */
  86611. _indexInSourceMeshInstanceArray: number;
  86612. constructor(name: string, source: Mesh);
  86613. /**
  86614. * Returns the string "InstancedMesh".
  86615. */
  86616. getClassName(): string;
  86617. /** Gets the list of lights affecting that mesh */
  86618. readonly lightSources: Light[];
  86619. _resyncLightSources(): void;
  86620. _resyncLighSource(light: Light): void;
  86621. _removeLightSource(light: Light, dispose: boolean): void;
  86622. /**
  86623. * If the source mesh receives shadows
  86624. */
  86625. readonly receiveShadows: boolean;
  86626. /**
  86627. * The material of the source mesh
  86628. */
  86629. readonly material: Nullable<Material>;
  86630. /**
  86631. * Visibility of the source mesh
  86632. */
  86633. readonly visibility: number;
  86634. /**
  86635. * Skeleton of the source mesh
  86636. */
  86637. readonly skeleton: Nullable<Skeleton>;
  86638. /**
  86639. * Rendering ground id of the source mesh
  86640. */
  86641. renderingGroupId: number;
  86642. /**
  86643. * Returns the total number of vertices (integer).
  86644. */
  86645. getTotalVertices(): number;
  86646. /**
  86647. * Returns a positive integer : the total number of indices in this mesh geometry.
  86648. * @returns the numner of indices or zero if the mesh has no geometry.
  86649. */
  86650. getTotalIndices(): number;
  86651. /**
  86652. * The source mesh of the instance
  86653. */
  86654. readonly sourceMesh: Mesh;
  86655. /**
  86656. * Is this node ready to be used/rendered
  86657. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  86658. * @return {boolean} is it ready
  86659. */
  86660. isReady(completeCheck?: boolean): boolean;
  86661. /**
  86662. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  86663. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  86664. * @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.
  86665. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  86666. */
  86667. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  86668. /**
  86669. * Sets the vertex data of the mesh geometry for the requested `kind`.
  86670. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  86671. * The `data` are either a numeric array either a Float32Array.
  86672. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  86673. * 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).
  86674. * Note that a new underlying VertexBuffer object is created each call.
  86675. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  86676. *
  86677. * Possible `kind` values :
  86678. * - VertexBuffer.PositionKind
  86679. * - VertexBuffer.UVKind
  86680. * - VertexBuffer.UV2Kind
  86681. * - VertexBuffer.UV3Kind
  86682. * - VertexBuffer.UV4Kind
  86683. * - VertexBuffer.UV5Kind
  86684. * - VertexBuffer.UV6Kind
  86685. * - VertexBuffer.ColorKind
  86686. * - VertexBuffer.MatricesIndicesKind
  86687. * - VertexBuffer.MatricesIndicesExtraKind
  86688. * - VertexBuffer.MatricesWeightsKind
  86689. * - VertexBuffer.MatricesWeightsExtraKind
  86690. *
  86691. * Returns the Mesh.
  86692. */
  86693. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  86694. /**
  86695. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  86696. * If the mesh has no geometry, it is simply returned as it is.
  86697. * The `data` are either a numeric array either a Float32Array.
  86698. * No new underlying VertexBuffer object is created.
  86699. * 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.
  86700. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  86701. *
  86702. * Possible `kind` values :
  86703. * - VertexBuffer.PositionKind
  86704. * - VertexBuffer.UVKind
  86705. * - VertexBuffer.UV2Kind
  86706. * - VertexBuffer.UV3Kind
  86707. * - VertexBuffer.UV4Kind
  86708. * - VertexBuffer.UV5Kind
  86709. * - VertexBuffer.UV6Kind
  86710. * - VertexBuffer.ColorKind
  86711. * - VertexBuffer.MatricesIndicesKind
  86712. * - VertexBuffer.MatricesIndicesExtraKind
  86713. * - VertexBuffer.MatricesWeightsKind
  86714. * - VertexBuffer.MatricesWeightsExtraKind
  86715. *
  86716. * Returns the Mesh.
  86717. */
  86718. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  86719. /**
  86720. * Sets the mesh indices.
  86721. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  86722. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  86723. * This method creates a new index buffer each call.
  86724. * Returns the Mesh.
  86725. */
  86726. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  86727. /**
  86728. * Boolean : True if the mesh owns the requested kind of data.
  86729. */
  86730. isVerticesDataPresent(kind: string): boolean;
  86731. /**
  86732. * Returns an array of indices (IndicesArray).
  86733. */
  86734. getIndices(): Nullable<IndicesArray>;
  86735. readonly _positions: Nullable<Vector3[]>;
  86736. /**
  86737. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  86738. * This means the mesh underlying bounding box and sphere are recomputed.
  86739. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  86740. * @returns the current mesh
  86741. */
  86742. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  86743. /** @hidden */
  86744. _preActivate(): InstancedMesh;
  86745. /** @hidden */
  86746. _activate(renderId: number, intermediateRendering: boolean): boolean;
  86747. /** @hidden */
  86748. _postActivate(): void;
  86749. getWorldMatrix(): Matrix;
  86750. readonly isAnInstance: boolean;
  86751. /**
  86752. * Returns the current associated LOD AbstractMesh.
  86753. */
  86754. getLOD(camera: Camera): AbstractMesh;
  86755. /** @hidden */
  86756. _syncSubMeshes(): InstancedMesh;
  86757. /** @hidden */
  86758. _generatePointsArray(): boolean;
  86759. /**
  86760. * Creates a new InstancedMesh from the current mesh.
  86761. * - name (string) : the cloned mesh name
  86762. * - newParent (optional Node) : the optional Node to parent the clone to.
  86763. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  86764. *
  86765. * Returns the clone.
  86766. */
  86767. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  86768. /**
  86769. * Disposes the InstancedMesh.
  86770. * Returns nothing.
  86771. */
  86772. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  86773. }
  86774. interface Mesh {
  86775. /**
  86776. * Register a custom buffer that will be instanced
  86777. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  86778. * @param kind defines the buffer kind
  86779. * @param stride defines the stride in floats
  86780. */
  86781. registerInstancedBuffer(kind: string, stride: number): void;
  86782. /** @hidden */
  86783. _userInstancedBuffersStorage: {
  86784. data: {
  86785. [key: string]: Float32Array;
  86786. };
  86787. sizes: {
  86788. [key: string]: number;
  86789. };
  86790. vertexBuffers: {
  86791. [key: string]: Nullable<VertexBuffer>;
  86792. };
  86793. strides: {
  86794. [key: string]: number;
  86795. };
  86796. };
  86797. }
  86798. interface AbstractMesh {
  86799. /**
  86800. * Object used to store instanced buffers defined by user
  86801. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  86802. */
  86803. instancedBuffers: {
  86804. [key: string]: any;
  86805. };
  86806. }
  86807. }
  86808. declare module BABYLON {
  86809. /**
  86810. * Defines the options associated with the creation of a shader material.
  86811. */
  86812. export interface IShaderMaterialOptions {
  86813. /**
  86814. * Does the material work in alpha blend mode
  86815. */
  86816. needAlphaBlending: boolean;
  86817. /**
  86818. * Does the material work in alpha test mode
  86819. */
  86820. needAlphaTesting: boolean;
  86821. /**
  86822. * The list of attribute names used in the shader
  86823. */
  86824. attributes: string[];
  86825. /**
  86826. * The list of unifrom names used in the shader
  86827. */
  86828. uniforms: string[];
  86829. /**
  86830. * The list of UBO names used in the shader
  86831. */
  86832. uniformBuffers: string[];
  86833. /**
  86834. * The list of sampler names used in the shader
  86835. */
  86836. samplers: string[];
  86837. /**
  86838. * The list of defines used in the shader
  86839. */
  86840. defines: string[];
  86841. }
  86842. /**
  86843. * 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.
  86844. *
  86845. * This returned material effects how the mesh will look based on the code in the shaders.
  86846. *
  86847. * @see http://doc.babylonjs.com/how_to/shader_material
  86848. */
  86849. export class ShaderMaterial extends Material {
  86850. private _shaderPath;
  86851. private _options;
  86852. private _textures;
  86853. private _textureArrays;
  86854. private _floats;
  86855. private _ints;
  86856. private _floatsArrays;
  86857. private _colors3;
  86858. private _colors3Arrays;
  86859. private _colors4;
  86860. private _colors4Arrays;
  86861. private _vectors2;
  86862. private _vectors3;
  86863. private _vectors4;
  86864. private _matrices;
  86865. private _matrices3x3;
  86866. private _matrices2x2;
  86867. private _vectors2Arrays;
  86868. private _vectors3Arrays;
  86869. private _vectors4Arrays;
  86870. private _cachedWorldViewMatrix;
  86871. private _cachedWorldViewProjectionMatrix;
  86872. private _renderId;
  86873. /**
  86874. * Instantiate a new shader material.
  86875. * 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.
  86876. * This returned material effects how the mesh will look based on the code in the shaders.
  86877. * @see http://doc.babylonjs.com/how_to/shader_material
  86878. * @param name Define the name of the material in the scene
  86879. * @param scene Define the scene the material belongs to
  86880. * @param shaderPath Defines the route to the shader code in one of three ways:
  86881. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  86882. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  86883. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  86884. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  86885. * @param options Define the options used to create the shader
  86886. */
  86887. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  86888. /**
  86889. * Gets the options used to compile the shader.
  86890. * They can be modified to trigger a new compilation
  86891. */
  86892. readonly options: IShaderMaterialOptions;
  86893. /**
  86894. * Gets the current class name of the material e.g. "ShaderMaterial"
  86895. * Mainly use in serialization.
  86896. * @returns the class name
  86897. */
  86898. getClassName(): string;
  86899. /**
  86900. * Specifies if the material will require alpha blending
  86901. * @returns a boolean specifying if alpha blending is needed
  86902. */
  86903. needAlphaBlending(): boolean;
  86904. /**
  86905. * Specifies if this material should be rendered in alpha test mode
  86906. * @returns a boolean specifying if an alpha test is needed.
  86907. */
  86908. needAlphaTesting(): boolean;
  86909. private _checkUniform;
  86910. /**
  86911. * Set a texture in the shader.
  86912. * @param name Define the name of the uniform samplers as defined in the shader
  86913. * @param texture Define the texture to bind to this sampler
  86914. * @return the material itself allowing "fluent" like uniform updates
  86915. */
  86916. setTexture(name: string, texture: Texture): ShaderMaterial;
  86917. /**
  86918. * Set a texture array in the shader.
  86919. * @param name Define the name of the uniform sampler array as defined in the shader
  86920. * @param textures Define the list of textures to bind to this sampler
  86921. * @return the material itself allowing "fluent" like uniform updates
  86922. */
  86923. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  86924. /**
  86925. * Set a float in the shader.
  86926. * @param name Define the name of the uniform as defined in the shader
  86927. * @param value Define the value to give to the uniform
  86928. * @return the material itself allowing "fluent" like uniform updates
  86929. */
  86930. setFloat(name: string, value: number): ShaderMaterial;
  86931. /**
  86932. * Set a int in the shader.
  86933. * @param name Define the name of the uniform as defined in the shader
  86934. * @param value Define the value to give to the uniform
  86935. * @return the material itself allowing "fluent" like uniform updates
  86936. */
  86937. setInt(name: string, value: number): ShaderMaterial;
  86938. /**
  86939. * Set an array of floats in the shader.
  86940. * @param name Define the name of the uniform as defined in the shader
  86941. * @param value Define the value to give to the uniform
  86942. * @return the material itself allowing "fluent" like uniform updates
  86943. */
  86944. setFloats(name: string, value: number[]): ShaderMaterial;
  86945. /**
  86946. * Set a vec3 in the shader from a Color3.
  86947. * @param name Define the name of the uniform as defined in the shader
  86948. * @param value Define the value to give to the uniform
  86949. * @return the material itself allowing "fluent" like uniform updates
  86950. */
  86951. setColor3(name: string, value: Color3): ShaderMaterial;
  86952. /**
  86953. * Set a vec3 array in the shader from a Color3 array.
  86954. * @param name Define the name of the uniform as defined in the shader
  86955. * @param value Define the value to give to the uniform
  86956. * @return the material itself allowing "fluent" like uniform updates
  86957. */
  86958. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  86959. /**
  86960. * Set a vec4 in the shader from a Color4.
  86961. * @param name Define the name of the uniform as defined in the shader
  86962. * @param value Define the value to give to the uniform
  86963. * @return the material itself allowing "fluent" like uniform updates
  86964. */
  86965. setColor4(name: string, value: Color4): ShaderMaterial;
  86966. /**
  86967. * Set a vec4 array in the shader from a Color4 array.
  86968. * @param name Define the name of the uniform as defined in the shader
  86969. * @param value Define the value to give to the uniform
  86970. * @return the material itself allowing "fluent" like uniform updates
  86971. */
  86972. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  86973. /**
  86974. * Set a vec2 in the shader from a Vector2.
  86975. * @param name Define the name of the uniform as defined in the shader
  86976. * @param value Define the value to give to the uniform
  86977. * @return the material itself allowing "fluent" like uniform updates
  86978. */
  86979. setVector2(name: string, value: Vector2): ShaderMaterial;
  86980. /**
  86981. * Set a vec3 in the shader from a Vector3.
  86982. * @param name Define the name of the uniform as defined in the shader
  86983. * @param value Define the value to give to the uniform
  86984. * @return the material itself allowing "fluent" like uniform updates
  86985. */
  86986. setVector3(name: string, value: Vector3): ShaderMaterial;
  86987. /**
  86988. * Set a vec4 in the shader from a Vector4.
  86989. * @param name Define the name of the uniform as defined in the shader
  86990. * @param value Define the value to give to the uniform
  86991. * @return the material itself allowing "fluent" like uniform updates
  86992. */
  86993. setVector4(name: string, value: Vector4): ShaderMaterial;
  86994. /**
  86995. * Set a mat4 in the shader from a Matrix.
  86996. * @param name Define the name of the uniform as defined in the shader
  86997. * @param value Define the value to give to the uniform
  86998. * @return the material itself allowing "fluent" like uniform updates
  86999. */
  87000. setMatrix(name: string, value: Matrix): ShaderMaterial;
  87001. /**
  87002. * Set a mat3 in the shader from a Float32Array.
  87003. * @param name Define the name of the uniform as defined in the shader
  87004. * @param value Define the value to give to the uniform
  87005. * @return the material itself allowing "fluent" like uniform updates
  87006. */
  87007. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  87008. /**
  87009. * Set a mat2 in the shader from a Float32Array.
  87010. * @param name Define the name of the uniform as defined in the shader
  87011. * @param value Define the value to give to the uniform
  87012. * @return the material itself allowing "fluent" like uniform updates
  87013. */
  87014. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  87015. /**
  87016. * Set a vec2 array in the shader from a number array.
  87017. * @param name Define the name of the uniform as defined in the shader
  87018. * @param value Define the value to give to the uniform
  87019. * @return the material itself allowing "fluent" like uniform updates
  87020. */
  87021. setArray2(name: string, value: number[]): ShaderMaterial;
  87022. /**
  87023. * Set a vec3 array in the shader from a number array.
  87024. * @param name Define the name of the uniform as defined in the shader
  87025. * @param value Define the value to give to the uniform
  87026. * @return the material itself allowing "fluent" like uniform updates
  87027. */
  87028. setArray3(name: string, value: number[]): ShaderMaterial;
  87029. /**
  87030. * Set a vec4 array in the shader from a number array.
  87031. * @param name Define the name of the uniform as defined in the shader
  87032. * @param value Define the value to give to the uniform
  87033. * @return the material itself allowing "fluent" like uniform updates
  87034. */
  87035. setArray4(name: string, value: number[]): ShaderMaterial;
  87036. private _checkCache;
  87037. /**
  87038. * Specifies that the submesh is ready to be used
  87039. * @param mesh defines the mesh to check
  87040. * @param subMesh defines which submesh to check
  87041. * @param useInstances specifies that instances should be used
  87042. * @returns a boolean indicating that the submesh is ready or not
  87043. */
  87044. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  87045. /**
  87046. * Checks if the material is ready to render the requested mesh
  87047. * @param mesh Define the mesh to render
  87048. * @param useInstances Define whether or not the material is used with instances
  87049. * @returns true if ready, otherwise false
  87050. */
  87051. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  87052. /**
  87053. * Binds the world matrix to the material
  87054. * @param world defines the world transformation matrix
  87055. */
  87056. bindOnlyWorldMatrix(world: Matrix): void;
  87057. /**
  87058. * Binds the material to the mesh
  87059. * @param world defines the world transformation matrix
  87060. * @param mesh defines the mesh to bind the material to
  87061. */
  87062. bind(world: Matrix, mesh?: Mesh): void;
  87063. /**
  87064. * Gets the active textures from the material
  87065. * @returns an array of textures
  87066. */
  87067. getActiveTextures(): BaseTexture[];
  87068. /**
  87069. * Specifies if the material uses a texture
  87070. * @param texture defines the texture to check against the material
  87071. * @returns a boolean specifying if the material uses the texture
  87072. */
  87073. hasTexture(texture: BaseTexture): boolean;
  87074. /**
  87075. * Makes a duplicate of the material, and gives it a new name
  87076. * @param name defines the new name for the duplicated material
  87077. * @returns the cloned material
  87078. */
  87079. clone(name: string): ShaderMaterial;
  87080. /**
  87081. * Disposes the material
  87082. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  87083. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  87084. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  87085. */
  87086. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  87087. /**
  87088. * Serializes this material in a JSON representation
  87089. * @returns the serialized material object
  87090. */
  87091. serialize(): any;
  87092. /**
  87093. * Creates a shader material from parsed shader material data
  87094. * @param source defines the JSON represnetation of the material
  87095. * @param scene defines the hosting scene
  87096. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  87097. * @returns a new material
  87098. */
  87099. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  87100. }
  87101. }
  87102. declare module BABYLON {
  87103. /** @hidden */
  87104. export var colorPixelShader: {
  87105. name: string;
  87106. shader: string;
  87107. };
  87108. }
  87109. declare module BABYLON {
  87110. /** @hidden */
  87111. export var colorVertexShader: {
  87112. name: string;
  87113. shader: string;
  87114. };
  87115. }
  87116. declare module BABYLON {
  87117. /**
  87118. * Line mesh
  87119. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  87120. */
  87121. export class LinesMesh extends Mesh {
  87122. /**
  87123. * If vertex color should be applied to the mesh
  87124. */
  87125. readonly useVertexColor?: boolean | undefined;
  87126. /**
  87127. * If vertex alpha should be applied to the mesh
  87128. */
  87129. readonly useVertexAlpha?: boolean | undefined;
  87130. /**
  87131. * Color of the line (Default: White)
  87132. */
  87133. color: Color3;
  87134. /**
  87135. * Alpha of the line (Default: 1)
  87136. */
  87137. alpha: number;
  87138. /**
  87139. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  87140. * This margin is expressed in world space coordinates, so its value may vary.
  87141. * Default value is 0.1
  87142. */
  87143. intersectionThreshold: number;
  87144. private _colorShader;
  87145. private color4;
  87146. /**
  87147. * Creates a new LinesMesh
  87148. * @param name defines the name
  87149. * @param scene defines the hosting scene
  87150. * @param parent defines the parent mesh if any
  87151. * @param source defines the optional source LinesMesh used to clone data from
  87152. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  87153. * When false, achieved by calling a clone(), also passing False.
  87154. * This will make creation of children, recursive.
  87155. * @param useVertexColor defines if this LinesMesh supports vertex color
  87156. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  87157. */
  87158. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  87159. /**
  87160. * If vertex color should be applied to the mesh
  87161. */
  87162. useVertexColor?: boolean | undefined,
  87163. /**
  87164. * If vertex alpha should be applied to the mesh
  87165. */
  87166. useVertexAlpha?: boolean | undefined);
  87167. private _addClipPlaneDefine;
  87168. private _removeClipPlaneDefine;
  87169. isReady(): boolean;
  87170. /**
  87171. * Returns the string "LineMesh"
  87172. */
  87173. getClassName(): string;
  87174. /**
  87175. * @hidden
  87176. */
  87177. /**
  87178. * @hidden
  87179. */
  87180. material: Material;
  87181. /**
  87182. * @hidden
  87183. */
  87184. readonly checkCollisions: boolean;
  87185. /** @hidden */
  87186. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  87187. /** @hidden */
  87188. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  87189. /**
  87190. * Disposes of the line mesh
  87191. * @param doNotRecurse If children should be disposed
  87192. */
  87193. dispose(doNotRecurse?: boolean): void;
  87194. /**
  87195. * Returns a new LineMesh object cloned from the current one.
  87196. */
  87197. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  87198. /**
  87199. * Creates a new InstancedLinesMesh object from the mesh model.
  87200. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  87201. * @param name defines the name of the new instance
  87202. * @returns a new InstancedLinesMesh
  87203. */
  87204. createInstance(name: string): InstancedLinesMesh;
  87205. }
  87206. /**
  87207. * Creates an instance based on a source LinesMesh
  87208. */
  87209. export class InstancedLinesMesh extends InstancedMesh {
  87210. /**
  87211. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  87212. * This margin is expressed in world space coordinates, so its value may vary.
  87213. * Initilized with the intersectionThreshold value of the source LinesMesh
  87214. */
  87215. intersectionThreshold: number;
  87216. constructor(name: string, source: LinesMesh);
  87217. /**
  87218. * Returns the string "InstancedLinesMesh".
  87219. */
  87220. getClassName(): string;
  87221. }
  87222. }
  87223. declare module BABYLON {
  87224. /** @hidden */
  87225. export var linePixelShader: {
  87226. name: string;
  87227. shader: string;
  87228. };
  87229. }
  87230. declare module BABYLON {
  87231. /** @hidden */
  87232. export var lineVertexShader: {
  87233. name: string;
  87234. shader: string;
  87235. };
  87236. }
  87237. declare module BABYLON {
  87238. interface AbstractMesh {
  87239. /**
  87240. * Gets the edgesRenderer associated with the mesh
  87241. */
  87242. edgesRenderer: Nullable<EdgesRenderer>;
  87243. }
  87244. interface LinesMesh {
  87245. /**
  87246. * Enables the edge rendering mode on the mesh.
  87247. * This mode makes the mesh edges visible
  87248. * @param epsilon defines the maximal distance between two angles to detect a face
  87249. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  87250. * @returns the currentAbstractMesh
  87251. * @see https://www.babylonjs-playground.com/#19O9TU#0
  87252. */
  87253. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  87254. }
  87255. interface InstancedLinesMesh {
  87256. /**
  87257. * Enables the edge rendering mode on the mesh.
  87258. * This mode makes the mesh edges visible
  87259. * @param epsilon defines the maximal distance between two angles to detect a face
  87260. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  87261. * @returns the current InstancedLinesMesh
  87262. * @see https://www.babylonjs-playground.com/#19O9TU#0
  87263. */
  87264. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  87265. }
  87266. /**
  87267. * Defines the minimum contract an Edges renderer should follow.
  87268. */
  87269. export interface IEdgesRenderer extends IDisposable {
  87270. /**
  87271. * Gets or sets a boolean indicating if the edgesRenderer is active
  87272. */
  87273. isEnabled: boolean;
  87274. /**
  87275. * Renders the edges of the attached mesh,
  87276. */
  87277. render(): void;
  87278. /**
  87279. * Checks wether or not the edges renderer is ready to render.
  87280. * @return true if ready, otherwise false.
  87281. */
  87282. isReady(): boolean;
  87283. }
  87284. /**
  87285. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  87286. */
  87287. export class EdgesRenderer implements IEdgesRenderer {
  87288. /**
  87289. * Define the size of the edges with an orthographic camera
  87290. */
  87291. edgesWidthScalerForOrthographic: number;
  87292. /**
  87293. * Define the size of the edges with a perspective camera
  87294. */
  87295. edgesWidthScalerForPerspective: number;
  87296. protected _source: AbstractMesh;
  87297. protected _linesPositions: number[];
  87298. protected _linesNormals: number[];
  87299. protected _linesIndices: number[];
  87300. protected _epsilon: number;
  87301. protected _indicesCount: number;
  87302. protected _lineShader: ShaderMaterial;
  87303. protected _ib: DataBuffer;
  87304. protected _buffers: {
  87305. [key: string]: Nullable<VertexBuffer>;
  87306. };
  87307. protected _checkVerticesInsteadOfIndices: boolean;
  87308. private _meshRebuildObserver;
  87309. private _meshDisposeObserver;
  87310. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  87311. isEnabled: boolean;
  87312. /**
  87313. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  87314. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  87315. * @param source Mesh used to create edges
  87316. * @param epsilon sum of angles in adjacency to check for edge
  87317. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  87318. * @param generateEdgesLines - should generate Lines or only prepare resources.
  87319. */
  87320. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  87321. protected _prepareRessources(): void;
  87322. /** @hidden */
  87323. _rebuild(): void;
  87324. /**
  87325. * Releases the required resources for the edges renderer
  87326. */
  87327. dispose(): void;
  87328. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  87329. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  87330. /**
  87331. * Checks if the pair of p0 and p1 is en edge
  87332. * @param faceIndex
  87333. * @param edge
  87334. * @param faceNormals
  87335. * @param p0
  87336. * @param p1
  87337. * @private
  87338. */
  87339. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  87340. /**
  87341. * push line into the position, normal and index buffer
  87342. * @protected
  87343. */
  87344. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  87345. /**
  87346. * Generates lines edges from adjacencjes
  87347. * @private
  87348. */
  87349. _generateEdgesLines(): void;
  87350. /**
  87351. * Checks wether or not the edges renderer is ready to render.
  87352. * @return true if ready, otherwise false.
  87353. */
  87354. isReady(): boolean;
  87355. /**
  87356. * Renders the edges of the attached mesh,
  87357. */
  87358. render(): void;
  87359. }
  87360. /**
  87361. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  87362. */
  87363. export class LineEdgesRenderer extends EdgesRenderer {
  87364. /**
  87365. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  87366. * @param source LineMesh used to generate edges
  87367. * @param epsilon not important (specified angle for edge detection)
  87368. * @param checkVerticesInsteadOfIndices not important for LineMesh
  87369. */
  87370. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  87371. /**
  87372. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  87373. */
  87374. _generateEdgesLines(): void;
  87375. }
  87376. }
  87377. declare module BABYLON {
  87378. /**
  87379. * This represents the object necessary to create a rendering group.
  87380. * This is exclusively used and created by the rendering manager.
  87381. * To modify the behavior, you use the available helpers in your scene or meshes.
  87382. * @hidden
  87383. */
  87384. export class RenderingGroup {
  87385. index: number;
  87386. private static _zeroVector;
  87387. private _scene;
  87388. private _opaqueSubMeshes;
  87389. private _transparentSubMeshes;
  87390. private _alphaTestSubMeshes;
  87391. private _depthOnlySubMeshes;
  87392. private _particleSystems;
  87393. private _spriteManagers;
  87394. private _opaqueSortCompareFn;
  87395. private _alphaTestSortCompareFn;
  87396. private _transparentSortCompareFn;
  87397. private _renderOpaque;
  87398. private _renderAlphaTest;
  87399. private _renderTransparent;
  87400. /** @hidden */
  87401. _edgesRenderers: SmartArray<IEdgesRenderer>;
  87402. onBeforeTransparentRendering: () => void;
  87403. /**
  87404. * Set the opaque sort comparison function.
  87405. * If null the sub meshes will be render in the order they were created
  87406. */
  87407. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  87408. /**
  87409. * Set the alpha test sort comparison function.
  87410. * If null the sub meshes will be render in the order they were created
  87411. */
  87412. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  87413. /**
  87414. * Set the transparent sort comparison function.
  87415. * If null the sub meshes will be render in the order they were created
  87416. */
  87417. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  87418. /**
  87419. * Creates a new rendering group.
  87420. * @param index The rendering group index
  87421. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  87422. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  87423. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  87424. */
  87425. 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>);
  87426. /**
  87427. * Render all the sub meshes contained in the group.
  87428. * @param customRenderFunction Used to override the default render behaviour of the group.
  87429. * @returns true if rendered some submeshes.
  87430. */
  87431. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  87432. /**
  87433. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  87434. * @param subMeshes The submeshes to render
  87435. */
  87436. private renderOpaqueSorted;
  87437. /**
  87438. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  87439. * @param subMeshes The submeshes to render
  87440. */
  87441. private renderAlphaTestSorted;
  87442. /**
  87443. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  87444. * @param subMeshes The submeshes to render
  87445. */
  87446. private renderTransparentSorted;
  87447. /**
  87448. * Renders the submeshes in a specified order.
  87449. * @param subMeshes The submeshes to sort before render
  87450. * @param sortCompareFn The comparison function use to sort
  87451. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  87452. * @param transparent Specifies to activate blending if true
  87453. */
  87454. private static renderSorted;
  87455. /**
  87456. * Renders the submeshes in the order they were dispatched (no sort applied).
  87457. * @param subMeshes The submeshes to render
  87458. */
  87459. private static renderUnsorted;
  87460. /**
  87461. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  87462. * are rendered back to front if in the same alpha index.
  87463. *
  87464. * @param a The first submesh
  87465. * @param b The second submesh
  87466. * @returns The result of the comparison
  87467. */
  87468. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  87469. /**
  87470. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  87471. * are rendered back to front.
  87472. *
  87473. * @param a The first submesh
  87474. * @param b The second submesh
  87475. * @returns The result of the comparison
  87476. */
  87477. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  87478. /**
  87479. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  87480. * are rendered front to back (prevent overdraw).
  87481. *
  87482. * @param a The first submesh
  87483. * @param b The second submesh
  87484. * @returns The result of the comparison
  87485. */
  87486. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  87487. /**
  87488. * Resets the different lists of submeshes to prepare a new frame.
  87489. */
  87490. prepare(): void;
  87491. dispose(): void;
  87492. /**
  87493. * Inserts the submesh in its correct queue depending on its material.
  87494. * @param subMesh The submesh to dispatch
  87495. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  87496. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  87497. */
  87498. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  87499. dispatchSprites(spriteManager: ISpriteManager): void;
  87500. dispatchParticles(particleSystem: IParticleSystem): void;
  87501. private _renderParticles;
  87502. private _renderSprites;
  87503. }
  87504. }
  87505. declare module BABYLON {
  87506. /**
  87507. * Interface describing the different options available in the rendering manager
  87508. * regarding Auto Clear between groups.
  87509. */
  87510. export interface IRenderingManagerAutoClearSetup {
  87511. /**
  87512. * Defines whether or not autoclear is enable.
  87513. */
  87514. autoClear: boolean;
  87515. /**
  87516. * Defines whether or not to autoclear the depth buffer.
  87517. */
  87518. depth: boolean;
  87519. /**
  87520. * Defines whether or not to autoclear the stencil buffer.
  87521. */
  87522. stencil: boolean;
  87523. }
  87524. /**
  87525. * This class is used by the onRenderingGroupObservable
  87526. */
  87527. export class RenderingGroupInfo {
  87528. /**
  87529. * The Scene that being rendered
  87530. */
  87531. scene: Scene;
  87532. /**
  87533. * The camera currently used for the rendering pass
  87534. */
  87535. camera: Nullable<Camera>;
  87536. /**
  87537. * The ID of the renderingGroup being processed
  87538. */
  87539. renderingGroupId: number;
  87540. }
  87541. /**
  87542. * This is the manager responsible of all the rendering for meshes sprites and particles.
  87543. * It is enable to manage the different groups as well as the different necessary sort functions.
  87544. * This should not be used directly aside of the few static configurations
  87545. */
  87546. export class RenderingManager {
  87547. /**
  87548. * The max id used for rendering groups (not included)
  87549. */
  87550. static MAX_RENDERINGGROUPS: number;
  87551. /**
  87552. * The min id used for rendering groups (included)
  87553. */
  87554. static MIN_RENDERINGGROUPS: number;
  87555. /**
  87556. * Used to globally prevent autoclearing scenes.
  87557. */
  87558. static AUTOCLEAR: boolean;
  87559. /**
  87560. * @hidden
  87561. */
  87562. _useSceneAutoClearSetup: boolean;
  87563. private _scene;
  87564. private _renderingGroups;
  87565. private _depthStencilBufferAlreadyCleaned;
  87566. private _autoClearDepthStencil;
  87567. private _customOpaqueSortCompareFn;
  87568. private _customAlphaTestSortCompareFn;
  87569. private _customTransparentSortCompareFn;
  87570. private _renderingGroupInfo;
  87571. /**
  87572. * Instantiates a new rendering group for a particular scene
  87573. * @param scene Defines the scene the groups belongs to
  87574. */
  87575. constructor(scene: Scene);
  87576. private _clearDepthStencilBuffer;
  87577. /**
  87578. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  87579. * @hidden
  87580. */
  87581. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  87582. /**
  87583. * Resets the different information of the group to prepare a new frame
  87584. * @hidden
  87585. */
  87586. reset(): void;
  87587. /**
  87588. * Dispose and release the group and its associated resources.
  87589. * @hidden
  87590. */
  87591. dispose(): void;
  87592. /**
  87593. * Clear the info related to rendering groups preventing retention points during dispose.
  87594. */
  87595. freeRenderingGroups(): void;
  87596. private _prepareRenderingGroup;
  87597. /**
  87598. * Add a sprite manager to the rendering manager in order to render it this frame.
  87599. * @param spriteManager Define the sprite manager to render
  87600. */
  87601. dispatchSprites(spriteManager: ISpriteManager): void;
  87602. /**
  87603. * Add a particle system to the rendering manager in order to render it this frame.
  87604. * @param particleSystem Define the particle system to render
  87605. */
  87606. dispatchParticles(particleSystem: IParticleSystem): void;
  87607. /**
  87608. * Add a submesh to the manager in order to render it this frame
  87609. * @param subMesh The submesh to dispatch
  87610. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  87611. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  87612. */
  87613. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  87614. /**
  87615. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  87616. * This allowed control for front to back rendering or reversly depending of the special needs.
  87617. *
  87618. * @param renderingGroupId The rendering group id corresponding to its index
  87619. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  87620. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  87621. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  87622. */
  87623. 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;
  87624. /**
  87625. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  87626. *
  87627. * @param renderingGroupId The rendering group id corresponding to its index
  87628. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  87629. * @param depth Automatically clears depth between groups if true and autoClear is true.
  87630. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  87631. */
  87632. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  87633. /**
  87634. * Gets the current auto clear configuration for one rendering group of the rendering
  87635. * manager.
  87636. * @param index the rendering group index to get the information for
  87637. * @returns The auto clear setup for the requested rendering group
  87638. */
  87639. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  87640. }
  87641. }
  87642. declare module BABYLON {
  87643. /**
  87644. * This Helps creating a texture that will be created from a camera in your scene.
  87645. * It is basically a dynamic texture that could be used to create special effects for instance.
  87646. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  87647. */
  87648. export class RenderTargetTexture extends Texture {
  87649. isCube: boolean;
  87650. /**
  87651. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  87652. */
  87653. static readonly REFRESHRATE_RENDER_ONCE: number;
  87654. /**
  87655. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  87656. */
  87657. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  87658. /**
  87659. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  87660. * the central point of your effect and can save a lot of performances.
  87661. */
  87662. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  87663. /**
  87664. * Use this predicate to dynamically define the list of mesh you want to render.
  87665. * If set, the renderList property will be overwritten.
  87666. */
  87667. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  87668. private _renderList;
  87669. /**
  87670. * Use this list to define the list of mesh you want to render.
  87671. */
  87672. renderList: Nullable<Array<AbstractMesh>>;
  87673. private _hookArray;
  87674. /**
  87675. * Define if particles should be rendered in your texture.
  87676. */
  87677. renderParticles: boolean;
  87678. /**
  87679. * Define if sprites should be rendered in your texture.
  87680. */
  87681. renderSprites: boolean;
  87682. /**
  87683. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  87684. */
  87685. coordinatesMode: number;
  87686. /**
  87687. * Define the camera used to render the texture.
  87688. */
  87689. activeCamera: Nullable<Camera>;
  87690. /**
  87691. * Override the render function of the texture with your own one.
  87692. */
  87693. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  87694. /**
  87695. * Define if camera post processes should be use while rendering the texture.
  87696. */
  87697. useCameraPostProcesses: boolean;
  87698. /**
  87699. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  87700. */
  87701. ignoreCameraViewport: boolean;
  87702. private _postProcessManager;
  87703. private _postProcesses;
  87704. private _resizeObserver;
  87705. /**
  87706. * An event triggered when the texture is unbind.
  87707. */
  87708. onBeforeBindObservable: Observable<RenderTargetTexture>;
  87709. /**
  87710. * An event triggered when the texture is unbind.
  87711. */
  87712. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  87713. private _onAfterUnbindObserver;
  87714. /**
  87715. * Set a after unbind callback in the texture.
  87716. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  87717. */
  87718. onAfterUnbind: () => void;
  87719. /**
  87720. * An event triggered before rendering the texture
  87721. */
  87722. onBeforeRenderObservable: Observable<number>;
  87723. private _onBeforeRenderObserver;
  87724. /**
  87725. * Set a before render callback in the texture.
  87726. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  87727. */
  87728. onBeforeRender: (faceIndex: number) => void;
  87729. /**
  87730. * An event triggered after rendering the texture
  87731. */
  87732. onAfterRenderObservable: Observable<number>;
  87733. private _onAfterRenderObserver;
  87734. /**
  87735. * Set a after render callback in the texture.
  87736. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  87737. */
  87738. onAfterRender: (faceIndex: number) => void;
  87739. /**
  87740. * An event triggered after the texture clear
  87741. */
  87742. onClearObservable: Observable<Engine>;
  87743. private _onClearObserver;
  87744. /**
  87745. * Set a clear callback in the texture.
  87746. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  87747. */
  87748. onClear: (Engine: Engine) => void;
  87749. /**
  87750. * An event triggered when the texture is resized.
  87751. */
  87752. onResizeObservable: Observable<RenderTargetTexture>;
  87753. /**
  87754. * Define the clear color of the Render Target if it should be different from the scene.
  87755. */
  87756. clearColor: Color4;
  87757. protected _size: number | {
  87758. width: number;
  87759. height: number;
  87760. };
  87761. protected _initialSizeParameter: number | {
  87762. width: number;
  87763. height: number;
  87764. } | {
  87765. ratio: number;
  87766. };
  87767. protected _sizeRatio: Nullable<number>;
  87768. /** @hidden */
  87769. _generateMipMaps: boolean;
  87770. protected _renderingManager: RenderingManager;
  87771. /** @hidden */
  87772. _waitingRenderList: string[];
  87773. protected _doNotChangeAspectRatio: boolean;
  87774. protected _currentRefreshId: number;
  87775. protected _refreshRate: number;
  87776. protected _textureMatrix: Matrix;
  87777. protected _samples: number;
  87778. protected _renderTargetOptions: RenderTargetCreationOptions;
  87779. /**
  87780. * Gets render target creation options that were used.
  87781. */
  87782. readonly renderTargetOptions: RenderTargetCreationOptions;
  87783. protected _engine: Engine;
  87784. protected _onRatioRescale(): void;
  87785. /**
  87786. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  87787. * It must define where the camera used to render the texture is set
  87788. */
  87789. boundingBoxPosition: Vector3;
  87790. private _boundingBoxSize;
  87791. /**
  87792. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  87793. * When defined, the cubemap will switch to local mode
  87794. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87795. * @example https://www.babylonjs-playground.com/#RNASML
  87796. */
  87797. boundingBoxSize: Vector3;
  87798. /**
  87799. * In case the RTT has been created with a depth texture, get the associated
  87800. * depth texture.
  87801. * Otherwise, return null.
  87802. */
  87803. depthStencilTexture: Nullable<InternalTexture>;
  87804. /**
  87805. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  87806. * or used a shadow, depth texture...
  87807. * @param name The friendly name of the texture
  87808. * @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)
  87809. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  87810. * @param generateMipMaps True if mip maps need to be generated after render.
  87811. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  87812. * @param type The type of the buffer in the RTT (int, half float, float...)
  87813. * @param isCube True if a cube texture needs to be created
  87814. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  87815. * @param generateDepthBuffer True to generate a depth buffer
  87816. * @param generateStencilBuffer True to generate a stencil buffer
  87817. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  87818. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  87819. * @param delayAllocation if the texture allocation should be delayed (default: false)
  87820. */
  87821. constructor(name: string, size: number | {
  87822. width: number;
  87823. height: number;
  87824. } | {
  87825. ratio: number;
  87826. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  87827. /**
  87828. * Creates a depth stencil texture.
  87829. * This is only available in WebGL 2 or with the depth texture extension available.
  87830. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  87831. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  87832. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  87833. */
  87834. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  87835. private _processSizeParameter;
  87836. /**
  87837. * Define the number of samples to use in case of MSAA.
  87838. * It defaults to one meaning no MSAA has been enabled.
  87839. */
  87840. samples: number;
  87841. /**
  87842. * Resets the refresh counter of the texture and start bak from scratch.
  87843. * Could be useful to regenerate the texture if it is setup to render only once.
  87844. */
  87845. resetRefreshCounter(): void;
  87846. /**
  87847. * Define the refresh rate of the texture or the rendering frequency.
  87848. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  87849. */
  87850. refreshRate: number;
  87851. /**
  87852. * Adds a post process to the render target rendering passes.
  87853. * @param postProcess define the post process to add
  87854. */
  87855. addPostProcess(postProcess: PostProcess): void;
  87856. /**
  87857. * Clear all the post processes attached to the render target
  87858. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  87859. */
  87860. clearPostProcesses(dispose?: boolean): void;
  87861. /**
  87862. * Remove one of the post process from the list of attached post processes to the texture
  87863. * @param postProcess define the post process to remove from the list
  87864. */
  87865. removePostProcess(postProcess: PostProcess): void;
  87866. /** @hidden */
  87867. _shouldRender(): boolean;
  87868. /**
  87869. * Gets the actual render size of the texture.
  87870. * @returns the width of the render size
  87871. */
  87872. getRenderSize(): number;
  87873. /**
  87874. * Gets the actual render width of the texture.
  87875. * @returns the width of the render size
  87876. */
  87877. getRenderWidth(): number;
  87878. /**
  87879. * Gets the actual render height of the texture.
  87880. * @returns the height of the render size
  87881. */
  87882. getRenderHeight(): number;
  87883. /**
  87884. * Get if the texture can be rescaled or not.
  87885. */
  87886. readonly canRescale: boolean;
  87887. /**
  87888. * Resize the texture using a ratio.
  87889. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  87890. */
  87891. scale(ratio: number): void;
  87892. /**
  87893. * Get the texture reflection matrix used to rotate/transform the reflection.
  87894. * @returns the reflection matrix
  87895. */
  87896. getReflectionTextureMatrix(): Matrix;
  87897. /**
  87898. * Resize the texture to a new desired size.
  87899. * Be carrefull as it will recreate all the data in the new texture.
  87900. * @param size Define the new size. It can be:
  87901. * - a number for squared texture,
  87902. * - an object containing { width: number, height: number }
  87903. * - or an object containing a ratio { ratio: number }
  87904. */
  87905. resize(size: number | {
  87906. width: number;
  87907. height: number;
  87908. } | {
  87909. ratio: number;
  87910. }): void;
  87911. /**
  87912. * Renders all the objects from the render list into the texture.
  87913. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  87914. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  87915. */
  87916. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  87917. private _bestReflectionRenderTargetDimension;
  87918. /**
  87919. * @hidden
  87920. * @param faceIndex face index to bind to if this is a cubetexture
  87921. */
  87922. _bindFrameBuffer(faceIndex?: number): void;
  87923. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  87924. private renderToTarget;
  87925. /**
  87926. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  87927. * This allowed control for front to back rendering or reversly depending of the special needs.
  87928. *
  87929. * @param renderingGroupId The rendering group id corresponding to its index
  87930. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  87931. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  87932. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  87933. */
  87934. 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;
  87935. /**
  87936. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  87937. *
  87938. * @param renderingGroupId The rendering group id corresponding to its index
  87939. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  87940. */
  87941. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  87942. /**
  87943. * Clones the texture.
  87944. * @returns the cloned texture
  87945. */
  87946. clone(): RenderTargetTexture;
  87947. /**
  87948. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  87949. * @returns The JSON representation of the texture
  87950. */
  87951. serialize(): any;
  87952. /**
  87953. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  87954. */
  87955. disposeFramebufferObjects(): void;
  87956. /**
  87957. * Dispose the texture and release its associated resources.
  87958. */
  87959. dispose(): void;
  87960. /** @hidden */
  87961. _rebuild(): void;
  87962. /**
  87963. * Clear the info related to rendering groups preventing retention point in material dispose.
  87964. */
  87965. freeRenderingGroups(): void;
  87966. /**
  87967. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  87968. * @returns the view count
  87969. */
  87970. getViewCount(): number;
  87971. }
  87972. }
  87973. declare module BABYLON {
  87974. /**
  87975. * Options for compiling materials.
  87976. */
  87977. export interface IMaterialCompilationOptions {
  87978. /**
  87979. * Defines whether clip planes are enabled.
  87980. */
  87981. clipPlane: boolean;
  87982. /**
  87983. * Defines whether instances are enabled.
  87984. */
  87985. useInstances: boolean;
  87986. }
  87987. /**
  87988. * Base class for the main features of a material in Babylon.js
  87989. */
  87990. export class Material implements IAnimatable {
  87991. /**
  87992. * Returns the triangle fill mode
  87993. */
  87994. static readonly TriangleFillMode: number;
  87995. /**
  87996. * Returns the wireframe mode
  87997. */
  87998. static readonly WireFrameFillMode: number;
  87999. /**
  88000. * Returns the point fill mode
  88001. */
  88002. static readonly PointFillMode: number;
  88003. /**
  88004. * Returns the point list draw mode
  88005. */
  88006. static readonly PointListDrawMode: number;
  88007. /**
  88008. * Returns the line list draw mode
  88009. */
  88010. static readonly LineListDrawMode: number;
  88011. /**
  88012. * Returns the line loop draw mode
  88013. */
  88014. static readonly LineLoopDrawMode: number;
  88015. /**
  88016. * Returns the line strip draw mode
  88017. */
  88018. static readonly LineStripDrawMode: number;
  88019. /**
  88020. * Returns the triangle strip draw mode
  88021. */
  88022. static readonly TriangleStripDrawMode: number;
  88023. /**
  88024. * Returns the triangle fan draw mode
  88025. */
  88026. static readonly TriangleFanDrawMode: number;
  88027. /**
  88028. * Stores the clock-wise side orientation
  88029. */
  88030. static readonly ClockWiseSideOrientation: number;
  88031. /**
  88032. * Stores the counter clock-wise side orientation
  88033. */
  88034. static readonly CounterClockWiseSideOrientation: number;
  88035. /**
  88036. * The dirty texture flag value
  88037. */
  88038. static readonly TextureDirtyFlag: number;
  88039. /**
  88040. * The dirty light flag value
  88041. */
  88042. static readonly LightDirtyFlag: number;
  88043. /**
  88044. * The dirty fresnel flag value
  88045. */
  88046. static readonly FresnelDirtyFlag: number;
  88047. /**
  88048. * The dirty attribute flag value
  88049. */
  88050. static readonly AttributesDirtyFlag: number;
  88051. /**
  88052. * The dirty misc flag value
  88053. */
  88054. static readonly MiscDirtyFlag: number;
  88055. /**
  88056. * The all dirty flag value
  88057. */
  88058. static readonly AllDirtyFlag: number;
  88059. /**
  88060. * The ID of the material
  88061. */
  88062. id: string;
  88063. /**
  88064. * Gets or sets the unique id of the material
  88065. */
  88066. uniqueId: number;
  88067. /**
  88068. * The name of the material
  88069. */
  88070. name: string;
  88071. /**
  88072. * Gets or sets user defined metadata
  88073. */
  88074. metadata: any;
  88075. /**
  88076. * For internal use only. Please do not use.
  88077. */
  88078. reservedDataStore: any;
  88079. /**
  88080. * Specifies if the ready state should be checked on each call
  88081. */
  88082. checkReadyOnEveryCall: boolean;
  88083. /**
  88084. * Specifies if the ready state should be checked once
  88085. */
  88086. checkReadyOnlyOnce: boolean;
  88087. /**
  88088. * The state of the material
  88089. */
  88090. state: string;
  88091. /**
  88092. * The alpha value of the material
  88093. */
  88094. protected _alpha: number;
  88095. /**
  88096. * List of inspectable custom properties (used by the Inspector)
  88097. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  88098. */
  88099. inspectableCustomProperties: IInspectable[];
  88100. /**
  88101. * Sets the alpha value of the material
  88102. */
  88103. /**
  88104. * Gets the alpha value of the material
  88105. */
  88106. alpha: number;
  88107. /**
  88108. * Specifies if back face culling is enabled
  88109. */
  88110. protected _backFaceCulling: boolean;
  88111. /**
  88112. * Sets the back-face culling state
  88113. */
  88114. /**
  88115. * Gets the back-face culling state
  88116. */
  88117. backFaceCulling: boolean;
  88118. /**
  88119. * Stores the value for side orientation
  88120. */
  88121. sideOrientation: number;
  88122. /**
  88123. * Callback triggered when the material is compiled
  88124. */
  88125. onCompiled: Nullable<(effect: Effect) => void>;
  88126. /**
  88127. * Callback triggered when an error occurs
  88128. */
  88129. onError: Nullable<(effect: Effect, errors: string) => void>;
  88130. /**
  88131. * Callback triggered to get the render target textures
  88132. */
  88133. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  88134. /**
  88135. * Gets a boolean indicating that current material needs to register RTT
  88136. */
  88137. readonly hasRenderTargetTextures: boolean;
  88138. /**
  88139. * Specifies if the material should be serialized
  88140. */
  88141. doNotSerialize: boolean;
  88142. /**
  88143. * @hidden
  88144. */
  88145. _storeEffectOnSubMeshes: boolean;
  88146. /**
  88147. * Stores the animations for the material
  88148. */
  88149. animations: Nullable<Array<Animation>>;
  88150. /**
  88151. * An event triggered when the material is disposed
  88152. */
  88153. onDisposeObservable: Observable<Material>;
  88154. /**
  88155. * An observer which watches for dispose events
  88156. */
  88157. private _onDisposeObserver;
  88158. private _onUnBindObservable;
  88159. /**
  88160. * Called during a dispose event
  88161. */
  88162. onDispose: () => void;
  88163. private _onBindObservable;
  88164. /**
  88165. * An event triggered when the material is bound
  88166. */
  88167. readonly onBindObservable: Observable<AbstractMesh>;
  88168. /**
  88169. * An observer which watches for bind events
  88170. */
  88171. private _onBindObserver;
  88172. /**
  88173. * Called during a bind event
  88174. */
  88175. onBind: (Mesh: AbstractMesh) => void;
  88176. /**
  88177. * An event triggered when the material is unbound
  88178. */
  88179. readonly onUnBindObservable: Observable<Material>;
  88180. /**
  88181. * Stores the value of the alpha mode
  88182. */
  88183. private _alphaMode;
  88184. /**
  88185. * Sets the value of the alpha mode.
  88186. *
  88187. * | Value | Type | Description |
  88188. * | --- | --- | --- |
  88189. * | 0 | ALPHA_DISABLE | |
  88190. * | 1 | ALPHA_ADD | |
  88191. * | 2 | ALPHA_COMBINE | |
  88192. * | 3 | ALPHA_SUBTRACT | |
  88193. * | 4 | ALPHA_MULTIPLY | |
  88194. * | 5 | ALPHA_MAXIMIZED | |
  88195. * | 6 | ALPHA_ONEONE | |
  88196. * | 7 | ALPHA_PREMULTIPLIED | |
  88197. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  88198. * | 9 | ALPHA_INTERPOLATE | |
  88199. * | 10 | ALPHA_SCREENMODE | |
  88200. *
  88201. */
  88202. /**
  88203. * Gets the value of the alpha mode
  88204. */
  88205. alphaMode: number;
  88206. /**
  88207. * Stores the state of the need depth pre-pass value
  88208. */
  88209. private _needDepthPrePass;
  88210. /**
  88211. * Sets the need depth pre-pass value
  88212. */
  88213. /**
  88214. * Gets the depth pre-pass value
  88215. */
  88216. needDepthPrePass: boolean;
  88217. /**
  88218. * Specifies if depth writing should be disabled
  88219. */
  88220. disableDepthWrite: boolean;
  88221. /**
  88222. * Specifies if depth writing should be forced
  88223. */
  88224. forceDepthWrite: boolean;
  88225. /**
  88226. * Specifies if there should be a separate pass for culling
  88227. */
  88228. separateCullingPass: boolean;
  88229. /**
  88230. * Stores the state specifing if fog should be enabled
  88231. */
  88232. private _fogEnabled;
  88233. /**
  88234. * Sets the state for enabling fog
  88235. */
  88236. /**
  88237. * Gets the value of the fog enabled state
  88238. */
  88239. fogEnabled: boolean;
  88240. /**
  88241. * Stores the size of points
  88242. */
  88243. pointSize: number;
  88244. /**
  88245. * Stores the z offset value
  88246. */
  88247. zOffset: number;
  88248. /**
  88249. * Gets a value specifying if wireframe mode is enabled
  88250. */
  88251. /**
  88252. * Sets the state of wireframe mode
  88253. */
  88254. wireframe: boolean;
  88255. /**
  88256. * Gets the value specifying if point clouds are enabled
  88257. */
  88258. /**
  88259. * Sets the state of point cloud mode
  88260. */
  88261. pointsCloud: boolean;
  88262. /**
  88263. * Gets the material fill mode
  88264. */
  88265. /**
  88266. * Sets the material fill mode
  88267. */
  88268. fillMode: number;
  88269. /**
  88270. * @hidden
  88271. * Stores the effects for the material
  88272. */
  88273. _effect: Nullable<Effect>;
  88274. /**
  88275. * @hidden
  88276. * Specifies if the material was previously ready
  88277. */
  88278. _wasPreviouslyReady: boolean;
  88279. /**
  88280. * Specifies if uniform buffers should be used
  88281. */
  88282. private _useUBO;
  88283. /**
  88284. * Stores a reference to the scene
  88285. */
  88286. private _scene;
  88287. /**
  88288. * Stores the fill mode state
  88289. */
  88290. private _fillMode;
  88291. /**
  88292. * Specifies if the depth write state should be cached
  88293. */
  88294. private _cachedDepthWriteState;
  88295. /**
  88296. * Stores the uniform buffer
  88297. */
  88298. protected _uniformBuffer: UniformBuffer;
  88299. /** @hidden */
  88300. _indexInSceneMaterialArray: number;
  88301. /** @hidden */
  88302. meshMap: Nullable<{
  88303. [id: string]: AbstractMesh | undefined;
  88304. }>;
  88305. /**
  88306. * Creates a material instance
  88307. * @param name defines the name of the material
  88308. * @param scene defines the scene to reference
  88309. * @param doNotAdd specifies if the material should be added to the scene
  88310. */
  88311. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  88312. /**
  88313. * Returns a string representation of the current material
  88314. * @param fullDetails defines a boolean indicating which levels of logging is desired
  88315. * @returns a string with material information
  88316. */
  88317. toString(fullDetails?: boolean): string;
  88318. /**
  88319. * Gets the class name of the material
  88320. * @returns a string with the class name of the material
  88321. */
  88322. getClassName(): string;
  88323. /**
  88324. * Specifies if updates for the material been locked
  88325. */
  88326. readonly isFrozen: boolean;
  88327. /**
  88328. * Locks updates for the material
  88329. */
  88330. freeze(): void;
  88331. /**
  88332. * Unlocks updates for the material
  88333. */
  88334. unfreeze(): void;
  88335. /**
  88336. * Specifies if the material is ready to be used
  88337. * @param mesh defines the mesh to check
  88338. * @param useInstances specifies if instances should be used
  88339. * @returns a boolean indicating if the material is ready to be used
  88340. */
  88341. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  88342. /**
  88343. * Specifies that the submesh is ready to be used
  88344. * @param mesh defines the mesh to check
  88345. * @param subMesh defines which submesh to check
  88346. * @param useInstances specifies that instances should be used
  88347. * @returns a boolean indicating that the submesh is ready or not
  88348. */
  88349. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  88350. /**
  88351. * Returns the material effect
  88352. * @returns the effect associated with the material
  88353. */
  88354. getEffect(): Nullable<Effect>;
  88355. /**
  88356. * Returns the current scene
  88357. * @returns a Scene
  88358. */
  88359. getScene(): Scene;
  88360. /**
  88361. * Specifies if the material will require alpha blending
  88362. * @returns a boolean specifying if alpha blending is needed
  88363. */
  88364. needAlphaBlending(): boolean;
  88365. /**
  88366. * Specifies if the mesh will require alpha blending
  88367. * @param mesh defines the mesh to check
  88368. * @returns a boolean specifying if alpha blending is needed for the mesh
  88369. */
  88370. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  88371. /**
  88372. * Specifies if this material should be rendered in alpha test mode
  88373. * @returns a boolean specifying if an alpha test is needed.
  88374. */
  88375. needAlphaTesting(): boolean;
  88376. /**
  88377. * Gets the texture used for the alpha test
  88378. * @returns the texture to use for alpha testing
  88379. */
  88380. getAlphaTestTexture(): Nullable<BaseTexture>;
  88381. /**
  88382. * Marks the material to indicate that it needs to be re-calculated
  88383. */
  88384. markDirty(): void;
  88385. /** @hidden */
  88386. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  88387. /**
  88388. * Binds the material to the mesh
  88389. * @param world defines the world transformation matrix
  88390. * @param mesh defines the mesh to bind the material to
  88391. */
  88392. bind(world: Matrix, mesh?: Mesh): void;
  88393. /**
  88394. * Binds the submesh to the material
  88395. * @param world defines the world transformation matrix
  88396. * @param mesh defines the mesh containing the submesh
  88397. * @param subMesh defines the submesh to bind the material to
  88398. */
  88399. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  88400. /**
  88401. * Binds the world matrix to the material
  88402. * @param world defines the world transformation matrix
  88403. */
  88404. bindOnlyWorldMatrix(world: Matrix): void;
  88405. /**
  88406. * Binds the scene's uniform buffer to the effect.
  88407. * @param effect defines the effect to bind to the scene uniform buffer
  88408. * @param sceneUbo defines the uniform buffer storing scene data
  88409. */
  88410. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  88411. /**
  88412. * Binds the view matrix to the effect
  88413. * @param effect defines the effect to bind the view matrix to
  88414. */
  88415. bindView(effect: Effect): void;
  88416. /**
  88417. * Binds the view projection matrix to the effect
  88418. * @param effect defines the effect to bind the view projection matrix to
  88419. */
  88420. bindViewProjection(effect: Effect): void;
  88421. /**
  88422. * Specifies if material alpha testing should be turned on for the mesh
  88423. * @param mesh defines the mesh to check
  88424. */
  88425. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  88426. /**
  88427. * Processes to execute after binding the material to a mesh
  88428. * @param mesh defines the rendered mesh
  88429. */
  88430. protected _afterBind(mesh?: Mesh): void;
  88431. /**
  88432. * Unbinds the material from the mesh
  88433. */
  88434. unbind(): void;
  88435. /**
  88436. * Gets the active textures from the material
  88437. * @returns an array of textures
  88438. */
  88439. getActiveTextures(): BaseTexture[];
  88440. /**
  88441. * Specifies if the material uses a texture
  88442. * @param texture defines the texture to check against the material
  88443. * @returns a boolean specifying if the material uses the texture
  88444. */
  88445. hasTexture(texture: BaseTexture): boolean;
  88446. /**
  88447. * Makes a duplicate of the material, and gives it a new name
  88448. * @param name defines the new name for the duplicated material
  88449. * @returns the cloned material
  88450. */
  88451. clone(name: string): Nullable<Material>;
  88452. /**
  88453. * Gets the meshes bound to the material
  88454. * @returns an array of meshes bound to the material
  88455. */
  88456. getBindedMeshes(): AbstractMesh[];
  88457. /**
  88458. * Force shader compilation
  88459. * @param mesh defines the mesh associated with this material
  88460. * @param onCompiled defines a function to execute once the material is compiled
  88461. * @param options defines the options to configure the compilation
  88462. * @param onError defines a function to execute if the material fails compiling
  88463. */
  88464. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  88465. /**
  88466. * Force shader compilation
  88467. * @param mesh defines the mesh that will use this material
  88468. * @param options defines additional options for compiling the shaders
  88469. * @returns a promise that resolves when the compilation completes
  88470. */
  88471. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  88472. private static readonly _AllDirtyCallBack;
  88473. private static readonly _ImageProcessingDirtyCallBack;
  88474. private static readonly _TextureDirtyCallBack;
  88475. private static readonly _FresnelDirtyCallBack;
  88476. private static readonly _MiscDirtyCallBack;
  88477. private static readonly _LightsDirtyCallBack;
  88478. private static readonly _AttributeDirtyCallBack;
  88479. private static _FresnelAndMiscDirtyCallBack;
  88480. private static _TextureAndMiscDirtyCallBack;
  88481. private static readonly _DirtyCallbackArray;
  88482. private static readonly _RunDirtyCallBacks;
  88483. /**
  88484. * Marks a define in the material to indicate that it needs to be re-computed
  88485. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  88486. */
  88487. markAsDirty(flag: number): void;
  88488. /**
  88489. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  88490. * @param func defines a function which checks material defines against the submeshes
  88491. */
  88492. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  88493. /**
  88494. * Indicates that we need to re-calculated for all submeshes
  88495. */
  88496. protected _markAllSubMeshesAsAllDirty(): void;
  88497. /**
  88498. * Indicates that image processing needs to be re-calculated for all submeshes
  88499. */
  88500. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  88501. /**
  88502. * Indicates that textures need to be re-calculated for all submeshes
  88503. */
  88504. protected _markAllSubMeshesAsTexturesDirty(): void;
  88505. /**
  88506. * Indicates that fresnel needs to be re-calculated for all submeshes
  88507. */
  88508. protected _markAllSubMeshesAsFresnelDirty(): void;
  88509. /**
  88510. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  88511. */
  88512. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  88513. /**
  88514. * Indicates that lights need to be re-calculated for all submeshes
  88515. */
  88516. protected _markAllSubMeshesAsLightsDirty(): void;
  88517. /**
  88518. * Indicates that attributes need to be re-calculated for all submeshes
  88519. */
  88520. protected _markAllSubMeshesAsAttributesDirty(): void;
  88521. /**
  88522. * Indicates that misc needs to be re-calculated for all submeshes
  88523. */
  88524. protected _markAllSubMeshesAsMiscDirty(): void;
  88525. /**
  88526. * Indicates that textures and misc need to be re-calculated for all submeshes
  88527. */
  88528. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  88529. /**
  88530. * Disposes the material
  88531. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  88532. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  88533. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  88534. */
  88535. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  88536. /** @hidden */
  88537. private releaseVertexArrayObject;
  88538. /**
  88539. * Serializes this material
  88540. * @returns the serialized material object
  88541. */
  88542. serialize(): any;
  88543. /**
  88544. * Creates a material from parsed material data
  88545. * @param parsedMaterial defines parsed material data
  88546. * @param scene defines the hosting scene
  88547. * @param rootUrl defines the root URL to use to load textures
  88548. * @returns a new material
  88549. */
  88550. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  88551. }
  88552. }
  88553. declare module BABYLON {
  88554. /**
  88555. * A multi-material is used to apply different materials to different parts of the same object without the need of
  88556. * separate meshes. This can be use to improve performances.
  88557. * @see http://doc.babylonjs.com/how_to/multi_materials
  88558. */
  88559. export class MultiMaterial extends Material {
  88560. private _subMaterials;
  88561. /**
  88562. * Gets or Sets the list of Materials used within the multi material.
  88563. * They need to be ordered according to the submeshes order in the associated mesh
  88564. */
  88565. subMaterials: Nullable<Material>[];
  88566. /**
  88567. * Function used to align with Node.getChildren()
  88568. * @returns the list of Materials used within the multi material
  88569. */
  88570. getChildren(): Nullable<Material>[];
  88571. /**
  88572. * Instantiates a new Multi Material
  88573. * A multi-material is used to apply different materials to different parts of the same object without the need of
  88574. * separate meshes. This can be use to improve performances.
  88575. * @see http://doc.babylonjs.com/how_to/multi_materials
  88576. * @param name Define the name in the scene
  88577. * @param scene Define the scene the material belongs to
  88578. */
  88579. constructor(name: string, scene: Scene);
  88580. private _hookArray;
  88581. /**
  88582. * Get one of the submaterial by its index in the submaterials array
  88583. * @param index The index to look the sub material at
  88584. * @returns The Material if the index has been defined
  88585. */
  88586. getSubMaterial(index: number): Nullable<Material>;
  88587. /**
  88588. * Get the list of active textures for the whole sub materials list.
  88589. * @returns All the textures that will be used during the rendering
  88590. */
  88591. getActiveTextures(): BaseTexture[];
  88592. /**
  88593. * Gets the current class name of the material e.g. "MultiMaterial"
  88594. * Mainly use in serialization.
  88595. * @returns the class name
  88596. */
  88597. getClassName(): string;
  88598. /**
  88599. * Checks if the material is ready to render the requested sub mesh
  88600. * @param mesh Define the mesh the submesh belongs to
  88601. * @param subMesh Define the sub mesh to look readyness for
  88602. * @param useInstances Define whether or not the material is used with instances
  88603. * @returns true if ready, otherwise false
  88604. */
  88605. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  88606. /**
  88607. * Clones the current material and its related sub materials
  88608. * @param name Define the name of the newly cloned material
  88609. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  88610. * @returns the cloned material
  88611. */
  88612. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  88613. /**
  88614. * Serializes the materials into a JSON representation.
  88615. * @returns the JSON representation
  88616. */
  88617. serialize(): any;
  88618. /**
  88619. * Dispose the material and release its associated resources
  88620. * @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)
  88621. * @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)
  88622. * @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)
  88623. */
  88624. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  88625. /**
  88626. * Creates a MultiMaterial from parsed MultiMaterial data.
  88627. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  88628. * @param scene defines the hosting scene
  88629. * @returns a new MultiMaterial
  88630. */
  88631. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  88632. }
  88633. }
  88634. declare module BABYLON {
  88635. /**
  88636. * Base class for submeshes
  88637. */
  88638. export class BaseSubMesh {
  88639. /** @hidden */
  88640. _materialDefines: Nullable<MaterialDefines>;
  88641. /** @hidden */
  88642. _materialEffect: Nullable<Effect>;
  88643. /**
  88644. * Gets associated effect
  88645. */
  88646. readonly effect: Nullable<Effect>;
  88647. /**
  88648. * Sets associated effect (effect used to render this submesh)
  88649. * @param effect defines the effect to associate with
  88650. * @param defines defines the set of defines used to compile this effect
  88651. */
  88652. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  88653. }
  88654. /**
  88655. * Defines a subdivision inside a mesh
  88656. */
  88657. export class SubMesh extends BaseSubMesh implements ICullable {
  88658. /** the material index to use */
  88659. materialIndex: number;
  88660. /** vertex index start */
  88661. verticesStart: number;
  88662. /** vertices count */
  88663. verticesCount: number;
  88664. /** index start */
  88665. indexStart: number;
  88666. /** indices count */
  88667. indexCount: number;
  88668. /** @hidden */
  88669. _linesIndexCount: number;
  88670. private _mesh;
  88671. private _renderingMesh;
  88672. private _boundingInfo;
  88673. private _linesIndexBuffer;
  88674. /** @hidden */
  88675. _lastColliderWorldVertices: Nullable<Vector3[]>;
  88676. /** @hidden */
  88677. _trianglePlanes: Plane[];
  88678. /** @hidden */
  88679. _lastColliderTransformMatrix: Nullable<Matrix>;
  88680. /** @hidden */
  88681. _renderId: number;
  88682. /** @hidden */
  88683. _alphaIndex: number;
  88684. /** @hidden */
  88685. _distanceToCamera: number;
  88686. /** @hidden */
  88687. _id: number;
  88688. private _currentMaterial;
  88689. /**
  88690. * Add a new submesh to a mesh
  88691. * @param materialIndex defines the material index to use
  88692. * @param verticesStart defines vertex index start
  88693. * @param verticesCount defines vertices count
  88694. * @param indexStart defines index start
  88695. * @param indexCount defines indices count
  88696. * @param mesh defines the parent mesh
  88697. * @param renderingMesh defines an optional rendering mesh
  88698. * @param createBoundingBox defines if bounding box should be created for this submesh
  88699. * @returns the new submesh
  88700. */
  88701. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  88702. /**
  88703. * Creates a new submesh
  88704. * @param materialIndex defines the material index to use
  88705. * @param verticesStart defines vertex index start
  88706. * @param verticesCount defines vertices count
  88707. * @param indexStart defines index start
  88708. * @param indexCount defines indices count
  88709. * @param mesh defines the parent mesh
  88710. * @param renderingMesh defines an optional rendering mesh
  88711. * @param createBoundingBox defines if bounding box should be created for this submesh
  88712. */
  88713. constructor(
  88714. /** the material index to use */
  88715. materialIndex: number,
  88716. /** vertex index start */
  88717. verticesStart: number,
  88718. /** vertices count */
  88719. verticesCount: number,
  88720. /** index start */
  88721. indexStart: number,
  88722. /** indices count */
  88723. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  88724. /**
  88725. * Returns true if this submesh covers the entire parent mesh
  88726. * @ignorenaming
  88727. */
  88728. readonly IsGlobal: boolean;
  88729. /**
  88730. * Returns the submesh BoudingInfo object
  88731. * @returns current bounding info (or mesh's one if the submesh is global)
  88732. */
  88733. getBoundingInfo(): BoundingInfo;
  88734. /**
  88735. * Sets the submesh BoundingInfo
  88736. * @param boundingInfo defines the new bounding info to use
  88737. * @returns the SubMesh
  88738. */
  88739. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  88740. /**
  88741. * Returns the mesh of the current submesh
  88742. * @return the parent mesh
  88743. */
  88744. getMesh(): AbstractMesh;
  88745. /**
  88746. * Returns the rendering mesh of the submesh
  88747. * @returns the rendering mesh (could be different from parent mesh)
  88748. */
  88749. getRenderingMesh(): Mesh;
  88750. /**
  88751. * Returns the submesh material
  88752. * @returns null or the current material
  88753. */
  88754. getMaterial(): Nullable<Material>;
  88755. /**
  88756. * Sets a new updated BoundingInfo object to the submesh
  88757. * @param data defines an optional position array to use to determine the bounding info
  88758. * @returns the SubMesh
  88759. */
  88760. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  88761. /** @hidden */
  88762. _checkCollision(collider: Collider): boolean;
  88763. /**
  88764. * Updates the submesh BoundingInfo
  88765. * @param world defines the world matrix to use to update the bounding info
  88766. * @returns the submesh
  88767. */
  88768. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  88769. /**
  88770. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  88771. * @param frustumPlanes defines the frustum planes
  88772. * @returns true if the submesh is intersecting with the frustum
  88773. */
  88774. isInFrustum(frustumPlanes: Plane[]): boolean;
  88775. /**
  88776. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  88777. * @param frustumPlanes defines the frustum planes
  88778. * @returns true if the submesh is inside the frustum
  88779. */
  88780. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  88781. /**
  88782. * Renders the submesh
  88783. * @param enableAlphaMode defines if alpha needs to be used
  88784. * @returns the submesh
  88785. */
  88786. render(enableAlphaMode: boolean): SubMesh;
  88787. /**
  88788. * @hidden
  88789. */
  88790. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  88791. /**
  88792. * Checks if the submesh intersects with a ray
  88793. * @param ray defines the ray to test
  88794. * @returns true is the passed ray intersects the submesh bounding box
  88795. */
  88796. canIntersects(ray: Ray): boolean;
  88797. /**
  88798. * Intersects current submesh with a ray
  88799. * @param ray defines the ray to test
  88800. * @param positions defines mesh's positions array
  88801. * @param indices defines mesh's indices array
  88802. * @param fastCheck defines if only bounding info should be used
  88803. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  88804. * @returns intersection info or null if no intersection
  88805. */
  88806. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  88807. /** @hidden */
  88808. private _intersectLines;
  88809. /** @hidden */
  88810. private _intersectUnIndexedLines;
  88811. /** @hidden */
  88812. private _intersectTriangles;
  88813. /** @hidden */
  88814. private _intersectUnIndexedTriangles;
  88815. /** @hidden */
  88816. _rebuild(): void;
  88817. /**
  88818. * Creates a new submesh from the passed mesh
  88819. * @param newMesh defines the new hosting mesh
  88820. * @param newRenderingMesh defines an optional rendering mesh
  88821. * @returns the new submesh
  88822. */
  88823. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  88824. /**
  88825. * Release associated resources
  88826. */
  88827. dispose(): void;
  88828. /**
  88829. * Gets the class name
  88830. * @returns the string "SubMesh".
  88831. */
  88832. getClassName(): string;
  88833. /**
  88834. * Creates a new submesh from indices data
  88835. * @param materialIndex the index of the main mesh material
  88836. * @param startIndex the index where to start the copy in the mesh indices array
  88837. * @param indexCount the number of indices to copy then from the startIndex
  88838. * @param mesh the main mesh to create the submesh from
  88839. * @param renderingMesh the optional rendering mesh
  88840. * @returns a new submesh
  88841. */
  88842. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  88843. }
  88844. }
  88845. declare module BABYLON {
  88846. /**
  88847. * Class used to represent data loading progression
  88848. */
  88849. export class SceneLoaderFlags {
  88850. private static _ForceFullSceneLoadingForIncremental;
  88851. private static _ShowLoadingScreen;
  88852. private static _CleanBoneMatrixWeights;
  88853. private static _loggingLevel;
  88854. /**
  88855. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  88856. */
  88857. static ForceFullSceneLoadingForIncremental: boolean;
  88858. /**
  88859. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  88860. */
  88861. static ShowLoadingScreen: boolean;
  88862. /**
  88863. * Defines the current logging level (while loading the scene)
  88864. * @ignorenaming
  88865. */
  88866. static loggingLevel: number;
  88867. /**
  88868. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  88869. */
  88870. static CleanBoneMatrixWeights: boolean;
  88871. }
  88872. }
  88873. declare module BABYLON {
  88874. /**
  88875. * Class used to store geometry data (vertex buffers + index buffer)
  88876. */
  88877. export class Geometry implements IGetSetVerticesData {
  88878. /**
  88879. * Gets or sets the ID of the geometry
  88880. */
  88881. id: string;
  88882. /**
  88883. * Gets or sets the unique ID of the geometry
  88884. */
  88885. uniqueId: number;
  88886. /**
  88887. * Gets the delay loading state of the geometry (none by default which means not delayed)
  88888. */
  88889. delayLoadState: number;
  88890. /**
  88891. * Gets the file containing the data to load when running in delay load state
  88892. */
  88893. delayLoadingFile: Nullable<string>;
  88894. /**
  88895. * Callback called when the geometry is updated
  88896. */
  88897. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  88898. private _scene;
  88899. private _engine;
  88900. private _meshes;
  88901. private _totalVertices;
  88902. /** @hidden */
  88903. _indices: IndicesArray;
  88904. /** @hidden */
  88905. _vertexBuffers: {
  88906. [key: string]: VertexBuffer;
  88907. };
  88908. private _isDisposed;
  88909. private _extend;
  88910. private _boundingBias;
  88911. /** @hidden */
  88912. _delayInfo: Array<string>;
  88913. private _indexBuffer;
  88914. private _indexBufferIsUpdatable;
  88915. /** @hidden */
  88916. _boundingInfo: Nullable<BoundingInfo>;
  88917. /** @hidden */
  88918. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  88919. /** @hidden */
  88920. _softwareSkinningFrameId: number;
  88921. private _vertexArrayObjects;
  88922. private _updatable;
  88923. /** @hidden */
  88924. _positions: Nullable<Vector3[]>;
  88925. /**
  88926. * 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
  88927. */
  88928. /**
  88929. * 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
  88930. */
  88931. boundingBias: Vector2;
  88932. /**
  88933. * Static function used to attach a new empty geometry to a mesh
  88934. * @param mesh defines the mesh to attach the geometry to
  88935. * @returns the new Geometry
  88936. */
  88937. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  88938. /**
  88939. * Creates a new geometry
  88940. * @param id defines the unique ID
  88941. * @param scene defines the hosting scene
  88942. * @param vertexData defines the VertexData used to get geometry data
  88943. * @param updatable defines if geometry must be updatable (false by default)
  88944. * @param mesh defines the mesh that will be associated with the geometry
  88945. */
  88946. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  88947. /**
  88948. * Gets the current extend of the geometry
  88949. */
  88950. readonly extend: {
  88951. minimum: Vector3;
  88952. maximum: Vector3;
  88953. };
  88954. /**
  88955. * Gets the hosting scene
  88956. * @returns the hosting Scene
  88957. */
  88958. getScene(): Scene;
  88959. /**
  88960. * Gets the hosting engine
  88961. * @returns the hosting Engine
  88962. */
  88963. getEngine(): Engine;
  88964. /**
  88965. * Defines if the geometry is ready to use
  88966. * @returns true if the geometry is ready to be used
  88967. */
  88968. isReady(): boolean;
  88969. /**
  88970. * Gets a value indicating that the geometry should not be serialized
  88971. */
  88972. readonly doNotSerialize: boolean;
  88973. /** @hidden */
  88974. _rebuild(): void;
  88975. /**
  88976. * Affects all geometry data in one call
  88977. * @param vertexData defines the geometry data
  88978. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  88979. */
  88980. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  88981. /**
  88982. * Set specific vertex data
  88983. * @param kind defines the data kind (Position, normal, etc...)
  88984. * @param data defines the vertex data to use
  88985. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  88986. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  88987. */
  88988. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  88989. /**
  88990. * Removes a specific vertex data
  88991. * @param kind defines the data kind (Position, normal, etc...)
  88992. */
  88993. removeVerticesData(kind: string): void;
  88994. /**
  88995. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  88996. * @param buffer defines the vertex buffer to use
  88997. * @param totalVertices defines the total number of vertices for position kind (could be null)
  88998. */
  88999. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  89000. /**
  89001. * Update a specific vertex buffer
  89002. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  89003. * It will do nothing if the buffer is not updatable
  89004. * @param kind defines the data kind (Position, normal, etc...)
  89005. * @param data defines the data to use
  89006. * @param offset defines the offset in the target buffer where to store the data
  89007. * @param useBytes set to true if the offset is in bytes
  89008. */
  89009. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  89010. /**
  89011. * Update a specific vertex buffer
  89012. * This function will create a new buffer if the current one is not updatable
  89013. * @param kind defines the data kind (Position, normal, etc...)
  89014. * @param data defines the data to use
  89015. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  89016. */
  89017. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  89018. private _updateBoundingInfo;
  89019. /** @hidden */
  89020. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  89021. /**
  89022. * Gets total number of vertices
  89023. * @returns the total number of vertices
  89024. */
  89025. getTotalVertices(): number;
  89026. /**
  89027. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  89028. * @param kind defines the data kind (Position, normal, etc...)
  89029. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89030. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89031. * @returns a float array containing vertex data
  89032. */
  89033. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  89034. /**
  89035. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  89036. * @param kind defines the data kind (Position, normal, etc...)
  89037. * @returns true if the vertex buffer with the specified kind is updatable
  89038. */
  89039. isVertexBufferUpdatable(kind: string): boolean;
  89040. /**
  89041. * Gets a specific vertex buffer
  89042. * @param kind defines the data kind (Position, normal, etc...)
  89043. * @returns a VertexBuffer
  89044. */
  89045. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  89046. /**
  89047. * Returns all vertex buffers
  89048. * @return an object holding all vertex buffers indexed by kind
  89049. */
  89050. getVertexBuffers(): Nullable<{
  89051. [key: string]: VertexBuffer;
  89052. }>;
  89053. /**
  89054. * Gets a boolean indicating if specific vertex buffer is present
  89055. * @param kind defines the data kind (Position, normal, etc...)
  89056. * @returns true if data is present
  89057. */
  89058. isVerticesDataPresent(kind: string): boolean;
  89059. /**
  89060. * Gets a list of all attached data kinds (Position, normal, etc...)
  89061. * @returns a list of string containing all kinds
  89062. */
  89063. getVerticesDataKinds(): string[];
  89064. /**
  89065. * Update index buffer
  89066. * @param indices defines the indices to store in the index buffer
  89067. * @param offset defines the offset in the target buffer where to store the data
  89068. * @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)
  89069. */
  89070. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  89071. /**
  89072. * Creates a new index buffer
  89073. * @param indices defines the indices to store in the index buffer
  89074. * @param totalVertices defines the total number of vertices (could be null)
  89075. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  89076. */
  89077. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  89078. /**
  89079. * Return the total number of indices
  89080. * @returns the total number of indices
  89081. */
  89082. getTotalIndices(): number;
  89083. /**
  89084. * Gets the index buffer array
  89085. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89086. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89087. * @returns the index buffer array
  89088. */
  89089. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  89090. /**
  89091. * Gets the index buffer
  89092. * @return the index buffer
  89093. */
  89094. getIndexBuffer(): Nullable<DataBuffer>;
  89095. /** @hidden */
  89096. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  89097. /**
  89098. * Release the associated resources for a specific mesh
  89099. * @param mesh defines the source mesh
  89100. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  89101. */
  89102. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  89103. /**
  89104. * Apply current geometry to a given mesh
  89105. * @param mesh defines the mesh to apply geometry to
  89106. */
  89107. applyToMesh(mesh: Mesh): void;
  89108. private _updateExtend;
  89109. private _applyToMesh;
  89110. private notifyUpdate;
  89111. /**
  89112. * Load the geometry if it was flagged as delay loaded
  89113. * @param scene defines the hosting scene
  89114. * @param onLoaded defines a callback called when the geometry is loaded
  89115. */
  89116. load(scene: Scene, onLoaded?: () => void): void;
  89117. private _queueLoad;
  89118. /**
  89119. * Invert the geometry to move from a right handed system to a left handed one.
  89120. */
  89121. toLeftHanded(): void;
  89122. /** @hidden */
  89123. _resetPointsArrayCache(): void;
  89124. /** @hidden */
  89125. _generatePointsArray(): boolean;
  89126. /**
  89127. * Gets a value indicating if the geometry is disposed
  89128. * @returns true if the geometry was disposed
  89129. */
  89130. isDisposed(): boolean;
  89131. private _disposeVertexArrayObjects;
  89132. /**
  89133. * Free all associated resources
  89134. */
  89135. dispose(): void;
  89136. /**
  89137. * Clone the current geometry into a new geometry
  89138. * @param id defines the unique ID of the new geometry
  89139. * @returns a new geometry object
  89140. */
  89141. copy(id: string): Geometry;
  89142. /**
  89143. * Serialize the current geometry info (and not the vertices data) into a JSON object
  89144. * @return a JSON representation of the current geometry data (without the vertices data)
  89145. */
  89146. serialize(): any;
  89147. private toNumberArray;
  89148. /**
  89149. * Serialize all vertices data into a JSON oject
  89150. * @returns a JSON representation of the current geometry data
  89151. */
  89152. serializeVerticeData(): any;
  89153. /**
  89154. * Extracts a clone of a mesh geometry
  89155. * @param mesh defines the source mesh
  89156. * @param id defines the unique ID of the new geometry object
  89157. * @returns the new geometry object
  89158. */
  89159. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  89160. /**
  89161. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  89162. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  89163. * Be aware Math.random() could cause collisions, but:
  89164. * "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"
  89165. * @returns a string containing a new GUID
  89166. */
  89167. static RandomId(): string;
  89168. /** @hidden */
  89169. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  89170. private static _CleanMatricesWeights;
  89171. /**
  89172. * Create a new geometry from persisted data (Using .babylon file format)
  89173. * @param parsedVertexData defines the persisted data
  89174. * @param scene defines the hosting scene
  89175. * @param rootUrl defines the root url to use to load assets (like delayed data)
  89176. * @returns the new geometry object
  89177. */
  89178. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  89179. }
  89180. }
  89181. declare module BABYLON {
  89182. /**
  89183. * Define an interface for all classes that will get and set the data on vertices
  89184. */
  89185. export interface IGetSetVerticesData {
  89186. /**
  89187. * Gets a boolean indicating if specific vertex data is present
  89188. * @param kind defines the vertex data kind to use
  89189. * @returns true is data kind is present
  89190. */
  89191. isVerticesDataPresent(kind: string): boolean;
  89192. /**
  89193. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  89194. * @param kind defines the data kind (Position, normal, etc...)
  89195. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89196. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89197. * @returns a float array containing vertex data
  89198. */
  89199. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  89200. /**
  89201. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  89202. * @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.
  89203. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89204. * @returns the indices array or an empty array if the mesh has no geometry
  89205. */
  89206. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  89207. /**
  89208. * Set specific vertex data
  89209. * @param kind defines the data kind (Position, normal, etc...)
  89210. * @param data defines the vertex data to use
  89211. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  89212. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  89213. */
  89214. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  89215. /**
  89216. * Update a specific associated vertex buffer
  89217. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  89218. * - VertexBuffer.PositionKind
  89219. * - VertexBuffer.UVKind
  89220. * - VertexBuffer.UV2Kind
  89221. * - VertexBuffer.UV3Kind
  89222. * - VertexBuffer.UV4Kind
  89223. * - VertexBuffer.UV5Kind
  89224. * - VertexBuffer.UV6Kind
  89225. * - VertexBuffer.ColorKind
  89226. * - VertexBuffer.MatricesIndicesKind
  89227. * - VertexBuffer.MatricesIndicesExtraKind
  89228. * - VertexBuffer.MatricesWeightsKind
  89229. * - VertexBuffer.MatricesWeightsExtraKind
  89230. * @param data defines the data source
  89231. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  89232. * @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)
  89233. */
  89234. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  89235. /**
  89236. * Creates a new index buffer
  89237. * @param indices defines the indices to store in the index buffer
  89238. * @param totalVertices defines the total number of vertices (could be null)
  89239. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  89240. */
  89241. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  89242. }
  89243. /**
  89244. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  89245. */
  89246. export class VertexData {
  89247. /**
  89248. * Mesh side orientation : usually the external or front surface
  89249. */
  89250. static readonly FRONTSIDE: number;
  89251. /**
  89252. * Mesh side orientation : usually the internal or back surface
  89253. */
  89254. static readonly BACKSIDE: number;
  89255. /**
  89256. * Mesh side orientation : both internal and external or front and back surfaces
  89257. */
  89258. static readonly DOUBLESIDE: number;
  89259. /**
  89260. * Mesh side orientation : by default, `FRONTSIDE`
  89261. */
  89262. static readonly DEFAULTSIDE: number;
  89263. /**
  89264. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  89265. */
  89266. positions: Nullable<FloatArray>;
  89267. /**
  89268. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  89269. */
  89270. normals: Nullable<FloatArray>;
  89271. /**
  89272. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  89273. */
  89274. tangents: Nullable<FloatArray>;
  89275. /**
  89276. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89277. */
  89278. uvs: Nullable<FloatArray>;
  89279. /**
  89280. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89281. */
  89282. uvs2: Nullable<FloatArray>;
  89283. /**
  89284. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89285. */
  89286. uvs3: Nullable<FloatArray>;
  89287. /**
  89288. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89289. */
  89290. uvs4: Nullable<FloatArray>;
  89291. /**
  89292. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89293. */
  89294. uvs5: Nullable<FloatArray>;
  89295. /**
  89296. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89297. */
  89298. uvs6: Nullable<FloatArray>;
  89299. /**
  89300. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  89301. */
  89302. colors: Nullable<FloatArray>;
  89303. /**
  89304. * 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).
  89305. */
  89306. matricesIndices: Nullable<FloatArray>;
  89307. /**
  89308. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  89309. */
  89310. matricesWeights: Nullable<FloatArray>;
  89311. /**
  89312. * An array extending the number of possible indices
  89313. */
  89314. matricesIndicesExtra: Nullable<FloatArray>;
  89315. /**
  89316. * An array extending the number of possible weights when the number of indices is extended
  89317. */
  89318. matricesWeightsExtra: Nullable<FloatArray>;
  89319. /**
  89320. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  89321. */
  89322. indices: Nullable<IndicesArray>;
  89323. /**
  89324. * Uses the passed data array to set the set the values for the specified kind of data
  89325. * @param data a linear array of floating numbers
  89326. * @param kind the type of data that is being set, eg positions, colors etc
  89327. */
  89328. set(data: FloatArray, kind: string): void;
  89329. /**
  89330. * Associates the vertexData to the passed Mesh.
  89331. * Sets it as updatable or not (default `false`)
  89332. * @param mesh the mesh the vertexData is applied to
  89333. * @param updatable when used and having the value true allows new data to update the vertexData
  89334. * @returns the VertexData
  89335. */
  89336. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  89337. /**
  89338. * Associates the vertexData to the passed Geometry.
  89339. * Sets it as updatable or not (default `false`)
  89340. * @param geometry the geometry the vertexData is applied to
  89341. * @param updatable when used and having the value true allows new data to update the vertexData
  89342. * @returns VertexData
  89343. */
  89344. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  89345. /**
  89346. * Updates the associated mesh
  89347. * @param mesh the mesh to be updated
  89348. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  89349. * @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
  89350. * @returns VertexData
  89351. */
  89352. updateMesh(mesh: Mesh): VertexData;
  89353. /**
  89354. * Updates the associated geometry
  89355. * @param geometry the geometry to be updated
  89356. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  89357. * @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
  89358. * @returns VertexData.
  89359. */
  89360. updateGeometry(geometry: Geometry): VertexData;
  89361. private _applyTo;
  89362. private _update;
  89363. /**
  89364. * Transforms each position and each normal of the vertexData according to the passed Matrix
  89365. * @param matrix the transforming matrix
  89366. * @returns the VertexData
  89367. */
  89368. transform(matrix: Matrix): VertexData;
  89369. /**
  89370. * Merges the passed VertexData into the current one
  89371. * @param other the VertexData to be merged into the current one
  89372. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  89373. * @returns the modified VertexData
  89374. */
  89375. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  89376. private _mergeElement;
  89377. private _validate;
  89378. /**
  89379. * Serializes the VertexData
  89380. * @returns a serialized object
  89381. */
  89382. serialize(): any;
  89383. /**
  89384. * Extracts the vertexData from a mesh
  89385. * @param mesh the mesh from which to extract the VertexData
  89386. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  89387. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  89388. * @returns the object VertexData associated to the passed mesh
  89389. */
  89390. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  89391. /**
  89392. * Extracts the vertexData from the geometry
  89393. * @param geometry the geometry from which to extract the VertexData
  89394. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  89395. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  89396. * @returns the object VertexData associated to the passed mesh
  89397. */
  89398. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  89399. private static _ExtractFrom;
  89400. /**
  89401. * Creates the VertexData for a Ribbon
  89402. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  89403. * * pathArray array of paths, each of which an array of successive Vector3
  89404. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  89405. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  89406. * * 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
  89407. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89408. * * 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)
  89409. * * 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)
  89410. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  89411. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  89412. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  89413. * @returns the VertexData of the ribbon
  89414. */
  89415. static CreateRibbon(options: {
  89416. pathArray: Vector3[][];
  89417. closeArray?: boolean;
  89418. closePath?: boolean;
  89419. offset?: number;
  89420. sideOrientation?: number;
  89421. frontUVs?: Vector4;
  89422. backUVs?: Vector4;
  89423. invertUV?: boolean;
  89424. uvs?: Vector2[];
  89425. colors?: Color4[];
  89426. }): VertexData;
  89427. /**
  89428. * Creates the VertexData for a box
  89429. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89430. * * size sets the width, height and depth of the box to the value of size, optional default 1
  89431. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  89432. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  89433. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  89434. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  89435. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  89436. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89437. * * 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)
  89438. * * 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)
  89439. * @returns the VertexData of the box
  89440. */
  89441. static CreateBox(options: {
  89442. size?: number;
  89443. width?: number;
  89444. height?: number;
  89445. depth?: number;
  89446. faceUV?: Vector4[];
  89447. faceColors?: Color4[];
  89448. sideOrientation?: number;
  89449. frontUVs?: Vector4;
  89450. backUVs?: Vector4;
  89451. }): VertexData;
  89452. /**
  89453. * Creates the VertexData for a tiled box
  89454. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89455. * * faceTiles sets the pattern, tile size and number of tiles for a face
  89456. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  89457. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  89458. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89459. * @returns the VertexData of the box
  89460. */
  89461. static CreateTiledBox(options: {
  89462. pattern?: number;
  89463. width?: number;
  89464. height?: number;
  89465. depth?: number;
  89466. tileSize?: number;
  89467. tileWidth?: number;
  89468. tileHeight?: number;
  89469. alignHorizontal?: number;
  89470. alignVertical?: number;
  89471. faceUV?: Vector4[];
  89472. faceColors?: Color4[];
  89473. sideOrientation?: number;
  89474. }): VertexData;
  89475. /**
  89476. * Creates the VertexData for a tiled plane
  89477. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89478. * * pattern a limited pattern arrangement depending on the number
  89479. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  89480. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  89481. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  89482. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89483. * * 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)
  89484. * * 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)
  89485. * @returns the VertexData of the tiled plane
  89486. */
  89487. static CreateTiledPlane(options: {
  89488. pattern?: number;
  89489. tileSize?: number;
  89490. tileWidth?: number;
  89491. tileHeight?: number;
  89492. size?: number;
  89493. width?: number;
  89494. height?: number;
  89495. alignHorizontal?: number;
  89496. alignVertical?: number;
  89497. sideOrientation?: number;
  89498. frontUVs?: Vector4;
  89499. backUVs?: Vector4;
  89500. }): VertexData;
  89501. /**
  89502. * Creates the VertexData for an ellipsoid, defaults to a sphere
  89503. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89504. * * segments sets the number of horizontal strips optional, default 32
  89505. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  89506. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  89507. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  89508. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  89509. * * 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
  89510. * * 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
  89511. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89512. * * 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)
  89513. * * 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)
  89514. * @returns the VertexData of the ellipsoid
  89515. */
  89516. static CreateSphere(options: {
  89517. segments?: number;
  89518. diameter?: number;
  89519. diameterX?: number;
  89520. diameterY?: number;
  89521. diameterZ?: number;
  89522. arc?: number;
  89523. slice?: number;
  89524. sideOrientation?: number;
  89525. frontUVs?: Vector4;
  89526. backUVs?: Vector4;
  89527. }): VertexData;
  89528. /**
  89529. * Creates the VertexData for a cylinder, cone or prism
  89530. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89531. * * height sets the height (y direction) of the cylinder, optional, default 2
  89532. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  89533. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  89534. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  89535. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  89536. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  89537. * * 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
  89538. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  89539. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  89540. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  89541. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  89542. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89543. * * 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)
  89544. * * 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)
  89545. * @returns the VertexData of the cylinder, cone or prism
  89546. */
  89547. static CreateCylinder(options: {
  89548. height?: number;
  89549. diameterTop?: number;
  89550. diameterBottom?: number;
  89551. diameter?: number;
  89552. tessellation?: number;
  89553. subdivisions?: number;
  89554. arc?: number;
  89555. faceColors?: Color4[];
  89556. faceUV?: Vector4[];
  89557. hasRings?: boolean;
  89558. enclose?: boolean;
  89559. sideOrientation?: number;
  89560. frontUVs?: Vector4;
  89561. backUVs?: Vector4;
  89562. }): VertexData;
  89563. /**
  89564. * Creates the VertexData for a torus
  89565. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89566. * * diameter the diameter of the torus, optional default 1
  89567. * * thickness the diameter of the tube forming the torus, optional default 0.5
  89568. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  89569. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89570. * * 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)
  89571. * * 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)
  89572. * @returns the VertexData of the torus
  89573. */
  89574. static CreateTorus(options: {
  89575. diameter?: number;
  89576. thickness?: number;
  89577. tessellation?: number;
  89578. sideOrientation?: number;
  89579. frontUVs?: Vector4;
  89580. backUVs?: Vector4;
  89581. }): VertexData;
  89582. /**
  89583. * Creates the VertexData of the LineSystem
  89584. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  89585. * - lines an array of lines, each line being an array of successive Vector3
  89586. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  89587. * @returns the VertexData of the LineSystem
  89588. */
  89589. static CreateLineSystem(options: {
  89590. lines: Vector3[][];
  89591. colors?: Nullable<Color4[][]>;
  89592. }): VertexData;
  89593. /**
  89594. * Create the VertexData for a DashedLines
  89595. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  89596. * - points an array successive Vector3
  89597. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  89598. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  89599. * - dashNb the intended total number of dashes, optional, default 200
  89600. * @returns the VertexData for the DashedLines
  89601. */
  89602. static CreateDashedLines(options: {
  89603. points: Vector3[];
  89604. dashSize?: number;
  89605. gapSize?: number;
  89606. dashNb?: number;
  89607. }): VertexData;
  89608. /**
  89609. * Creates the VertexData for a Ground
  89610. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  89611. * - width the width (x direction) of the ground, optional, default 1
  89612. * - height the height (z direction) of the ground, optional, default 1
  89613. * - subdivisions the number of subdivisions per side, optional, default 1
  89614. * @returns the VertexData of the Ground
  89615. */
  89616. static CreateGround(options: {
  89617. width?: number;
  89618. height?: number;
  89619. subdivisions?: number;
  89620. subdivisionsX?: number;
  89621. subdivisionsY?: number;
  89622. }): VertexData;
  89623. /**
  89624. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  89625. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  89626. * * xmin the ground minimum X coordinate, optional, default -1
  89627. * * zmin the ground minimum Z coordinate, optional, default -1
  89628. * * xmax the ground maximum X coordinate, optional, default 1
  89629. * * zmax the ground maximum Z coordinate, optional, default 1
  89630. * * 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}
  89631. * * 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}
  89632. * @returns the VertexData of the TiledGround
  89633. */
  89634. static CreateTiledGround(options: {
  89635. xmin: number;
  89636. zmin: number;
  89637. xmax: number;
  89638. zmax: number;
  89639. subdivisions?: {
  89640. w: number;
  89641. h: number;
  89642. };
  89643. precision?: {
  89644. w: number;
  89645. h: number;
  89646. };
  89647. }): VertexData;
  89648. /**
  89649. * Creates the VertexData of the Ground designed from a heightmap
  89650. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  89651. * * width the width (x direction) of the ground
  89652. * * height the height (z direction) of the ground
  89653. * * subdivisions the number of subdivisions per side
  89654. * * minHeight the minimum altitude on the ground, optional, default 0
  89655. * * maxHeight the maximum altitude on the ground, optional default 1
  89656. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  89657. * * buffer the array holding the image color data
  89658. * * bufferWidth the width of image
  89659. * * bufferHeight the height of image
  89660. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  89661. * @returns the VertexData of the Ground designed from a heightmap
  89662. */
  89663. static CreateGroundFromHeightMap(options: {
  89664. width: number;
  89665. height: number;
  89666. subdivisions: number;
  89667. minHeight: number;
  89668. maxHeight: number;
  89669. colorFilter: Color3;
  89670. buffer: Uint8Array;
  89671. bufferWidth: number;
  89672. bufferHeight: number;
  89673. alphaFilter: number;
  89674. }): VertexData;
  89675. /**
  89676. * Creates the VertexData for a Plane
  89677. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  89678. * * size sets the width and height of the plane to the value of size, optional default 1
  89679. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  89680. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  89681. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89682. * * 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)
  89683. * * 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)
  89684. * @returns the VertexData of the box
  89685. */
  89686. static CreatePlane(options: {
  89687. size?: number;
  89688. width?: number;
  89689. height?: number;
  89690. sideOrientation?: number;
  89691. frontUVs?: Vector4;
  89692. backUVs?: Vector4;
  89693. }): VertexData;
  89694. /**
  89695. * Creates the VertexData of the Disc or regular Polygon
  89696. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  89697. * * radius the radius of the disc, optional default 0.5
  89698. * * tessellation the number of polygon sides, optional, default 64
  89699. * * 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
  89700. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89701. * * 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)
  89702. * * 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)
  89703. * @returns the VertexData of the box
  89704. */
  89705. static CreateDisc(options: {
  89706. radius?: number;
  89707. tessellation?: number;
  89708. arc?: number;
  89709. sideOrientation?: number;
  89710. frontUVs?: Vector4;
  89711. backUVs?: Vector4;
  89712. }): VertexData;
  89713. /**
  89714. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  89715. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  89716. * @param polygon a mesh built from polygonTriangulation.build()
  89717. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89718. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  89719. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  89720. * @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)
  89721. * @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)
  89722. * @returns the VertexData of the Polygon
  89723. */
  89724. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  89725. /**
  89726. * Creates the VertexData of the IcoSphere
  89727. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  89728. * * radius the radius of the IcoSphere, optional default 1
  89729. * * radiusX allows stretching in the x direction, optional, default radius
  89730. * * radiusY allows stretching in the y direction, optional, default radius
  89731. * * radiusZ allows stretching in the z direction, optional, default radius
  89732. * * flat when true creates a flat shaded mesh, optional, default true
  89733. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  89734. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89735. * * 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)
  89736. * * 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)
  89737. * @returns the VertexData of the IcoSphere
  89738. */
  89739. static CreateIcoSphere(options: {
  89740. radius?: number;
  89741. radiusX?: number;
  89742. radiusY?: number;
  89743. radiusZ?: number;
  89744. flat?: boolean;
  89745. subdivisions?: number;
  89746. sideOrientation?: number;
  89747. frontUVs?: Vector4;
  89748. backUVs?: Vector4;
  89749. }): VertexData;
  89750. /**
  89751. * Creates the VertexData for a Polyhedron
  89752. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  89753. * * type provided types are:
  89754. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  89755. * * 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)
  89756. * * size the size of the IcoSphere, optional default 1
  89757. * * sizeX allows stretching in the x direction, optional, default size
  89758. * * sizeY allows stretching in the y direction, optional, default size
  89759. * * sizeZ allows stretching in the z direction, optional, default size
  89760. * * 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
  89761. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  89762. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  89763. * * flat when true creates a flat shaded mesh, optional, default true
  89764. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  89765. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89766. * * 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)
  89767. * * 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)
  89768. * @returns the VertexData of the Polyhedron
  89769. */
  89770. static CreatePolyhedron(options: {
  89771. type?: number;
  89772. size?: number;
  89773. sizeX?: number;
  89774. sizeY?: number;
  89775. sizeZ?: number;
  89776. custom?: any;
  89777. faceUV?: Vector4[];
  89778. faceColors?: Color4[];
  89779. flat?: boolean;
  89780. sideOrientation?: number;
  89781. frontUVs?: Vector4;
  89782. backUVs?: Vector4;
  89783. }): VertexData;
  89784. /**
  89785. * Creates the VertexData for a TorusKnot
  89786. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  89787. * * radius the radius of the torus knot, optional, default 2
  89788. * * tube the thickness of the tube, optional, default 0.5
  89789. * * radialSegments the number of sides on each tube segments, optional, default 32
  89790. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  89791. * * p the number of windings around the z axis, optional, default 2
  89792. * * q the number of windings around the x axis, optional, default 3
  89793. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89794. * * 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)
  89795. * * 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)
  89796. * @returns the VertexData of the Torus Knot
  89797. */
  89798. static CreateTorusKnot(options: {
  89799. radius?: number;
  89800. tube?: number;
  89801. radialSegments?: number;
  89802. tubularSegments?: number;
  89803. p?: number;
  89804. q?: number;
  89805. sideOrientation?: number;
  89806. frontUVs?: Vector4;
  89807. backUVs?: Vector4;
  89808. }): VertexData;
  89809. /**
  89810. * Compute normals for given positions and indices
  89811. * @param positions an array of vertex positions, [...., x, y, z, ......]
  89812. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  89813. * @param normals an array of vertex normals, [...., x, y, z, ......]
  89814. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  89815. * * facetNormals : optional array of facet normals (vector3)
  89816. * * facetPositions : optional array of facet positions (vector3)
  89817. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  89818. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  89819. * * bInfo : optional bounding info, required for facetPartitioning computation
  89820. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  89821. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  89822. * * useRightHandedSystem: optional boolean to for right handed system computation
  89823. * * depthSort : optional boolean to enable the facet depth sort computation
  89824. * * distanceTo : optional Vector3 to compute the facet depth from this location
  89825. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  89826. */
  89827. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  89828. facetNormals?: any;
  89829. facetPositions?: any;
  89830. facetPartitioning?: any;
  89831. ratio?: number;
  89832. bInfo?: any;
  89833. bbSize?: Vector3;
  89834. subDiv?: any;
  89835. useRightHandedSystem?: boolean;
  89836. depthSort?: boolean;
  89837. distanceTo?: Vector3;
  89838. depthSortedFacets?: any;
  89839. }): void;
  89840. /** @hidden */
  89841. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  89842. /**
  89843. * Applies VertexData created from the imported parameters to the geometry
  89844. * @param parsedVertexData the parsed data from an imported file
  89845. * @param geometry the geometry to apply the VertexData to
  89846. */
  89847. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  89848. }
  89849. }
  89850. declare module BABYLON {
  89851. /**
  89852. * Defines a target to use with MorphTargetManager
  89853. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  89854. */
  89855. export class MorphTarget implements IAnimatable {
  89856. /** defines the name of the target */
  89857. name: string;
  89858. /**
  89859. * Gets or sets the list of animations
  89860. */
  89861. animations: Animation[];
  89862. private _scene;
  89863. private _positions;
  89864. private _normals;
  89865. private _tangents;
  89866. private _uvs;
  89867. private _influence;
  89868. private _uniqueId;
  89869. /**
  89870. * Observable raised when the influence changes
  89871. */
  89872. onInfluenceChanged: Observable<boolean>;
  89873. /** @hidden */
  89874. _onDataLayoutChanged: Observable<void>;
  89875. /**
  89876. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  89877. */
  89878. influence: number;
  89879. /**
  89880. * Gets or sets the id of the morph Target
  89881. */
  89882. id: string;
  89883. private _animationPropertiesOverride;
  89884. /**
  89885. * Gets or sets the animation properties override
  89886. */
  89887. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  89888. /**
  89889. * Creates a new MorphTarget
  89890. * @param name defines the name of the target
  89891. * @param influence defines the influence to use
  89892. * @param scene defines the scene the morphtarget belongs to
  89893. */
  89894. constructor(
  89895. /** defines the name of the target */
  89896. name: string, influence?: number, scene?: Nullable<Scene>);
  89897. /**
  89898. * Gets the unique ID of this manager
  89899. */
  89900. readonly uniqueId: number;
  89901. /**
  89902. * Gets a boolean defining if the target contains position data
  89903. */
  89904. readonly hasPositions: boolean;
  89905. /**
  89906. * Gets a boolean defining if the target contains normal data
  89907. */
  89908. readonly hasNormals: boolean;
  89909. /**
  89910. * Gets a boolean defining if the target contains tangent data
  89911. */
  89912. readonly hasTangents: boolean;
  89913. /**
  89914. * Gets a boolean defining if the target contains texture coordinates data
  89915. */
  89916. readonly hasUVs: boolean;
  89917. /**
  89918. * Affects position data to this target
  89919. * @param data defines the position data to use
  89920. */
  89921. setPositions(data: Nullable<FloatArray>): void;
  89922. /**
  89923. * Gets the position data stored in this target
  89924. * @returns a FloatArray containing the position data (or null if not present)
  89925. */
  89926. getPositions(): Nullable<FloatArray>;
  89927. /**
  89928. * Affects normal data to this target
  89929. * @param data defines the normal data to use
  89930. */
  89931. setNormals(data: Nullable<FloatArray>): void;
  89932. /**
  89933. * Gets the normal data stored in this target
  89934. * @returns a FloatArray containing the normal data (or null if not present)
  89935. */
  89936. getNormals(): Nullable<FloatArray>;
  89937. /**
  89938. * Affects tangent data to this target
  89939. * @param data defines the tangent data to use
  89940. */
  89941. setTangents(data: Nullable<FloatArray>): void;
  89942. /**
  89943. * Gets the tangent data stored in this target
  89944. * @returns a FloatArray containing the tangent data (or null if not present)
  89945. */
  89946. getTangents(): Nullable<FloatArray>;
  89947. /**
  89948. * Affects texture coordinates data to this target
  89949. * @param data defines the texture coordinates data to use
  89950. */
  89951. setUVs(data: Nullable<FloatArray>): void;
  89952. /**
  89953. * Gets the texture coordinates data stored in this target
  89954. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  89955. */
  89956. getUVs(): Nullable<FloatArray>;
  89957. /**
  89958. * Clone the current target
  89959. * @returns a new MorphTarget
  89960. */
  89961. clone(): MorphTarget;
  89962. /**
  89963. * Serializes the current target into a Serialization object
  89964. * @returns the serialized object
  89965. */
  89966. serialize(): any;
  89967. /**
  89968. * Returns the string "MorphTarget"
  89969. * @returns "MorphTarget"
  89970. */
  89971. getClassName(): string;
  89972. /**
  89973. * Creates a new target from serialized data
  89974. * @param serializationObject defines the serialized data to use
  89975. * @returns a new MorphTarget
  89976. */
  89977. static Parse(serializationObject: any): MorphTarget;
  89978. /**
  89979. * Creates a MorphTarget from mesh data
  89980. * @param mesh defines the source mesh
  89981. * @param name defines the name to use for the new target
  89982. * @param influence defines the influence to attach to the target
  89983. * @returns a new MorphTarget
  89984. */
  89985. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  89986. }
  89987. }
  89988. declare module BABYLON {
  89989. /**
  89990. * This class is used to deform meshes using morphing between different targets
  89991. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  89992. */
  89993. export class MorphTargetManager {
  89994. private _targets;
  89995. private _targetInfluenceChangedObservers;
  89996. private _targetDataLayoutChangedObservers;
  89997. private _activeTargets;
  89998. private _scene;
  89999. private _influences;
  90000. private _supportsNormals;
  90001. private _supportsTangents;
  90002. private _supportsUVs;
  90003. private _vertexCount;
  90004. private _uniqueId;
  90005. private _tempInfluences;
  90006. /**
  90007. * Gets or sets a boolean indicating if normals must be morphed
  90008. */
  90009. enableNormalMorphing: boolean;
  90010. /**
  90011. * Gets or sets a boolean indicating if tangents must be morphed
  90012. */
  90013. enableTangentMorphing: boolean;
  90014. /**
  90015. * Gets or sets a boolean indicating if UV must be morphed
  90016. */
  90017. enableUVMorphing: boolean;
  90018. /**
  90019. * Creates a new MorphTargetManager
  90020. * @param scene defines the current scene
  90021. */
  90022. constructor(scene?: Nullable<Scene>);
  90023. /**
  90024. * Gets the unique ID of this manager
  90025. */
  90026. readonly uniqueId: number;
  90027. /**
  90028. * Gets the number of vertices handled by this manager
  90029. */
  90030. readonly vertexCount: number;
  90031. /**
  90032. * Gets a boolean indicating if this manager supports morphing of normals
  90033. */
  90034. readonly supportsNormals: boolean;
  90035. /**
  90036. * Gets a boolean indicating if this manager supports morphing of tangents
  90037. */
  90038. readonly supportsTangents: boolean;
  90039. /**
  90040. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  90041. */
  90042. readonly supportsUVs: boolean;
  90043. /**
  90044. * Gets the number of targets stored in this manager
  90045. */
  90046. readonly numTargets: number;
  90047. /**
  90048. * Gets the number of influencers (ie. the number of targets with influences > 0)
  90049. */
  90050. readonly numInfluencers: number;
  90051. /**
  90052. * Gets the list of influences (one per target)
  90053. */
  90054. readonly influences: Float32Array;
  90055. /**
  90056. * Gets the active target at specified index. An active target is a target with an influence > 0
  90057. * @param index defines the index to check
  90058. * @returns the requested target
  90059. */
  90060. getActiveTarget(index: number): MorphTarget;
  90061. /**
  90062. * Gets the target at specified index
  90063. * @param index defines the index to check
  90064. * @returns the requested target
  90065. */
  90066. getTarget(index: number): MorphTarget;
  90067. /**
  90068. * Add a new target to this manager
  90069. * @param target defines the target to add
  90070. */
  90071. addTarget(target: MorphTarget): void;
  90072. /**
  90073. * Removes a target from the manager
  90074. * @param target defines the target to remove
  90075. */
  90076. removeTarget(target: MorphTarget): void;
  90077. /**
  90078. * Clone the current manager
  90079. * @returns a new MorphTargetManager
  90080. */
  90081. clone(): MorphTargetManager;
  90082. /**
  90083. * Serializes the current manager into a Serialization object
  90084. * @returns the serialized object
  90085. */
  90086. serialize(): any;
  90087. private _syncActiveTargets;
  90088. /**
  90089. * Syncrhonize the targets with all the meshes using this morph target manager
  90090. */
  90091. synchronize(): void;
  90092. /**
  90093. * Creates a new MorphTargetManager from serialized data
  90094. * @param serializationObject defines the serialized data
  90095. * @param scene defines the hosting scene
  90096. * @returns the new MorphTargetManager
  90097. */
  90098. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  90099. }
  90100. }
  90101. declare module BABYLON {
  90102. /**
  90103. * Class used to represent a specific level of detail of a mesh
  90104. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  90105. */
  90106. export class MeshLODLevel {
  90107. /** Defines the distance where this level should start being displayed */
  90108. distance: number;
  90109. /** Defines the mesh to use to render this level */
  90110. mesh: Nullable<Mesh>;
  90111. /**
  90112. * Creates a new LOD level
  90113. * @param distance defines the distance where this level should star being displayed
  90114. * @param mesh defines the mesh to use to render this level
  90115. */
  90116. constructor(
  90117. /** Defines the distance where this level should start being displayed */
  90118. distance: number,
  90119. /** Defines the mesh to use to render this level */
  90120. mesh: Nullable<Mesh>);
  90121. }
  90122. }
  90123. declare module BABYLON {
  90124. /**
  90125. * Mesh representing the gorund
  90126. */
  90127. export class GroundMesh extends Mesh {
  90128. /** If octree should be generated */
  90129. generateOctree: boolean;
  90130. private _heightQuads;
  90131. /** @hidden */
  90132. _subdivisionsX: number;
  90133. /** @hidden */
  90134. _subdivisionsY: number;
  90135. /** @hidden */
  90136. _width: number;
  90137. /** @hidden */
  90138. _height: number;
  90139. /** @hidden */
  90140. _minX: number;
  90141. /** @hidden */
  90142. _maxX: number;
  90143. /** @hidden */
  90144. _minZ: number;
  90145. /** @hidden */
  90146. _maxZ: number;
  90147. constructor(name: string, scene: Scene);
  90148. /**
  90149. * "GroundMesh"
  90150. * @returns "GroundMesh"
  90151. */
  90152. getClassName(): string;
  90153. /**
  90154. * The minimum of x and y subdivisions
  90155. */
  90156. readonly subdivisions: number;
  90157. /**
  90158. * X subdivisions
  90159. */
  90160. readonly subdivisionsX: number;
  90161. /**
  90162. * Y subdivisions
  90163. */
  90164. readonly subdivisionsY: number;
  90165. /**
  90166. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  90167. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  90168. * @param chunksCount the number of subdivisions for x and y
  90169. * @param octreeBlocksSize (Default: 32)
  90170. */
  90171. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  90172. /**
  90173. * Returns a height (y) value in the Worl system :
  90174. * the ground altitude at the coordinates (x, z) expressed in the World system.
  90175. * @param x x coordinate
  90176. * @param z z coordinate
  90177. * @returns the ground y position if (x, z) are outside the ground surface.
  90178. */
  90179. getHeightAtCoordinates(x: number, z: number): number;
  90180. /**
  90181. * Returns a normalized vector (Vector3) orthogonal to the ground
  90182. * at the ground coordinates (x, z) expressed in the World system.
  90183. * @param x x coordinate
  90184. * @param z z coordinate
  90185. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  90186. */
  90187. getNormalAtCoordinates(x: number, z: number): Vector3;
  90188. /**
  90189. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  90190. * at the ground coordinates (x, z) expressed in the World system.
  90191. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  90192. * @param x x coordinate
  90193. * @param z z coordinate
  90194. * @param ref vector to store the result
  90195. * @returns the GroundMesh.
  90196. */
  90197. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  90198. /**
  90199. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  90200. * if the ground has been updated.
  90201. * This can be used in the render loop.
  90202. * @returns the GroundMesh.
  90203. */
  90204. updateCoordinateHeights(): GroundMesh;
  90205. private _getFacetAt;
  90206. private _initHeightQuads;
  90207. private _computeHeightQuads;
  90208. /**
  90209. * Serializes this ground mesh
  90210. * @param serializationObject object to write serialization to
  90211. */
  90212. serialize(serializationObject: any): void;
  90213. /**
  90214. * Parses a serialized ground mesh
  90215. * @param parsedMesh the serialized mesh
  90216. * @param scene the scene to create the ground mesh in
  90217. * @returns the created ground mesh
  90218. */
  90219. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  90220. }
  90221. }
  90222. declare module BABYLON {
  90223. /**
  90224. * Interface for Physics-Joint data
  90225. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90226. */
  90227. export interface PhysicsJointData {
  90228. /**
  90229. * The main pivot of the joint
  90230. */
  90231. mainPivot?: Vector3;
  90232. /**
  90233. * The connected pivot of the joint
  90234. */
  90235. connectedPivot?: Vector3;
  90236. /**
  90237. * The main axis of the joint
  90238. */
  90239. mainAxis?: Vector3;
  90240. /**
  90241. * The connected axis of the joint
  90242. */
  90243. connectedAxis?: Vector3;
  90244. /**
  90245. * The collision of the joint
  90246. */
  90247. collision?: boolean;
  90248. /**
  90249. * Native Oimo/Cannon/Energy data
  90250. */
  90251. nativeParams?: any;
  90252. }
  90253. /**
  90254. * This is a holder class for the physics joint created by the physics plugin
  90255. * It holds a set of functions to control the underlying joint
  90256. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90257. */
  90258. export class PhysicsJoint {
  90259. /**
  90260. * The type of the physics joint
  90261. */
  90262. type: number;
  90263. /**
  90264. * The data for the physics joint
  90265. */
  90266. jointData: PhysicsJointData;
  90267. private _physicsJoint;
  90268. protected _physicsPlugin: IPhysicsEnginePlugin;
  90269. /**
  90270. * Initializes the physics joint
  90271. * @param type The type of the physics joint
  90272. * @param jointData The data for the physics joint
  90273. */
  90274. constructor(
  90275. /**
  90276. * The type of the physics joint
  90277. */
  90278. type: number,
  90279. /**
  90280. * The data for the physics joint
  90281. */
  90282. jointData: PhysicsJointData);
  90283. /**
  90284. * Gets the physics joint
  90285. */
  90286. /**
  90287. * Sets the physics joint
  90288. */
  90289. physicsJoint: any;
  90290. /**
  90291. * Sets the physics plugin
  90292. */
  90293. physicsPlugin: IPhysicsEnginePlugin;
  90294. /**
  90295. * Execute a function that is physics-plugin specific.
  90296. * @param {Function} func the function that will be executed.
  90297. * It accepts two parameters: the physics world and the physics joint
  90298. */
  90299. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  90300. /**
  90301. * Distance-Joint type
  90302. */
  90303. static DistanceJoint: number;
  90304. /**
  90305. * Hinge-Joint type
  90306. */
  90307. static HingeJoint: number;
  90308. /**
  90309. * Ball-and-Socket joint type
  90310. */
  90311. static BallAndSocketJoint: number;
  90312. /**
  90313. * Wheel-Joint type
  90314. */
  90315. static WheelJoint: number;
  90316. /**
  90317. * Slider-Joint type
  90318. */
  90319. static SliderJoint: number;
  90320. /**
  90321. * Prismatic-Joint type
  90322. */
  90323. static PrismaticJoint: number;
  90324. /**
  90325. * Universal-Joint type
  90326. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  90327. */
  90328. static UniversalJoint: number;
  90329. /**
  90330. * Hinge-Joint 2 type
  90331. */
  90332. static Hinge2Joint: number;
  90333. /**
  90334. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  90335. */
  90336. static PointToPointJoint: number;
  90337. /**
  90338. * Spring-Joint type
  90339. */
  90340. static SpringJoint: number;
  90341. /**
  90342. * Lock-Joint type
  90343. */
  90344. static LockJoint: number;
  90345. }
  90346. /**
  90347. * A class representing a physics distance joint
  90348. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90349. */
  90350. export class DistanceJoint extends PhysicsJoint {
  90351. /**
  90352. *
  90353. * @param jointData The data for the Distance-Joint
  90354. */
  90355. constructor(jointData: DistanceJointData);
  90356. /**
  90357. * Update the predefined distance.
  90358. * @param maxDistance The maximum preferred distance
  90359. * @param minDistance The minimum preferred distance
  90360. */
  90361. updateDistance(maxDistance: number, minDistance?: number): void;
  90362. }
  90363. /**
  90364. * Represents a Motor-Enabled Joint
  90365. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90366. */
  90367. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  90368. /**
  90369. * Initializes the Motor-Enabled Joint
  90370. * @param type The type of the joint
  90371. * @param jointData The physica joint data for the joint
  90372. */
  90373. constructor(type: number, jointData: PhysicsJointData);
  90374. /**
  90375. * Set the motor values.
  90376. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90377. * @param force the force to apply
  90378. * @param maxForce max force for this motor.
  90379. */
  90380. setMotor(force?: number, maxForce?: number): void;
  90381. /**
  90382. * Set the motor's limits.
  90383. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90384. * @param upperLimit The upper limit of the motor
  90385. * @param lowerLimit The lower limit of the motor
  90386. */
  90387. setLimit(upperLimit: number, lowerLimit?: number): void;
  90388. }
  90389. /**
  90390. * This class represents a single physics Hinge-Joint
  90391. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90392. */
  90393. export class HingeJoint extends MotorEnabledJoint {
  90394. /**
  90395. * Initializes the Hinge-Joint
  90396. * @param jointData The joint data for the Hinge-Joint
  90397. */
  90398. constructor(jointData: PhysicsJointData);
  90399. /**
  90400. * Set the motor values.
  90401. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90402. * @param {number} force the force to apply
  90403. * @param {number} maxForce max force for this motor.
  90404. */
  90405. setMotor(force?: number, maxForce?: number): void;
  90406. /**
  90407. * Set the motor's limits.
  90408. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90409. * @param upperLimit The upper limit of the motor
  90410. * @param lowerLimit The lower limit of the motor
  90411. */
  90412. setLimit(upperLimit: number, lowerLimit?: number): void;
  90413. }
  90414. /**
  90415. * This class represents a dual hinge physics joint (same as wheel joint)
  90416. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90417. */
  90418. export class Hinge2Joint extends MotorEnabledJoint {
  90419. /**
  90420. * Initializes the Hinge2-Joint
  90421. * @param jointData The joint data for the Hinge2-Joint
  90422. */
  90423. constructor(jointData: PhysicsJointData);
  90424. /**
  90425. * Set the motor values.
  90426. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90427. * @param {number} targetSpeed the speed the motor is to reach
  90428. * @param {number} maxForce max force for this motor.
  90429. * @param {motorIndex} the motor's index, 0 or 1.
  90430. */
  90431. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  90432. /**
  90433. * Set the motor limits.
  90434. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90435. * @param {number} upperLimit the upper limit
  90436. * @param {number} lowerLimit lower limit
  90437. * @param {motorIndex} the motor's index, 0 or 1.
  90438. */
  90439. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  90440. }
  90441. /**
  90442. * Interface for a motor enabled joint
  90443. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90444. */
  90445. export interface IMotorEnabledJoint {
  90446. /**
  90447. * Physics joint
  90448. */
  90449. physicsJoint: any;
  90450. /**
  90451. * Sets the motor of the motor-enabled joint
  90452. * @param force The force of the motor
  90453. * @param maxForce The maximum force of the motor
  90454. * @param motorIndex The index of the motor
  90455. */
  90456. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  90457. /**
  90458. * Sets the limit of the motor
  90459. * @param upperLimit The upper limit of the motor
  90460. * @param lowerLimit The lower limit of the motor
  90461. * @param motorIndex The index of the motor
  90462. */
  90463. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  90464. }
  90465. /**
  90466. * Joint data for a Distance-Joint
  90467. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90468. */
  90469. export interface DistanceJointData extends PhysicsJointData {
  90470. /**
  90471. * Max distance the 2 joint objects can be apart
  90472. */
  90473. maxDistance: number;
  90474. }
  90475. /**
  90476. * Joint data from a spring joint
  90477. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90478. */
  90479. export interface SpringJointData extends PhysicsJointData {
  90480. /**
  90481. * Length of the spring
  90482. */
  90483. length: number;
  90484. /**
  90485. * Stiffness of the spring
  90486. */
  90487. stiffness: number;
  90488. /**
  90489. * Damping of the spring
  90490. */
  90491. damping: number;
  90492. /** this callback will be called when applying the force to the impostors. */
  90493. forceApplicationCallback: () => void;
  90494. }
  90495. }
  90496. declare module BABYLON {
  90497. /**
  90498. * Holds the data for the raycast result
  90499. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90500. */
  90501. export class PhysicsRaycastResult {
  90502. private _hasHit;
  90503. private _hitDistance;
  90504. private _hitNormalWorld;
  90505. private _hitPointWorld;
  90506. private _rayFromWorld;
  90507. private _rayToWorld;
  90508. /**
  90509. * Gets if there was a hit
  90510. */
  90511. readonly hasHit: boolean;
  90512. /**
  90513. * Gets the distance from the hit
  90514. */
  90515. readonly hitDistance: number;
  90516. /**
  90517. * Gets the hit normal/direction in the world
  90518. */
  90519. readonly hitNormalWorld: Vector3;
  90520. /**
  90521. * Gets the hit point in the world
  90522. */
  90523. readonly hitPointWorld: Vector3;
  90524. /**
  90525. * Gets the ray "start point" of the ray in the world
  90526. */
  90527. readonly rayFromWorld: Vector3;
  90528. /**
  90529. * Gets the ray "end point" of the ray in the world
  90530. */
  90531. readonly rayToWorld: Vector3;
  90532. /**
  90533. * Sets the hit data (normal & point in world space)
  90534. * @param hitNormalWorld defines the normal in world space
  90535. * @param hitPointWorld defines the point in world space
  90536. */
  90537. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  90538. /**
  90539. * Sets the distance from the start point to the hit point
  90540. * @param distance
  90541. */
  90542. setHitDistance(distance: number): void;
  90543. /**
  90544. * Calculates the distance manually
  90545. */
  90546. calculateHitDistance(): void;
  90547. /**
  90548. * Resets all the values to default
  90549. * @param from The from point on world space
  90550. * @param to The to point on world space
  90551. */
  90552. reset(from?: Vector3, to?: Vector3): void;
  90553. }
  90554. /**
  90555. * Interface for the size containing width and height
  90556. */
  90557. interface IXYZ {
  90558. /**
  90559. * X
  90560. */
  90561. x: number;
  90562. /**
  90563. * Y
  90564. */
  90565. y: number;
  90566. /**
  90567. * Z
  90568. */
  90569. z: number;
  90570. }
  90571. }
  90572. declare module BABYLON {
  90573. /**
  90574. * Interface used to describe a physics joint
  90575. */
  90576. export interface PhysicsImpostorJoint {
  90577. /** Defines the main impostor to which the joint is linked */
  90578. mainImpostor: PhysicsImpostor;
  90579. /** Defines the impostor that is connected to the main impostor using this joint */
  90580. connectedImpostor: PhysicsImpostor;
  90581. /** Defines the joint itself */
  90582. joint: PhysicsJoint;
  90583. }
  90584. /** @hidden */
  90585. export interface IPhysicsEnginePlugin {
  90586. world: any;
  90587. name: string;
  90588. setGravity(gravity: Vector3): void;
  90589. setTimeStep(timeStep: number): void;
  90590. getTimeStep(): number;
  90591. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  90592. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  90593. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  90594. generatePhysicsBody(impostor: PhysicsImpostor): void;
  90595. removePhysicsBody(impostor: PhysicsImpostor): void;
  90596. generateJoint(joint: PhysicsImpostorJoint): void;
  90597. removeJoint(joint: PhysicsImpostorJoint): void;
  90598. isSupported(): boolean;
  90599. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  90600. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  90601. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  90602. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  90603. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  90604. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  90605. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  90606. getBodyMass(impostor: PhysicsImpostor): number;
  90607. getBodyFriction(impostor: PhysicsImpostor): number;
  90608. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  90609. getBodyRestitution(impostor: PhysicsImpostor): number;
  90610. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  90611. getBodyPressure?(impostor: PhysicsImpostor): number;
  90612. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  90613. getBodyStiffness?(impostor: PhysicsImpostor): number;
  90614. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  90615. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  90616. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  90617. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  90618. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  90619. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  90620. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  90621. sleepBody(impostor: PhysicsImpostor): void;
  90622. wakeUpBody(impostor: PhysicsImpostor): void;
  90623. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  90624. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  90625. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  90626. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  90627. getRadius(impostor: PhysicsImpostor): number;
  90628. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  90629. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  90630. dispose(): void;
  90631. }
  90632. /**
  90633. * Interface used to define a physics engine
  90634. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  90635. */
  90636. export interface IPhysicsEngine {
  90637. /**
  90638. * Gets the gravity vector used by the simulation
  90639. */
  90640. gravity: Vector3;
  90641. /**
  90642. * Sets the gravity vector used by the simulation
  90643. * @param gravity defines the gravity vector to use
  90644. */
  90645. setGravity(gravity: Vector3): void;
  90646. /**
  90647. * Set the time step of the physics engine.
  90648. * Default is 1/60.
  90649. * To slow it down, enter 1/600 for example.
  90650. * To speed it up, 1/30
  90651. * @param newTimeStep the new timestep to apply to this world.
  90652. */
  90653. setTimeStep(newTimeStep: number): void;
  90654. /**
  90655. * Get the time step of the physics engine.
  90656. * @returns the current time step
  90657. */
  90658. getTimeStep(): number;
  90659. /**
  90660. * Release all resources
  90661. */
  90662. dispose(): void;
  90663. /**
  90664. * Gets the name of the current physics plugin
  90665. * @returns the name of the plugin
  90666. */
  90667. getPhysicsPluginName(): string;
  90668. /**
  90669. * Adding a new impostor for the impostor tracking.
  90670. * This will be done by the impostor itself.
  90671. * @param impostor the impostor to add
  90672. */
  90673. addImpostor(impostor: PhysicsImpostor): void;
  90674. /**
  90675. * Remove an impostor from the engine.
  90676. * This impostor and its mesh will not longer be updated by the physics engine.
  90677. * @param impostor the impostor to remove
  90678. */
  90679. removeImpostor(impostor: PhysicsImpostor): void;
  90680. /**
  90681. * Add a joint to the physics engine
  90682. * @param mainImpostor defines the main impostor to which the joint is added.
  90683. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  90684. * @param joint defines the joint that will connect both impostors.
  90685. */
  90686. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  90687. /**
  90688. * Removes a joint from the simulation
  90689. * @param mainImpostor defines the impostor used with the joint
  90690. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  90691. * @param joint defines the joint to remove
  90692. */
  90693. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  90694. /**
  90695. * Gets the current plugin used to run the simulation
  90696. * @returns current plugin
  90697. */
  90698. getPhysicsPlugin(): IPhysicsEnginePlugin;
  90699. /**
  90700. * Gets the list of physic impostors
  90701. * @returns an array of PhysicsImpostor
  90702. */
  90703. getImpostors(): Array<PhysicsImpostor>;
  90704. /**
  90705. * Gets the impostor for a physics enabled object
  90706. * @param object defines the object impersonated by the impostor
  90707. * @returns the PhysicsImpostor or null if not found
  90708. */
  90709. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  90710. /**
  90711. * Gets the impostor for a physics body object
  90712. * @param body defines physics body used by the impostor
  90713. * @returns the PhysicsImpostor or null if not found
  90714. */
  90715. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  90716. /**
  90717. * Does a raycast in the physics world
  90718. * @param from when should the ray start?
  90719. * @param to when should the ray end?
  90720. * @returns PhysicsRaycastResult
  90721. */
  90722. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  90723. /**
  90724. * Called by the scene. No need to call it.
  90725. * @param delta defines the timespam between frames
  90726. */
  90727. _step(delta: number): void;
  90728. }
  90729. }
  90730. declare module BABYLON {
  90731. /**
  90732. * The interface for the physics imposter parameters
  90733. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90734. */
  90735. export interface PhysicsImpostorParameters {
  90736. /**
  90737. * The mass of the physics imposter
  90738. */
  90739. mass: number;
  90740. /**
  90741. * The friction of the physics imposter
  90742. */
  90743. friction?: number;
  90744. /**
  90745. * The coefficient of restitution of the physics imposter
  90746. */
  90747. restitution?: number;
  90748. /**
  90749. * The native options of the physics imposter
  90750. */
  90751. nativeOptions?: any;
  90752. /**
  90753. * Specifies if the parent should be ignored
  90754. */
  90755. ignoreParent?: boolean;
  90756. /**
  90757. * Specifies if bi-directional transformations should be disabled
  90758. */
  90759. disableBidirectionalTransformation?: boolean;
  90760. /**
  90761. * The pressure inside the physics imposter, soft object only
  90762. */
  90763. pressure?: number;
  90764. /**
  90765. * The stiffness the physics imposter, soft object only
  90766. */
  90767. stiffness?: number;
  90768. /**
  90769. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  90770. */
  90771. velocityIterations?: number;
  90772. /**
  90773. * The number of iterations used in maintaining consistent vertex positions, soft object only
  90774. */
  90775. positionIterations?: number;
  90776. /**
  90777. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  90778. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  90779. * Add to fix multiple points
  90780. */
  90781. fixedPoints?: number;
  90782. /**
  90783. * The collision margin around a soft object
  90784. */
  90785. margin?: number;
  90786. /**
  90787. * The collision margin around a soft object
  90788. */
  90789. damping?: number;
  90790. /**
  90791. * The path for a rope based on an extrusion
  90792. */
  90793. path?: any;
  90794. /**
  90795. * The shape of an extrusion used for a rope based on an extrusion
  90796. */
  90797. shape?: any;
  90798. }
  90799. /**
  90800. * Interface for a physics-enabled object
  90801. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90802. */
  90803. export interface IPhysicsEnabledObject {
  90804. /**
  90805. * The position of the physics-enabled object
  90806. */
  90807. position: Vector3;
  90808. /**
  90809. * The rotation of the physics-enabled object
  90810. */
  90811. rotationQuaternion: Nullable<Quaternion>;
  90812. /**
  90813. * The scale of the physics-enabled object
  90814. */
  90815. scaling: Vector3;
  90816. /**
  90817. * The rotation of the physics-enabled object
  90818. */
  90819. rotation?: Vector3;
  90820. /**
  90821. * The parent of the physics-enabled object
  90822. */
  90823. parent?: any;
  90824. /**
  90825. * The bounding info of the physics-enabled object
  90826. * @returns The bounding info of the physics-enabled object
  90827. */
  90828. getBoundingInfo(): BoundingInfo;
  90829. /**
  90830. * Computes the world matrix
  90831. * @param force Specifies if the world matrix should be computed by force
  90832. * @returns A world matrix
  90833. */
  90834. computeWorldMatrix(force: boolean): Matrix;
  90835. /**
  90836. * Gets the world matrix
  90837. * @returns A world matrix
  90838. */
  90839. getWorldMatrix?(): Matrix;
  90840. /**
  90841. * Gets the child meshes
  90842. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  90843. * @returns An array of abstract meshes
  90844. */
  90845. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  90846. /**
  90847. * Gets the vertex data
  90848. * @param kind The type of vertex data
  90849. * @returns A nullable array of numbers, or a float32 array
  90850. */
  90851. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  90852. /**
  90853. * Gets the indices from the mesh
  90854. * @returns A nullable array of index arrays
  90855. */
  90856. getIndices?(): Nullable<IndicesArray>;
  90857. /**
  90858. * Gets the scene from the mesh
  90859. * @returns the indices array or null
  90860. */
  90861. getScene?(): Scene;
  90862. /**
  90863. * Gets the absolute position from the mesh
  90864. * @returns the absolute position
  90865. */
  90866. getAbsolutePosition(): Vector3;
  90867. /**
  90868. * Gets the absolute pivot point from the mesh
  90869. * @returns the absolute pivot point
  90870. */
  90871. getAbsolutePivotPoint(): Vector3;
  90872. /**
  90873. * Rotates the mesh
  90874. * @param axis The axis of rotation
  90875. * @param amount The amount of rotation
  90876. * @param space The space of the rotation
  90877. * @returns The rotation transform node
  90878. */
  90879. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  90880. /**
  90881. * Translates the mesh
  90882. * @param axis The axis of translation
  90883. * @param distance The distance of translation
  90884. * @param space The space of the translation
  90885. * @returns The transform node
  90886. */
  90887. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  90888. /**
  90889. * Sets the absolute position of the mesh
  90890. * @param absolutePosition The absolute position of the mesh
  90891. * @returns The transform node
  90892. */
  90893. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  90894. /**
  90895. * Gets the class name of the mesh
  90896. * @returns The class name
  90897. */
  90898. getClassName(): string;
  90899. }
  90900. /**
  90901. * Represents a physics imposter
  90902. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90903. */
  90904. export class PhysicsImpostor {
  90905. /**
  90906. * The physics-enabled object used as the physics imposter
  90907. */
  90908. object: IPhysicsEnabledObject;
  90909. /**
  90910. * The type of the physics imposter
  90911. */
  90912. type: number;
  90913. private _options;
  90914. private _scene?;
  90915. /**
  90916. * The default object size of the imposter
  90917. */
  90918. static DEFAULT_OBJECT_SIZE: Vector3;
  90919. /**
  90920. * The identity quaternion of the imposter
  90921. */
  90922. static IDENTITY_QUATERNION: Quaternion;
  90923. /** @hidden */
  90924. _pluginData: any;
  90925. private _physicsEngine;
  90926. private _physicsBody;
  90927. private _bodyUpdateRequired;
  90928. private _onBeforePhysicsStepCallbacks;
  90929. private _onAfterPhysicsStepCallbacks;
  90930. /** @hidden */
  90931. _onPhysicsCollideCallbacks: Array<{
  90932. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  90933. otherImpostors: Array<PhysicsImpostor>;
  90934. }>;
  90935. private _deltaPosition;
  90936. private _deltaRotation;
  90937. private _deltaRotationConjugated;
  90938. /** @hidden */
  90939. _isFromLine: boolean;
  90940. private _parent;
  90941. private _isDisposed;
  90942. private static _tmpVecs;
  90943. private static _tmpQuat;
  90944. /**
  90945. * Specifies if the physics imposter is disposed
  90946. */
  90947. readonly isDisposed: boolean;
  90948. /**
  90949. * Gets the mass of the physics imposter
  90950. */
  90951. mass: number;
  90952. /**
  90953. * Gets the coefficient of friction
  90954. */
  90955. /**
  90956. * Sets the coefficient of friction
  90957. */
  90958. friction: number;
  90959. /**
  90960. * Gets the coefficient of restitution
  90961. */
  90962. /**
  90963. * Sets the coefficient of restitution
  90964. */
  90965. restitution: number;
  90966. /**
  90967. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  90968. */
  90969. /**
  90970. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  90971. */
  90972. pressure: number;
  90973. /**
  90974. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  90975. */
  90976. /**
  90977. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  90978. */
  90979. stiffness: number;
  90980. /**
  90981. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  90982. */
  90983. /**
  90984. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  90985. */
  90986. velocityIterations: number;
  90987. /**
  90988. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  90989. */
  90990. /**
  90991. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  90992. */
  90993. positionIterations: number;
  90994. /**
  90995. * The unique id of the physics imposter
  90996. * set by the physics engine when adding this impostor to the array
  90997. */
  90998. uniqueId: number;
  90999. /**
  91000. * @hidden
  91001. */
  91002. soft: boolean;
  91003. /**
  91004. * @hidden
  91005. */
  91006. segments: number;
  91007. private _joints;
  91008. /**
  91009. * Initializes the physics imposter
  91010. * @param object The physics-enabled object used as the physics imposter
  91011. * @param type The type of the physics imposter
  91012. * @param _options The options for the physics imposter
  91013. * @param _scene The Babylon scene
  91014. */
  91015. constructor(
  91016. /**
  91017. * The physics-enabled object used as the physics imposter
  91018. */
  91019. object: IPhysicsEnabledObject,
  91020. /**
  91021. * The type of the physics imposter
  91022. */
  91023. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  91024. /**
  91025. * This function will completly initialize this impostor.
  91026. * It will create a new body - but only if this mesh has no parent.
  91027. * If it has, this impostor will not be used other than to define the impostor
  91028. * of the child mesh.
  91029. * @hidden
  91030. */
  91031. _init(): void;
  91032. private _getPhysicsParent;
  91033. /**
  91034. * Should a new body be generated.
  91035. * @returns boolean specifying if body initialization is required
  91036. */
  91037. isBodyInitRequired(): boolean;
  91038. /**
  91039. * Sets the updated scaling
  91040. * @param updated Specifies if the scaling is updated
  91041. */
  91042. setScalingUpdated(): void;
  91043. /**
  91044. * Force a regeneration of this or the parent's impostor's body.
  91045. * Use under cautious - This will remove all joints already implemented.
  91046. */
  91047. forceUpdate(): void;
  91048. /**
  91049. * Gets the body that holds this impostor. Either its own, or its parent.
  91050. */
  91051. /**
  91052. * Set the physics body. Used mainly by the physics engine/plugin
  91053. */
  91054. physicsBody: any;
  91055. /**
  91056. * Get the parent of the physics imposter
  91057. * @returns Physics imposter or null
  91058. */
  91059. /**
  91060. * Sets the parent of the physics imposter
  91061. */
  91062. parent: Nullable<PhysicsImpostor>;
  91063. /**
  91064. * Resets the update flags
  91065. */
  91066. resetUpdateFlags(): void;
  91067. /**
  91068. * Gets the object extend size
  91069. * @returns the object extend size
  91070. */
  91071. getObjectExtendSize(): Vector3;
  91072. /**
  91073. * Gets the object center
  91074. * @returns The object center
  91075. */
  91076. getObjectCenter(): Vector3;
  91077. /**
  91078. * Get a specific parametes from the options parameter
  91079. * @param paramName The object parameter name
  91080. * @returns The object parameter
  91081. */
  91082. getParam(paramName: string): any;
  91083. /**
  91084. * Sets a specific parameter in the options given to the physics plugin
  91085. * @param paramName The parameter name
  91086. * @param value The value of the parameter
  91087. */
  91088. setParam(paramName: string, value: number): void;
  91089. /**
  91090. * Specifically change the body's mass option. Won't recreate the physics body object
  91091. * @param mass The mass of the physics imposter
  91092. */
  91093. setMass(mass: number): void;
  91094. /**
  91095. * Gets the linear velocity
  91096. * @returns linear velocity or null
  91097. */
  91098. getLinearVelocity(): Nullable<Vector3>;
  91099. /**
  91100. * Sets the linear velocity
  91101. * @param velocity linear velocity or null
  91102. */
  91103. setLinearVelocity(velocity: Nullable<Vector3>): void;
  91104. /**
  91105. * Gets the angular velocity
  91106. * @returns angular velocity or null
  91107. */
  91108. getAngularVelocity(): Nullable<Vector3>;
  91109. /**
  91110. * Sets the angular velocity
  91111. * @param velocity The velocity or null
  91112. */
  91113. setAngularVelocity(velocity: Nullable<Vector3>): void;
  91114. /**
  91115. * Execute a function with the physics plugin native code
  91116. * Provide a function the will have two variables - the world object and the physics body object
  91117. * @param func The function to execute with the physics plugin native code
  91118. */
  91119. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  91120. /**
  91121. * Register a function that will be executed before the physics world is stepping forward
  91122. * @param func The function to execute before the physics world is stepped forward
  91123. */
  91124. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91125. /**
  91126. * Unregister a function that will be executed before the physics world is stepping forward
  91127. * @param func The function to execute before the physics world is stepped forward
  91128. */
  91129. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91130. /**
  91131. * Register a function that will be executed after the physics step
  91132. * @param func The function to execute after physics step
  91133. */
  91134. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91135. /**
  91136. * Unregisters a function that will be executed after the physics step
  91137. * @param func The function to execute after physics step
  91138. */
  91139. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91140. /**
  91141. * register a function that will be executed when this impostor collides against a different body
  91142. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  91143. * @param func Callback that is executed on collision
  91144. */
  91145. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  91146. /**
  91147. * Unregisters the physics imposter on contact
  91148. * @param collideAgainst The physics object to collide against
  91149. * @param func Callback to execute on collision
  91150. */
  91151. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  91152. private _tmpQuat;
  91153. private _tmpQuat2;
  91154. /**
  91155. * Get the parent rotation
  91156. * @returns The parent rotation
  91157. */
  91158. getParentsRotation(): Quaternion;
  91159. /**
  91160. * this function is executed by the physics engine.
  91161. */
  91162. beforeStep: () => void;
  91163. /**
  91164. * this function is executed by the physics engine
  91165. */
  91166. afterStep: () => void;
  91167. /**
  91168. * Legacy collision detection event support
  91169. */
  91170. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  91171. /**
  91172. * event and body object due to cannon's event-based architecture.
  91173. */
  91174. onCollide: (e: {
  91175. body: any;
  91176. }) => void;
  91177. /**
  91178. * Apply a force
  91179. * @param force The force to apply
  91180. * @param contactPoint The contact point for the force
  91181. * @returns The physics imposter
  91182. */
  91183. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  91184. /**
  91185. * Apply an impulse
  91186. * @param force The impulse force
  91187. * @param contactPoint The contact point for the impulse force
  91188. * @returns The physics imposter
  91189. */
  91190. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  91191. /**
  91192. * A help function to create a joint
  91193. * @param otherImpostor A physics imposter used to create a joint
  91194. * @param jointType The type of joint
  91195. * @param jointData The data for the joint
  91196. * @returns The physics imposter
  91197. */
  91198. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  91199. /**
  91200. * Add a joint to this impostor with a different impostor
  91201. * @param otherImpostor A physics imposter used to add a joint
  91202. * @param joint The joint to add
  91203. * @returns The physics imposter
  91204. */
  91205. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  91206. /**
  91207. * Add an anchor to a cloth impostor
  91208. * @param otherImpostor rigid impostor to anchor to
  91209. * @param width ratio across width from 0 to 1
  91210. * @param height ratio up height from 0 to 1
  91211. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  91212. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  91213. * @returns impostor the soft imposter
  91214. */
  91215. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  91216. /**
  91217. * Add a hook to a rope impostor
  91218. * @param otherImpostor rigid impostor to anchor to
  91219. * @param length ratio across rope from 0 to 1
  91220. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  91221. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  91222. * @returns impostor the rope imposter
  91223. */
  91224. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  91225. /**
  91226. * Will keep this body still, in a sleep mode.
  91227. * @returns the physics imposter
  91228. */
  91229. sleep(): PhysicsImpostor;
  91230. /**
  91231. * Wake the body up.
  91232. * @returns The physics imposter
  91233. */
  91234. wakeUp(): PhysicsImpostor;
  91235. /**
  91236. * Clones the physics imposter
  91237. * @param newObject The physics imposter clones to this physics-enabled object
  91238. * @returns A nullable physics imposter
  91239. */
  91240. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  91241. /**
  91242. * Disposes the physics imposter
  91243. */
  91244. dispose(): void;
  91245. /**
  91246. * Sets the delta position
  91247. * @param position The delta position amount
  91248. */
  91249. setDeltaPosition(position: Vector3): void;
  91250. /**
  91251. * Sets the delta rotation
  91252. * @param rotation The delta rotation amount
  91253. */
  91254. setDeltaRotation(rotation: Quaternion): void;
  91255. /**
  91256. * Gets the box size of the physics imposter and stores the result in the input parameter
  91257. * @param result Stores the box size
  91258. * @returns The physics imposter
  91259. */
  91260. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  91261. /**
  91262. * Gets the radius of the physics imposter
  91263. * @returns Radius of the physics imposter
  91264. */
  91265. getRadius(): number;
  91266. /**
  91267. * Sync a bone with this impostor
  91268. * @param bone The bone to sync to the impostor.
  91269. * @param boneMesh The mesh that the bone is influencing.
  91270. * @param jointPivot The pivot of the joint / bone in local space.
  91271. * @param distToJoint Optional distance from the impostor to the joint.
  91272. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  91273. */
  91274. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  91275. /**
  91276. * Sync impostor to a bone
  91277. * @param bone The bone that the impostor will be synced to.
  91278. * @param boneMesh The mesh that the bone is influencing.
  91279. * @param jointPivot The pivot of the joint / bone in local space.
  91280. * @param distToJoint Optional distance from the impostor to the joint.
  91281. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  91282. * @param boneAxis Optional vector3 axis the bone is aligned with
  91283. */
  91284. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  91285. /**
  91286. * No-Imposter type
  91287. */
  91288. static NoImpostor: number;
  91289. /**
  91290. * Sphere-Imposter type
  91291. */
  91292. static SphereImpostor: number;
  91293. /**
  91294. * Box-Imposter type
  91295. */
  91296. static BoxImpostor: number;
  91297. /**
  91298. * Plane-Imposter type
  91299. */
  91300. static PlaneImpostor: number;
  91301. /**
  91302. * Mesh-imposter type
  91303. */
  91304. static MeshImpostor: number;
  91305. /**
  91306. * Capsule-Impostor type (Ammo.js plugin only)
  91307. */
  91308. static CapsuleImpostor: number;
  91309. /**
  91310. * Cylinder-Imposter type
  91311. */
  91312. static CylinderImpostor: number;
  91313. /**
  91314. * Particle-Imposter type
  91315. */
  91316. static ParticleImpostor: number;
  91317. /**
  91318. * Heightmap-Imposter type
  91319. */
  91320. static HeightmapImpostor: number;
  91321. /**
  91322. * ConvexHull-Impostor type (Ammo.js plugin only)
  91323. */
  91324. static ConvexHullImpostor: number;
  91325. /**
  91326. * Rope-Imposter type
  91327. */
  91328. static RopeImpostor: number;
  91329. /**
  91330. * Cloth-Imposter type
  91331. */
  91332. static ClothImpostor: number;
  91333. /**
  91334. * Softbody-Imposter type
  91335. */
  91336. static SoftbodyImpostor: number;
  91337. }
  91338. }
  91339. declare module BABYLON {
  91340. /**
  91341. * @hidden
  91342. **/
  91343. export class _CreationDataStorage {
  91344. closePath?: boolean;
  91345. closeArray?: boolean;
  91346. idx: number[];
  91347. dashSize: number;
  91348. gapSize: number;
  91349. path3D: Path3D;
  91350. pathArray: Vector3[][];
  91351. arc: number;
  91352. radius: number;
  91353. cap: number;
  91354. tessellation: number;
  91355. }
  91356. /**
  91357. * @hidden
  91358. **/
  91359. class _InstanceDataStorage {
  91360. visibleInstances: any;
  91361. batchCache: _InstancesBatch;
  91362. instancesBufferSize: number;
  91363. instancesBuffer: Nullable<Buffer>;
  91364. instancesData: Float32Array;
  91365. overridenInstanceCount: number;
  91366. isFrozen: boolean;
  91367. previousBatch: Nullable<_InstancesBatch>;
  91368. hardwareInstancedRendering: boolean;
  91369. sideOrientation: number;
  91370. }
  91371. /**
  91372. * @hidden
  91373. **/
  91374. export class _InstancesBatch {
  91375. mustReturn: boolean;
  91376. visibleInstances: Nullable<InstancedMesh[]>[];
  91377. renderSelf: boolean[];
  91378. hardwareInstancedRendering: boolean[];
  91379. }
  91380. /**
  91381. * Class used to represent renderable models
  91382. */
  91383. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  91384. /**
  91385. * Mesh side orientation : usually the external or front surface
  91386. */
  91387. static readonly FRONTSIDE: number;
  91388. /**
  91389. * Mesh side orientation : usually the internal or back surface
  91390. */
  91391. static readonly BACKSIDE: number;
  91392. /**
  91393. * Mesh side orientation : both internal and external or front and back surfaces
  91394. */
  91395. static readonly DOUBLESIDE: number;
  91396. /**
  91397. * Mesh side orientation : by default, `FRONTSIDE`
  91398. */
  91399. static readonly DEFAULTSIDE: number;
  91400. /**
  91401. * Mesh cap setting : no cap
  91402. */
  91403. static readonly NO_CAP: number;
  91404. /**
  91405. * Mesh cap setting : one cap at the beginning of the mesh
  91406. */
  91407. static readonly CAP_START: number;
  91408. /**
  91409. * Mesh cap setting : one cap at the end of the mesh
  91410. */
  91411. static readonly CAP_END: number;
  91412. /**
  91413. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  91414. */
  91415. static readonly CAP_ALL: number;
  91416. /**
  91417. * Mesh pattern setting : no flip or rotate
  91418. */
  91419. static readonly NO_FLIP: number;
  91420. /**
  91421. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  91422. */
  91423. static readonly FLIP_TILE: number;
  91424. /**
  91425. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  91426. */
  91427. static readonly ROTATE_TILE: number;
  91428. /**
  91429. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  91430. */
  91431. static readonly FLIP_ROW: number;
  91432. /**
  91433. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  91434. */
  91435. static readonly ROTATE_ROW: number;
  91436. /**
  91437. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  91438. */
  91439. static readonly FLIP_N_ROTATE_TILE: number;
  91440. /**
  91441. * Mesh pattern setting : rotate pattern and rotate
  91442. */
  91443. static readonly FLIP_N_ROTATE_ROW: number;
  91444. /**
  91445. * Mesh tile positioning : part tiles same on left/right or top/bottom
  91446. */
  91447. static readonly CENTER: number;
  91448. /**
  91449. * Mesh tile positioning : part tiles on left
  91450. */
  91451. static readonly LEFT: number;
  91452. /**
  91453. * Mesh tile positioning : part tiles on right
  91454. */
  91455. static readonly RIGHT: number;
  91456. /**
  91457. * Mesh tile positioning : part tiles on top
  91458. */
  91459. static readonly TOP: number;
  91460. /**
  91461. * Mesh tile positioning : part tiles on bottom
  91462. */
  91463. static readonly BOTTOM: number;
  91464. /**
  91465. * Gets the default side orientation.
  91466. * @param orientation the orientation to value to attempt to get
  91467. * @returns the default orientation
  91468. * @hidden
  91469. */
  91470. static _GetDefaultSideOrientation(orientation?: number): number;
  91471. private _internalMeshDataInfo;
  91472. /**
  91473. * An event triggered before rendering the mesh
  91474. */
  91475. readonly onBeforeRenderObservable: Observable<Mesh>;
  91476. /**
  91477. * An event triggered before binding the mesh
  91478. */
  91479. readonly onBeforeBindObservable: Observable<Mesh>;
  91480. /**
  91481. * An event triggered after rendering the mesh
  91482. */
  91483. readonly onAfterRenderObservable: Observable<Mesh>;
  91484. /**
  91485. * An event triggered before drawing the mesh
  91486. */
  91487. readonly onBeforeDrawObservable: Observable<Mesh>;
  91488. private _onBeforeDrawObserver;
  91489. /**
  91490. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  91491. */
  91492. onBeforeDraw: () => void;
  91493. readonly hasInstances: boolean;
  91494. /**
  91495. * Gets the delay loading state of the mesh (when delay loading is turned on)
  91496. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  91497. */
  91498. delayLoadState: number;
  91499. /**
  91500. * Gets the list of instances created from this mesh
  91501. * it is not supposed to be modified manually.
  91502. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  91503. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  91504. */
  91505. instances: InstancedMesh[];
  91506. /**
  91507. * Gets the file containing delay loading data for this mesh
  91508. */
  91509. delayLoadingFile: string;
  91510. /** @hidden */
  91511. _binaryInfo: any;
  91512. /**
  91513. * User defined function used to change how LOD level selection is done
  91514. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  91515. */
  91516. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  91517. /**
  91518. * Gets or sets the morph target manager
  91519. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  91520. */
  91521. morphTargetManager: Nullable<MorphTargetManager>;
  91522. /** @hidden */
  91523. _creationDataStorage: Nullable<_CreationDataStorage>;
  91524. /** @hidden */
  91525. _geometry: Nullable<Geometry>;
  91526. /** @hidden */
  91527. _delayInfo: Array<string>;
  91528. /** @hidden */
  91529. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  91530. /** @hidden */
  91531. _instanceDataStorage: _InstanceDataStorage;
  91532. private _effectiveMaterial;
  91533. /** @hidden */
  91534. _shouldGenerateFlatShading: boolean;
  91535. /** @hidden */
  91536. _originalBuilderSideOrientation: number;
  91537. /**
  91538. * Use this property to change the original side orientation defined at construction time
  91539. */
  91540. overrideMaterialSideOrientation: Nullable<number>;
  91541. /**
  91542. * Gets the source mesh (the one used to clone this one from)
  91543. */
  91544. readonly source: Nullable<Mesh>;
  91545. /**
  91546. * Gets or sets a boolean indicating that this mesh does not use index buffer
  91547. */
  91548. isUnIndexed: boolean;
  91549. /**
  91550. * @constructor
  91551. * @param name The value used by scene.getMeshByName() to do a lookup.
  91552. * @param scene The scene to add this mesh to.
  91553. * @param parent The parent of this mesh, if it has one
  91554. * @param source An optional Mesh from which geometry is shared, cloned.
  91555. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  91556. * When false, achieved by calling a clone(), also passing False.
  91557. * This will make creation of children, recursive.
  91558. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  91559. */
  91560. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  91561. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  91562. doNotInstantiate: boolean;
  91563. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  91564. /**
  91565. * Gets the class name
  91566. * @returns the string "Mesh".
  91567. */
  91568. getClassName(): string;
  91569. /** @hidden */
  91570. readonly _isMesh: boolean;
  91571. /**
  91572. * Returns a description of this mesh
  91573. * @param fullDetails define if full details about this mesh must be used
  91574. * @returns a descriptive string representing this mesh
  91575. */
  91576. toString(fullDetails?: boolean): string;
  91577. /** @hidden */
  91578. _unBindEffect(): void;
  91579. /**
  91580. * Gets a boolean indicating if this mesh has LOD
  91581. */
  91582. readonly hasLODLevels: boolean;
  91583. /**
  91584. * Gets the list of MeshLODLevel associated with the current mesh
  91585. * @returns an array of MeshLODLevel
  91586. */
  91587. getLODLevels(): MeshLODLevel[];
  91588. private _sortLODLevels;
  91589. /**
  91590. * Add a mesh as LOD level triggered at the given distance.
  91591. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91592. * @param distance The distance from the center of the object to show this level
  91593. * @param mesh The mesh to be added as LOD level (can be null)
  91594. * @return This mesh (for chaining)
  91595. */
  91596. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  91597. /**
  91598. * Returns the LOD level mesh at the passed distance or null if not found.
  91599. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91600. * @param distance The distance from the center of the object to show this level
  91601. * @returns a Mesh or `null`
  91602. */
  91603. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  91604. /**
  91605. * Remove a mesh from the LOD array
  91606. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91607. * @param mesh defines the mesh to be removed
  91608. * @return This mesh (for chaining)
  91609. */
  91610. removeLODLevel(mesh: Mesh): Mesh;
  91611. /**
  91612. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  91613. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91614. * @param camera defines the camera to use to compute distance
  91615. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  91616. * @return This mesh (for chaining)
  91617. */
  91618. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  91619. /**
  91620. * Gets the mesh internal Geometry object
  91621. */
  91622. readonly geometry: Nullable<Geometry>;
  91623. /**
  91624. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  91625. * @returns the total number of vertices
  91626. */
  91627. getTotalVertices(): number;
  91628. /**
  91629. * Returns the content of an associated vertex buffer
  91630. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  91631. * - VertexBuffer.PositionKind
  91632. * - VertexBuffer.UVKind
  91633. * - VertexBuffer.UV2Kind
  91634. * - VertexBuffer.UV3Kind
  91635. * - VertexBuffer.UV4Kind
  91636. * - VertexBuffer.UV5Kind
  91637. * - VertexBuffer.UV6Kind
  91638. * - VertexBuffer.ColorKind
  91639. * - VertexBuffer.MatricesIndicesKind
  91640. * - VertexBuffer.MatricesIndicesExtraKind
  91641. * - VertexBuffer.MatricesWeightsKind
  91642. * - VertexBuffer.MatricesWeightsExtraKind
  91643. * @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
  91644. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  91645. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  91646. */
  91647. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  91648. /**
  91649. * Returns the mesh VertexBuffer object from the requested `kind`
  91650. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  91651. * - VertexBuffer.PositionKind
  91652. * - VertexBuffer.NormalKind
  91653. * - VertexBuffer.UVKind
  91654. * - VertexBuffer.UV2Kind
  91655. * - VertexBuffer.UV3Kind
  91656. * - VertexBuffer.UV4Kind
  91657. * - VertexBuffer.UV5Kind
  91658. * - VertexBuffer.UV6Kind
  91659. * - VertexBuffer.ColorKind
  91660. * - VertexBuffer.MatricesIndicesKind
  91661. * - VertexBuffer.MatricesIndicesExtraKind
  91662. * - VertexBuffer.MatricesWeightsKind
  91663. * - VertexBuffer.MatricesWeightsExtraKind
  91664. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  91665. */
  91666. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  91667. /**
  91668. * Tests if a specific vertex buffer is associated with this mesh
  91669. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  91670. * - VertexBuffer.PositionKind
  91671. * - VertexBuffer.NormalKind
  91672. * - VertexBuffer.UVKind
  91673. * - VertexBuffer.UV2Kind
  91674. * - VertexBuffer.UV3Kind
  91675. * - VertexBuffer.UV4Kind
  91676. * - VertexBuffer.UV5Kind
  91677. * - VertexBuffer.UV6Kind
  91678. * - VertexBuffer.ColorKind
  91679. * - VertexBuffer.MatricesIndicesKind
  91680. * - VertexBuffer.MatricesIndicesExtraKind
  91681. * - VertexBuffer.MatricesWeightsKind
  91682. * - VertexBuffer.MatricesWeightsExtraKind
  91683. * @returns a boolean
  91684. */
  91685. isVerticesDataPresent(kind: string): boolean;
  91686. /**
  91687. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  91688. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  91689. * - VertexBuffer.PositionKind
  91690. * - VertexBuffer.UVKind
  91691. * - VertexBuffer.UV2Kind
  91692. * - VertexBuffer.UV3Kind
  91693. * - VertexBuffer.UV4Kind
  91694. * - VertexBuffer.UV5Kind
  91695. * - VertexBuffer.UV6Kind
  91696. * - VertexBuffer.ColorKind
  91697. * - VertexBuffer.MatricesIndicesKind
  91698. * - VertexBuffer.MatricesIndicesExtraKind
  91699. * - VertexBuffer.MatricesWeightsKind
  91700. * - VertexBuffer.MatricesWeightsExtraKind
  91701. * @returns a boolean
  91702. */
  91703. isVertexBufferUpdatable(kind: string): boolean;
  91704. /**
  91705. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  91706. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  91707. * - VertexBuffer.PositionKind
  91708. * - VertexBuffer.NormalKind
  91709. * - VertexBuffer.UVKind
  91710. * - VertexBuffer.UV2Kind
  91711. * - VertexBuffer.UV3Kind
  91712. * - VertexBuffer.UV4Kind
  91713. * - VertexBuffer.UV5Kind
  91714. * - VertexBuffer.UV6Kind
  91715. * - VertexBuffer.ColorKind
  91716. * - VertexBuffer.MatricesIndicesKind
  91717. * - VertexBuffer.MatricesIndicesExtraKind
  91718. * - VertexBuffer.MatricesWeightsKind
  91719. * - VertexBuffer.MatricesWeightsExtraKind
  91720. * @returns an array of strings
  91721. */
  91722. getVerticesDataKinds(): string[];
  91723. /**
  91724. * Returns a positive integer : the total number of indices in this mesh geometry.
  91725. * @returns the numner of indices or zero if the mesh has no geometry.
  91726. */
  91727. getTotalIndices(): number;
  91728. /**
  91729. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  91730. * @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.
  91731. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  91732. * @returns the indices array or an empty array if the mesh has no geometry
  91733. */
  91734. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  91735. readonly isBlocked: boolean;
  91736. /**
  91737. * Determine if the current mesh is ready to be rendered
  91738. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  91739. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  91740. * @returns true if all associated assets are ready (material, textures, shaders)
  91741. */
  91742. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  91743. /**
  91744. * 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.
  91745. */
  91746. readonly areNormalsFrozen: boolean;
  91747. /**
  91748. * 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.
  91749. * @returns the current mesh
  91750. */
  91751. freezeNormals(): Mesh;
  91752. /**
  91753. * 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
  91754. * @returns the current mesh
  91755. */
  91756. unfreezeNormals(): Mesh;
  91757. /**
  91758. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  91759. */
  91760. overridenInstanceCount: number;
  91761. /** @hidden */
  91762. _preActivate(): Mesh;
  91763. /** @hidden */
  91764. _preActivateForIntermediateRendering(renderId: number): Mesh;
  91765. /** @hidden */
  91766. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  91767. /**
  91768. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  91769. * This means the mesh underlying bounding box and sphere are recomputed.
  91770. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  91771. * @returns the current mesh
  91772. */
  91773. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  91774. /** @hidden */
  91775. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  91776. /**
  91777. * This function will subdivide the mesh into multiple submeshes
  91778. * @param count defines the expected number of submeshes
  91779. */
  91780. subdivide(count: number): void;
  91781. /**
  91782. * Copy a FloatArray into a specific associated vertex buffer
  91783. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  91784. * - VertexBuffer.PositionKind
  91785. * - VertexBuffer.UVKind
  91786. * - VertexBuffer.UV2Kind
  91787. * - VertexBuffer.UV3Kind
  91788. * - VertexBuffer.UV4Kind
  91789. * - VertexBuffer.UV5Kind
  91790. * - VertexBuffer.UV6Kind
  91791. * - VertexBuffer.ColorKind
  91792. * - VertexBuffer.MatricesIndicesKind
  91793. * - VertexBuffer.MatricesIndicesExtraKind
  91794. * - VertexBuffer.MatricesWeightsKind
  91795. * - VertexBuffer.MatricesWeightsExtraKind
  91796. * @param data defines the data source
  91797. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  91798. * @param stride defines the data stride size (can be null)
  91799. * @returns the current mesh
  91800. */
  91801. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  91802. /**
  91803. * Delete a vertex buffer associated with this mesh
  91804. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  91805. * - VertexBuffer.PositionKind
  91806. * - VertexBuffer.UVKind
  91807. * - VertexBuffer.UV2Kind
  91808. * - VertexBuffer.UV3Kind
  91809. * - VertexBuffer.UV4Kind
  91810. * - VertexBuffer.UV5Kind
  91811. * - VertexBuffer.UV6Kind
  91812. * - VertexBuffer.ColorKind
  91813. * - VertexBuffer.MatricesIndicesKind
  91814. * - VertexBuffer.MatricesIndicesExtraKind
  91815. * - VertexBuffer.MatricesWeightsKind
  91816. * - VertexBuffer.MatricesWeightsExtraKind
  91817. */
  91818. removeVerticesData(kind: string): void;
  91819. /**
  91820. * Flags an associated vertex buffer as updatable
  91821. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  91822. * - VertexBuffer.PositionKind
  91823. * - VertexBuffer.UVKind
  91824. * - VertexBuffer.UV2Kind
  91825. * - VertexBuffer.UV3Kind
  91826. * - VertexBuffer.UV4Kind
  91827. * - VertexBuffer.UV5Kind
  91828. * - VertexBuffer.UV6Kind
  91829. * - VertexBuffer.ColorKind
  91830. * - VertexBuffer.MatricesIndicesKind
  91831. * - VertexBuffer.MatricesIndicesExtraKind
  91832. * - VertexBuffer.MatricesWeightsKind
  91833. * - VertexBuffer.MatricesWeightsExtraKind
  91834. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  91835. */
  91836. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  91837. /**
  91838. * Sets the mesh global Vertex Buffer
  91839. * @param buffer defines the buffer to use
  91840. * @returns the current mesh
  91841. */
  91842. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  91843. /**
  91844. * Update a specific associated vertex buffer
  91845. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  91846. * - VertexBuffer.PositionKind
  91847. * - VertexBuffer.UVKind
  91848. * - VertexBuffer.UV2Kind
  91849. * - VertexBuffer.UV3Kind
  91850. * - VertexBuffer.UV4Kind
  91851. * - VertexBuffer.UV5Kind
  91852. * - VertexBuffer.UV6Kind
  91853. * - VertexBuffer.ColorKind
  91854. * - VertexBuffer.MatricesIndicesKind
  91855. * - VertexBuffer.MatricesIndicesExtraKind
  91856. * - VertexBuffer.MatricesWeightsKind
  91857. * - VertexBuffer.MatricesWeightsExtraKind
  91858. * @param data defines the data source
  91859. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  91860. * @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)
  91861. * @returns the current mesh
  91862. */
  91863. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  91864. /**
  91865. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  91866. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  91867. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  91868. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  91869. * @returns the current mesh
  91870. */
  91871. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  91872. /**
  91873. * Creates a un-shared specific occurence of the geometry for the mesh.
  91874. * @returns the current mesh
  91875. */
  91876. makeGeometryUnique(): Mesh;
  91877. /**
  91878. * Set the index buffer of this mesh
  91879. * @param indices defines the source data
  91880. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  91881. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  91882. * @returns the current mesh
  91883. */
  91884. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  91885. /**
  91886. * Update the current index buffer
  91887. * @param indices defines the source data
  91888. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  91889. * @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)
  91890. * @returns the current mesh
  91891. */
  91892. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  91893. /**
  91894. * Invert the geometry to move from a right handed system to a left handed one.
  91895. * @returns the current mesh
  91896. */
  91897. toLeftHanded(): Mesh;
  91898. /** @hidden */
  91899. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  91900. /** @hidden */
  91901. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  91902. /**
  91903. * Registers for this mesh a javascript function called just before the rendering process
  91904. * @param func defines the function to call before rendering this mesh
  91905. * @returns the current mesh
  91906. */
  91907. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  91908. /**
  91909. * Disposes a previously registered javascript function called before the rendering
  91910. * @param func defines the function to remove
  91911. * @returns the current mesh
  91912. */
  91913. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  91914. /**
  91915. * Registers for this mesh a javascript function called just after the rendering is complete
  91916. * @param func defines the function to call after rendering this mesh
  91917. * @returns the current mesh
  91918. */
  91919. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  91920. /**
  91921. * Disposes a previously registered javascript function called after the rendering.
  91922. * @param func defines the function to remove
  91923. * @returns the current mesh
  91924. */
  91925. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  91926. /** @hidden */
  91927. _getInstancesRenderList(subMeshId: number): _InstancesBatch;
  91928. /** @hidden */
  91929. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  91930. /** @hidden */
  91931. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  91932. /** @hidden */
  91933. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  91934. /** @hidden */
  91935. _rebuild(): void;
  91936. /** @hidden */
  91937. _freeze(): void;
  91938. /** @hidden */
  91939. _unFreeze(): void;
  91940. /**
  91941. * 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
  91942. * @param subMesh defines the subMesh to render
  91943. * @param enableAlphaMode defines if alpha mode can be changed
  91944. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  91945. * @returns the current mesh
  91946. */
  91947. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  91948. private _onBeforeDraw;
  91949. /**
  91950. * Renormalize the mesh and patch it up if there are no weights
  91951. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  91952. * However in the case of zero weights then we set just a single influence to 1.
  91953. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  91954. */
  91955. cleanMatrixWeights(): void;
  91956. private normalizeSkinFourWeights;
  91957. private normalizeSkinWeightsAndExtra;
  91958. /**
  91959. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  91960. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  91961. * the user know there was an issue with importing the mesh
  91962. * @returns a validation object with skinned, valid and report string
  91963. */
  91964. validateSkinning(): {
  91965. skinned: boolean;
  91966. valid: boolean;
  91967. report: string;
  91968. };
  91969. /** @hidden */
  91970. _checkDelayState(): Mesh;
  91971. private _queueLoad;
  91972. /**
  91973. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  91974. * A mesh is in the frustum if its bounding box intersects the frustum
  91975. * @param frustumPlanes defines the frustum to test
  91976. * @returns true if the mesh is in the frustum planes
  91977. */
  91978. isInFrustum(frustumPlanes: Plane[]): boolean;
  91979. /**
  91980. * Sets the mesh material by the material or multiMaterial `id` property
  91981. * @param id is a string identifying the material or the multiMaterial
  91982. * @returns the current mesh
  91983. */
  91984. setMaterialByID(id: string): Mesh;
  91985. /**
  91986. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  91987. * @returns an array of IAnimatable
  91988. */
  91989. getAnimatables(): IAnimatable[];
  91990. /**
  91991. * Modifies the mesh geometry according to the passed transformation matrix.
  91992. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  91993. * The mesh normals are modified using the same transformation.
  91994. * Note that, under the hood, this method sets a new VertexBuffer each call.
  91995. * @param transform defines the transform matrix to use
  91996. * @see http://doc.babylonjs.com/resources/baking_transformations
  91997. * @returns the current mesh
  91998. */
  91999. bakeTransformIntoVertices(transform: Matrix): Mesh;
  92000. /**
  92001. * Modifies the mesh geometry according to its own current World Matrix.
  92002. * The mesh World Matrix is then reset.
  92003. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  92004. * Note that, under the hood, this method sets a new VertexBuffer each call.
  92005. * @see http://doc.babylonjs.com/resources/baking_transformations
  92006. * @returns the current mesh
  92007. */
  92008. bakeCurrentTransformIntoVertices(): Mesh;
  92009. /** @hidden */
  92010. readonly _positions: Nullable<Vector3[]>;
  92011. /** @hidden */
  92012. _resetPointsArrayCache(): Mesh;
  92013. /** @hidden */
  92014. _generatePointsArray(): boolean;
  92015. /**
  92016. * Returns a new Mesh object generated from the current mesh properties.
  92017. * This method must not get confused with createInstance()
  92018. * @param name is a string, the name given to the new mesh
  92019. * @param newParent can be any Node object (default `null`)
  92020. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  92021. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  92022. * @returns a new mesh
  92023. */
  92024. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  92025. /**
  92026. * Releases resources associated with this mesh.
  92027. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  92028. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  92029. */
  92030. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  92031. /** @hidden */
  92032. _disposeInstanceSpecificData(): void;
  92033. /**
  92034. * Modifies the mesh geometry according to a displacement map.
  92035. * 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.
  92036. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  92037. * @param url is a string, the URL from the image file is to be downloaded.
  92038. * @param minHeight is the lower limit of the displacement.
  92039. * @param maxHeight is the upper limit of the displacement.
  92040. * @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.
  92041. * @param uvOffset is an optional vector2 used to offset UV.
  92042. * @param uvScale is an optional vector2 used to scale UV.
  92043. * @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.
  92044. * @returns the Mesh.
  92045. */
  92046. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  92047. /**
  92048. * Modifies the mesh geometry according to a displacementMap buffer.
  92049. * 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.
  92050. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  92051. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  92052. * @param heightMapWidth is the width of the buffer image.
  92053. * @param heightMapHeight is the height of the buffer image.
  92054. * @param minHeight is the lower limit of the displacement.
  92055. * @param maxHeight is the upper limit of the displacement.
  92056. * @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.
  92057. * @param uvOffset is an optional vector2 used to offset UV.
  92058. * @param uvScale is an optional vector2 used to scale UV.
  92059. * @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.
  92060. * @returns the Mesh.
  92061. */
  92062. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  92063. /**
  92064. * Modify the mesh to get a flat shading rendering.
  92065. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  92066. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  92067. * @returns current mesh
  92068. */
  92069. convertToFlatShadedMesh(): Mesh;
  92070. /**
  92071. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  92072. * In other words, more vertices, no more indices and a single bigger VBO.
  92073. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  92074. * @returns current mesh
  92075. */
  92076. convertToUnIndexedMesh(): Mesh;
  92077. /**
  92078. * Inverses facet orientations.
  92079. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92080. * @param flipNormals will also inverts the normals
  92081. * @returns current mesh
  92082. */
  92083. flipFaces(flipNormals?: boolean): Mesh;
  92084. /**
  92085. * Increase the number of facets and hence vertices in a mesh
  92086. * Vertex normals are interpolated from existing vertex normals
  92087. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92088. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  92089. */
  92090. increaseVertices(numberPerEdge: number): void;
  92091. /**
  92092. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  92093. * This will undo any application of covertToFlatShadedMesh
  92094. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92095. */
  92096. forceSharedVertices(): void;
  92097. /** @hidden */
  92098. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  92099. /** @hidden */
  92100. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  92101. /**
  92102. * Creates a new InstancedMesh object from the mesh model.
  92103. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  92104. * @param name defines the name of the new instance
  92105. * @returns a new InstancedMesh
  92106. */
  92107. createInstance(name: string): InstancedMesh;
  92108. /**
  92109. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  92110. * After this call, all the mesh instances have the same submeshes than the current mesh.
  92111. * @returns the current mesh
  92112. */
  92113. synchronizeInstances(): Mesh;
  92114. /**
  92115. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  92116. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  92117. * This should be used together with the simplification to avoid disappearing triangles.
  92118. * @param successCallback an optional success callback to be called after the optimization finished.
  92119. * @returns the current mesh
  92120. */
  92121. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  92122. /**
  92123. * Serialize current mesh
  92124. * @param serializationObject defines the object which will receive the serialization data
  92125. */
  92126. serialize(serializationObject: any): void;
  92127. /** @hidden */
  92128. _syncGeometryWithMorphTargetManager(): void;
  92129. /** @hidden */
  92130. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  92131. /**
  92132. * Returns a new Mesh object parsed from the source provided.
  92133. * @param parsedMesh is the source
  92134. * @param scene defines the hosting scene
  92135. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  92136. * @returns a new Mesh
  92137. */
  92138. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  92139. /**
  92140. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  92141. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  92142. * @param name defines the name of the mesh to create
  92143. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  92144. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  92145. * @param closePath creates a seam between the first and the last points of each path of the path array
  92146. * @param offset is taken in account only if the `pathArray` is containing a single path
  92147. * @param scene defines the hosting scene
  92148. * @param updatable defines if the mesh must be flagged as updatable
  92149. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92150. * @param instance defines an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#ribbon)
  92151. * @returns a new Mesh
  92152. */
  92153. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92154. /**
  92155. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  92156. * @param name defines the name of the mesh to create
  92157. * @param radius sets the radius size (float) of the polygon (default 0.5)
  92158. * @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
  92159. * @param scene defines the hosting scene
  92160. * @param updatable defines if the mesh must be flagged as updatable
  92161. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92162. * @returns a new Mesh
  92163. */
  92164. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  92165. /**
  92166. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  92167. * @param name defines the name of the mesh to create
  92168. * @param size sets the size (float) of each box side (default 1)
  92169. * @param scene defines the hosting scene
  92170. * @param updatable defines if the mesh must be flagged as updatable
  92171. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92172. * @returns a new Mesh
  92173. */
  92174. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  92175. /**
  92176. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  92177. * @param name defines the name of the mesh to create
  92178. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  92179. * @param diameter sets the diameter size (float) of the sphere (default 1)
  92180. * @param scene defines the hosting scene
  92181. * @param updatable defines if the mesh must be flagged as updatable
  92182. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92183. * @returns a new Mesh
  92184. */
  92185. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92186. /**
  92187. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  92188. * @param name defines the name of the mesh to create
  92189. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  92190. * @param diameter sets the diameter size (float) of the sphere (default 1)
  92191. * @param scene defines the hosting scene
  92192. * @returns a new Mesh
  92193. */
  92194. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  92195. /**
  92196. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  92197. * @param name defines the name of the mesh to create
  92198. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  92199. * @param diameterTop set the top cap diameter (floats, default 1)
  92200. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  92201. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  92202. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  92203. * @param scene defines the hosting scene
  92204. * @param updatable defines if the mesh must be flagged as updatable
  92205. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92206. * @returns a new Mesh
  92207. */
  92208. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  92209. /**
  92210. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  92211. * @param name defines the name of the mesh to create
  92212. * @param diameter sets the diameter size (float) of the torus (default 1)
  92213. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  92214. * @param tessellation sets the number of torus sides (postive integer, default 16)
  92215. * @param scene defines the hosting scene
  92216. * @param updatable defines if the mesh must be flagged as updatable
  92217. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92218. * @returns a new Mesh
  92219. */
  92220. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92221. /**
  92222. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  92223. * @param name defines the name of the mesh to create
  92224. * @param radius sets the global radius size (float) of the torus knot (default 2)
  92225. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  92226. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  92227. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  92228. * @param p the number of windings on X axis (positive integers, default 2)
  92229. * @param q the number of windings on Y axis (positive integers, default 3)
  92230. * @param scene defines the hosting scene
  92231. * @param updatable defines if the mesh must be flagged as updatable
  92232. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92233. * @returns a new Mesh
  92234. */
  92235. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92236. /**
  92237. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  92238. * @param name defines the name of the mesh to create
  92239. * @param points is an array successive Vector3
  92240. * @param scene defines the hosting scene
  92241. * @param updatable defines if the mesh must be flagged as updatable
  92242. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines).
  92243. * @returns a new Mesh
  92244. */
  92245. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  92246. /**
  92247. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  92248. * @param name defines the name of the mesh to create
  92249. * @param points is an array successive Vector3
  92250. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  92251. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  92252. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  92253. * @param scene defines the hosting scene
  92254. * @param updatable defines if the mesh must be flagged as updatable
  92255. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines)
  92256. * @returns a new Mesh
  92257. */
  92258. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  92259. /**
  92260. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  92261. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  92262. * 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.
  92263. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  92264. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  92265. * Remember you can only change the shape positions, not their number when updating a polygon.
  92266. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  92267. * @param name defines the name of the mesh to create
  92268. * @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
  92269. * @param scene defines the hosting scene
  92270. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  92271. * @param updatable defines if the mesh must be flagged as updatable
  92272. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92273. * @param earcutInjection can be used to inject your own earcut reference
  92274. * @returns a new Mesh
  92275. */
  92276. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  92277. /**
  92278. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  92279. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  92280. * @param name defines the name of the mesh to create
  92281. * @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
  92282. * @param depth defines the height of extrusion
  92283. * @param scene defines the hosting scene
  92284. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  92285. * @param updatable defines if the mesh must be flagged as updatable
  92286. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92287. * @param earcutInjection can be used to inject your own earcut reference
  92288. * @returns a new Mesh
  92289. */
  92290. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  92291. /**
  92292. * Creates an extruded shape mesh.
  92293. * 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
  92294. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  92295. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  92296. * @param name defines the name of the mesh to create
  92297. * @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
  92298. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  92299. * @param scale is the value to scale the shape
  92300. * @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
  92301. * @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
  92302. * @param scene defines the hosting scene
  92303. * @param updatable defines if the mesh must be flagged as updatable
  92304. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92305. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#extruded-shape)
  92306. * @returns a new Mesh
  92307. */
  92308. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92309. /**
  92310. * Creates an custom extruded shape mesh.
  92311. * The custom extrusion is a parametric shape.
  92312. * It has no predefined shape. Its final shape will depend on the input parameters.
  92313. * Please consider using the same method from the MeshBuilder class instead
  92314. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  92315. * @param name defines the name of the mesh to create
  92316. * @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
  92317. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  92318. * @param scaleFunction is a custom Javascript function called on each path point
  92319. * @param rotationFunction is a custom Javascript function called on each path point
  92320. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  92321. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  92322. * @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
  92323. * @param scene defines the hosting scene
  92324. * @param updatable defines if the mesh must be flagged as updatable
  92325. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92326. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape)
  92327. * @returns a new Mesh
  92328. */
  92329. 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;
  92330. /**
  92331. * Creates lathe mesh.
  92332. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  92333. * Please consider using the same method from the MeshBuilder class instead
  92334. * @param name defines the name of the mesh to create
  92335. * @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
  92336. * @param radius is the radius value of the lathe
  92337. * @param tessellation is the side number of the lathe.
  92338. * @param scene defines the hosting scene
  92339. * @param updatable defines if the mesh must be flagged as updatable
  92340. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92341. * @returns a new Mesh
  92342. */
  92343. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92344. /**
  92345. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  92346. * @param name defines the name of the mesh to create
  92347. * @param size sets the size (float) of both sides of the plane at once (default 1)
  92348. * @param scene defines the hosting scene
  92349. * @param updatable defines if the mesh must be flagged as updatable
  92350. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92351. * @returns a new Mesh
  92352. */
  92353. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92354. /**
  92355. * Creates a ground mesh.
  92356. * Please consider using the same method from the MeshBuilder class instead
  92357. * @param name defines the name of the mesh to create
  92358. * @param width set the width of the ground
  92359. * @param height set the height of the ground
  92360. * @param subdivisions sets the number of subdivisions per side
  92361. * @param scene defines the hosting scene
  92362. * @param updatable defines if the mesh must be flagged as updatable
  92363. * @returns a new Mesh
  92364. */
  92365. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  92366. /**
  92367. * Creates a tiled ground mesh.
  92368. * Please consider using the same method from the MeshBuilder class instead
  92369. * @param name defines the name of the mesh to create
  92370. * @param xmin set the ground minimum X coordinate
  92371. * @param zmin set the ground minimum Y coordinate
  92372. * @param xmax set the ground maximum X coordinate
  92373. * @param zmax set the ground maximum Z coordinate
  92374. * @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
  92375. * @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
  92376. * @param scene defines the hosting scene
  92377. * @param updatable defines if the mesh must be flagged as updatable
  92378. * @returns a new Mesh
  92379. */
  92380. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  92381. w: number;
  92382. h: number;
  92383. }, precision: {
  92384. w: number;
  92385. h: number;
  92386. }, scene: Scene, updatable?: boolean): Mesh;
  92387. /**
  92388. * Creates a ground mesh from a height map.
  92389. * Please consider using the same method from the MeshBuilder class instead
  92390. * @see http://doc.babylonjs.com/babylon101/height_map
  92391. * @param name defines the name of the mesh to create
  92392. * @param url sets the URL of the height map image resource
  92393. * @param width set the ground width size
  92394. * @param height set the ground height size
  92395. * @param subdivisions sets the number of subdivision per side
  92396. * @param minHeight is the minimum altitude on the ground
  92397. * @param maxHeight is the maximum altitude on the ground
  92398. * @param scene defines the hosting scene
  92399. * @param updatable defines if the mesh must be flagged as updatable
  92400. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  92401. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  92402. * @returns a new Mesh
  92403. */
  92404. 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;
  92405. /**
  92406. * Creates a tube mesh.
  92407. * The tube is a parametric shape.
  92408. * It has no predefined shape. Its final shape will depend on the input parameters.
  92409. * Please consider using the same method from the MeshBuilder class instead
  92410. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  92411. * @param name defines the name of the mesh to create
  92412. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  92413. * @param radius sets the tube radius size
  92414. * @param tessellation is the number of sides on the tubular surface
  92415. * @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
  92416. * @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
  92417. * @param scene defines the hosting scene
  92418. * @param updatable defines if the mesh must be flagged as updatable
  92419. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92420. * @param instance is an instance of an existing Tube object to be updated with the passed `pathArray` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#tube)
  92421. * @returns a new Mesh
  92422. */
  92423. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  92424. (i: number, distance: number): number;
  92425. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92426. /**
  92427. * Creates a polyhedron mesh.
  92428. * Please consider using the same method from the MeshBuilder class instead.
  92429. * * 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
  92430. * * The parameter `size` (positive float, default 1) sets the polygon size
  92431. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  92432. * * 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`
  92433. * * 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
  92434. * * 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)`)
  92435. * * 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
  92436. * * 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
  92437. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  92438. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  92439. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  92440. * @param name defines the name of the mesh to create
  92441. * @param options defines the options used to create the mesh
  92442. * @param scene defines the hosting scene
  92443. * @returns a new Mesh
  92444. */
  92445. static CreatePolyhedron(name: string, options: {
  92446. type?: number;
  92447. size?: number;
  92448. sizeX?: number;
  92449. sizeY?: number;
  92450. sizeZ?: number;
  92451. custom?: any;
  92452. faceUV?: Vector4[];
  92453. faceColors?: Color4[];
  92454. updatable?: boolean;
  92455. sideOrientation?: number;
  92456. }, scene: Scene): Mesh;
  92457. /**
  92458. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  92459. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  92460. * * 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`)
  92461. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  92462. * * 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
  92463. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  92464. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  92465. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  92466. * @param name defines the name of the mesh
  92467. * @param options defines the options used to create the mesh
  92468. * @param scene defines the hosting scene
  92469. * @returns a new Mesh
  92470. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  92471. */
  92472. static CreateIcoSphere(name: string, options: {
  92473. radius?: number;
  92474. flat?: boolean;
  92475. subdivisions?: number;
  92476. sideOrientation?: number;
  92477. updatable?: boolean;
  92478. }, scene: Scene): Mesh;
  92479. /**
  92480. * Creates a decal mesh.
  92481. * Please consider using the same method from the MeshBuilder class instead.
  92482. * A decal is a mesh usually applied as a model onto the surface of another mesh
  92483. * @param name defines the name of the mesh
  92484. * @param sourceMesh defines the mesh receiving the decal
  92485. * @param position sets the position of the decal in world coordinates
  92486. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  92487. * @param size sets the decal scaling
  92488. * @param angle sets the angle to rotate the decal
  92489. * @returns a new Mesh
  92490. */
  92491. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  92492. /**
  92493. * Prepare internal position array for software CPU skinning
  92494. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  92495. */
  92496. setPositionsForCPUSkinning(): Float32Array;
  92497. /**
  92498. * Prepare internal normal array for software CPU skinning
  92499. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  92500. */
  92501. setNormalsForCPUSkinning(): Float32Array;
  92502. /**
  92503. * Updates the vertex buffer by applying transformation from the bones
  92504. * @param skeleton defines the skeleton to apply to current mesh
  92505. * @returns the current mesh
  92506. */
  92507. applySkeleton(skeleton: Skeleton): Mesh;
  92508. /**
  92509. * 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
  92510. * @param meshes defines the list of meshes to scan
  92511. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  92512. */
  92513. static MinMax(meshes: AbstractMesh[]): {
  92514. min: Vector3;
  92515. max: Vector3;
  92516. };
  92517. /**
  92518. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  92519. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  92520. * @returns a vector3
  92521. */
  92522. static Center(meshesOrMinMaxVector: {
  92523. min: Vector3;
  92524. max: Vector3;
  92525. } | AbstractMesh[]): Vector3;
  92526. /**
  92527. * Merge the array of meshes into a single mesh for performance reasons.
  92528. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  92529. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  92530. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  92531. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  92532. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  92533. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  92534. * @returns a new mesh
  92535. */
  92536. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  92537. /** @hidden */
  92538. addInstance(instance: InstancedMesh): void;
  92539. /** @hidden */
  92540. removeInstance(instance: InstancedMesh): void;
  92541. }
  92542. }
  92543. declare module BABYLON {
  92544. /**
  92545. * This is the base class of all the camera used in the application.
  92546. * @see http://doc.babylonjs.com/features/cameras
  92547. */
  92548. export class Camera extends Node {
  92549. /** @hidden */
  92550. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  92551. /**
  92552. * This is the default projection mode used by the cameras.
  92553. * It helps recreating a feeling of perspective and better appreciate depth.
  92554. * This is the best way to simulate real life cameras.
  92555. */
  92556. static readonly PERSPECTIVE_CAMERA: number;
  92557. /**
  92558. * This helps creating camera with an orthographic mode.
  92559. * 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.
  92560. */
  92561. static readonly ORTHOGRAPHIC_CAMERA: number;
  92562. /**
  92563. * This is the default FOV mode for perspective cameras.
  92564. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  92565. */
  92566. static readonly FOVMODE_VERTICAL_FIXED: number;
  92567. /**
  92568. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  92569. */
  92570. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  92571. /**
  92572. * This specifies ther is no need for a camera rig.
  92573. * Basically only one eye is rendered corresponding to the camera.
  92574. */
  92575. static readonly RIG_MODE_NONE: number;
  92576. /**
  92577. * Simulates a camera Rig with one blue eye and one red eye.
  92578. * This can be use with 3d blue and red glasses.
  92579. */
  92580. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  92581. /**
  92582. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  92583. */
  92584. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  92585. /**
  92586. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  92587. */
  92588. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  92589. /**
  92590. * Defines that both eyes of the camera will be rendered over under each other.
  92591. */
  92592. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  92593. /**
  92594. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  92595. */
  92596. static readonly RIG_MODE_VR: number;
  92597. /**
  92598. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  92599. */
  92600. static readonly RIG_MODE_WEBVR: number;
  92601. /**
  92602. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  92603. */
  92604. static readonly RIG_MODE_CUSTOM: number;
  92605. /**
  92606. * Defines if by default attaching controls should prevent the default javascript event to continue.
  92607. */
  92608. static ForceAttachControlToAlwaysPreventDefault: boolean;
  92609. /**
  92610. * Define the input manager associated with the camera.
  92611. */
  92612. inputs: CameraInputsManager<Camera>;
  92613. /** @hidden */
  92614. _position: Vector3;
  92615. /**
  92616. * Define the current local position of the camera in the scene
  92617. */
  92618. position: Vector3;
  92619. /**
  92620. * The vector the camera should consider as up.
  92621. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  92622. */
  92623. upVector: Vector3;
  92624. /**
  92625. * Define the current limit on the left side for an orthographic camera
  92626. * In scene unit
  92627. */
  92628. orthoLeft: Nullable<number>;
  92629. /**
  92630. * Define the current limit on the right side for an orthographic camera
  92631. * In scene unit
  92632. */
  92633. orthoRight: Nullable<number>;
  92634. /**
  92635. * Define the current limit on the bottom side for an orthographic camera
  92636. * In scene unit
  92637. */
  92638. orthoBottom: Nullable<number>;
  92639. /**
  92640. * Define the current limit on the top side for an orthographic camera
  92641. * In scene unit
  92642. */
  92643. orthoTop: Nullable<number>;
  92644. /**
  92645. * Field Of View is set in Radians. (default is 0.8)
  92646. */
  92647. fov: number;
  92648. /**
  92649. * Define the minimum distance the camera can see from.
  92650. * This is important to note that the depth buffer are not infinite and the closer it starts
  92651. * the more your scene might encounter depth fighting issue.
  92652. */
  92653. minZ: number;
  92654. /**
  92655. * Define the maximum distance the camera can see to.
  92656. * This is important to note that the depth buffer are not infinite and the further it end
  92657. * the more your scene might encounter depth fighting issue.
  92658. */
  92659. maxZ: number;
  92660. /**
  92661. * Define the default inertia of the camera.
  92662. * This helps giving a smooth feeling to the camera movement.
  92663. */
  92664. inertia: number;
  92665. /**
  92666. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  92667. */
  92668. mode: number;
  92669. /**
  92670. * Define wether the camera is intermediate.
  92671. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  92672. */
  92673. isIntermediate: boolean;
  92674. /**
  92675. * Define the viewport of the camera.
  92676. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  92677. */
  92678. viewport: Viewport;
  92679. /**
  92680. * Restricts the camera to viewing objects with the same layerMask.
  92681. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  92682. */
  92683. layerMask: number;
  92684. /**
  92685. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  92686. */
  92687. fovMode: number;
  92688. /**
  92689. * Rig mode of the camera.
  92690. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  92691. * This is normally controlled byt the camera themselves as internal use.
  92692. */
  92693. cameraRigMode: number;
  92694. /**
  92695. * Defines the distance between both "eyes" in case of a RIG
  92696. */
  92697. interaxialDistance: number;
  92698. /**
  92699. * Defines if stereoscopic rendering is done side by side or over under.
  92700. */
  92701. isStereoscopicSideBySide: boolean;
  92702. /**
  92703. * 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
  92704. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  92705. * else in the scene. (Eg. security camera)
  92706. *
  92707. * 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)
  92708. */
  92709. customRenderTargets: RenderTargetTexture[];
  92710. /**
  92711. * When set, the camera will render to this render target instead of the default canvas
  92712. *
  92713. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  92714. */
  92715. outputRenderTarget: Nullable<RenderTargetTexture>;
  92716. /**
  92717. * Observable triggered when the camera view matrix has changed.
  92718. */
  92719. onViewMatrixChangedObservable: Observable<Camera>;
  92720. /**
  92721. * Observable triggered when the camera Projection matrix has changed.
  92722. */
  92723. onProjectionMatrixChangedObservable: Observable<Camera>;
  92724. /**
  92725. * Observable triggered when the inputs have been processed.
  92726. */
  92727. onAfterCheckInputsObservable: Observable<Camera>;
  92728. /**
  92729. * Observable triggered when reset has been called and applied to the camera.
  92730. */
  92731. onRestoreStateObservable: Observable<Camera>;
  92732. /** @hidden */
  92733. _cameraRigParams: any;
  92734. /** @hidden */
  92735. _rigCameras: Camera[];
  92736. /** @hidden */
  92737. _rigPostProcess: Nullable<PostProcess>;
  92738. protected _webvrViewMatrix: Matrix;
  92739. /** @hidden */
  92740. _skipRendering: boolean;
  92741. /** @hidden */
  92742. _projectionMatrix: Matrix;
  92743. /** @hidden */
  92744. _postProcesses: Nullable<PostProcess>[];
  92745. /** @hidden */
  92746. _activeMeshes: SmartArray<AbstractMesh>;
  92747. protected _globalPosition: Vector3;
  92748. /** @hidden */
  92749. _computedViewMatrix: Matrix;
  92750. private _doNotComputeProjectionMatrix;
  92751. private _transformMatrix;
  92752. private _frustumPlanes;
  92753. private _refreshFrustumPlanes;
  92754. private _storedFov;
  92755. private _stateStored;
  92756. /**
  92757. * Instantiates a new camera object.
  92758. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  92759. * @see http://doc.babylonjs.com/features/cameras
  92760. * @param name Defines the name of the camera in the scene
  92761. * @param position Defines the position of the camera
  92762. * @param scene Defines the scene the camera belongs too
  92763. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  92764. */
  92765. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  92766. /**
  92767. * Store current camera state (fov, position, etc..)
  92768. * @returns the camera
  92769. */
  92770. storeState(): Camera;
  92771. /**
  92772. * Restores the camera state values if it has been stored. You must call storeState() first
  92773. */
  92774. protected _restoreStateValues(): boolean;
  92775. /**
  92776. * Restored camera state. You must call storeState() first.
  92777. * @returns true if restored and false otherwise
  92778. */
  92779. restoreState(): boolean;
  92780. /**
  92781. * Gets the class name of the camera.
  92782. * @returns the class name
  92783. */
  92784. getClassName(): string;
  92785. /** @hidden */
  92786. readonly _isCamera: boolean;
  92787. /**
  92788. * Gets a string representation of the camera useful for debug purpose.
  92789. * @param fullDetails Defines that a more verboe level of logging is required
  92790. * @returns the string representation
  92791. */
  92792. toString(fullDetails?: boolean): string;
  92793. /**
  92794. * Gets the current world space position of the camera.
  92795. */
  92796. readonly globalPosition: Vector3;
  92797. /**
  92798. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  92799. * @returns the active meshe list
  92800. */
  92801. getActiveMeshes(): SmartArray<AbstractMesh>;
  92802. /**
  92803. * Check wether a mesh is part of the current active mesh list of the camera
  92804. * @param mesh Defines the mesh to check
  92805. * @returns true if active, false otherwise
  92806. */
  92807. isActiveMesh(mesh: Mesh): boolean;
  92808. /**
  92809. * Is this camera ready to be used/rendered
  92810. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  92811. * @return true if the camera is ready
  92812. */
  92813. isReady(completeCheck?: boolean): boolean;
  92814. /** @hidden */
  92815. _initCache(): void;
  92816. /** @hidden */
  92817. _updateCache(ignoreParentClass?: boolean): void;
  92818. /** @hidden */
  92819. _isSynchronized(): boolean;
  92820. /** @hidden */
  92821. _isSynchronizedViewMatrix(): boolean;
  92822. /** @hidden */
  92823. _isSynchronizedProjectionMatrix(): boolean;
  92824. /**
  92825. * Attach the input controls to a specific dom element to get the input from.
  92826. * @param element Defines the element the controls should be listened from
  92827. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  92828. */
  92829. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  92830. /**
  92831. * Detach the current controls from the specified dom element.
  92832. * @param element Defines the element to stop listening the inputs from
  92833. */
  92834. detachControl(element: HTMLElement): void;
  92835. /**
  92836. * Update the camera state according to the different inputs gathered during the frame.
  92837. */
  92838. update(): void;
  92839. /** @hidden */
  92840. _checkInputs(): void;
  92841. /** @hidden */
  92842. readonly rigCameras: Camera[];
  92843. /**
  92844. * Gets the post process used by the rig cameras
  92845. */
  92846. readonly rigPostProcess: Nullable<PostProcess>;
  92847. /**
  92848. * Internal, gets the first post proces.
  92849. * @returns the first post process to be run on this camera.
  92850. */
  92851. _getFirstPostProcess(): Nullable<PostProcess>;
  92852. private _cascadePostProcessesToRigCams;
  92853. /**
  92854. * Attach a post process to the camera.
  92855. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  92856. * @param postProcess The post process to attach to the camera
  92857. * @param insertAt The position of the post process in case several of them are in use in the scene
  92858. * @returns the position the post process has been inserted at
  92859. */
  92860. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  92861. /**
  92862. * Detach a post process to the camera.
  92863. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  92864. * @param postProcess The post process to detach from the camera
  92865. */
  92866. detachPostProcess(postProcess: PostProcess): void;
  92867. /**
  92868. * Gets the current world matrix of the camera
  92869. */
  92870. getWorldMatrix(): Matrix;
  92871. /** @hidden */
  92872. _getViewMatrix(): Matrix;
  92873. /**
  92874. * Gets the current view matrix of the camera.
  92875. * @param force forces the camera to recompute the matrix without looking at the cached state
  92876. * @returns the view matrix
  92877. */
  92878. getViewMatrix(force?: boolean): Matrix;
  92879. /**
  92880. * Freeze the projection matrix.
  92881. * It will prevent the cache check of the camera projection compute and can speed up perf
  92882. * if no parameter of the camera are meant to change
  92883. * @param projection Defines manually a projection if necessary
  92884. */
  92885. freezeProjectionMatrix(projection?: Matrix): void;
  92886. /**
  92887. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  92888. */
  92889. unfreezeProjectionMatrix(): void;
  92890. /**
  92891. * Gets the current projection matrix of the camera.
  92892. * @param force forces the camera to recompute the matrix without looking at the cached state
  92893. * @returns the projection matrix
  92894. */
  92895. getProjectionMatrix(force?: boolean): Matrix;
  92896. /**
  92897. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  92898. * @returns a Matrix
  92899. */
  92900. getTransformationMatrix(): Matrix;
  92901. private _updateFrustumPlanes;
  92902. /**
  92903. * Checks if a cullable object (mesh...) is in the camera frustum
  92904. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  92905. * @param target The object to check
  92906. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  92907. * @returns true if the object is in frustum otherwise false
  92908. */
  92909. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  92910. /**
  92911. * Checks if a cullable object (mesh...) is in the camera frustum
  92912. * Unlike isInFrustum this cheks the full bounding box
  92913. * @param target The object to check
  92914. * @returns true if the object is in frustum otherwise false
  92915. */
  92916. isCompletelyInFrustum(target: ICullable): boolean;
  92917. /**
  92918. * Gets a ray in the forward direction from the camera.
  92919. * @param length Defines the length of the ray to create
  92920. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  92921. * @param origin Defines the start point of the ray which defaults to the camera position
  92922. * @returns the forward ray
  92923. */
  92924. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  92925. /**
  92926. * Releases resources associated with this node.
  92927. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  92928. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  92929. */
  92930. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  92931. /** @hidden */
  92932. _isLeftCamera: boolean;
  92933. /**
  92934. * Gets the left camera of a rig setup in case of Rigged Camera
  92935. */
  92936. readonly isLeftCamera: boolean;
  92937. /** @hidden */
  92938. _isRightCamera: boolean;
  92939. /**
  92940. * Gets the right camera of a rig setup in case of Rigged Camera
  92941. */
  92942. readonly isRightCamera: boolean;
  92943. /**
  92944. * Gets the left camera of a rig setup in case of Rigged Camera
  92945. */
  92946. readonly leftCamera: Nullable<FreeCamera>;
  92947. /**
  92948. * Gets the right camera of a rig setup in case of Rigged Camera
  92949. */
  92950. readonly rightCamera: Nullable<FreeCamera>;
  92951. /**
  92952. * Gets the left camera target of a rig setup in case of Rigged Camera
  92953. * @returns the target position
  92954. */
  92955. getLeftTarget(): Nullable<Vector3>;
  92956. /**
  92957. * Gets the right camera target of a rig setup in case of Rigged Camera
  92958. * @returns the target position
  92959. */
  92960. getRightTarget(): Nullable<Vector3>;
  92961. /**
  92962. * @hidden
  92963. */
  92964. setCameraRigMode(mode: number, rigParams: any): void;
  92965. /** @hidden */
  92966. static _setStereoscopicRigMode(camera: Camera): void;
  92967. /** @hidden */
  92968. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  92969. /** @hidden */
  92970. static _setVRRigMode(camera: Camera, rigParams: any): void;
  92971. /** @hidden */
  92972. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  92973. /** @hidden */
  92974. _getVRProjectionMatrix(): Matrix;
  92975. protected _updateCameraRotationMatrix(): void;
  92976. protected _updateWebVRCameraRotationMatrix(): void;
  92977. /**
  92978. * This function MUST be overwritten by the different WebVR cameras available.
  92979. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  92980. * @hidden
  92981. */
  92982. _getWebVRProjectionMatrix(): Matrix;
  92983. /**
  92984. * This function MUST be overwritten by the different WebVR cameras available.
  92985. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  92986. * @hidden
  92987. */
  92988. _getWebVRViewMatrix(): Matrix;
  92989. /** @hidden */
  92990. setCameraRigParameter(name: string, value: any): void;
  92991. /**
  92992. * needs to be overridden by children so sub has required properties to be copied
  92993. * @hidden
  92994. */
  92995. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  92996. /**
  92997. * May need to be overridden by children
  92998. * @hidden
  92999. */
  93000. _updateRigCameras(): void;
  93001. /** @hidden */
  93002. _setupInputs(): void;
  93003. /**
  93004. * Serialiaze the camera setup to a json represention
  93005. * @returns the JSON representation
  93006. */
  93007. serialize(): any;
  93008. /**
  93009. * Clones the current camera.
  93010. * @param name The cloned camera name
  93011. * @returns the cloned camera
  93012. */
  93013. clone(name: string): Camera;
  93014. /**
  93015. * Gets the direction of the camera relative to a given local axis.
  93016. * @param localAxis Defines the reference axis to provide a relative direction.
  93017. * @return the direction
  93018. */
  93019. getDirection(localAxis: Vector3): Vector3;
  93020. /**
  93021. * Returns the current camera absolute rotation
  93022. */
  93023. readonly absoluteRotation: Quaternion;
  93024. /**
  93025. * Gets the direction of the camera relative to a given local axis into a passed vector.
  93026. * @param localAxis Defines the reference axis to provide a relative direction.
  93027. * @param result Defines the vector to store the result in
  93028. */
  93029. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  93030. /**
  93031. * Gets a camera constructor for a given camera type
  93032. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  93033. * @param name The name of the camera the result will be able to instantiate
  93034. * @param scene The scene the result will construct the camera in
  93035. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  93036. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  93037. * @returns a factory method to construc the camera
  93038. */
  93039. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  93040. /**
  93041. * Compute the world matrix of the camera.
  93042. * @returns the camera world matrix
  93043. */
  93044. computeWorldMatrix(): Matrix;
  93045. /**
  93046. * Parse a JSON and creates the camera from the parsed information
  93047. * @param parsedCamera The JSON to parse
  93048. * @param scene The scene to instantiate the camera in
  93049. * @returns the newly constructed camera
  93050. */
  93051. static Parse(parsedCamera: any, scene: Scene): Camera;
  93052. }
  93053. }
  93054. declare module BABYLON {
  93055. /**
  93056. * Class containing static functions to help procedurally build meshes
  93057. */
  93058. export class DiscBuilder {
  93059. /**
  93060. * Creates a plane polygonal mesh. By default, this is a disc
  93061. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  93062. * * 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
  93063. * * 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
  93064. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  93065. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  93066. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  93067. * @param name defines the name of the mesh
  93068. * @param options defines the options used to create the mesh
  93069. * @param scene defines the hosting scene
  93070. * @returns the plane polygonal mesh
  93071. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  93072. */
  93073. static CreateDisc(name: string, options: {
  93074. radius?: number;
  93075. tessellation?: number;
  93076. arc?: number;
  93077. updatable?: boolean;
  93078. sideOrientation?: number;
  93079. frontUVs?: Vector4;
  93080. backUVs?: Vector4;
  93081. }, scene?: Nullable<Scene>): Mesh;
  93082. }
  93083. }
  93084. declare module BABYLON {
  93085. /**
  93086. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  93087. *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.
  93088. * The SPS is also a particle system. It provides some methods to manage the particles.
  93089. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  93090. *
  93091. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  93092. */
  93093. export class SolidParticleSystem implements IDisposable {
  93094. /**
  93095. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  93096. * Example : var p = SPS.particles[i];
  93097. */
  93098. particles: SolidParticle[];
  93099. /**
  93100. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  93101. */
  93102. nbParticles: number;
  93103. /**
  93104. * If the particles must ever face the camera (default false). Useful for planar particles.
  93105. */
  93106. billboard: boolean;
  93107. /**
  93108. * Recompute normals when adding a shape
  93109. */
  93110. recomputeNormals: boolean;
  93111. /**
  93112. * This a counter ofr your own usage. It's not set by any SPS functions.
  93113. */
  93114. counter: number;
  93115. /**
  93116. * The SPS name. This name is also given to the underlying mesh.
  93117. */
  93118. name: string;
  93119. /**
  93120. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  93121. */
  93122. mesh: Mesh;
  93123. /**
  93124. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  93125. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  93126. */
  93127. vars: any;
  93128. /**
  93129. * This array is populated when the SPS is set as 'pickable'.
  93130. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  93131. * Each element of this array is an object `{idx: int, faceId: int}`.
  93132. * `idx` is the picked particle index in the `SPS.particles` array
  93133. * `faceId` is the picked face index counted within this particle.
  93134. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  93135. */
  93136. pickedParticles: {
  93137. idx: number;
  93138. faceId: number;
  93139. }[];
  93140. /**
  93141. * This array is populated when `enableDepthSort` is set to true.
  93142. * Each element of this array is an instance of the class DepthSortedParticle.
  93143. */
  93144. depthSortedParticles: DepthSortedParticle[];
  93145. /**
  93146. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  93147. * @hidden
  93148. */
  93149. _bSphereOnly: boolean;
  93150. /**
  93151. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  93152. * @hidden
  93153. */
  93154. _bSphereRadiusFactor: number;
  93155. private _scene;
  93156. private _positions;
  93157. private _indices;
  93158. private _normals;
  93159. private _colors;
  93160. private _uvs;
  93161. private _indices32;
  93162. private _positions32;
  93163. private _normals32;
  93164. private _fixedNormal32;
  93165. private _colors32;
  93166. private _uvs32;
  93167. private _index;
  93168. private _updatable;
  93169. private _pickable;
  93170. private _isVisibilityBoxLocked;
  93171. private _alwaysVisible;
  93172. private _depthSort;
  93173. private _expandable;
  93174. private _shapeCounter;
  93175. private _copy;
  93176. private _color;
  93177. private _computeParticleColor;
  93178. private _computeParticleTexture;
  93179. private _computeParticleRotation;
  93180. private _computeParticleVertex;
  93181. private _computeBoundingBox;
  93182. private _depthSortParticles;
  93183. private _camera;
  93184. private _mustUnrotateFixedNormals;
  93185. private _particlesIntersect;
  93186. private _needs32Bits;
  93187. private _isNotBuilt;
  93188. /**
  93189. * Creates a SPS (Solid Particle System) object.
  93190. * @param name (String) is the SPS name, this will be the underlying mesh name.
  93191. * @param scene (Scene) is the scene in which the SPS is added.
  93192. * @param options defines the options of the sps e.g.
  93193. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  93194. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  93195. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  93196. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  93197. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  93198. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  93199. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  93200. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  93201. */
  93202. constructor(name: string, scene: Scene, options?: {
  93203. updatable?: boolean;
  93204. isPickable?: boolean;
  93205. enableDepthSort?: boolean;
  93206. particleIntersection?: boolean;
  93207. boundingSphereOnly?: boolean;
  93208. bSphereRadiusFactor?: number;
  93209. expandable?: boolean;
  93210. });
  93211. /**
  93212. * Builds the SPS underlying mesh. Returns a standard Mesh.
  93213. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  93214. * @returns the created mesh
  93215. */
  93216. buildMesh(): Mesh;
  93217. /**
  93218. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  93219. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  93220. * Thus the particles generated from `digest()` have their property `position` set yet.
  93221. * @param mesh ( Mesh ) is the mesh to be digested
  93222. * @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
  93223. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  93224. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  93225. * @returns the current SPS
  93226. */
  93227. digest(mesh: Mesh, options?: {
  93228. facetNb?: number;
  93229. number?: number;
  93230. delta?: number;
  93231. }): SolidParticleSystem;
  93232. private _unrotateFixedNormals;
  93233. private _resetCopy;
  93234. private _meshBuilder;
  93235. private _posToShape;
  93236. private _uvsToShapeUV;
  93237. private _addParticle;
  93238. /**
  93239. * Adds some particles to the SPS from the model shape. Returns the shape id.
  93240. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  93241. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  93242. * @param nb (positive integer) the number of particles to be created from this model
  93243. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  93244. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  93245. * @returns the number of shapes in the system
  93246. */
  93247. addShape(mesh: Mesh, nb: number, options?: {
  93248. positionFunction?: any;
  93249. vertexFunction?: any;
  93250. }): number;
  93251. private _rebuildParticle;
  93252. /**
  93253. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  93254. * @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.
  93255. * @returns the SPS.
  93256. */
  93257. rebuildMesh(reset?: boolean): SolidParticleSystem;
  93258. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  93259. * Returns an array with the removed particles.
  93260. * 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.
  93261. * The SPS can't be empty so at least one particle needs to remain in place.
  93262. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  93263. * @param start index of the first particle to remove
  93264. * @param end index of the last particle to remove (included)
  93265. * @returns an array populated with the removed particles
  93266. */
  93267. removeParticles(start: number, end: number): SolidParticle[];
  93268. /**
  93269. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  93270. * This method calls `updateParticle()` for each particle of the SPS.
  93271. * For an animated SPS, it is usually called within the render loop.
  93272. * 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.
  93273. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  93274. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  93275. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  93276. * @returns the SPS.
  93277. */
  93278. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  93279. /**
  93280. * Disposes the SPS.
  93281. */
  93282. dispose(): void;
  93283. /**
  93284. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  93285. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93286. * @returns the SPS.
  93287. */
  93288. refreshVisibleSize(): SolidParticleSystem;
  93289. /**
  93290. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  93291. * @param size the size (float) of the visibility box
  93292. * note : this doesn't lock the SPS mesh bounding box.
  93293. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93294. */
  93295. setVisibilityBox(size: number): void;
  93296. /**
  93297. * Gets whether the SPS as always visible or not
  93298. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93299. */
  93300. /**
  93301. * Sets the SPS as always visible or not
  93302. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93303. */
  93304. isAlwaysVisible: boolean;
  93305. /**
  93306. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  93307. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93308. */
  93309. /**
  93310. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  93311. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93312. */
  93313. isVisibilityBoxLocked: boolean;
  93314. /**
  93315. * Tells to `setParticles()` to compute the particle rotations or not.
  93316. * Default value : true. The SPS is faster when it's set to false.
  93317. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  93318. */
  93319. /**
  93320. * Gets if `setParticles()` computes the particle rotations or not.
  93321. * Default value : true. The SPS is faster when it's set to false.
  93322. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  93323. */
  93324. computeParticleRotation: boolean;
  93325. /**
  93326. * Tells to `setParticles()` to compute the particle colors or not.
  93327. * Default value : true. The SPS is faster when it's set to false.
  93328. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  93329. */
  93330. /**
  93331. * Gets if `setParticles()` computes the particle colors or not.
  93332. * Default value : true. The SPS is faster when it's set to false.
  93333. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  93334. */
  93335. computeParticleColor: boolean;
  93336. /**
  93337. * Gets if `setParticles()` computes the particle textures or not.
  93338. * Default value : true. The SPS is faster when it's set to false.
  93339. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  93340. */
  93341. computeParticleTexture: boolean;
  93342. /**
  93343. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  93344. * Default value : false. The SPS is faster when it's set to false.
  93345. * Note : the particle custom vertex positions aren't stored values.
  93346. */
  93347. /**
  93348. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  93349. * Default value : false. The SPS is faster when it's set to false.
  93350. * Note : the particle custom vertex positions aren't stored values.
  93351. */
  93352. computeParticleVertex: boolean;
  93353. /**
  93354. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  93355. */
  93356. /**
  93357. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  93358. */
  93359. computeBoundingBox: boolean;
  93360. /**
  93361. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  93362. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  93363. * Default : `true`
  93364. */
  93365. /**
  93366. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  93367. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  93368. * Default : `true`
  93369. */
  93370. depthSortParticles: boolean;
  93371. /**
  93372. * Gets if the SPS is created as expandable at construction time.
  93373. * Default : `false`
  93374. */
  93375. readonly expandable: boolean;
  93376. /**
  93377. * This function does nothing. It may be overwritten to set all the particle first values.
  93378. * The SPS doesn't call this function, you may have to call it by your own.
  93379. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  93380. */
  93381. initParticles(): void;
  93382. /**
  93383. * This function does nothing. It may be overwritten to recycle a particle.
  93384. * The SPS doesn't call this function, you may have to call it by your own.
  93385. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  93386. * @param particle The particle to recycle
  93387. * @returns the recycled particle
  93388. */
  93389. recycleParticle(particle: SolidParticle): SolidParticle;
  93390. /**
  93391. * Updates a particle : this function should be overwritten by the user.
  93392. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  93393. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  93394. * @example : just set a particle position or velocity and recycle conditions
  93395. * @param particle The particle to update
  93396. * @returns the updated particle
  93397. */
  93398. updateParticle(particle: SolidParticle): SolidParticle;
  93399. /**
  93400. * Updates a vertex of a particle : it can be overwritten by the user.
  93401. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  93402. * @param particle the current particle
  93403. * @param vertex the current index of the current particle
  93404. * @param pt the index of the current vertex in the particle shape
  93405. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  93406. * @example : just set a vertex particle position
  93407. * @returns the updated vertex
  93408. */
  93409. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  93410. /**
  93411. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  93412. * This does nothing and may be overwritten by the user.
  93413. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93414. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93415. * @param update the boolean update value actually passed to setParticles()
  93416. */
  93417. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  93418. /**
  93419. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  93420. * This will be passed three parameters.
  93421. * This does nothing and may be overwritten by the user.
  93422. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93423. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93424. * @param update the boolean update value actually passed to setParticles()
  93425. */
  93426. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  93427. }
  93428. }
  93429. declare module BABYLON {
  93430. /**
  93431. * Represents one particle of a solid particle system.
  93432. */
  93433. export class SolidParticle {
  93434. /**
  93435. * particle global index
  93436. */
  93437. idx: number;
  93438. /**
  93439. * The color of the particle
  93440. */
  93441. color: Nullable<Color4>;
  93442. /**
  93443. * The world space position of the particle.
  93444. */
  93445. position: Vector3;
  93446. /**
  93447. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  93448. */
  93449. rotation: Vector3;
  93450. /**
  93451. * The world space rotation quaternion of the particle.
  93452. */
  93453. rotationQuaternion: Nullable<Quaternion>;
  93454. /**
  93455. * The scaling of the particle.
  93456. */
  93457. scaling: Vector3;
  93458. /**
  93459. * The uvs of the particle.
  93460. */
  93461. uvs: Vector4;
  93462. /**
  93463. * The current speed of the particle.
  93464. */
  93465. velocity: Vector3;
  93466. /**
  93467. * The pivot point in the particle local space.
  93468. */
  93469. pivot: Vector3;
  93470. /**
  93471. * Must the particle be translated from its pivot point in its local space ?
  93472. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  93473. * Default : false
  93474. */
  93475. translateFromPivot: boolean;
  93476. /**
  93477. * Is the particle active or not ?
  93478. */
  93479. alive: boolean;
  93480. /**
  93481. * Is the particle visible or not ?
  93482. */
  93483. isVisible: boolean;
  93484. /**
  93485. * Index of this particle in the global "positions" array (Internal use)
  93486. * @hidden
  93487. */
  93488. _pos: number;
  93489. /**
  93490. * @hidden Index of this particle in the global "indices" array (Internal use)
  93491. */
  93492. _ind: number;
  93493. /**
  93494. * @hidden ModelShape of this particle (Internal use)
  93495. */
  93496. _model: ModelShape;
  93497. /**
  93498. * ModelShape id of this particle
  93499. */
  93500. shapeId: number;
  93501. /**
  93502. * Index of the particle in its shape id
  93503. */
  93504. idxInShape: number;
  93505. /**
  93506. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  93507. */
  93508. _modelBoundingInfo: BoundingInfo;
  93509. /**
  93510. * @hidden Particle BoundingInfo object (Internal use)
  93511. */
  93512. _boundingInfo: BoundingInfo;
  93513. /**
  93514. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  93515. */
  93516. _sps: SolidParticleSystem;
  93517. /**
  93518. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  93519. */
  93520. _stillInvisible: boolean;
  93521. /**
  93522. * @hidden Last computed particle rotation matrix
  93523. */
  93524. _rotationMatrix: number[];
  93525. /**
  93526. * Parent particle Id, if any.
  93527. * Default null.
  93528. */
  93529. parentId: Nullable<number>;
  93530. /**
  93531. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  93532. * The possible values are :
  93533. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  93534. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  93535. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  93536. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  93537. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  93538. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  93539. * */
  93540. cullingStrategy: number;
  93541. /**
  93542. * @hidden Internal global position in the SPS.
  93543. */
  93544. _globalPosition: Vector3;
  93545. /**
  93546. * Creates a Solid Particle object.
  93547. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  93548. * @param particleIndex (integer) is the particle index in the Solid Particle System pool. It's also the particle identifier.
  93549. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  93550. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  93551. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  93552. * @param shapeId (integer) is the model shape identifier in the SPS.
  93553. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  93554. * @param sps defines the sps it is associated to
  93555. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  93556. */
  93557. constructor(particleIndex: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  93558. /**
  93559. * Legacy support, changed scale to scaling
  93560. */
  93561. /**
  93562. * Legacy support, changed scale to scaling
  93563. */
  93564. scale: Vector3;
  93565. /**
  93566. * Legacy support, changed quaternion to rotationQuaternion
  93567. */
  93568. /**
  93569. * Legacy support, changed quaternion to rotationQuaternion
  93570. */
  93571. quaternion: Nullable<Quaternion>;
  93572. /**
  93573. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  93574. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  93575. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  93576. * @returns true if it intersects
  93577. */
  93578. intersectsMesh(target: Mesh | SolidParticle): boolean;
  93579. /**
  93580. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  93581. * A particle is in the frustum if its bounding box intersects the frustum
  93582. * @param frustumPlanes defines the frustum to test
  93583. * @returns true if the particle is in the frustum planes
  93584. */
  93585. isInFrustum(frustumPlanes: Plane[]): boolean;
  93586. /**
  93587. * get the rotation matrix of the particle
  93588. * @hidden
  93589. */
  93590. getRotationMatrix(m: Matrix): void;
  93591. }
  93592. /**
  93593. * Represents the shape of the model used by one particle of a solid particle system.
  93594. * SPS internal tool, don't use it manually.
  93595. */
  93596. export class ModelShape {
  93597. /**
  93598. * The shape id
  93599. * @hidden
  93600. */
  93601. shapeID: number;
  93602. /**
  93603. * flat array of model positions (internal use)
  93604. * @hidden
  93605. */
  93606. _shape: Vector3[];
  93607. /**
  93608. * flat array of model UVs (internal use)
  93609. * @hidden
  93610. */
  93611. _shapeUV: number[];
  93612. /**
  93613. * color array of the model
  93614. * @hidden
  93615. */
  93616. _shapeColors: number[];
  93617. /**
  93618. * indices array of the model
  93619. * @hidden
  93620. */
  93621. _indices: number[];
  93622. /**
  93623. * normals array of the model
  93624. * @hidden
  93625. */
  93626. _normals: number[];
  93627. /**
  93628. * length of the shape in the model indices array (internal use)
  93629. * @hidden
  93630. */
  93631. _indicesLength: number;
  93632. /**
  93633. * Custom position function (internal use)
  93634. * @hidden
  93635. */
  93636. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  93637. /**
  93638. * Custom vertex function (internal use)
  93639. * @hidden
  93640. */
  93641. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  93642. /**
  93643. * 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.
  93644. * SPS internal tool, don't use it manually.
  93645. * @hidden
  93646. */
  93647. 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>);
  93648. }
  93649. /**
  93650. * Represents a Depth Sorted Particle in the solid particle system.
  93651. */
  93652. export class DepthSortedParticle {
  93653. /**
  93654. * Index of the particle in the "indices" array
  93655. */
  93656. ind: number;
  93657. /**
  93658. * Length of the particle shape in the "indices" array
  93659. */
  93660. indicesLength: number;
  93661. /**
  93662. * Squared distance from the particle to the camera
  93663. */
  93664. sqDistance: number;
  93665. }
  93666. }
  93667. declare module BABYLON {
  93668. /**
  93669. * @hidden
  93670. */
  93671. export class _MeshCollisionData {
  93672. _checkCollisions: boolean;
  93673. _collisionMask: number;
  93674. _collisionGroup: number;
  93675. _collider: Nullable<Collider>;
  93676. _oldPositionForCollisions: Vector3;
  93677. _diffPositionForCollisions: Vector3;
  93678. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  93679. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  93680. }
  93681. }
  93682. declare module BABYLON {
  93683. /** @hidden */
  93684. class _FacetDataStorage {
  93685. facetPositions: Vector3[];
  93686. facetNormals: Vector3[];
  93687. facetPartitioning: number[][];
  93688. facetNb: number;
  93689. partitioningSubdivisions: number;
  93690. partitioningBBoxRatio: number;
  93691. facetDataEnabled: boolean;
  93692. facetParameters: any;
  93693. bbSize: Vector3;
  93694. subDiv: {
  93695. max: number;
  93696. X: number;
  93697. Y: number;
  93698. Z: number;
  93699. };
  93700. facetDepthSort: boolean;
  93701. facetDepthSortEnabled: boolean;
  93702. depthSortedIndices: IndicesArray;
  93703. depthSortedFacets: {
  93704. ind: number;
  93705. sqDistance: number;
  93706. }[];
  93707. facetDepthSortFunction: (f1: {
  93708. ind: number;
  93709. sqDistance: number;
  93710. }, f2: {
  93711. ind: number;
  93712. sqDistance: number;
  93713. }) => number;
  93714. facetDepthSortFrom: Vector3;
  93715. facetDepthSortOrigin: Vector3;
  93716. invertedMatrix: Matrix;
  93717. }
  93718. /**
  93719. * @hidden
  93720. **/
  93721. class _InternalAbstractMeshDataInfo {
  93722. _hasVertexAlpha: boolean;
  93723. _useVertexColors: boolean;
  93724. _numBoneInfluencers: number;
  93725. _applyFog: boolean;
  93726. _receiveShadows: boolean;
  93727. _facetData: _FacetDataStorage;
  93728. _visibility: number;
  93729. _skeleton: Nullable<Skeleton>;
  93730. _layerMask: number;
  93731. _computeBonesUsingShaders: boolean;
  93732. _isActive: boolean;
  93733. _onlyForInstances: boolean;
  93734. _isActiveIntermediate: boolean;
  93735. _onlyForInstancesIntermediate: boolean;
  93736. _actAsRegularMesh: boolean;
  93737. }
  93738. /**
  93739. * Class used to store all common mesh properties
  93740. */
  93741. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  93742. /** No occlusion */
  93743. static OCCLUSION_TYPE_NONE: number;
  93744. /** Occlusion set to optimisitic */
  93745. static OCCLUSION_TYPE_OPTIMISTIC: number;
  93746. /** Occlusion set to strict */
  93747. static OCCLUSION_TYPE_STRICT: number;
  93748. /** Use an accurante occlusion algorithm */
  93749. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  93750. /** Use a conservative occlusion algorithm */
  93751. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  93752. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  93753. * Test order :
  93754. * Is the bounding sphere outside the frustum ?
  93755. * If not, are the bounding box vertices outside the frustum ?
  93756. * It not, then the cullable object is in the frustum.
  93757. */
  93758. static readonly CULLINGSTRATEGY_STANDARD: number;
  93759. /** Culling strategy : Bounding Sphere Only.
  93760. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  93761. * It's also less accurate than the standard because some not visible objects can still be selected.
  93762. * Test : is the bounding sphere outside the frustum ?
  93763. * If not, then the cullable object is in the frustum.
  93764. */
  93765. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  93766. /** Culling strategy : Optimistic Inclusion.
  93767. * This in an inclusion test first, then the standard exclusion test.
  93768. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  93769. * 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.
  93770. * Anyway, it's as accurate as the standard strategy.
  93771. * Test :
  93772. * Is the cullable object bounding sphere center in the frustum ?
  93773. * If not, apply the default culling strategy.
  93774. */
  93775. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  93776. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  93777. * This in an inclusion test first, then the bounding sphere only exclusion test.
  93778. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  93779. * 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.
  93780. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  93781. * Test :
  93782. * Is the cullable object bounding sphere center in the frustum ?
  93783. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  93784. */
  93785. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  93786. /**
  93787. * No billboard
  93788. */
  93789. static readonly BILLBOARDMODE_NONE: number;
  93790. /** Billboard on X axis */
  93791. static readonly BILLBOARDMODE_X: number;
  93792. /** Billboard on Y axis */
  93793. static readonly BILLBOARDMODE_Y: number;
  93794. /** Billboard on Z axis */
  93795. static readonly BILLBOARDMODE_Z: number;
  93796. /** Billboard on all axes */
  93797. static readonly BILLBOARDMODE_ALL: number;
  93798. /** Billboard on using position instead of orientation */
  93799. static readonly BILLBOARDMODE_USE_POSITION: number;
  93800. /** @hidden */
  93801. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  93802. /**
  93803. * The culling strategy to use to check whether the mesh must be rendered or not.
  93804. * This value can be changed at any time and will be used on the next render mesh selection.
  93805. * The possible values are :
  93806. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  93807. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  93808. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  93809. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  93810. * Please read each static variable documentation to get details about the culling process.
  93811. * */
  93812. cullingStrategy: number;
  93813. /**
  93814. * Gets the number of facets in the mesh
  93815. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  93816. */
  93817. readonly facetNb: number;
  93818. /**
  93819. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  93820. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  93821. */
  93822. partitioningSubdivisions: number;
  93823. /**
  93824. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  93825. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  93826. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  93827. */
  93828. partitioningBBoxRatio: number;
  93829. /**
  93830. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  93831. * Works only for updatable meshes.
  93832. * Doesn't work with multi-materials
  93833. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  93834. */
  93835. mustDepthSortFacets: boolean;
  93836. /**
  93837. * The location (Vector3) where the facet depth sort must be computed from.
  93838. * By default, the active camera position.
  93839. * Used only when facet depth sort is enabled
  93840. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  93841. */
  93842. facetDepthSortFrom: Vector3;
  93843. /**
  93844. * gets a boolean indicating if facetData is enabled
  93845. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  93846. */
  93847. readonly isFacetDataEnabled: boolean;
  93848. /** @hidden */
  93849. _updateNonUniformScalingState(value: boolean): boolean;
  93850. /**
  93851. * An event triggered when this mesh collides with another one
  93852. */
  93853. onCollideObservable: Observable<AbstractMesh>;
  93854. /** Set a function to call when this mesh collides with another one */
  93855. onCollide: () => void;
  93856. /**
  93857. * An event triggered when the collision's position changes
  93858. */
  93859. onCollisionPositionChangeObservable: Observable<Vector3>;
  93860. /** Set a function to call when the collision's position changes */
  93861. onCollisionPositionChange: () => void;
  93862. /**
  93863. * An event triggered when material is changed
  93864. */
  93865. onMaterialChangedObservable: Observable<AbstractMesh>;
  93866. /**
  93867. * Gets or sets the orientation for POV movement & rotation
  93868. */
  93869. definedFacingForward: boolean;
  93870. /** @hidden */
  93871. _occlusionQuery: Nullable<WebGLQuery>;
  93872. /** @hidden */
  93873. _renderingGroup: Nullable<RenderingGroup>;
  93874. /**
  93875. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  93876. */
  93877. /**
  93878. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  93879. */
  93880. visibility: number;
  93881. /** Gets or sets the alpha index used to sort transparent meshes
  93882. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  93883. */
  93884. alphaIndex: number;
  93885. /**
  93886. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  93887. */
  93888. isVisible: boolean;
  93889. /**
  93890. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  93891. */
  93892. isPickable: boolean;
  93893. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  93894. showSubMeshesBoundingBox: boolean;
  93895. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  93896. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  93897. */
  93898. isBlocker: boolean;
  93899. /**
  93900. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  93901. */
  93902. enablePointerMoveEvents: boolean;
  93903. /**
  93904. * Specifies the rendering group id for this mesh (0 by default)
  93905. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  93906. */
  93907. renderingGroupId: number;
  93908. private _material;
  93909. /** Gets or sets current material */
  93910. material: Nullable<Material>;
  93911. /**
  93912. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  93913. * @see http://doc.babylonjs.com/babylon101/shadows
  93914. */
  93915. receiveShadows: boolean;
  93916. /** Defines color to use when rendering outline */
  93917. outlineColor: Color3;
  93918. /** Define width to use when rendering outline */
  93919. outlineWidth: number;
  93920. /** Defines color to use when rendering overlay */
  93921. overlayColor: Color3;
  93922. /** Defines alpha to use when rendering overlay */
  93923. overlayAlpha: number;
  93924. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  93925. hasVertexAlpha: boolean;
  93926. /** 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) */
  93927. useVertexColors: boolean;
  93928. /**
  93929. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  93930. */
  93931. computeBonesUsingShaders: boolean;
  93932. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  93933. numBoneInfluencers: number;
  93934. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  93935. applyFog: boolean;
  93936. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  93937. useOctreeForRenderingSelection: boolean;
  93938. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  93939. useOctreeForPicking: boolean;
  93940. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  93941. useOctreeForCollisions: boolean;
  93942. /**
  93943. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  93944. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  93945. */
  93946. layerMask: number;
  93947. /**
  93948. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  93949. */
  93950. alwaysSelectAsActiveMesh: boolean;
  93951. /**
  93952. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  93953. */
  93954. doNotSyncBoundingInfo: boolean;
  93955. /**
  93956. * Gets or sets the current action manager
  93957. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  93958. */
  93959. actionManager: Nullable<AbstractActionManager>;
  93960. private _meshCollisionData;
  93961. /**
  93962. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  93963. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  93964. */
  93965. ellipsoid: Vector3;
  93966. /**
  93967. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  93968. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  93969. */
  93970. ellipsoidOffset: Vector3;
  93971. /**
  93972. * Gets or sets a collision mask used to mask collisions (default is -1).
  93973. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  93974. */
  93975. collisionMask: number;
  93976. /**
  93977. * Gets or sets the current collision group mask (-1 by default).
  93978. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  93979. */
  93980. collisionGroup: number;
  93981. /**
  93982. * Defines edge width used when edgesRenderer is enabled
  93983. * @see https://www.babylonjs-playground.com/#10OJSG#13
  93984. */
  93985. edgesWidth: number;
  93986. /**
  93987. * Defines edge color used when edgesRenderer is enabled
  93988. * @see https://www.babylonjs-playground.com/#10OJSG#13
  93989. */
  93990. edgesColor: Color4;
  93991. /** @hidden */
  93992. _edgesRenderer: Nullable<IEdgesRenderer>;
  93993. /** @hidden */
  93994. _masterMesh: Nullable<AbstractMesh>;
  93995. /** @hidden */
  93996. _boundingInfo: Nullable<BoundingInfo>;
  93997. /** @hidden */
  93998. _renderId: number;
  93999. /**
  94000. * Gets or sets the list of subMeshes
  94001. * @see http://doc.babylonjs.com/how_to/multi_materials
  94002. */
  94003. subMeshes: SubMesh[];
  94004. /** @hidden */
  94005. _intersectionsInProgress: AbstractMesh[];
  94006. /** @hidden */
  94007. _unIndexed: boolean;
  94008. /** @hidden */
  94009. _lightSources: Light[];
  94010. /** Gets the list of lights affecting that mesh */
  94011. readonly lightSources: Light[];
  94012. /** @hidden */
  94013. readonly _positions: Nullable<Vector3[]>;
  94014. /** @hidden */
  94015. _waitingData: {
  94016. lods: Nullable<any>;
  94017. actions: Nullable<any>;
  94018. freezeWorldMatrix: Nullable<boolean>;
  94019. };
  94020. /** @hidden */
  94021. _bonesTransformMatrices: Nullable<Float32Array>;
  94022. /** @hidden */
  94023. _transformMatrixTexture: Nullable<RawTexture>;
  94024. /**
  94025. * Gets or sets a skeleton to apply skining transformations
  94026. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94027. */
  94028. skeleton: Nullable<Skeleton>;
  94029. /**
  94030. * An event triggered when the mesh is rebuilt.
  94031. */
  94032. onRebuildObservable: Observable<AbstractMesh>;
  94033. /**
  94034. * Creates a new AbstractMesh
  94035. * @param name defines the name of the mesh
  94036. * @param scene defines the hosting scene
  94037. */
  94038. constructor(name: string, scene?: Nullable<Scene>);
  94039. /**
  94040. * Returns the string "AbstractMesh"
  94041. * @returns "AbstractMesh"
  94042. */
  94043. getClassName(): string;
  94044. /**
  94045. * Gets a string representation of the current mesh
  94046. * @param fullDetails defines a boolean indicating if full details must be included
  94047. * @returns a string representation of the current mesh
  94048. */
  94049. toString(fullDetails?: boolean): string;
  94050. /**
  94051. * @hidden
  94052. */
  94053. protected _getEffectiveParent(): Nullable<Node>;
  94054. /** @hidden */
  94055. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  94056. /** @hidden */
  94057. _rebuild(): void;
  94058. /** @hidden */
  94059. _resyncLightSources(): void;
  94060. /** @hidden */
  94061. _resyncLighSource(light: Light): void;
  94062. /** @hidden */
  94063. _unBindEffect(): void;
  94064. /** @hidden */
  94065. _removeLightSource(light: Light, dispose: boolean): void;
  94066. private _markSubMeshesAsDirty;
  94067. /** @hidden */
  94068. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  94069. /** @hidden */
  94070. _markSubMeshesAsAttributesDirty(): void;
  94071. /** @hidden */
  94072. _markSubMeshesAsMiscDirty(): void;
  94073. /**
  94074. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  94075. */
  94076. scaling: Vector3;
  94077. /**
  94078. * Returns true if the mesh is blocked. Implemented by child classes
  94079. */
  94080. readonly isBlocked: boolean;
  94081. /**
  94082. * Returns the mesh itself by default. Implemented by child classes
  94083. * @param camera defines the camera to use to pick the right LOD level
  94084. * @returns the currentAbstractMesh
  94085. */
  94086. getLOD(camera: Camera): Nullable<AbstractMesh>;
  94087. /**
  94088. * Returns 0 by default. Implemented by child classes
  94089. * @returns an integer
  94090. */
  94091. getTotalVertices(): number;
  94092. /**
  94093. * Returns a positive integer : the total number of indices in this mesh geometry.
  94094. * @returns the numner of indices or zero if the mesh has no geometry.
  94095. */
  94096. getTotalIndices(): number;
  94097. /**
  94098. * Returns null by default. Implemented by child classes
  94099. * @returns null
  94100. */
  94101. getIndices(): Nullable<IndicesArray>;
  94102. /**
  94103. * Returns the array of the requested vertex data kind. Implemented by child classes
  94104. * @param kind defines the vertex data kind to use
  94105. * @returns null
  94106. */
  94107. getVerticesData(kind: string): Nullable<FloatArray>;
  94108. /**
  94109. * Sets the vertex data of the mesh geometry for the requested `kind`.
  94110. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  94111. * Note that a new underlying VertexBuffer object is created each call.
  94112. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  94113. * @param kind defines vertex data kind:
  94114. * * VertexBuffer.PositionKind
  94115. * * VertexBuffer.UVKind
  94116. * * VertexBuffer.UV2Kind
  94117. * * VertexBuffer.UV3Kind
  94118. * * VertexBuffer.UV4Kind
  94119. * * VertexBuffer.UV5Kind
  94120. * * VertexBuffer.UV6Kind
  94121. * * VertexBuffer.ColorKind
  94122. * * VertexBuffer.MatricesIndicesKind
  94123. * * VertexBuffer.MatricesIndicesExtraKind
  94124. * * VertexBuffer.MatricesWeightsKind
  94125. * * VertexBuffer.MatricesWeightsExtraKind
  94126. * @param data defines the data source
  94127. * @param updatable defines if the data must be flagged as updatable (or static)
  94128. * @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
  94129. * @returns the current mesh
  94130. */
  94131. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  94132. /**
  94133. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  94134. * If the mesh has no geometry, it is simply returned as it is.
  94135. * @param kind defines vertex data kind:
  94136. * * VertexBuffer.PositionKind
  94137. * * VertexBuffer.UVKind
  94138. * * VertexBuffer.UV2Kind
  94139. * * VertexBuffer.UV3Kind
  94140. * * VertexBuffer.UV4Kind
  94141. * * VertexBuffer.UV5Kind
  94142. * * VertexBuffer.UV6Kind
  94143. * * VertexBuffer.ColorKind
  94144. * * VertexBuffer.MatricesIndicesKind
  94145. * * VertexBuffer.MatricesIndicesExtraKind
  94146. * * VertexBuffer.MatricesWeightsKind
  94147. * * VertexBuffer.MatricesWeightsExtraKind
  94148. * @param data defines the data source
  94149. * @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
  94150. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  94151. * @returns the current mesh
  94152. */
  94153. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  94154. /**
  94155. * Sets the mesh indices,
  94156. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  94157. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  94158. * @param totalVertices Defines the total number of vertices
  94159. * @returns the current mesh
  94160. */
  94161. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  94162. /**
  94163. * Gets a boolean indicating if specific vertex data is present
  94164. * @param kind defines the vertex data kind to use
  94165. * @returns true is data kind is present
  94166. */
  94167. isVerticesDataPresent(kind: string): boolean;
  94168. /**
  94169. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  94170. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  94171. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  94172. * @returns a BoundingInfo
  94173. */
  94174. getBoundingInfo(): BoundingInfo;
  94175. /**
  94176. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94177. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94178. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94179. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94180. * @returns the current mesh
  94181. */
  94182. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  94183. /**
  94184. * Overwrite the current bounding info
  94185. * @param boundingInfo defines the new bounding info
  94186. * @returns the current mesh
  94187. */
  94188. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  94189. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  94190. readonly useBones: boolean;
  94191. /** @hidden */
  94192. _preActivate(): void;
  94193. /** @hidden */
  94194. _preActivateForIntermediateRendering(renderId: number): void;
  94195. /** @hidden */
  94196. _activate(renderId: number, intermediateRendering: boolean): boolean;
  94197. /** @hidden */
  94198. _postActivate(): void;
  94199. /** @hidden */
  94200. _freeze(): void;
  94201. /** @hidden */
  94202. _unFreeze(): void;
  94203. /**
  94204. * Gets the current world matrix
  94205. * @returns a Matrix
  94206. */
  94207. getWorldMatrix(): Matrix;
  94208. /** @hidden */
  94209. _getWorldMatrixDeterminant(): number;
  94210. /**
  94211. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  94212. */
  94213. readonly isAnInstance: boolean;
  94214. /**
  94215. * Gets a boolean indicating if this mesh has instances
  94216. */
  94217. readonly hasInstances: boolean;
  94218. /**
  94219. * Perform relative position change from the point of view of behind the front of the mesh.
  94220. * This is performed taking into account the meshes current rotation, so you do not have to care.
  94221. * Supports definition of mesh facing forward or backward
  94222. * @param amountRight defines the distance on the right axis
  94223. * @param amountUp defines the distance on the up axis
  94224. * @param amountForward defines the distance on the forward axis
  94225. * @returns the current mesh
  94226. */
  94227. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  94228. /**
  94229. * Calculate relative position change from the point of view of behind the front of the mesh.
  94230. * This is performed taking into account the meshes current rotation, so you do not have to care.
  94231. * Supports definition of mesh facing forward or backward
  94232. * @param amountRight defines the distance on the right axis
  94233. * @param amountUp defines the distance on the up axis
  94234. * @param amountForward defines the distance on the forward axis
  94235. * @returns the new displacement vector
  94236. */
  94237. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  94238. /**
  94239. * Perform relative rotation change from the point of view of behind the front of the mesh.
  94240. * Supports definition of mesh facing forward or backward
  94241. * @param flipBack defines the flip
  94242. * @param twirlClockwise defines the twirl
  94243. * @param tiltRight defines the tilt
  94244. * @returns the current mesh
  94245. */
  94246. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  94247. /**
  94248. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  94249. * Supports definition of mesh facing forward or backward.
  94250. * @param flipBack defines the flip
  94251. * @param twirlClockwise defines the twirl
  94252. * @param tiltRight defines the tilt
  94253. * @returns the new rotation vector
  94254. */
  94255. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  94256. /**
  94257. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  94258. * This means the mesh underlying bounding box and sphere are recomputed.
  94259. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  94260. * @returns the current mesh
  94261. */
  94262. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  94263. /** @hidden */
  94264. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  94265. /** @hidden */
  94266. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  94267. /** @hidden */
  94268. _updateBoundingInfo(): AbstractMesh;
  94269. /** @hidden */
  94270. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  94271. /** @hidden */
  94272. protected _afterComputeWorldMatrix(): void;
  94273. /** @hidden */
  94274. readonly _effectiveMesh: AbstractMesh;
  94275. /**
  94276. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  94277. * A mesh is in the frustum if its bounding box intersects the frustum
  94278. * @param frustumPlanes defines the frustum to test
  94279. * @returns true if the mesh is in the frustum planes
  94280. */
  94281. isInFrustum(frustumPlanes: Plane[]): boolean;
  94282. /**
  94283. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  94284. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  94285. * @param frustumPlanes defines the frustum to test
  94286. * @returns true if the mesh is completely in the frustum planes
  94287. */
  94288. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  94289. /**
  94290. * True if the mesh intersects another mesh or a SolidParticle object
  94291. * @param mesh defines a target mesh or SolidParticle to test
  94292. * @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)
  94293. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  94294. * @returns true if there is an intersection
  94295. */
  94296. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  94297. /**
  94298. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  94299. * @param point defines the point to test
  94300. * @returns true if there is an intersection
  94301. */
  94302. intersectsPoint(point: Vector3): boolean;
  94303. /**
  94304. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  94305. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94306. */
  94307. checkCollisions: boolean;
  94308. /**
  94309. * Gets Collider object used to compute collisions (not physics)
  94310. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94311. */
  94312. readonly collider: Nullable<Collider>;
  94313. /**
  94314. * Move the mesh using collision engine
  94315. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94316. * @param displacement defines the requested displacement vector
  94317. * @returns the current mesh
  94318. */
  94319. moveWithCollisions(displacement: Vector3): AbstractMesh;
  94320. private _onCollisionPositionChange;
  94321. /** @hidden */
  94322. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  94323. /** @hidden */
  94324. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  94325. /** @hidden */
  94326. _checkCollision(collider: Collider): AbstractMesh;
  94327. /** @hidden */
  94328. _generatePointsArray(): boolean;
  94329. /**
  94330. * Checks if the passed Ray intersects with the mesh
  94331. * @param ray defines the ray to use
  94332. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  94333. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  94334. * @returns the picking info
  94335. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  94336. */
  94337. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  94338. /**
  94339. * Clones the current mesh
  94340. * @param name defines the mesh name
  94341. * @param newParent defines the new mesh parent
  94342. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  94343. * @returns the new mesh
  94344. */
  94345. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  94346. /**
  94347. * Disposes all the submeshes of the current meshnp
  94348. * @returns the current mesh
  94349. */
  94350. releaseSubMeshes(): AbstractMesh;
  94351. /**
  94352. * Releases resources associated with this abstract mesh.
  94353. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94354. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94355. */
  94356. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94357. /**
  94358. * Adds the passed mesh as a child to the current mesh
  94359. * @param mesh defines the child mesh
  94360. * @returns the current mesh
  94361. */
  94362. addChild(mesh: AbstractMesh): AbstractMesh;
  94363. /**
  94364. * Removes the passed mesh from the current mesh children list
  94365. * @param mesh defines the child mesh
  94366. * @returns the current mesh
  94367. */
  94368. removeChild(mesh: AbstractMesh): AbstractMesh;
  94369. /** @hidden */
  94370. private _initFacetData;
  94371. /**
  94372. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  94373. * This method can be called within the render loop.
  94374. * 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
  94375. * @returns the current mesh
  94376. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94377. */
  94378. updateFacetData(): AbstractMesh;
  94379. /**
  94380. * Returns the facetLocalNormals array.
  94381. * The normals are expressed in the mesh local spac
  94382. * @returns an array of Vector3
  94383. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94384. */
  94385. getFacetLocalNormals(): Vector3[];
  94386. /**
  94387. * Returns the facetLocalPositions array.
  94388. * The facet positions are expressed in the mesh local space
  94389. * @returns an array of Vector3
  94390. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94391. */
  94392. getFacetLocalPositions(): Vector3[];
  94393. /**
  94394. * Returns the facetLocalPartioning array
  94395. * @returns an array of array of numbers
  94396. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94397. */
  94398. getFacetLocalPartitioning(): number[][];
  94399. /**
  94400. * Returns the i-th facet position in the world system.
  94401. * This method allocates a new Vector3 per call
  94402. * @param i defines the facet index
  94403. * @returns a new Vector3
  94404. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94405. */
  94406. getFacetPosition(i: number): Vector3;
  94407. /**
  94408. * Sets the reference Vector3 with the i-th facet position in the world system
  94409. * @param i defines the facet index
  94410. * @param ref defines the target vector
  94411. * @returns the current mesh
  94412. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94413. */
  94414. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  94415. /**
  94416. * Returns the i-th facet normal in the world system.
  94417. * This method allocates a new Vector3 per call
  94418. * @param i defines the facet index
  94419. * @returns a new Vector3
  94420. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94421. */
  94422. getFacetNormal(i: number): Vector3;
  94423. /**
  94424. * Sets the reference Vector3 with the i-th facet normal in the world system
  94425. * @param i defines the facet index
  94426. * @param ref defines the target vector
  94427. * @returns the current mesh
  94428. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94429. */
  94430. getFacetNormalToRef(i: number, ref: Vector3): this;
  94431. /**
  94432. * 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)
  94433. * @param x defines x coordinate
  94434. * @param y defines y coordinate
  94435. * @param z defines z coordinate
  94436. * @returns the array of facet indexes
  94437. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94438. */
  94439. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  94440. /**
  94441. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  94442. * @param projected sets as the (x,y,z) world projection on the facet
  94443. * @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
  94444. * @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
  94445. * @param x defines x coordinate
  94446. * @param y defines y coordinate
  94447. * @param z defines z coordinate
  94448. * @returns the face index if found (or null instead)
  94449. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94450. */
  94451. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  94452. /**
  94453. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  94454. * @param projected sets as the (x,y,z) local projection on the facet
  94455. * @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
  94456. * @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
  94457. * @param x defines x coordinate
  94458. * @param y defines y coordinate
  94459. * @param z defines z coordinate
  94460. * @returns the face index if found (or null instead)
  94461. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94462. */
  94463. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  94464. /**
  94465. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  94466. * @returns the parameters
  94467. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94468. */
  94469. getFacetDataParameters(): any;
  94470. /**
  94471. * Disables the feature FacetData and frees the related memory
  94472. * @returns the current mesh
  94473. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94474. */
  94475. disableFacetData(): AbstractMesh;
  94476. /**
  94477. * Updates the AbstractMesh indices array
  94478. * @param indices defines the data source
  94479. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  94480. * @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)
  94481. * @returns the current mesh
  94482. */
  94483. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  94484. /**
  94485. * Creates new normals data for the mesh
  94486. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  94487. * @returns the current mesh
  94488. */
  94489. createNormals(updatable: boolean): AbstractMesh;
  94490. /**
  94491. * Align the mesh with a normal
  94492. * @param normal defines the normal to use
  94493. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  94494. * @returns the current mesh
  94495. */
  94496. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  94497. /** @hidden */
  94498. _checkOcclusionQuery(): boolean;
  94499. /**
  94500. * Disables the mesh edge rendering mode
  94501. * @returns the currentAbstractMesh
  94502. */
  94503. disableEdgesRendering(): AbstractMesh;
  94504. /**
  94505. * Enables the edge rendering mode on the mesh.
  94506. * This mode makes the mesh edges visible
  94507. * @param epsilon defines the maximal distance between two angles to detect a face
  94508. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  94509. * @returns the currentAbstractMesh
  94510. * @see https://www.babylonjs-playground.com/#19O9TU#0
  94511. */
  94512. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  94513. }
  94514. }
  94515. declare module BABYLON {
  94516. /**
  94517. * Interface used to define ActionEvent
  94518. */
  94519. export interface IActionEvent {
  94520. /** The mesh or sprite that triggered the action */
  94521. source: any;
  94522. /** The X mouse cursor position at the time of the event */
  94523. pointerX: number;
  94524. /** The Y mouse cursor position at the time of the event */
  94525. pointerY: number;
  94526. /** The mesh that is currently pointed at (can be null) */
  94527. meshUnderPointer: Nullable<AbstractMesh>;
  94528. /** the original (browser) event that triggered the ActionEvent */
  94529. sourceEvent?: any;
  94530. /** additional data for the event */
  94531. additionalData?: any;
  94532. }
  94533. /**
  94534. * ActionEvent is the event being sent when an action is triggered.
  94535. */
  94536. export class ActionEvent implements IActionEvent {
  94537. /** The mesh or sprite that triggered the action */
  94538. source: any;
  94539. /** The X mouse cursor position at the time of the event */
  94540. pointerX: number;
  94541. /** The Y mouse cursor position at the time of the event */
  94542. pointerY: number;
  94543. /** The mesh that is currently pointed at (can be null) */
  94544. meshUnderPointer: Nullable<AbstractMesh>;
  94545. /** the original (browser) event that triggered the ActionEvent */
  94546. sourceEvent?: any;
  94547. /** additional data for the event */
  94548. additionalData?: any;
  94549. /**
  94550. * Creates a new ActionEvent
  94551. * @param source The mesh or sprite that triggered the action
  94552. * @param pointerX The X mouse cursor position at the time of the event
  94553. * @param pointerY The Y mouse cursor position at the time of the event
  94554. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  94555. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  94556. * @param additionalData additional data for the event
  94557. */
  94558. constructor(
  94559. /** The mesh or sprite that triggered the action */
  94560. source: any,
  94561. /** The X mouse cursor position at the time of the event */
  94562. pointerX: number,
  94563. /** The Y mouse cursor position at the time of the event */
  94564. pointerY: number,
  94565. /** The mesh that is currently pointed at (can be null) */
  94566. meshUnderPointer: Nullable<AbstractMesh>,
  94567. /** the original (browser) event that triggered the ActionEvent */
  94568. sourceEvent?: any,
  94569. /** additional data for the event */
  94570. additionalData?: any);
  94571. /**
  94572. * Helper function to auto-create an ActionEvent from a source mesh.
  94573. * @param source The source mesh that triggered the event
  94574. * @param evt The original (browser) event
  94575. * @param additionalData additional data for the event
  94576. * @returns the new ActionEvent
  94577. */
  94578. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  94579. /**
  94580. * Helper function to auto-create an ActionEvent from a source sprite
  94581. * @param source The source sprite that triggered the event
  94582. * @param scene Scene associated with the sprite
  94583. * @param evt The original (browser) event
  94584. * @param additionalData additional data for the event
  94585. * @returns the new ActionEvent
  94586. */
  94587. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  94588. /**
  94589. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  94590. * @param scene the scene where the event occurred
  94591. * @param evt The original (browser) event
  94592. * @returns the new ActionEvent
  94593. */
  94594. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  94595. /**
  94596. * Helper function to auto-create an ActionEvent from a primitive
  94597. * @param prim defines the target primitive
  94598. * @param pointerPos defines the pointer position
  94599. * @param evt The original (browser) event
  94600. * @param additionalData additional data for the event
  94601. * @returns the new ActionEvent
  94602. */
  94603. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  94604. }
  94605. }
  94606. declare module BABYLON {
  94607. /**
  94608. * Abstract class used to decouple action Manager from scene and meshes.
  94609. * Do not instantiate.
  94610. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  94611. */
  94612. export abstract class AbstractActionManager implements IDisposable {
  94613. /** Gets the list of active triggers */
  94614. static Triggers: {
  94615. [key: string]: number;
  94616. };
  94617. /** Gets the cursor to use when hovering items */
  94618. hoverCursor: string;
  94619. /** Gets the list of actions */
  94620. actions: IAction[];
  94621. /**
  94622. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  94623. */
  94624. isRecursive: boolean;
  94625. /**
  94626. * Releases all associated resources
  94627. */
  94628. abstract dispose(): void;
  94629. /**
  94630. * Does this action manager has pointer triggers
  94631. */
  94632. abstract readonly hasPointerTriggers: boolean;
  94633. /**
  94634. * Does this action manager has pick triggers
  94635. */
  94636. abstract readonly hasPickTriggers: boolean;
  94637. /**
  94638. * Process a specific trigger
  94639. * @param trigger defines the trigger to process
  94640. * @param evt defines the event details to be processed
  94641. */
  94642. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  94643. /**
  94644. * Does this action manager handles actions of any of the given triggers
  94645. * @param triggers defines the triggers to be tested
  94646. * @return a boolean indicating whether one (or more) of the triggers is handled
  94647. */
  94648. abstract hasSpecificTriggers(triggers: number[]): boolean;
  94649. /**
  94650. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  94651. * speed.
  94652. * @param triggerA defines the trigger to be tested
  94653. * @param triggerB defines the trigger to be tested
  94654. * @return a boolean indicating whether one (or more) of the triggers is handled
  94655. */
  94656. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  94657. /**
  94658. * Does this action manager handles actions of a given trigger
  94659. * @param trigger defines the trigger to be tested
  94660. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  94661. * @return whether the trigger is handled
  94662. */
  94663. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  94664. /**
  94665. * Serialize this manager to a JSON object
  94666. * @param name defines the property name to store this manager
  94667. * @returns a JSON representation of this manager
  94668. */
  94669. abstract serialize(name: string): any;
  94670. /**
  94671. * Registers an action to this action manager
  94672. * @param action defines the action to be registered
  94673. * @return the action amended (prepared) after registration
  94674. */
  94675. abstract registerAction(action: IAction): Nullable<IAction>;
  94676. /**
  94677. * Unregisters an action to this action manager
  94678. * @param action defines the action to be unregistered
  94679. * @return a boolean indicating whether the action has been unregistered
  94680. */
  94681. abstract unregisterAction(action: IAction): Boolean;
  94682. /**
  94683. * Does exist one action manager with at least one trigger
  94684. **/
  94685. static readonly HasTriggers: boolean;
  94686. /**
  94687. * Does exist one action manager with at least one pick trigger
  94688. **/
  94689. static readonly HasPickTriggers: boolean;
  94690. /**
  94691. * Does exist one action manager that handles actions of a given trigger
  94692. * @param trigger defines the trigger to be tested
  94693. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  94694. **/
  94695. static HasSpecificTrigger(trigger: number): boolean;
  94696. }
  94697. }
  94698. declare module BABYLON {
  94699. /**
  94700. * Defines how a node can be built from a string name.
  94701. */
  94702. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  94703. /**
  94704. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  94705. */
  94706. export class Node implements IBehaviorAware<Node> {
  94707. /** @hidden */
  94708. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  94709. private static _NodeConstructors;
  94710. /**
  94711. * Add a new node constructor
  94712. * @param type defines the type name of the node to construct
  94713. * @param constructorFunc defines the constructor function
  94714. */
  94715. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  94716. /**
  94717. * Returns a node constructor based on type name
  94718. * @param type defines the type name
  94719. * @param name defines the new node name
  94720. * @param scene defines the hosting scene
  94721. * @param options defines optional options to transmit to constructors
  94722. * @returns the new constructor or null
  94723. */
  94724. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  94725. /**
  94726. * Gets or sets the name of the node
  94727. */
  94728. name: string;
  94729. /**
  94730. * Gets or sets the id of the node
  94731. */
  94732. id: string;
  94733. /**
  94734. * Gets or sets the unique id of the node
  94735. */
  94736. uniqueId: number;
  94737. /**
  94738. * Gets or sets a string used to store user defined state for the node
  94739. */
  94740. state: string;
  94741. /**
  94742. * Gets or sets an object used to store user defined information for the node
  94743. */
  94744. metadata: any;
  94745. /**
  94746. * For internal use only. Please do not use.
  94747. */
  94748. reservedDataStore: any;
  94749. /**
  94750. * List of inspectable custom properties (used by the Inspector)
  94751. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  94752. */
  94753. inspectableCustomProperties: IInspectable[];
  94754. private _doNotSerialize;
  94755. /**
  94756. * Gets or sets a boolean used to define if the node must be serialized
  94757. */
  94758. doNotSerialize: boolean;
  94759. /** @hidden */
  94760. _isDisposed: boolean;
  94761. /**
  94762. * Gets a list of Animations associated with the node
  94763. */
  94764. animations: Animation[];
  94765. protected _ranges: {
  94766. [name: string]: Nullable<AnimationRange>;
  94767. };
  94768. /**
  94769. * Callback raised when the node is ready to be used
  94770. */
  94771. onReady: Nullable<(node: Node) => void>;
  94772. private _isEnabled;
  94773. private _isParentEnabled;
  94774. private _isReady;
  94775. /** @hidden */
  94776. _currentRenderId: number;
  94777. private _parentUpdateId;
  94778. /** @hidden */
  94779. _childUpdateId: number;
  94780. /** @hidden */
  94781. _waitingParentId: Nullable<string>;
  94782. /** @hidden */
  94783. _scene: Scene;
  94784. /** @hidden */
  94785. _cache: any;
  94786. private _parentNode;
  94787. private _children;
  94788. /** @hidden */
  94789. _worldMatrix: Matrix;
  94790. /** @hidden */
  94791. _worldMatrixDeterminant: number;
  94792. /** @hidden */
  94793. _worldMatrixDeterminantIsDirty: boolean;
  94794. /** @hidden */
  94795. private _sceneRootNodesIndex;
  94796. /**
  94797. * Gets a boolean indicating if the node has been disposed
  94798. * @returns true if the node was disposed
  94799. */
  94800. isDisposed(): boolean;
  94801. /**
  94802. * Gets or sets the parent of the node (without keeping the current position in the scene)
  94803. * @see https://doc.babylonjs.com/how_to/parenting
  94804. */
  94805. parent: Nullable<Node>;
  94806. /** @hidden */
  94807. _addToSceneRootNodes(): void;
  94808. /** @hidden */
  94809. _removeFromSceneRootNodes(): void;
  94810. private _animationPropertiesOverride;
  94811. /**
  94812. * Gets or sets the animation properties override
  94813. */
  94814. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  94815. /**
  94816. * Gets a string idenfifying the name of the class
  94817. * @returns "Node" string
  94818. */
  94819. getClassName(): string;
  94820. /** @hidden */
  94821. readonly _isNode: boolean;
  94822. /**
  94823. * An event triggered when the mesh is disposed
  94824. */
  94825. onDisposeObservable: Observable<Node>;
  94826. private _onDisposeObserver;
  94827. /**
  94828. * Sets a callback that will be raised when the node will be disposed
  94829. */
  94830. onDispose: () => void;
  94831. /**
  94832. * Creates a new Node
  94833. * @param name the name and id to be given to this node
  94834. * @param scene the scene this node will be added to
  94835. */
  94836. constructor(name: string, scene?: Nullable<Scene>);
  94837. /**
  94838. * Gets the scene of the node
  94839. * @returns a scene
  94840. */
  94841. getScene(): Scene;
  94842. /**
  94843. * Gets the engine of the node
  94844. * @returns a Engine
  94845. */
  94846. getEngine(): Engine;
  94847. private _behaviors;
  94848. /**
  94849. * Attach a behavior to the node
  94850. * @see http://doc.babylonjs.com/features/behaviour
  94851. * @param behavior defines the behavior to attach
  94852. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  94853. * @returns the current Node
  94854. */
  94855. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  94856. /**
  94857. * Remove an attached behavior
  94858. * @see http://doc.babylonjs.com/features/behaviour
  94859. * @param behavior defines the behavior to attach
  94860. * @returns the current Node
  94861. */
  94862. removeBehavior(behavior: Behavior<Node>): Node;
  94863. /**
  94864. * Gets the list of attached behaviors
  94865. * @see http://doc.babylonjs.com/features/behaviour
  94866. */
  94867. readonly behaviors: Behavior<Node>[];
  94868. /**
  94869. * Gets an attached behavior by name
  94870. * @param name defines the name of the behavior to look for
  94871. * @see http://doc.babylonjs.com/features/behaviour
  94872. * @returns null if behavior was not found else the requested behavior
  94873. */
  94874. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  94875. /**
  94876. * Returns the latest update of the World matrix
  94877. * @returns a Matrix
  94878. */
  94879. getWorldMatrix(): Matrix;
  94880. /** @hidden */
  94881. _getWorldMatrixDeterminant(): number;
  94882. /**
  94883. * Returns directly the latest state of the mesh World matrix.
  94884. * A Matrix is returned.
  94885. */
  94886. readonly worldMatrixFromCache: Matrix;
  94887. /** @hidden */
  94888. _initCache(): void;
  94889. /** @hidden */
  94890. updateCache(force?: boolean): void;
  94891. /** @hidden */
  94892. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  94893. /** @hidden */
  94894. _updateCache(ignoreParentClass?: boolean): void;
  94895. /** @hidden */
  94896. _isSynchronized(): boolean;
  94897. /** @hidden */
  94898. _markSyncedWithParent(): void;
  94899. /** @hidden */
  94900. isSynchronizedWithParent(): boolean;
  94901. /** @hidden */
  94902. isSynchronized(): boolean;
  94903. /**
  94904. * Is this node ready to be used/rendered
  94905. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  94906. * @return true if the node is ready
  94907. */
  94908. isReady(completeCheck?: boolean): boolean;
  94909. /**
  94910. * Is this node enabled?
  94911. * 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
  94912. * @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
  94913. * @return whether this node (and its parent) is enabled
  94914. */
  94915. isEnabled(checkAncestors?: boolean): boolean;
  94916. /** @hidden */
  94917. protected _syncParentEnabledState(): void;
  94918. /**
  94919. * Set the enabled state of this node
  94920. * @param value defines the new enabled state
  94921. */
  94922. setEnabled(value: boolean): void;
  94923. /**
  94924. * Is this node a descendant of the given node?
  94925. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  94926. * @param ancestor defines the parent node to inspect
  94927. * @returns a boolean indicating if this node is a descendant of the given node
  94928. */
  94929. isDescendantOf(ancestor: Node): boolean;
  94930. /** @hidden */
  94931. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  94932. /**
  94933. * Will return all nodes that have this node as ascendant
  94934. * @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
  94935. * @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
  94936. * @return all children nodes of all types
  94937. */
  94938. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  94939. /**
  94940. * Get all child-meshes of this node
  94941. * @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)
  94942. * @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
  94943. * @returns an array of AbstractMesh
  94944. */
  94945. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  94946. /**
  94947. * Get all direct children of this node
  94948. * @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
  94949. * @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)
  94950. * @returns an array of Node
  94951. */
  94952. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  94953. /** @hidden */
  94954. _setReady(state: boolean): void;
  94955. /**
  94956. * Get an animation by name
  94957. * @param name defines the name of the animation to look for
  94958. * @returns null if not found else the requested animation
  94959. */
  94960. getAnimationByName(name: string): Nullable<Animation>;
  94961. /**
  94962. * Creates an animation range for this node
  94963. * @param name defines the name of the range
  94964. * @param from defines the starting key
  94965. * @param to defines the end key
  94966. */
  94967. createAnimationRange(name: string, from: number, to: number): void;
  94968. /**
  94969. * Delete a specific animation range
  94970. * @param name defines the name of the range to delete
  94971. * @param deleteFrames defines if animation frames from the range must be deleted as well
  94972. */
  94973. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  94974. /**
  94975. * Get an animation range by name
  94976. * @param name defines the name of the animation range to look for
  94977. * @returns null if not found else the requested animation range
  94978. */
  94979. getAnimationRange(name: string): Nullable<AnimationRange>;
  94980. /**
  94981. * Gets the list of all animation ranges defined on this node
  94982. * @returns an array
  94983. */
  94984. getAnimationRanges(): Nullable<AnimationRange>[];
  94985. /**
  94986. * Will start the animation sequence
  94987. * @param name defines the range frames for animation sequence
  94988. * @param loop defines if the animation should loop (false by default)
  94989. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  94990. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  94991. * @returns the object created for this animation. If range does not exist, it will return null
  94992. */
  94993. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  94994. /**
  94995. * Serialize animation ranges into a JSON compatible object
  94996. * @returns serialization object
  94997. */
  94998. serializeAnimationRanges(): any;
  94999. /**
  95000. * Computes the world matrix of the node
  95001. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  95002. * @returns the world matrix
  95003. */
  95004. computeWorldMatrix(force?: boolean): Matrix;
  95005. /**
  95006. * Releases resources associated with this node.
  95007. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  95008. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  95009. */
  95010. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95011. /**
  95012. * Parse animation range data from a serialization object and store them into a given node
  95013. * @param node defines where to store the animation ranges
  95014. * @param parsedNode defines the serialization object to read data from
  95015. * @param scene defines the hosting scene
  95016. */
  95017. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  95018. /**
  95019. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  95020. * @param includeDescendants Include bounding info from descendants as well (true by default)
  95021. * @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
  95022. * @returns the new bounding vectors
  95023. */
  95024. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  95025. min: Vector3;
  95026. max: Vector3;
  95027. };
  95028. }
  95029. }
  95030. declare module BABYLON {
  95031. /**
  95032. * @hidden
  95033. */
  95034. export class _IAnimationState {
  95035. key: number;
  95036. repeatCount: number;
  95037. workValue?: any;
  95038. loopMode?: number;
  95039. offsetValue?: any;
  95040. highLimitValue?: any;
  95041. }
  95042. /**
  95043. * Class used to store any kind of animation
  95044. */
  95045. export class Animation {
  95046. /**Name of the animation */
  95047. name: string;
  95048. /**Property to animate */
  95049. targetProperty: string;
  95050. /**The frames per second of the animation */
  95051. framePerSecond: number;
  95052. /**The data type of the animation */
  95053. dataType: number;
  95054. /**The loop mode of the animation */
  95055. loopMode?: number | undefined;
  95056. /**Specifies if blending should be enabled */
  95057. enableBlending?: boolean | undefined;
  95058. /**
  95059. * Use matrix interpolation instead of using direct key value when animating matrices
  95060. */
  95061. static AllowMatricesInterpolation: boolean;
  95062. /**
  95063. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  95064. */
  95065. static AllowMatrixDecomposeForInterpolation: boolean;
  95066. /**
  95067. * Stores the key frames of the animation
  95068. */
  95069. private _keys;
  95070. /**
  95071. * Stores the easing function of the animation
  95072. */
  95073. private _easingFunction;
  95074. /**
  95075. * @hidden Internal use only
  95076. */
  95077. _runtimeAnimations: RuntimeAnimation[];
  95078. /**
  95079. * The set of event that will be linked to this animation
  95080. */
  95081. private _events;
  95082. /**
  95083. * Stores an array of target property paths
  95084. */
  95085. targetPropertyPath: string[];
  95086. /**
  95087. * Stores the blending speed of the animation
  95088. */
  95089. blendingSpeed: number;
  95090. /**
  95091. * Stores the animation ranges for the animation
  95092. */
  95093. private _ranges;
  95094. /**
  95095. * @hidden Internal use
  95096. */
  95097. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  95098. /**
  95099. * Sets up an animation
  95100. * @param property The property to animate
  95101. * @param animationType The animation type to apply
  95102. * @param framePerSecond The frames per second of the animation
  95103. * @param easingFunction The easing function used in the animation
  95104. * @returns The created animation
  95105. */
  95106. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  95107. /**
  95108. * Create and start an animation on a node
  95109. * @param name defines the name of the global animation that will be run on all nodes
  95110. * @param node defines the root node where the animation will take place
  95111. * @param targetProperty defines property to animate
  95112. * @param framePerSecond defines the number of frame per second yo use
  95113. * @param totalFrame defines the number of frames in total
  95114. * @param from defines the initial value
  95115. * @param to defines the final value
  95116. * @param loopMode defines which loop mode you want to use (off by default)
  95117. * @param easingFunction defines the easing function to use (linear by default)
  95118. * @param onAnimationEnd defines the callback to call when animation end
  95119. * @returns the animatable created for this animation
  95120. */
  95121. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  95122. /**
  95123. * Create and start an animation on a node and its descendants
  95124. * @param name defines the name of the global animation that will be run on all nodes
  95125. * @param node defines the root node where the animation will take place
  95126. * @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
  95127. * @param targetProperty defines property to animate
  95128. * @param framePerSecond defines the number of frame per second to use
  95129. * @param totalFrame defines the number of frames in total
  95130. * @param from defines the initial value
  95131. * @param to defines the final value
  95132. * @param loopMode defines which loop mode you want to use (off by default)
  95133. * @param easingFunction defines the easing function to use (linear by default)
  95134. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95135. * @returns the list of animatables created for all nodes
  95136. * @example https://www.babylonjs-playground.com/#MH0VLI
  95137. */
  95138. 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[]>;
  95139. /**
  95140. * Creates a new animation, merges it with the existing animations and starts it
  95141. * @param name Name of the animation
  95142. * @param node Node which contains the scene that begins the animations
  95143. * @param targetProperty Specifies which property to animate
  95144. * @param framePerSecond The frames per second of the animation
  95145. * @param totalFrame The total number of frames
  95146. * @param from The frame at the beginning of the animation
  95147. * @param to The frame at the end of the animation
  95148. * @param loopMode Specifies the loop mode of the animation
  95149. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  95150. * @param onAnimationEnd Callback to run once the animation is complete
  95151. * @returns Nullable animation
  95152. */
  95153. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  95154. /**
  95155. * Transition property of an host to the target Value
  95156. * @param property The property to transition
  95157. * @param targetValue The target Value of the property
  95158. * @param host The object where the property to animate belongs
  95159. * @param scene Scene used to run the animation
  95160. * @param frameRate Framerate (in frame/s) to use
  95161. * @param transition The transition type we want to use
  95162. * @param duration The duration of the animation, in milliseconds
  95163. * @param onAnimationEnd Callback trigger at the end of the animation
  95164. * @returns Nullable animation
  95165. */
  95166. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  95167. /**
  95168. * Return the array of runtime animations currently using this animation
  95169. */
  95170. readonly runtimeAnimations: RuntimeAnimation[];
  95171. /**
  95172. * Specifies if any of the runtime animations are currently running
  95173. */
  95174. readonly hasRunningRuntimeAnimations: boolean;
  95175. /**
  95176. * Initializes the animation
  95177. * @param name Name of the animation
  95178. * @param targetProperty Property to animate
  95179. * @param framePerSecond The frames per second of the animation
  95180. * @param dataType The data type of the animation
  95181. * @param loopMode The loop mode of the animation
  95182. * @param enableBlending Specifies if blending should be enabled
  95183. */
  95184. constructor(
  95185. /**Name of the animation */
  95186. name: string,
  95187. /**Property to animate */
  95188. targetProperty: string,
  95189. /**The frames per second of the animation */
  95190. framePerSecond: number,
  95191. /**The data type of the animation */
  95192. dataType: number,
  95193. /**The loop mode of the animation */
  95194. loopMode?: number | undefined,
  95195. /**Specifies if blending should be enabled */
  95196. enableBlending?: boolean | undefined);
  95197. /**
  95198. * Converts the animation to a string
  95199. * @param fullDetails support for multiple levels of logging within scene loading
  95200. * @returns String form of the animation
  95201. */
  95202. toString(fullDetails?: boolean): string;
  95203. /**
  95204. * Add an event to this animation
  95205. * @param event Event to add
  95206. */
  95207. addEvent(event: AnimationEvent): void;
  95208. /**
  95209. * Remove all events found at the given frame
  95210. * @param frame The frame to remove events from
  95211. */
  95212. removeEvents(frame: number): void;
  95213. /**
  95214. * Retrieves all the events from the animation
  95215. * @returns Events from the animation
  95216. */
  95217. getEvents(): AnimationEvent[];
  95218. /**
  95219. * Creates an animation range
  95220. * @param name Name of the animation range
  95221. * @param from Starting frame of the animation range
  95222. * @param to Ending frame of the animation
  95223. */
  95224. createRange(name: string, from: number, to: number): void;
  95225. /**
  95226. * Deletes an animation range by name
  95227. * @param name Name of the animation range to delete
  95228. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  95229. */
  95230. deleteRange(name: string, deleteFrames?: boolean): void;
  95231. /**
  95232. * Gets the animation range by name, or null if not defined
  95233. * @param name Name of the animation range
  95234. * @returns Nullable animation range
  95235. */
  95236. getRange(name: string): Nullable<AnimationRange>;
  95237. /**
  95238. * Gets the key frames from the animation
  95239. * @returns The key frames of the animation
  95240. */
  95241. getKeys(): Array<IAnimationKey>;
  95242. /**
  95243. * Gets the highest frame rate of the animation
  95244. * @returns Highest frame rate of the animation
  95245. */
  95246. getHighestFrame(): number;
  95247. /**
  95248. * Gets the easing function of the animation
  95249. * @returns Easing function of the animation
  95250. */
  95251. getEasingFunction(): IEasingFunction;
  95252. /**
  95253. * Sets the easing function of the animation
  95254. * @param easingFunction A custom mathematical formula for animation
  95255. */
  95256. setEasingFunction(easingFunction: EasingFunction): void;
  95257. /**
  95258. * Interpolates a scalar linearly
  95259. * @param startValue Start value of the animation curve
  95260. * @param endValue End value of the animation curve
  95261. * @param gradient Scalar amount to interpolate
  95262. * @returns Interpolated scalar value
  95263. */
  95264. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  95265. /**
  95266. * Interpolates a scalar cubically
  95267. * @param startValue Start value of the animation curve
  95268. * @param outTangent End tangent of the animation
  95269. * @param endValue End value of the animation curve
  95270. * @param inTangent Start tangent of the animation curve
  95271. * @param gradient Scalar amount to interpolate
  95272. * @returns Interpolated scalar value
  95273. */
  95274. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  95275. /**
  95276. * Interpolates a quaternion using a spherical linear interpolation
  95277. * @param startValue Start value of the animation curve
  95278. * @param endValue End value of the animation curve
  95279. * @param gradient Scalar amount to interpolate
  95280. * @returns Interpolated quaternion value
  95281. */
  95282. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  95283. /**
  95284. * Interpolates a quaternion cubically
  95285. * @param startValue Start value of the animation curve
  95286. * @param outTangent End tangent of the animation curve
  95287. * @param endValue End value of the animation curve
  95288. * @param inTangent Start tangent of the animation curve
  95289. * @param gradient Scalar amount to interpolate
  95290. * @returns Interpolated quaternion value
  95291. */
  95292. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  95293. /**
  95294. * Interpolates a Vector3 linearl
  95295. * @param startValue Start value of the animation curve
  95296. * @param endValue End value of the animation curve
  95297. * @param gradient Scalar amount to interpolate
  95298. * @returns Interpolated scalar value
  95299. */
  95300. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  95301. /**
  95302. * Interpolates a Vector3 cubically
  95303. * @param startValue Start value of the animation curve
  95304. * @param outTangent End tangent of the animation
  95305. * @param endValue End value of the animation curve
  95306. * @param inTangent Start tangent of the animation curve
  95307. * @param gradient Scalar amount to interpolate
  95308. * @returns InterpolatedVector3 value
  95309. */
  95310. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  95311. /**
  95312. * Interpolates a Vector2 linearly
  95313. * @param startValue Start value of the animation curve
  95314. * @param endValue End value of the animation curve
  95315. * @param gradient Scalar amount to interpolate
  95316. * @returns Interpolated Vector2 value
  95317. */
  95318. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  95319. /**
  95320. * Interpolates a Vector2 cubically
  95321. * @param startValue Start value of the animation curve
  95322. * @param outTangent End tangent of the animation
  95323. * @param endValue End value of the animation curve
  95324. * @param inTangent Start tangent of the animation curve
  95325. * @param gradient Scalar amount to interpolate
  95326. * @returns Interpolated Vector2 value
  95327. */
  95328. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  95329. /**
  95330. * Interpolates a size linearly
  95331. * @param startValue Start value of the animation curve
  95332. * @param endValue End value of the animation curve
  95333. * @param gradient Scalar amount to interpolate
  95334. * @returns Interpolated Size value
  95335. */
  95336. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  95337. /**
  95338. * Interpolates a Color3 linearly
  95339. * @param startValue Start value of the animation curve
  95340. * @param endValue End value of the animation curve
  95341. * @param gradient Scalar amount to interpolate
  95342. * @returns Interpolated Color3 value
  95343. */
  95344. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  95345. /**
  95346. * Interpolates a Color4 linearly
  95347. * @param startValue Start value of the animation curve
  95348. * @param endValue End value of the animation curve
  95349. * @param gradient Scalar amount to interpolate
  95350. * @returns Interpolated Color3 value
  95351. */
  95352. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  95353. /**
  95354. * @hidden Internal use only
  95355. */
  95356. _getKeyValue(value: any): any;
  95357. /**
  95358. * @hidden Internal use only
  95359. */
  95360. _interpolate(currentFrame: number, state: _IAnimationState): any;
  95361. /**
  95362. * Defines the function to use to interpolate matrices
  95363. * @param startValue defines the start matrix
  95364. * @param endValue defines the end matrix
  95365. * @param gradient defines the gradient between both matrices
  95366. * @param result defines an optional target matrix where to store the interpolation
  95367. * @returns the interpolated matrix
  95368. */
  95369. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  95370. /**
  95371. * Makes a copy of the animation
  95372. * @returns Cloned animation
  95373. */
  95374. clone(): Animation;
  95375. /**
  95376. * Sets the key frames of the animation
  95377. * @param values The animation key frames to set
  95378. */
  95379. setKeys(values: Array<IAnimationKey>): void;
  95380. /**
  95381. * Serializes the animation to an object
  95382. * @returns Serialized object
  95383. */
  95384. serialize(): any;
  95385. /**
  95386. * Float animation type
  95387. */
  95388. static readonly ANIMATIONTYPE_FLOAT: number;
  95389. /**
  95390. * Vector3 animation type
  95391. */
  95392. static readonly ANIMATIONTYPE_VECTOR3: number;
  95393. /**
  95394. * Quaternion animation type
  95395. */
  95396. static readonly ANIMATIONTYPE_QUATERNION: number;
  95397. /**
  95398. * Matrix animation type
  95399. */
  95400. static readonly ANIMATIONTYPE_MATRIX: number;
  95401. /**
  95402. * Color3 animation type
  95403. */
  95404. static readonly ANIMATIONTYPE_COLOR3: number;
  95405. /**
  95406. * Color3 animation type
  95407. */
  95408. static readonly ANIMATIONTYPE_COLOR4: number;
  95409. /**
  95410. * Vector2 animation type
  95411. */
  95412. static readonly ANIMATIONTYPE_VECTOR2: number;
  95413. /**
  95414. * Size animation type
  95415. */
  95416. static readonly ANIMATIONTYPE_SIZE: number;
  95417. /**
  95418. * Relative Loop Mode
  95419. */
  95420. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  95421. /**
  95422. * Cycle Loop Mode
  95423. */
  95424. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  95425. /**
  95426. * Constant Loop Mode
  95427. */
  95428. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  95429. /** @hidden */
  95430. static _UniversalLerp(left: any, right: any, amount: number): any;
  95431. /**
  95432. * Parses an animation object and creates an animation
  95433. * @param parsedAnimation Parsed animation object
  95434. * @returns Animation object
  95435. */
  95436. static Parse(parsedAnimation: any): Animation;
  95437. /**
  95438. * Appends the serialized animations from the source animations
  95439. * @param source Source containing the animations
  95440. * @param destination Target to store the animations
  95441. */
  95442. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  95443. }
  95444. }
  95445. declare module BABYLON {
  95446. /**
  95447. * Interface containing an array of animations
  95448. */
  95449. export interface IAnimatable {
  95450. /**
  95451. * Array of animations
  95452. */
  95453. animations: Nullable<Array<Animation>>;
  95454. }
  95455. }
  95456. declare module BABYLON {
  95457. /**
  95458. * This represents all the required information to add a fresnel effect on a material:
  95459. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  95460. */
  95461. export class FresnelParameters {
  95462. private _isEnabled;
  95463. /**
  95464. * Define if the fresnel effect is enable or not.
  95465. */
  95466. isEnabled: boolean;
  95467. /**
  95468. * Define the color used on edges (grazing angle)
  95469. */
  95470. leftColor: Color3;
  95471. /**
  95472. * Define the color used on center
  95473. */
  95474. rightColor: Color3;
  95475. /**
  95476. * Define bias applied to computed fresnel term
  95477. */
  95478. bias: number;
  95479. /**
  95480. * Defined the power exponent applied to fresnel term
  95481. */
  95482. power: number;
  95483. /**
  95484. * Clones the current fresnel and its valuues
  95485. * @returns a clone fresnel configuration
  95486. */
  95487. clone(): FresnelParameters;
  95488. /**
  95489. * Serializes the current fresnel parameters to a JSON representation.
  95490. * @return the JSON serialization
  95491. */
  95492. serialize(): any;
  95493. /**
  95494. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  95495. * @param parsedFresnelParameters Define the JSON representation
  95496. * @returns the parsed parameters
  95497. */
  95498. static Parse(parsedFresnelParameters: any): FresnelParameters;
  95499. }
  95500. }
  95501. declare module BABYLON {
  95502. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  95503. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95504. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95505. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95506. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95507. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95508. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95509. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95510. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95511. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95512. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95513. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95514. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95515. /**
  95516. * Decorator used to define property that can be serialized as reference to a camera
  95517. * @param sourceName defines the name of the property to decorate
  95518. */
  95519. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95520. /**
  95521. * Class used to help serialization objects
  95522. */
  95523. export class SerializationHelper {
  95524. /** @hidden */
  95525. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  95526. /** @hidden */
  95527. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  95528. /** @hidden */
  95529. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  95530. /** @hidden */
  95531. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  95532. /**
  95533. * Appends the serialized animations from the source animations
  95534. * @param source Source containing the animations
  95535. * @param destination Target to store the animations
  95536. */
  95537. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  95538. /**
  95539. * Static function used to serialized a specific entity
  95540. * @param entity defines the entity to serialize
  95541. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  95542. * @returns a JSON compatible object representing the serialization of the entity
  95543. */
  95544. static Serialize<T>(entity: T, serializationObject?: any): any;
  95545. /**
  95546. * Creates a new entity from a serialization data object
  95547. * @param creationFunction defines a function used to instanciated the new entity
  95548. * @param source defines the source serialization data
  95549. * @param scene defines the hosting scene
  95550. * @param rootUrl defines the root url for resources
  95551. * @returns a new entity
  95552. */
  95553. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  95554. /**
  95555. * Clones an object
  95556. * @param creationFunction defines the function used to instanciate the new object
  95557. * @param source defines the source object
  95558. * @returns the cloned object
  95559. */
  95560. static Clone<T>(creationFunction: () => T, source: T): T;
  95561. /**
  95562. * Instanciates a new object based on a source one (some data will be shared between both object)
  95563. * @param creationFunction defines the function used to instanciate the new object
  95564. * @param source defines the source object
  95565. * @returns the new object
  95566. */
  95567. static Instanciate<T>(creationFunction: () => T, source: T): T;
  95568. }
  95569. }
  95570. declare module BABYLON {
  95571. /**
  95572. * Class used to manipulate GUIDs
  95573. */
  95574. export class GUID {
  95575. /**
  95576. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  95577. * Be aware Math.random() could cause collisions, but:
  95578. * "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"
  95579. * @returns a pseudo random id
  95580. */
  95581. static RandomId(): string;
  95582. }
  95583. }
  95584. declare module BABYLON {
  95585. /**
  95586. * Base class of all the textures in babylon.
  95587. * It groups all the common properties the materials, post process, lights... might need
  95588. * in order to make a correct use of the texture.
  95589. */
  95590. export class BaseTexture implements IAnimatable {
  95591. /**
  95592. * Default anisotropic filtering level for the application.
  95593. * It is set to 4 as a good tradeoff between perf and quality.
  95594. */
  95595. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  95596. /**
  95597. * Gets or sets the unique id of the texture
  95598. */
  95599. uniqueId: number;
  95600. /**
  95601. * Define the name of the texture.
  95602. */
  95603. name: string;
  95604. /**
  95605. * Gets or sets an object used to store user defined information.
  95606. */
  95607. metadata: any;
  95608. /**
  95609. * For internal use only. Please do not use.
  95610. */
  95611. reservedDataStore: any;
  95612. private _hasAlpha;
  95613. /**
  95614. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  95615. */
  95616. hasAlpha: boolean;
  95617. /**
  95618. * Defines if the alpha value should be determined via the rgb values.
  95619. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  95620. */
  95621. getAlphaFromRGB: boolean;
  95622. /**
  95623. * Intensity or strength of the texture.
  95624. * It is commonly used by materials to fine tune the intensity of the texture
  95625. */
  95626. level: number;
  95627. /**
  95628. * Define the UV chanel to use starting from 0 and defaulting to 0.
  95629. * This is part of the texture as textures usually maps to one uv set.
  95630. */
  95631. coordinatesIndex: number;
  95632. private _coordinatesMode;
  95633. /**
  95634. * How a texture is mapped.
  95635. *
  95636. * | Value | Type | Description |
  95637. * | ----- | ----------------------------------- | ----------- |
  95638. * | 0 | EXPLICIT_MODE | |
  95639. * | 1 | SPHERICAL_MODE | |
  95640. * | 2 | PLANAR_MODE | |
  95641. * | 3 | CUBIC_MODE | |
  95642. * | 4 | PROJECTION_MODE | |
  95643. * | 5 | SKYBOX_MODE | |
  95644. * | 6 | INVCUBIC_MODE | |
  95645. * | 7 | EQUIRECTANGULAR_MODE | |
  95646. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  95647. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  95648. */
  95649. coordinatesMode: number;
  95650. /**
  95651. * | Value | Type | Description |
  95652. * | ----- | ------------------ | ----------- |
  95653. * | 0 | CLAMP_ADDRESSMODE | |
  95654. * | 1 | WRAP_ADDRESSMODE | |
  95655. * | 2 | MIRROR_ADDRESSMODE | |
  95656. */
  95657. wrapU: number;
  95658. /**
  95659. * | Value | Type | Description |
  95660. * | ----- | ------------------ | ----------- |
  95661. * | 0 | CLAMP_ADDRESSMODE | |
  95662. * | 1 | WRAP_ADDRESSMODE | |
  95663. * | 2 | MIRROR_ADDRESSMODE | |
  95664. */
  95665. wrapV: number;
  95666. /**
  95667. * | Value | Type | Description |
  95668. * | ----- | ------------------ | ----------- |
  95669. * | 0 | CLAMP_ADDRESSMODE | |
  95670. * | 1 | WRAP_ADDRESSMODE | |
  95671. * | 2 | MIRROR_ADDRESSMODE | |
  95672. */
  95673. wrapR: number;
  95674. /**
  95675. * With compliant hardware and browser (supporting anisotropic filtering)
  95676. * this defines the level of anisotropic filtering in the texture.
  95677. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  95678. */
  95679. anisotropicFilteringLevel: number;
  95680. /**
  95681. * Define if the texture is a cube texture or if false a 2d texture.
  95682. */
  95683. isCube: boolean;
  95684. /**
  95685. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  95686. */
  95687. is3D: boolean;
  95688. /**
  95689. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  95690. * HDR texture are usually stored in linear space.
  95691. * This only impacts the PBR and Background materials
  95692. */
  95693. gammaSpace: boolean;
  95694. /**
  95695. * Gets or sets whether or not the texture contains RGBD data.
  95696. */
  95697. isRGBD: boolean;
  95698. /**
  95699. * Is Z inverted in the texture (useful in a cube texture).
  95700. */
  95701. invertZ: boolean;
  95702. /**
  95703. * Are mip maps generated for this texture or not.
  95704. */
  95705. readonly noMipmap: boolean;
  95706. /**
  95707. * @hidden
  95708. */
  95709. lodLevelInAlpha: boolean;
  95710. /**
  95711. * With prefiltered texture, defined the offset used during the prefiltering steps.
  95712. */
  95713. lodGenerationOffset: number;
  95714. /**
  95715. * With prefiltered texture, defined the scale used during the prefiltering steps.
  95716. */
  95717. lodGenerationScale: number;
  95718. /**
  95719. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  95720. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  95721. * average roughness values.
  95722. */
  95723. linearSpecularLOD: boolean;
  95724. /**
  95725. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  95726. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  95727. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  95728. */
  95729. irradianceTexture: Nullable<BaseTexture>;
  95730. /**
  95731. * Define if the texture is a render target.
  95732. */
  95733. isRenderTarget: boolean;
  95734. /**
  95735. * Define the unique id of the texture in the scene.
  95736. */
  95737. readonly uid: string;
  95738. /**
  95739. * Return a string representation of the texture.
  95740. * @returns the texture as a string
  95741. */
  95742. toString(): string;
  95743. /**
  95744. * Get the class name of the texture.
  95745. * @returns "BaseTexture"
  95746. */
  95747. getClassName(): string;
  95748. /**
  95749. * Define the list of animation attached to the texture.
  95750. */
  95751. animations: Animation[];
  95752. /**
  95753. * An event triggered when the texture is disposed.
  95754. */
  95755. onDisposeObservable: Observable<BaseTexture>;
  95756. private _onDisposeObserver;
  95757. /**
  95758. * Callback triggered when the texture has been disposed.
  95759. * Kept for back compatibility, you can use the onDisposeObservable instead.
  95760. */
  95761. onDispose: () => void;
  95762. /**
  95763. * Define the current state of the loading sequence when in delayed load mode.
  95764. */
  95765. delayLoadState: number;
  95766. private _scene;
  95767. /** @hidden */
  95768. _texture: Nullable<InternalTexture>;
  95769. private _uid;
  95770. /**
  95771. * Define if the texture is preventinga material to render or not.
  95772. * If not and the texture is not ready, the engine will use a default black texture instead.
  95773. */
  95774. readonly isBlocking: boolean;
  95775. /**
  95776. * Instantiates a new BaseTexture.
  95777. * Base class of all the textures in babylon.
  95778. * It groups all the common properties the materials, post process, lights... might need
  95779. * in order to make a correct use of the texture.
  95780. * @param scene Define the scene the texture blongs to
  95781. */
  95782. constructor(scene: Nullable<Scene>);
  95783. /**
  95784. * Get the scene the texture belongs to.
  95785. * @returns the scene or null if undefined
  95786. */
  95787. getScene(): Nullable<Scene>;
  95788. /**
  95789. * Get the texture transform matrix used to offset tile the texture for istance.
  95790. * @returns the transformation matrix
  95791. */
  95792. getTextureMatrix(): Matrix;
  95793. /**
  95794. * Get the texture reflection matrix used to rotate/transform the reflection.
  95795. * @returns the reflection matrix
  95796. */
  95797. getReflectionTextureMatrix(): Matrix;
  95798. /**
  95799. * Get the underlying lower level texture from Babylon.
  95800. * @returns the insternal texture
  95801. */
  95802. getInternalTexture(): Nullable<InternalTexture>;
  95803. /**
  95804. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  95805. * @returns true if ready or not blocking
  95806. */
  95807. isReadyOrNotBlocking(): boolean;
  95808. /**
  95809. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  95810. * @returns true if fully ready
  95811. */
  95812. isReady(): boolean;
  95813. private _cachedSize;
  95814. /**
  95815. * Get the size of the texture.
  95816. * @returns the texture size.
  95817. */
  95818. getSize(): ISize;
  95819. /**
  95820. * Get the base size of the texture.
  95821. * It can be different from the size if the texture has been resized for POT for instance
  95822. * @returns the base size
  95823. */
  95824. getBaseSize(): ISize;
  95825. /**
  95826. * Update the sampling mode of the texture.
  95827. * Default is Trilinear mode.
  95828. *
  95829. * | Value | Type | Description |
  95830. * | ----- | ------------------ | ----------- |
  95831. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  95832. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  95833. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  95834. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  95835. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  95836. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  95837. * | 7 | NEAREST_LINEAR | |
  95838. * | 8 | NEAREST_NEAREST | |
  95839. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  95840. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  95841. * | 11 | LINEAR_LINEAR | |
  95842. * | 12 | LINEAR_NEAREST | |
  95843. *
  95844. * > _mag_: magnification filter (close to the viewer)
  95845. * > _min_: minification filter (far from the viewer)
  95846. * > _mip_: filter used between mip map levels
  95847. *@param samplingMode Define the new sampling mode of the texture
  95848. */
  95849. updateSamplingMode(samplingMode: number): void;
  95850. /**
  95851. * Scales the texture if is `canRescale()`
  95852. * @param ratio the resize factor we want to use to rescale
  95853. */
  95854. scale(ratio: number): void;
  95855. /**
  95856. * Get if the texture can rescale.
  95857. */
  95858. readonly canRescale: boolean;
  95859. /** @hidden */
  95860. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  95861. /** @hidden */
  95862. _rebuild(): void;
  95863. /**
  95864. * Triggers the load sequence in delayed load mode.
  95865. */
  95866. delayLoad(): void;
  95867. /**
  95868. * Clones the texture.
  95869. * @returns the cloned texture
  95870. */
  95871. clone(): Nullable<BaseTexture>;
  95872. /**
  95873. * Get the texture underlying type (INT, FLOAT...)
  95874. */
  95875. readonly textureType: number;
  95876. /**
  95877. * Get the texture underlying format (RGB, RGBA...)
  95878. */
  95879. readonly textureFormat: number;
  95880. /**
  95881. * Indicates that textures need to be re-calculated for all materials
  95882. */
  95883. protected _markAllSubMeshesAsTexturesDirty(): void;
  95884. /**
  95885. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  95886. * This will returns an RGBA array buffer containing either in values (0-255) or
  95887. * float values (0-1) depending of the underlying buffer type.
  95888. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  95889. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  95890. * @param buffer defines a user defined buffer to fill with data (can be null)
  95891. * @returns The Array buffer containing the pixels data.
  95892. */
  95893. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  95894. /**
  95895. * Release and destroy the underlying lower level texture aka internalTexture.
  95896. */
  95897. releaseInternalTexture(): void;
  95898. /** @hidden */
  95899. readonly _lodTextureHigh: Nullable<BaseTexture>;
  95900. /** @hidden */
  95901. readonly _lodTextureMid: Nullable<BaseTexture>;
  95902. /** @hidden */
  95903. readonly _lodTextureLow: Nullable<BaseTexture>;
  95904. /**
  95905. * Dispose the texture and release its associated resources.
  95906. */
  95907. dispose(): void;
  95908. /**
  95909. * Serialize the texture into a JSON representation that can be parsed later on.
  95910. * @returns the JSON representation of the texture
  95911. */
  95912. serialize(): any;
  95913. /**
  95914. * Helper function to be called back once a list of texture contains only ready textures.
  95915. * @param textures Define the list of textures to wait for
  95916. * @param callback Define the callback triggered once the entire list will be ready
  95917. */
  95918. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  95919. }
  95920. }
  95921. declare module BABYLON {
  95922. /**
  95923. * Options to be used when creating an effect.
  95924. */
  95925. export interface IEffectCreationOptions {
  95926. /**
  95927. * Atrributes that will be used in the shader.
  95928. */
  95929. attributes: string[];
  95930. /**
  95931. * Uniform varible names that will be set in the shader.
  95932. */
  95933. uniformsNames: string[];
  95934. /**
  95935. * Uniform buffer varible names that will be set in the shader.
  95936. */
  95937. uniformBuffersNames: string[];
  95938. /**
  95939. * Sampler texture variable names that will be set in the shader.
  95940. */
  95941. samplers: string[];
  95942. /**
  95943. * Define statements that will be set in the shader.
  95944. */
  95945. defines: any;
  95946. /**
  95947. * Possible fallbacks for this effect to improve performance when needed.
  95948. */
  95949. fallbacks: Nullable<IEffectFallbacks>;
  95950. /**
  95951. * Callback that will be called when the shader is compiled.
  95952. */
  95953. onCompiled: Nullable<(effect: Effect) => void>;
  95954. /**
  95955. * Callback that will be called if an error occurs during shader compilation.
  95956. */
  95957. onError: Nullable<(effect: Effect, errors: string) => void>;
  95958. /**
  95959. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  95960. */
  95961. indexParameters?: any;
  95962. /**
  95963. * Max number of lights that can be used in the shader.
  95964. */
  95965. maxSimultaneousLights?: number;
  95966. /**
  95967. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  95968. */
  95969. transformFeedbackVaryings?: Nullable<string[]>;
  95970. }
  95971. /**
  95972. * Effect containing vertex and fragment shader that can be executed on an object.
  95973. */
  95974. export class Effect implements IDisposable {
  95975. /**
  95976. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  95977. */
  95978. static ShadersRepository: string;
  95979. /**
  95980. * Name of the effect.
  95981. */
  95982. name: any;
  95983. /**
  95984. * String container all the define statements that should be set on the shader.
  95985. */
  95986. defines: string;
  95987. /**
  95988. * Callback that will be called when the shader is compiled.
  95989. */
  95990. onCompiled: Nullable<(effect: Effect) => void>;
  95991. /**
  95992. * Callback that will be called if an error occurs during shader compilation.
  95993. */
  95994. onError: Nullable<(effect: Effect, errors: string) => void>;
  95995. /**
  95996. * Callback that will be called when effect is bound.
  95997. */
  95998. onBind: Nullable<(effect: Effect) => void>;
  95999. /**
  96000. * Unique ID of the effect.
  96001. */
  96002. uniqueId: number;
  96003. /**
  96004. * Observable that will be called when the shader is compiled.
  96005. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  96006. */
  96007. onCompileObservable: Observable<Effect>;
  96008. /**
  96009. * Observable that will be called if an error occurs during shader compilation.
  96010. */
  96011. onErrorObservable: Observable<Effect>;
  96012. /** @hidden */
  96013. _onBindObservable: Nullable<Observable<Effect>>;
  96014. /**
  96015. * Observable that will be called when effect is bound.
  96016. */
  96017. readonly onBindObservable: Observable<Effect>;
  96018. /** @hidden */
  96019. _bonesComputationForcedToCPU: boolean;
  96020. private static _uniqueIdSeed;
  96021. private _engine;
  96022. private _uniformBuffersNames;
  96023. private _uniformsNames;
  96024. private _samplerList;
  96025. private _samplers;
  96026. private _isReady;
  96027. private _compilationError;
  96028. private _allFallbacksProcessed;
  96029. private _attributesNames;
  96030. private _attributes;
  96031. private _uniforms;
  96032. /**
  96033. * Key for the effect.
  96034. * @hidden
  96035. */
  96036. _key: string;
  96037. private _indexParameters;
  96038. private _fallbacks;
  96039. private _vertexSourceCode;
  96040. private _fragmentSourceCode;
  96041. private _vertexSourceCodeOverride;
  96042. private _fragmentSourceCodeOverride;
  96043. private _transformFeedbackVaryings;
  96044. /**
  96045. * Compiled shader to webGL program.
  96046. * @hidden
  96047. */
  96048. _pipelineContext: Nullable<IPipelineContext>;
  96049. private _valueCache;
  96050. private static _baseCache;
  96051. /**
  96052. * Instantiates an effect.
  96053. * An effect can be used to create/manage/execute vertex and fragment shaders.
  96054. * @param baseName Name of the effect.
  96055. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  96056. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  96057. * @param samplers List of sampler variables that will be passed to the shader.
  96058. * @param engine Engine to be used to render the effect
  96059. * @param defines Define statements to be added to the shader.
  96060. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  96061. * @param onCompiled Callback that will be called when the shader is compiled.
  96062. * @param onError Callback that will be called if an error occurs during shader compilation.
  96063. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  96064. */
  96065. 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);
  96066. private _useFinalCode;
  96067. /**
  96068. * Unique key for this effect
  96069. */
  96070. readonly key: string;
  96071. /**
  96072. * If the effect has been compiled and prepared.
  96073. * @returns if the effect is compiled and prepared.
  96074. */
  96075. isReady(): boolean;
  96076. private _isReadyInternal;
  96077. /**
  96078. * The engine the effect was initialized with.
  96079. * @returns the engine.
  96080. */
  96081. getEngine(): Engine;
  96082. /**
  96083. * The pipeline context for this effect
  96084. * @returns the associated pipeline context
  96085. */
  96086. getPipelineContext(): Nullable<IPipelineContext>;
  96087. /**
  96088. * The set of names of attribute variables for the shader.
  96089. * @returns An array of attribute names.
  96090. */
  96091. getAttributesNames(): string[];
  96092. /**
  96093. * Returns the attribute at the given index.
  96094. * @param index The index of the attribute.
  96095. * @returns The location of the attribute.
  96096. */
  96097. getAttributeLocation(index: number): number;
  96098. /**
  96099. * Returns the attribute based on the name of the variable.
  96100. * @param name of the attribute to look up.
  96101. * @returns the attribute location.
  96102. */
  96103. getAttributeLocationByName(name: string): number;
  96104. /**
  96105. * The number of attributes.
  96106. * @returns the numnber of attributes.
  96107. */
  96108. getAttributesCount(): number;
  96109. /**
  96110. * Gets the index of a uniform variable.
  96111. * @param uniformName of the uniform to look up.
  96112. * @returns the index.
  96113. */
  96114. getUniformIndex(uniformName: string): number;
  96115. /**
  96116. * Returns the attribute based on the name of the variable.
  96117. * @param uniformName of the uniform to look up.
  96118. * @returns the location of the uniform.
  96119. */
  96120. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  96121. /**
  96122. * Returns an array of sampler variable names
  96123. * @returns The array of sampler variable neames.
  96124. */
  96125. getSamplers(): string[];
  96126. /**
  96127. * The error from the last compilation.
  96128. * @returns the error string.
  96129. */
  96130. getCompilationError(): string;
  96131. /**
  96132. * Gets a boolean indicating that all fallbacks were used during compilation
  96133. * @returns true if all fallbacks were used
  96134. */
  96135. allFallbacksProcessed(): boolean;
  96136. /**
  96137. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  96138. * @param func The callback to be used.
  96139. */
  96140. executeWhenCompiled(func: (effect: Effect) => void): void;
  96141. private _checkIsReady;
  96142. private _loadShader;
  96143. /**
  96144. * Recompiles the webGL program
  96145. * @param vertexSourceCode The source code for the vertex shader.
  96146. * @param fragmentSourceCode The source code for the fragment shader.
  96147. * @param onCompiled Callback called when completed.
  96148. * @param onError Callback called on error.
  96149. * @hidden
  96150. */
  96151. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  96152. /**
  96153. * Prepares the effect
  96154. * @hidden
  96155. */
  96156. _prepareEffect(): void;
  96157. private _processCompilationErrors;
  96158. /**
  96159. * Checks if the effect is supported. (Must be called after compilation)
  96160. */
  96161. readonly isSupported: boolean;
  96162. /**
  96163. * Binds a texture to the engine to be used as output of the shader.
  96164. * @param channel Name of the output variable.
  96165. * @param texture Texture to bind.
  96166. * @hidden
  96167. */
  96168. _bindTexture(channel: string, texture: InternalTexture): void;
  96169. /**
  96170. * Sets a texture on the engine to be used in the shader.
  96171. * @param channel Name of the sampler variable.
  96172. * @param texture Texture to set.
  96173. */
  96174. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  96175. /**
  96176. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  96177. * @param channel Name of the sampler variable.
  96178. * @param texture Texture to set.
  96179. */
  96180. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  96181. /**
  96182. * Sets an array of textures on the engine to be used in the shader.
  96183. * @param channel Name of the variable.
  96184. * @param textures Textures to set.
  96185. */
  96186. setTextureArray(channel: string, textures: BaseTexture[]): void;
  96187. /**
  96188. * 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)
  96189. * @param channel Name of the sampler variable.
  96190. * @param postProcess Post process to get the input texture from.
  96191. */
  96192. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  96193. /**
  96194. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  96195. * 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)
  96196. * @param channel Name of the sampler variable.
  96197. * @param postProcess Post process to get the output texture from.
  96198. */
  96199. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  96200. /** @hidden */
  96201. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  96202. /** @hidden */
  96203. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  96204. /** @hidden */
  96205. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  96206. /** @hidden */
  96207. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  96208. /**
  96209. * Binds a buffer to a uniform.
  96210. * @param buffer Buffer to bind.
  96211. * @param name Name of the uniform variable to bind to.
  96212. */
  96213. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  96214. /**
  96215. * Binds block to a uniform.
  96216. * @param blockName Name of the block to bind.
  96217. * @param index Index to bind.
  96218. */
  96219. bindUniformBlock(blockName: string, index: number): void;
  96220. /**
  96221. * Sets an interger value on a uniform variable.
  96222. * @param uniformName Name of the variable.
  96223. * @param value Value to be set.
  96224. * @returns this effect.
  96225. */
  96226. setInt(uniformName: string, value: number): Effect;
  96227. /**
  96228. * Sets an int array on a uniform variable.
  96229. * @param uniformName Name of the variable.
  96230. * @param array array to be set.
  96231. * @returns this effect.
  96232. */
  96233. setIntArray(uniformName: string, array: Int32Array): Effect;
  96234. /**
  96235. * 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)
  96236. * @param uniformName Name of the variable.
  96237. * @param array array to be set.
  96238. * @returns this effect.
  96239. */
  96240. setIntArray2(uniformName: string, array: Int32Array): Effect;
  96241. /**
  96242. * 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)
  96243. * @param uniformName Name of the variable.
  96244. * @param array array to be set.
  96245. * @returns this effect.
  96246. */
  96247. setIntArray3(uniformName: string, array: Int32Array): Effect;
  96248. /**
  96249. * 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)
  96250. * @param uniformName Name of the variable.
  96251. * @param array array to be set.
  96252. * @returns this effect.
  96253. */
  96254. setIntArray4(uniformName: string, array: Int32Array): Effect;
  96255. /**
  96256. * Sets an float array on a uniform variable.
  96257. * @param uniformName Name of the variable.
  96258. * @param array array to be set.
  96259. * @returns this effect.
  96260. */
  96261. setFloatArray(uniformName: string, array: Float32Array): Effect;
  96262. /**
  96263. * 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)
  96264. * @param uniformName Name of the variable.
  96265. * @param array array to be set.
  96266. * @returns this effect.
  96267. */
  96268. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  96269. /**
  96270. * 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)
  96271. * @param uniformName Name of the variable.
  96272. * @param array array to be set.
  96273. * @returns this effect.
  96274. */
  96275. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  96276. /**
  96277. * 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)
  96278. * @param uniformName Name of the variable.
  96279. * @param array array to be set.
  96280. * @returns this effect.
  96281. */
  96282. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  96283. /**
  96284. * Sets an array on a uniform variable.
  96285. * @param uniformName Name of the variable.
  96286. * @param array array to be set.
  96287. * @returns this effect.
  96288. */
  96289. setArray(uniformName: string, array: number[]): Effect;
  96290. /**
  96291. * 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)
  96292. * @param uniformName Name of the variable.
  96293. * @param array array to be set.
  96294. * @returns this effect.
  96295. */
  96296. setArray2(uniformName: string, array: number[]): Effect;
  96297. /**
  96298. * 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)
  96299. * @param uniformName Name of the variable.
  96300. * @param array array to be set.
  96301. * @returns this effect.
  96302. */
  96303. setArray3(uniformName: string, array: number[]): Effect;
  96304. /**
  96305. * 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)
  96306. * @param uniformName Name of the variable.
  96307. * @param array array to be set.
  96308. * @returns this effect.
  96309. */
  96310. setArray4(uniformName: string, array: number[]): Effect;
  96311. /**
  96312. * Sets matrices on a uniform variable.
  96313. * @param uniformName Name of the variable.
  96314. * @param matrices matrices to be set.
  96315. * @returns this effect.
  96316. */
  96317. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  96318. /**
  96319. * Sets matrix on a uniform variable.
  96320. * @param uniformName Name of the variable.
  96321. * @param matrix matrix to be set.
  96322. * @returns this effect.
  96323. */
  96324. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  96325. /**
  96326. * 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)
  96327. * @param uniformName Name of the variable.
  96328. * @param matrix matrix to be set.
  96329. * @returns this effect.
  96330. */
  96331. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  96332. /**
  96333. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  96334. * @param uniformName Name of the variable.
  96335. * @param matrix matrix to be set.
  96336. * @returns this effect.
  96337. */
  96338. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  96339. /**
  96340. * Sets a float on a uniform variable.
  96341. * @param uniformName Name of the variable.
  96342. * @param value value to be set.
  96343. * @returns this effect.
  96344. */
  96345. setFloat(uniformName: string, value: number): Effect;
  96346. /**
  96347. * Sets a boolean on a uniform variable.
  96348. * @param uniformName Name of the variable.
  96349. * @param bool value to be set.
  96350. * @returns this effect.
  96351. */
  96352. setBool(uniformName: string, bool: boolean): Effect;
  96353. /**
  96354. * Sets a Vector2 on a uniform variable.
  96355. * @param uniformName Name of the variable.
  96356. * @param vector2 vector2 to be set.
  96357. * @returns this effect.
  96358. */
  96359. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  96360. /**
  96361. * Sets a float2 on a uniform variable.
  96362. * @param uniformName Name of the variable.
  96363. * @param x First float in float2.
  96364. * @param y Second float in float2.
  96365. * @returns this effect.
  96366. */
  96367. setFloat2(uniformName: string, x: number, y: number): Effect;
  96368. /**
  96369. * Sets a Vector3 on a uniform variable.
  96370. * @param uniformName Name of the variable.
  96371. * @param vector3 Value to be set.
  96372. * @returns this effect.
  96373. */
  96374. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  96375. /**
  96376. * Sets a float3 on a uniform variable.
  96377. * @param uniformName Name of the variable.
  96378. * @param x First float in float3.
  96379. * @param y Second float in float3.
  96380. * @param z Third float in float3.
  96381. * @returns this effect.
  96382. */
  96383. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  96384. /**
  96385. * Sets a Vector4 on a uniform variable.
  96386. * @param uniformName Name of the variable.
  96387. * @param vector4 Value to be set.
  96388. * @returns this effect.
  96389. */
  96390. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  96391. /**
  96392. * Sets a float4 on a uniform variable.
  96393. * @param uniformName Name of the variable.
  96394. * @param x First float in float4.
  96395. * @param y Second float in float4.
  96396. * @param z Third float in float4.
  96397. * @param w Fourth float in float4.
  96398. * @returns this effect.
  96399. */
  96400. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  96401. /**
  96402. * Sets a Color3 on a uniform variable.
  96403. * @param uniformName Name of the variable.
  96404. * @param color3 Value to be set.
  96405. * @returns this effect.
  96406. */
  96407. setColor3(uniformName: string, color3: IColor3Like): Effect;
  96408. /**
  96409. * Sets a Color4 on a uniform variable.
  96410. * @param uniformName Name of the variable.
  96411. * @param color3 Value to be set.
  96412. * @param alpha Alpha value to be set.
  96413. * @returns this effect.
  96414. */
  96415. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  96416. /**
  96417. * Sets a Color4 on a uniform variable
  96418. * @param uniformName defines the name of the variable
  96419. * @param color4 defines the value to be set
  96420. * @returns this effect.
  96421. */
  96422. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  96423. /** Release all associated resources */
  96424. dispose(): void;
  96425. /**
  96426. * This function will add a new shader to the shader store
  96427. * @param name the name of the shader
  96428. * @param pixelShader optional pixel shader content
  96429. * @param vertexShader optional vertex shader content
  96430. */
  96431. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  96432. /**
  96433. * Store of each shader (The can be looked up using effect.key)
  96434. */
  96435. static ShadersStore: {
  96436. [key: string]: string;
  96437. };
  96438. /**
  96439. * Store of each included file for a shader (The can be looked up using effect.key)
  96440. */
  96441. static IncludesShadersStore: {
  96442. [key: string]: string;
  96443. };
  96444. /**
  96445. * Resets the cache of effects.
  96446. */
  96447. static ResetCache(): void;
  96448. }
  96449. }
  96450. declare module BABYLON {
  96451. /**
  96452. * Interface used to describe the capabilities of the engine relatively to the current browser
  96453. */
  96454. export interface EngineCapabilities {
  96455. /** Maximum textures units per fragment shader */
  96456. maxTexturesImageUnits: number;
  96457. /** Maximum texture units per vertex shader */
  96458. maxVertexTextureImageUnits: number;
  96459. /** Maximum textures units in the entire pipeline */
  96460. maxCombinedTexturesImageUnits: number;
  96461. /** Maximum texture size */
  96462. maxTextureSize: number;
  96463. /** Maximum cube texture size */
  96464. maxCubemapTextureSize: number;
  96465. /** Maximum render texture size */
  96466. maxRenderTextureSize: number;
  96467. /** Maximum number of vertex attributes */
  96468. maxVertexAttribs: number;
  96469. /** Maximum number of varyings */
  96470. maxVaryingVectors: number;
  96471. /** Maximum number of uniforms per vertex shader */
  96472. maxVertexUniformVectors: number;
  96473. /** Maximum number of uniforms per fragment shader */
  96474. maxFragmentUniformVectors: number;
  96475. /** Defines if standard derivates (dx/dy) are supported */
  96476. standardDerivatives: boolean;
  96477. /** Defines if s3tc texture compression is supported */
  96478. s3tc?: WEBGL_compressed_texture_s3tc;
  96479. /** Defines if pvrtc texture compression is supported */
  96480. pvrtc: any;
  96481. /** Defines if etc1 texture compression is supported */
  96482. etc1: any;
  96483. /** Defines if etc2 texture compression is supported */
  96484. etc2: any;
  96485. /** Defines if astc texture compression is supported */
  96486. astc: any;
  96487. /** Defines if float textures are supported */
  96488. textureFloat: boolean;
  96489. /** Defines if vertex array objects are supported */
  96490. vertexArrayObject: boolean;
  96491. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  96492. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  96493. /** Gets the maximum level of anisotropy supported */
  96494. maxAnisotropy: number;
  96495. /** Defines if instancing is supported */
  96496. instancedArrays: boolean;
  96497. /** Defines if 32 bits indices are supported */
  96498. uintIndices: boolean;
  96499. /** Defines if high precision shaders are supported */
  96500. highPrecisionShaderSupported: boolean;
  96501. /** Defines if depth reading in the fragment shader is supported */
  96502. fragmentDepthSupported: boolean;
  96503. /** Defines if float texture linear filtering is supported*/
  96504. textureFloatLinearFiltering: boolean;
  96505. /** Defines if rendering to float textures is supported */
  96506. textureFloatRender: boolean;
  96507. /** Defines if half float textures are supported*/
  96508. textureHalfFloat: boolean;
  96509. /** Defines if half float texture linear filtering is supported*/
  96510. textureHalfFloatLinearFiltering: boolean;
  96511. /** Defines if rendering to half float textures is supported */
  96512. textureHalfFloatRender: boolean;
  96513. /** Defines if textureLOD shader command is supported */
  96514. textureLOD: boolean;
  96515. /** Defines if draw buffers extension is supported */
  96516. drawBuffersExtension: boolean;
  96517. /** Defines if depth textures are supported */
  96518. depthTextureExtension: boolean;
  96519. /** Defines if float color buffer are supported */
  96520. colorBufferFloat: boolean;
  96521. /** Gets disjoint timer query extension (null if not supported) */
  96522. timerQuery?: EXT_disjoint_timer_query;
  96523. /** Defines if timestamp can be used with timer query */
  96524. canUseTimestampForTimerQuery: boolean;
  96525. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  96526. multiview?: any;
  96527. /** Function used to let the system compiles shaders in background */
  96528. parallelShaderCompile?: {
  96529. COMPLETION_STATUS_KHR: number;
  96530. };
  96531. /** Max number of texture samples for MSAA */
  96532. maxMSAASamples: number;
  96533. /** Defines if the blend min max extension is supported */
  96534. blendMinMax: boolean;
  96535. }
  96536. }
  96537. declare module BABYLON {
  96538. /**
  96539. * @hidden
  96540. **/
  96541. export class DepthCullingState {
  96542. private _isDepthTestDirty;
  96543. private _isDepthMaskDirty;
  96544. private _isDepthFuncDirty;
  96545. private _isCullFaceDirty;
  96546. private _isCullDirty;
  96547. private _isZOffsetDirty;
  96548. private _isFrontFaceDirty;
  96549. private _depthTest;
  96550. private _depthMask;
  96551. private _depthFunc;
  96552. private _cull;
  96553. private _cullFace;
  96554. private _zOffset;
  96555. private _frontFace;
  96556. /**
  96557. * Initializes the state.
  96558. */
  96559. constructor();
  96560. readonly isDirty: boolean;
  96561. zOffset: number;
  96562. cullFace: Nullable<number>;
  96563. cull: Nullable<boolean>;
  96564. depthFunc: Nullable<number>;
  96565. depthMask: boolean;
  96566. depthTest: boolean;
  96567. frontFace: Nullable<number>;
  96568. reset(): void;
  96569. apply(gl: WebGLRenderingContext): void;
  96570. }
  96571. }
  96572. declare module BABYLON {
  96573. /**
  96574. * @hidden
  96575. **/
  96576. export class StencilState {
  96577. /** 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 */
  96578. static readonly ALWAYS: number;
  96579. /** Passed to stencilOperation to specify that stencil value must be kept */
  96580. static readonly KEEP: number;
  96581. /** Passed to stencilOperation to specify that stencil value must be replaced */
  96582. static readonly REPLACE: number;
  96583. private _isStencilTestDirty;
  96584. private _isStencilMaskDirty;
  96585. private _isStencilFuncDirty;
  96586. private _isStencilOpDirty;
  96587. private _stencilTest;
  96588. private _stencilMask;
  96589. private _stencilFunc;
  96590. private _stencilFuncRef;
  96591. private _stencilFuncMask;
  96592. private _stencilOpStencilFail;
  96593. private _stencilOpDepthFail;
  96594. private _stencilOpStencilDepthPass;
  96595. readonly isDirty: boolean;
  96596. stencilFunc: number;
  96597. stencilFuncRef: number;
  96598. stencilFuncMask: number;
  96599. stencilOpStencilFail: number;
  96600. stencilOpDepthFail: number;
  96601. stencilOpStencilDepthPass: number;
  96602. stencilMask: number;
  96603. stencilTest: boolean;
  96604. constructor();
  96605. reset(): void;
  96606. apply(gl: WebGLRenderingContext): void;
  96607. }
  96608. }
  96609. declare module BABYLON {
  96610. /**
  96611. * @hidden
  96612. **/
  96613. export class AlphaState {
  96614. private _isAlphaBlendDirty;
  96615. private _isBlendFunctionParametersDirty;
  96616. private _isBlendEquationParametersDirty;
  96617. private _isBlendConstantsDirty;
  96618. private _alphaBlend;
  96619. private _blendFunctionParameters;
  96620. private _blendEquationParameters;
  96621. private _blendConstants;
  96622. /**
  96623. * Initializes the state.
  96624. */
  96625. constructor();
  96626. readonly isDirty: boolean;
  96627. alphaBlend: boolean;
  96628. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  96629. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  96630. setAlphaEquationParameters(rgb: number, alpha: number): void;
  96631. reset(): void;
  96632. apply(gl: WebGLRenderingContext): void;
  96633. }
  96634. }
  96635. declare module BABYLON {
  96636. /** @hidden */
  96637. export class WebGL2ShaderProcessor implements IShaderProcessor {
  96638. attributeProcessor(attribute: string): string;
  96639. varyingProcessor(varying: string, isFragment: boolean): string;
  96640. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  96641. }
  96642. }
  96643. declare module BABYLON {
  96644. /**
  96645. * Interface for attribute information associated with buffer instanciation
  96646. */
  96647. export interface InstancingAttributeInfo {
  96648. /**
  96649. * Index/offset of the attribute in the vertex shader
  96650. */
  96651. index: number;
  96652. /**
  96653. * size of the attribute, 1, 2, 3 or 4
  96654. */
  96655. attributeSize: number;
  96656. /**
  96657. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  96658. * default is FLOAT
  96659. */
  96660. attributeType: number;
  96661. /**
  96662. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  96663. */
  96664. normalized: boolean;
  96665. /**
  96666. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  96667. */
  96668. offset: number;
  96669. /**
  96670. * Name of the GLSL attribute, for debugging purpose only
  96671. */
  96672. attributeName: string;
  96673. }
  96674. }
  96675. declare module BABYLON {
  96676. interface ThinEngine {
  96677. /**
  96678. * Update a video texture
  96679. * @param texture defines the texture to update
  96680. * @param video defines the video element to use
  96681. * @param invertY defines if data must be stored with Y axis inverted
  96682. */
  96683. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  96684. }
  96685. }
  96686. declare module BABYLON {
  96687. /**
  96688. * Settings for finer control over video usage
  96689. */
  96690. export interface VideoTextureSettings {
  96691. /**
  96692. * Applies `autoplay` to video, if specified
  96693. */
  96694. autoPlay?: boolean;
  96695. /**
  96696. * Applies `loop` to video, if specified
  96697. */
  96698. loop?: boolean;
  96699. /**
  96700. * Automatically updates internal texture from video at every frame in the render loop
  96701. */
  96702. autoUpdateTexture: boolean;
  96703. /**
  96704. * Image src displayed during the video loading or until the user interacts with the video.
  96705. */
  96706. poster?: string;
  96707. }
  96708. /**
  96709. * If you want to display a video in your scene, this is the special texture for that.
  96710. * This special texture works similar to other textures, with the exception of a few parameters.
  96711. * @see https://doc.babylonjs.com/how_to/video_texture
  96712. */
  96713. export class VideoTexture extends Texture {
  96714. /**
  96715. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  96716. */
  96717. readonly autoUpdateTexture: boolean;
  96718. /**
  96719. * The video instance used by the texture internally
  96720. */
  96721. readonly video: HTMLVideoElement;
  96722. private _onUserActionRequestedObservable;
  96723. /**
  96724. * Event triggerd when a dom action is required by the user to play the video.
  96725. * This happens due to recent changes in browser policies preventing video to auto start.
  96726. */
  96727. readonly onUserActionRequestedObservable: Observable<Texture>;
  96728. private _generateMipMaps;
  96729. private _engine;
  96730. private _stillImageCaptured;
  96731. private _displayingPosterTexture;
  96732. private _settings;
  96733. private _createInternalTextureOnEvent;
  96734. private _frameId;
  96735. /**
  96736. * Creates a video texture.
  96737. * If you want to display a video in your scene, this is the special texture for that.
  96738. * This special texture works similar to other textures, with the exception of a few parameters.
  96739. * @see https://doc.babylonjs.com/how_to/video_texture
  96740. * @param name optional name, will detect from video source, if not defined
  96741. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  96742. * @param scene is obviously the current scene.
  96743. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  96744. * @param invertY is false by default but can be used to invert video on Y axis
  96745. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  96746. * @param settings allows finer control over video usage
  96747. */
  96748. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  96749. private _getName;
  96750. private _getVideo;
  96751. private _createInternalTexture;
  96752. private reset;
  96753. /**
  96754. * @hidden Internal method to initiate `update`.
  96755. */
  96756. _rebuild(): void;
  96757. /**
  96758. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  96759. */
  96760. update(): void;
  96761. /**
  96762. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  96763. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  96764. */
  96765. updateTexture(isVisible: boolean): void;
  96766. protected _updateInternalTexture: () => void;
  96767. /**
  96768. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  96769. * @param url New url.
  96770. */
  96771. updateURL(url: string): void;
  96772. /**
  96773. * Dispose the texture and release its associated resources.
  96774. */
  96775. dispose(): void;
  96776. /**
  96777. * Creates a video texture straight from a stream.
  96778. * @param scene Define the scene the texture should be created in
  96779. * @param stream Define the stream the texture should be created from
  96780. * @returns The created video texture as a promise
  96781. */
  96782. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  96783. /**
  96784. * Creates a video texture straight from your WebCam video feed.
  96785. * @param scene Define the scene the texture should be created in
  96786. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  96787. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  96788. * @returns The created video texture as a promise
  96789. */
  96790. static CreateFromWebCamAsync(scene: Scene, constraints: {
  96791. minWidth: number;
  96792. maxWidth: number;
  96793. minHeight: number;
  96794. maxHeight: number;
  96795. deviceId: string;
  96796. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  96797. /**
  96798. * Creates a video texture straight from your WebCam video feed.
  96799. * @param scene Define the scene the texture should be created in
  96800. * @param onReady Define a callback to triggered once the texture will be ready
  96801. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  96802. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  96803. */
  96804. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  96805. minWidth: number;
  96806. maxWidth: number;
  96807. minHeight: number;
  96808. maxHeight: number;
  96809. deviceId: string;
  96810. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  96811. }
  96812. }
  96813. declare module BABYLON {
  96814. /**
  96815. * Defines the interface used by objects working like Scene
  96816. * @hidden
  96817. */
  96818. interface ISceneLike {
  96819. _addPendingData(data: any): void;
  96820. _removePendingData(data: any): void;
  96821. offlineProvider: IOfflineProvider;
  96822. }
  96823. /** Interface defining initialization parameters for Engine class */
  96824. export interface EngineOptions extends WebGLContextAttributes {
  96825. /**
  96826. * Defines if the engine should no exceed a specified device ratio
  96827. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  96828. */
  96829. limitDeviceRatio?: number;
  96830. /**
  96831. * Defines if webvr should be enabled automatically
  96832. * @see http://doc.babylonjs.com/how_to/webvr_camera
  96833. */
  96834. autoEnableWebVR?: boolean;
  96835. /**
  96836. * Defines if webgl2 should be turned off even if supported
  96837. * @see http://doc.babylonjs.com/features/webgl2
  96838. */
  96839. disableWebGL2Support?: boolean;
  96840. /**
  96841. * Defines if webaudio should be initialized as well
  96842. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  96843. */
  96844. audioEngine?: boolean;
  96845. /**
  96846. * Defines if animations should run using a deterministic lock step
  96847. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  96848. */
  96849. deterministicLockstep?: boolean;
  96850. /** Defines the maximum steps to use with deterministic lock step mode */
  96851. lockstepMaxSteps?: number;
  96852. /**
  96853. * Defines that engine should ignore context lost events
  96854. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  96855. */
  96856. doNotHandleContextLost?: boolean;
  96857. /**
  96858. * Defines that engine should ignore modifying touch action attribute and style
  96859. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  96860. */
  96861. doNotHandleTouchAction?: boolean;
  96862. /**
  96863. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  96864. */
  96865. useHighPrecisionFloats?: boolean;
  96866. }
  96867. /**
  96868. * The base engine class (root of all engines)
  96869. */
  96870. export class ThinEngine {
  96871. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  96872. static ExceptionList: ({
  96873. key: string;
  96874. capture: string;
  96875. captureConstraint: number;
  96876. targets: string[];
  96877. } | {
  96878. key: string;
  96879. capture: null;
  96880. captureConstraint: null;
  96881. targets: string[];
  96882. })[];
  96883. /** @hidden */
  96884. static _TextureLoaders: IInternalTextureLoader[];
  96885. /**
  96886. * Returns the current npm package of the sdk
  96887. */
  96888. static readonly NpmPackage: string;
  96889. /**
  96890. * Returns the current version of the framework
  96891. */
  96892. static readonly Version: string;
  96893. /**
  96894. * Returns a string describing the current engine
  96895. */
  96896. readonly description: string;
  96897. /**
  96898. * Gets or sets the epsilon value used by collision engine
  96899. */
  96900. static CollisionsEpsilon: number;
  96901. /**
  96902. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  96903. */
  96904. static ShadersRepository: string;
  96905. /** @hidden */
  96906. _shaderProcessor: IShaderProcessor;
  96907. /**
  96908. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  96909. */
  96910. forcePOTTextures: boolean;
  96911. /**
  96912. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  96913. */
  96914. isFullscreen: boolean;
  96915. /**
  96916. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  96917. */
  96918. cullBackFaces: boolean;
  96919. /**
  96920. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  96921. */
  96922. renderEvenInBackground: boolean;
  96923. /**
  96924. * Gets or sets a boolean indicating that cache can be kept between frames
  96925. */
  96926. preventCacheWipeBetweenFrames: boolean;
  96927. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  96928. validateShaderPrograms: boolean;
  96929. /**
  96930. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  96931. */
  96932. disableUniformBuffers: boolean;
  96933. /** @hidden */
  96934. _uniformBuffers: UniformBuffer[];
  96935. /**
  96936. * Gets a boolean indicating that the engine supports uniform buffers
  96937. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  96938. */
  96939. readonly supportsUniformBuffers: boolean;
  96940. /** @hidden */
  96941. _gl: WebGLRenderingContext;
  96942. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  96943. protected _windowIsBackground: boolean;
  96944. protected _webGLVersion: number;
  96945. protected _creationOptions: EngineOptions;
  96946. protected _highPrecisionShadersAllowed: boolean;
  96947. /** @hidden */
  96948. readonly _shouldUseHighPrecisionShader: boolean;
  96949. /**
  96950. * Gets a boolean indicating that only power of 2 textures are supported
  96951. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  96952. */
  96953. readonly needPOTTextures: boolean;
  96954. /** @hidden */
  96955. _badOS: boolean;
  96956. /** @hidden */
  96957. _badDesktopOS: boolean;
  96958. private _hardwareScalingLevel;
  96959. /** @hidden */
  96960. _caps: EngineCapabilities;
  96961. private _isStencilEnable;
  96962. protected _colorWrite: boolean;
  96963. private _glVersion;
  96964. private _glRenderer;
  96965. private _glVendor;
  96966. /** @hidden */
  96967. _videoTextureSupported: boolean;
  96968. protected _renderingQueueLaunched: boolean;
  96969. protected _activeRenderLoops: (() => void)[];
  96970. /**
  96971. * Observable signaled when a context lost event is raised
  96972. */
  96973. onContextLostObservable: Observable<ThinEngine>;
  96974. /**
  96975. * Observable signaled when a context restored event is raised
  96976. */
  96977. onContextRestoredObservable: Observable<ThinEngine>;
  96978. private _onContextLost;
  96979. private _onContextRestored;
  96980. protected _contextWasLost: boolean;
  96981. /** @hidden */
  96982. _doNotHandleContextLost: boolean;
  96983. /**
  96984. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  96985. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  96986. */
  96987. doNotHandleContextLost: boolean;
  96988. /**
  96989. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  96990. */
  96991. disableVertexArrayObjects: boolean;
  96992. /** @hidden */
  96993. protected _depthCullingState: DepthCullingState;
  96994. /** @hidden */
  96995. protected _stencilState: StencilState;
  96996. /** @hidden */
  96997. protected _alphaState: AlphaState;
  96998. /** @hidden */
  96999. _internalTexturesCache: InternalTexture[];
  97000. /** @hidden */
  97001. protected _activeChannel: number;
  97002. private _currentTextureChannel;
  97003. /** @hidden */
  97004. protected _boundTexturesCache: {
  97005. [key: string]: Nullable<InternalTexture>;
  97006. };
  97007. /** @hidden */
  97008. protected _currentEffect: Nullable<Effect>;
  97009. /** @hidden */
  97010. protected _currentProgram: Nullable<WebGLProgram>;
  97011. private _compiledEffects;
  97012. private _vertexAttribArraysEnabled;
  97013. /** @hidden */
  97014. protected _cachedViewport: Nullable<IViewportLike>;
  97015. private _cachedVertexArrayObject;
  97016. /** @hidden */
  97017. protected _cachedVertexBuffers: any;
  97018. /** @hidden */
  97019. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  97020. /** @hidden */
  97021. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  97022. /** @hidden */
  97023. _currentRenderTarget: Nullable<InternalTexture>;
  97024. private _uintIndicesCurrentlySet;
  97025. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  97026. /** @hidden */
  97027. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  97028. private _currentBufferPointers;
  97029. private _currentInstanceLocations;
  97030. private _currentInstanceBuffers;
  97031. private _textureUnits;
  97032. /** @hidden */
  97033. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  97034. /** @hidden */
  97035. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  97036. /** @hidden */
  97037. _boundRenderFunction: any;
  97038. private _vaoRecordInProgress;
  97039. private _mustWipeVertexAttributes;
  97040. private _emptyTexture;
  97041. private _emptyCubeTexture;
  97042. private _emptyTexture3D;
  97043. /** @hidden */
  97044. _frameHandler: number;
  97045. private _nextFreeTextureSlots;
  97046. private _maxSimultaneousTextures;
  97047. private _activeRequests;
  97048. protected _texturesSupported: string[];
  97049. /** @hidden */
  97050. _textureFormatInUse: Nullable<string>;
  97051. protected readonly _supportsHardwareTextureRescaling: boolean;
  97052. /**
  97053. * Gets the list of texture formats supported
  97054. */
  97055. readonly texturesSupported: Array<string>;
  97056. /**
  97057. * Gets the list of texture formats in use
  97058. */
  97059. readonly textureFormatInUse: Nullable<string>;
  97060. /**
  97061. * Gets the current viewport
  97062. */
  97063. readonly currentViewport: Nullable<IViewportLike>;
  97064. /**
  97065. * Gets the default empty texture
  97066. */
  97067. readonly emptyTexture: InternalTexture;
  97068. /**
  97069. * Gets the default empty 3D texture
  97070. */
  97071. readonly emptyTexture3D: InternalTexture;
  97072. /**
  97073. * Gets the default empty cube texture
  97074. */
  97075. readonly emptyCubeTexture: InternalTexture;
  97076. /**
  97077. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  97078. */
  97079. readonly premultipliedAlpha: boolean;
  97080. /**
  97081. * Observable event triggered before each texture is initialized
  97082. */
  97083. onBeforeTextureInitObservable: Observable<Texture>;
  97084. /**
  97085. * Creates a new engine
  97086. * @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
  97087. * @param antialias defines enable antialiasing (default: false)
  97088. * @param options defines further options to be sent to the getContext() function
  97089. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  97090. */
  97091. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  97092. private _rebuildInternalTextures;
  97093. private _rebuildEffects;
  97094. /**
  97095. * Gets a boolean indicating if all created effects are ready
  97096. * @returns true if all effects are ready
  97097. */
  97098. areAllEffectsReady(): boolean;
  97099. protected _rebuildBuffers(): void;
  97100. private _initGLContext;
  97101. /**
  97102. * Gets version of the current webGL context
  97103. */
  97104. readonly webGLVersion: number;
  97105. /**
  97106. * Gets a string idenfifying the name of the class
  97107. * @returns "Engine" string
  97108. */
  97109. getClassName(): string;
  97110. /**
  97111. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  97112. */
  97113. readonly isStencilEnable: boolean;
  97114. /** @hidden */
  97115. _prepareWorkingCanvas(): void;
  97116. /**
  97117. * Reset the texture cache to empty state
  97118. */
  97119. resetTextureCache(): void;
  97120. /**
  97121. * Gets an object containing information about the current webGL context
  97122. * @returns an object containing the vender, the renderer and the version of the current webGL context
  97123. */
  97124. getGlInfo(): {
  97125. vendor: string;
  97126. renderer: string;
  97127. version: string;
  97128. };
  97129. /**
  97130. * Defines the hardware scaling level.
  97131. * By default the hardware scaling level is computed from the window device ratio.
  97132. * 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.
  97133. * @param level defines the level to use
  97134. */
  97135. setHardwareScalingLevel(level: number): void;
  97136. /**
  97137. * Gets the current hardware scaling level.
  97138. * By default the hardware scaling level is computed from the window device ratio.
  97139. * 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.
  97140. * @returns a number indicating the current hardware scaling level
  97141. */
  97142. getHardwareScalingLevel(): number;
  97143. /**
  97144. * Gets the list of loaded textures
  97145. * @returns an array containing all loaded textures
  97146. */
  97147. getLoadedTexturesCache(): InternalTexture[];
  97148. /**
  97149. * Gets the object containing all engine capabilities
  97150. * @returns the EngineCapabilities object
  97151. */
  97152. getCaps(): EngineCapabilities;
  97153. /**
  97154. * stop executing a render loop function and remove it from the execution array
  97155. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  97156. */
  97157. stopRenderLoop(renderFunction?: () => void): void;
  97158. /** @hidden */
  97159. _renderLoop(): void;
  97160. /**
  97161. * Gets the HTML canvas attached with the current webGL context
  97162. * @returns a HTML canvas
  97163. */
  97164. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  97165. /**
  97166. * Gets host window
  97167. * @returns the host window object
  97168. */
  97169. getHostWindow(): Nullable<Window>;
  97170. /**
  97171. * Gets the current render width
  97172. * @param useScreen defines if screen size must be used (or the current render target if any)
  97173. * @returns a number defining the current render width
  97174. */
  97175. getRenderWidth(useScreen?: boolean): number;
  97176. /**
  97177. * Gets the current render height
  97178. * @param useScreen defines if screen size must be used (or the current render target if any)
  97179. * @returns a number defining the current render height
  97180. */
  97181. getRenderHeight(useScreen?: boolean): number;
  97182. /**
  97183. * Can be used to override the current requestAnimationFrame requester.
  97184. * @hidden
  97185. */
  97186. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  97187. /**
  97188. * Register and execute a render loop. The engine can have more than one render function
  97189. * @param renderFunction defines the function to continuously execute
  97190. */
  97191. runRenderLoop(renderFunction: () => void): void;
  97192. /**
  97193. * Clear the current render buffer or the current render target (if any is set up)
  97194. * @param color defines the color to use
  97195. * @param backBuffer defines if the back buffer must be cleared
  97196. * @param depth defines if the depth buffer must be cleared
  97197. * @param stencil defines if the stencil buffer must be cleared
  97198. */
  97199. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  97200. private _viewportCached;
  97201. /** @hidden */
  97202. _viewport(x: number, y: number, width: number, height: number): void;
  97203. /**
  97204. * Set the WebGL's viewport
  97205. * @param viewport defines the viewport element to be used
  97206. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  97207. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  97208. */
  97209. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  97210. /**
  97211. * Begin a new frame
  97212. */
  97213. beginFrame(): void;
  97214. /**
  97215. * Enf the current frame
  97216. */
  97217. endFrame(): void;
  97218. /**
  97219. * Resize the view according to the canvas' size
  97220. */
  97221. resize(): void;
  97222. /**
  97223. * Force a specific size of the canvas
  97224. * @param width defines the new canvas' width
  97225. * @param height defines the new canvas' height
  97226. */
  97227. setSize(width: number, height: number): void;
  97228. /**
  97229. * Binds the frame buffer to the specified texture.
  97230. * @param texture The texture to render to or null for the default canvas
  97231. * @param faceIndex The face of the texture to render to in case of cube texture
  97232. * @param requiredWidth The width of the target to render to
  97233. * @param requiredHeight The height of the target to render to
  97234. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  97235. * @param depthStencilTexture The depth stencil texture to use to render
  97236. * @param lodLevel defines le lod level to bind to the frame buffer
  97237. */
  97238. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  97239. /** @hidden */
  97240. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  97241. /**
  97242. * Unbind the current render target texture from the webGL context
  97243. * @param texture defines the render target texture to unbind
  97244. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  97245. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  97246. */
  97247. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  97248. /**
  97249. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  97250. */
  97251. flushFramebuffer(): void;
  97252. /**
  97253. * Unbind the current render target and bind the default framebuffer
  97254. */
  97255. restoreDefaultFramebuffer(): void;
  97256. /** @hidden */
  97257. protected _resetVertexBufferBinding(): void;
  97258. /**
  97259. * Creates a vertex buffer
  97260. * @param data the data for the vertex buffer
  97261. * @returns the new WebGL static buffer
  97262. */
  97263. createVertexBuffer(data: DataArray): DataBuffer;
  97264. private _createVertexBuffer;
  97265. /**
  97266. * Creates a dynamic vertex buffer
  97267. * @param data the data for the dynamic vertex buffer
  97268. * @returns the new WebGL dynamic buffer
  97269. */
  97270. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  97271. protected _resetIndexBufferBinding(): void;
  97272. /**
  97273. * Creates a new index buffer
  97274. * @param indices defines the content of the index buffer
  97275. * @param updatable defines if the index buffer must be updatable
  97276. * @returns a new webGL buffer
  97277. */
  97278. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  97279. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  97280. /**
  97281. * Bind a webGL buffer to the webGL context
  97282. * @param buffer defines the buffer to bind
  97283. */
  97284. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  97285. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  97286. private bindBuffer;
  97287. /**
  97288. * update the bound buffer with the given data
  97289. * @param data defines the data to update
  97290. */
  97291. updateArrayBuffer(data: Float32Array): void;
  97292. private _vertexAttribPointer;
  97293. private _bindIndexBufferWithCache;
  97294. private _bindVertexBuffersAttributes;
  97295. /**
  97296. * Records a vertex array object
  97297. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  97298. * @param vertexBuffers defines the list of vertex buffers to store
  97299. * @param indexBuffer defines the index buffer to store
  97300. * @param effect defines the effect to store
  97301. * @returns the new vertex array object
  97302. */
  97303. recordVertexArrayObject(vertexBuffers: {
  97304. [key: string]: VertexBuffer;
  97305. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  97306. /**
  97307. * Bind a specific vertex array object
  97308. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  97309. * @param vertexArrayObject defines the vertex array object to bind
  97310. * @param indexBuffer defines the index buffer to bind
  97311. */
  97312. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  97313. /**
  97314. * Bind webGl buffers directly to the webGL context
  97315. * @param vertexBuffer defines the vertex buffer to bind
  97316. * @param indexBuffer defines the index buffer to bind
  97317. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  97318. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  97319. * @param effect defines the effect associated with the vertex buffer
  97320. */
  97321. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  97322. private _unbindVertexArrayObject;
  97323. /**
  97324. * Bind a list of vertex buffers to the webGL context
  97325. * @param vertexBuffers defines the list of vertex buffers to bind
  97326. * @param indexBuffer defines the index buffer to bind
  97327. * @param effect defines the effect associated with the vertex buffers
  97328. */
  97329. bindBuffers(vertexBuffers: {
  97330. [key: string]: Nullable<VertexBuffer>;
  97331. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  97332. /**
  97333. * Unbind all instance attributes
  97334. */
  97335. unbindInstanceAttributes(): void;
  97336. /**
  97337. * Release and free the memory of a vertex array object
  97338. * @param vao defines the vertex array object to delete
  97339. */
  97340. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  97341. /** @hidden */
  97342. _releaseBuffer(buffer: DataBuffer): boolean;
  97343. protected _deleteBuffer(buffer: DataBuffer): void;
  97344. /**
  97345. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  97346. * @param instancesBuffer defines the webGL buffer to update and bind
  97347. * @param data defines the data to store in the buffer
  97348. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  97349. */
  97350. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  97351. /**
  97352. * Apply all cached states (depth, culling, stencil and alpha)
  97353. */
  97354. applyStates(): void;
  97355. /**
  97356. * Send a draw order
  97357. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  97358. * @param indexStart defines the starting index
  97359. * @param indexCount defines the number of index to draw
  97360. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97361. */
  97362. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  97363. /**
  97364. * Draw a list of points
  97365. * @param verticesStart defines the index of first vertex to draw
  97366. * @param verticesCount defines the count of vertices to draw
  97367. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97368. */
  97369. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  97370. /**
  97371. * Draw a list of unindexed primitives
  97372. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  97373. * @param verticesStart defines the index of first vertex to draw
  97374. * @param verticesCount defines the count of vertices to draw
  97375. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97376. */
  97377. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  97378. /**
  97379. * Draw a list of indexed primitives
  97380. * @param fillMode defines the primitive to use
  97381. * @param indexStart defines the starting index
  97382. * @param indexCount defines the number of index to draw
  97383. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97384. */
  97385. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  97386. /**
  97387. * Draw a list of unindexed primitives
  97388. * @param fillMode defines the primitive to use
  97389. * @param verticesStart defines the index of first vertex to draw
  97390. * @param verticesCount defines the count of vertices to draw
  97391. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97392. */
  97393. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  97394. private _drawMode;
  97395. /** @hidden */
  97396. protected _reportDrawCall(): void;
  97397. /** @hidden */
  97398. _releaseEffect(effect: Effect): void;
  97399. /** @hidden */
  97400. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  97401. /**
  97402. * Create a new effect (used to store vertex/fragment shaders)
  97403. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  97404. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  97405. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  97406. * @param samplers defines an array of string used to represent textures
  97407. * @param defines defines the string containing the defines to use to compile the shaders
  97408. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  97409. * @param onCompiled defines a function to call when the effect creation is successful
  97410. * @param onError defines a function to call when the effect creation has failed
  97411. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  97412. * @returns the new Effect
  97413. */
  97414. 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;
  97415. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  97416. private _compileShader;
  97417. private _compileRawShader;
  97418. /**
  97419. * Directly creates a webGL program
  97420. * @param pipelineContext defines the pipeline context to attach to
  97421. * @param vertexCode defines the vertex shader code to use
  97422. * @param fragmentCode defines the fragment shader code to use
  97423. * @param context defines the webGL context to use (if not set, the current one will be used)
  97424. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  97425. * @returns the new webGL program
  97426. */
  97427. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  97428. /**
  97429. * Creates a webGL program
  97430. * @param pipelineContext defines the pipeline context to attach to
  97431. * @param vertexCode defines the vertex shader code to use
  97432. * @param fragmentCode defines the fragment shader code to use
  97433. * @param defines defines the string containing the defines to use to compile the shaders
  97434. * @param context defines the webGL context to use (if not set, the current one will be used)
  97435. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  97436. * @returns the new webGL program
  97437. */
  97438. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  97439. /**
  97440. * Creates a new pipeline context
  97441. * @returns the new pipeline
  97442. */
  97443. createPipelineContext(): IPipelineContext;
  97444. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  97445. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  97446. /** @hidden */
  97447. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  97448. /** @hidden */
  97449. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  97450. /** @hidden */
  97451. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  97452. /**
  97453. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  97454. * @param pipelineContext defines the pipeline context to use
  97455. * @param uniformsNames defines the list of uniform names
  97456. * @returns an array of webGL uniform locations
  97457. */
  97458. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  97459. /**
  97460. * Gets the lsit of active attributes for a given webGL program
  97461. * @param pipelineContext defines the pipeline context to use
  97462. * @param attributesNames defines the list of attribute names to get
  97463. * @returns an array of indices indicating the offset of each attribute
  97464. */
  97465. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  97466. /**
  97467. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  97468. * @param effect defines the effect to activate
  97469. */
  97470. enableEffect(effect: Nullable<Effect>): void;
  97471. /**
  97472. * Set the value of an uniform to a number (int)
  97473. * @param uniform defines the webGL uniform location where to store the value
  97474. * @param value defines the int number to store
  97475. */
  97476. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  97477. /**
  97478. * Set the value of an uniform to an array of int32
  97479. * @param uniform defines the webGL uniform location where to store the value
  97480. * @param array defines the array of int32 to store
  97481. */
  97482. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97483. /**
  97484. * Set the value of an uniform to an array of int32 (stored as vec2)
  97485. * @param uniform defines the webGL uniform location where to store the value
  97486. * @param array defines the array of int32 to store
  97487. */
  97488. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97489. /**
  97490. * Set the value of an uniform to an array of int32 (stored as vec3)
  97491. * @param uniform defines the webGL uniform location where to store the value
  97492. * @param array defines the array of int32 to store
  97493. */
  97494. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97495. /**
  97496. * Set the value of an uniform to an array of int32 (stored as vec4)
  97497. * @param uniform defines the webGL uniform location where to store the value
  97498. * @param array defines the array of int32 to store
  97499. */
  97500. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97501. /**
  97502. * Set the value of an uniform to an array of number
  97503. * @param uniform defines the webGL uniform location where to store the value
  97504. * @param array defines the array of number to store
  97505. */
  97506. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97507. /**
  97508. * Set the value of an uniform to an array of number (stored as vec2)
  97509. * @param uniform defines the webGL uniform location where to store the value
  97510. * @param array defines the array of number to store
  97511. */
  97512. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97513. /**
  97514. * Set the value of an uniform to an array of number (stored as vec3)
  97515. * @param uniform defines the webGL uniform location where to store the value
  97516. * @param array defines the array of number to store
  97517. */
  97518. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97519. /**
  97520. * Set the value of an uniform to an array of number (stored as vec4)
  97521. * @param uniform defines the webGL uniform location where to store the value
  97522. * @param array defines the array of number to store
  97523. */
  97524. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97525. /**
  97526. * Set the value of an uniform to an array of float32 (stored as matrices)
  97527. * @param uniform defines the webGL uniform location where to store the value
  97528. * @param matrices defines the array of float32 to store
  97529. */
  97530. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  97531. /**
  97532. * Set the value of an uniform to a matrix (3x3)
  97533. * @param uniform defines the webGL uniform location where to store the value
  97534. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  97535. */
  97536. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  97537. /**
  97538. * Set the value of an uniform to a matrix (2x2)
  97539. * @param uniform defines the webGL uniform location where to store the value
  97540. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  97541. */
  97542. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  97543. /**
  97544. * Set the value of an uniform to a number (float)
  97545. * @param uniform defines the webGL uniform location where to store the value
  97546. * @param value defines the float number to store
  97547. */
  97548. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  97549. /**
  97550. * Set the value of an uniform to a vec2
  97551. * @param uniform defines the webGL uniform location where to store the value
  97552. * @param x defines the 1st component of the value
  97553. * @param y defines the 2nd component of the value
  97554. */
  97555. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  97556. /**
  97557. * Set the value of an uniform to a vec3
  97558. * @param uniform defines the webGL uniform location where to store the value
  97559. * @param x defines the 1st component of the value
  97560. * @param y defines the 2nd component of the value
  97561. * @param z defines the 3rd component of the value
  97562. */
  97563. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  97564. /**
  97565. * Set the value of an uniform to a vec4
  97566. * @param uniform defines the webGL uniform location where to store the value
  97567. * @param x defines the 1st component of the value
  97568. * @param y defines the 2nd component of the value
  97569. * @param z defines the 3rd component of the value
  97570. * @param w defines the 4th component of the value
  97571. */
  97572. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  97573. /**
  97574. * Gets the depth culling state manager
  97575. */
  97576. readonly depthCullingState: DepthCullingState;
  97577. /**
  97578. * Gets the alpha state manager
  97579. */
  97580. readonly alphaState: AlphaState;
  97581. /**
  97582. * Gets the stencil state manager
  97583. */
  97584. readonly stencilState: StencilState;
  97585. /**
  97586. * Clears the list of texture accessible through engine.
  97587. * This can help preventing texture load conflict due to name collision.
  97588. */
  97589. clearInternalTexturesCache(): void;
  97590. /**
  97591. * Force the entire cache to be cleared
  97592. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  97593. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  97594. */
  97595. wipeCaches(bruteForce?: boolean): void;
  97596. /** @hidden */
  97597. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  97598. min: number;
  97599. mag: number;
  97600. };
  97601. /** @hidden */
  97602. _createTexture(): WebGLTexture;
  97603. /**
  97604. * Usually called from Texture.ts.
  97605. * Passed information to create a WebGLTexture
  97606. * @param urlArg defines a value which contains one of the following:
  97607. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  97608. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  97609. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  97610. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  97611. * @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)
  97612. * @param scene needed for loading to the correct scene
  97613. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  97614. * @param onLoad optional callback to be called upon successful completion
  97615. * @param onError optional callback to be called upon failure
  97616. * @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
  97617. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  97618. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  97619. * @param forcedExtension defines the extension to use to pick the right loader
  97620. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  97621. * @param mimeType defines an optional mime type
  97622. * @returns a InternalTexture for assignment back into BABYLON.Texture
  97623. */
  97624. 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>, excludeLoaders?: Array<IInternalTextureLoader>, mimeType?: string): InternalTexture;
  97625. /**
  97626. * @hidden
  97627. */
  97628. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  97629. /**
  97630. * Creates a raw texture
  97631. * @param data defines the data to store in the texture
  97632. * @param width defines the width of the texture
  97633. * @param height defines the height of the texture
  97634. * @param format defines the format of the data
  97635. * @param generateMipMaps defines if the engine should generate the mip levels
  97636. * @param invertY defines if data must be stored with Y axis inverted
  97637. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  97638. * @param compression defines the compression used (null by default)
  97639. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  97640. * @returns the raw texture inside an InternalTexture
  97641. */
  97642. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, type?: number): InternalTexture;
  97643. /**
  97644. * Creates a new raw cube texture
  97645. * @param data defines the array of data to use to create each face
  97646. * @param size defines the size of the textures
  97647. * @param format defines the format of the data
  97648. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  97649. * @param generateMipMaps defines if the engine should generate the mip levels
  97650. * @param invertY defines if data must be stored with Y axis inverted
  97651. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  97652. * @param compression defines the compression used (null by default)
  97653. * @returns the cube texture as an InternalTexture
  97654. */
  97655. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>): InternalTexture;
  97656. /**
  97657. * Creates a new raw 3D texture
  97658. * @param data defines the data used to create the texture
  97659. * @param width defines the width of the texture
  97660. * @param height defines the height of the texture
  97661. * @param depth defines the depth of the texture
  97662. * @param format defines the format of the texture
  97663. * @param generateMipMaps defines if the engine must generate mip levels
  97664. * @param invertY defines if data must be stored with Y axis inverted
  97665. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  97666. * @param compression defines the compressed used (can be null)
  97667. * @param textureType defines the compressed used (can be null)
  97668. * @returns a new raw 3D texture (stored in an InternalTexture)
  97669. */
  97670. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  97671. private _unpackFlipYCached;
  97672. /**
  97673. * In case you are sharing the context with other applications, it might
  97674. * be interested to not cache the unpack flip y state to ensure a consistent
  97675. * value would be set.
  97676. */
  97677. enableUnpackFlipYCached: boolean;
  97678. /** @hidden */
  97679. _unpackFlipY(value: boolean): void;
  97680. /** @hidden */
  97681. _getUnpackAlignement(): number;
  97682. /**
  97683. * Update the sampling mode of a given texture
  97684. * @param samplingMode defines the required sampling mode
  97685. * @param texture defines the texture to update
  97686. */
  97687. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  97688. /** @hidden */
  97689. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  97690. width: number;
  97691. height: number;
  97692. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  97693. /** @hidden */
  97694. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  97695. /** @hidden */
  97696. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  97697. /** @hidden */
  97698. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  97699. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  97700. private _prepareWebGLTexture;
  97701. /** @hidden */
  97702. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  97703. /** @hidden */
  97704. _releaseFramebufferObjects(texture: InternalTexture): void;
  97705. /** @hidden */
  97706. _releaseTexture(texture: InternalTexture): void;
  97707. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  97708. protected _setProgram(program: WebGLProgram): void;
  97709. protected _boundUniforms: {
  97710. [key: number]: WebGLUniformLocation;
  97711. };
  97712. /**
  97713. * Binds an effect to the webGL context
  97714. * @param effect defines the effect to bind
  97715. */
  97716. bindSamplers(effect: Effect): void;
  97717. private _activateCurrentTexture;
  97718. /** @hidden */
  97719. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  97720. /** @hidden */
  97721. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  97722. /**
  97723. * Unbind all textures from the webGL context
  97724. */
  97725. unbindAllTextures(): void;
  97726. /**
  97727. * Sets a texture to the according uniform.
  97728. * @param channel The texture channel
  97729. * @param uniform The uniform to set
  97730. * @param texture The texture to apply
  97731. */
  97732. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  97733. private _bindSamplerUniformToChannel;
  97734. private _getTextureWrapMode;
  97735. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  97736. /**
  97737. * Sets an array of texture to the webGL context
  97738. * @param channel defines the channel where the texture array must be set
  97739. * @param uniform defines the associated uniform location
  97740. * @param textures defines the array of textures to bind
  97741. */
  97742. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  97743. /** @hidden */
  97744. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  97745. private _setTextureParameterFloat;
  97746. private _setTextureParameterInteger;
  97747. /**
  97748. * Unbind all vertex attributes from the webGL context
  97749. */
  97750. unbindAllAttributes(): void;
  97751. /**
  97752. * 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
  97753. */
  97754. releaseEffects(): void;
  97755. /**
  97756. * Dispose and release all associated resources
  97757. */
  97758. dispose(): void;
  97759. /**
  97760. * Attach a new callback raised when context lost event is fired
  97761. * @param callback defines the callback to call
  97762. */
  97763. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  97764. /**
  97765. * Attach a new callback raised when context restored event is fired
  97766. * @param callback defines the callback to call
  97767. */
  97768. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  97769. /**
  97770. * Get the current error code of the webGL context
  97771. * @returns the error code
  97772. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  97773. */
  97774. getError(): number;
  97775. private _canRenderToFloatFramebuffer;
  97776. private _canRenderToHalfFloatFramebuffer;
  97777. private _canRenderToFramebuffer;
  97778. /** @hidden */
  97779. _getWebGLTextureType(type: number): number;
  97780. /** @hidden */
  97781. _getInternalFormat(format: number): number;
  97782. /** @hidden */
  97783. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  97784. /** @hidden */
  97785. _getRGBAMultiSampleBufferFormat(type: number): number;
  97786. /** @hidden */
  97787. _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;
  97788. /**
  97789. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  97790. * @returns true if the engine can be created
  97791. * @ignorenaming
  97792. */
  97793. static isSupported(): boolean;
  97794. /**
  97795. * Find the next highest power of two.
  97796. * @param x Number to start search from.
  97797. * @return Next highest power of two.
  97798. */
  97799. static CeilingPOT(x: number): number;
  97800. /**
  97801. * Find the next lowest power of two.
  97802. * @param x Number to start search from.
  97803. * @return Next lowest power of two.
  97804. */
  97805. static FloorPOT(x: number): number;
  97806. /**
  97807. * Find the nearest power of two.
  97808. * @param x Number to start search from.
  97809. * @return Next nearest power of two.
  97810. */
  97811. static NearestPOT(x: number): number;
  97812. /**
  97813. * Get the closest exponent of two
  97814. * @param value defines the value to approximate
  97815. * @param max defines the maximum value to return
  97816. * @param mode defines how to define the closest value
  97817. * @returns closest exponent of two of the given value
  97818. */
  97819. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  97820. /**
  97821. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  97822. * @param func - the function to be called
  97823. * @param requester - the object that will request the next frame. Falls back to window.
  97824. * @returns frame number
  97825. */
  97826. static QueueNewFrame(func: () => void, requester?: any): number;
  97827. }
  97828. }
  97829. declare module BABYLON {
  97830. /**
  97831. * Class representing spherical harmonics coefficients to the 3rd degree
  97832. */
  97833. export class SphericalHarmonics {
  97834. /**
  97835. * Defines whether or not the harmonics have been prescaled for rendering.
  97836. */
  97837. preScaled: boolean;
  97838. /**
  97839. * The l0,0 coefficients of the spherical harmonics
  97840. */
  97841. l00: Vector3;
  97842. /**
  97843. * The l1,-1 coefficients of the spherical harmonics
  97844. */
  97845. l1_1: Vector3;
  97846. /**
  97847. * The l1,0 coefficients of the spherical harmonics
  97848. */
  97849. l10: Vector3;
  97850. /**
  97851. * The l1,1 coefficients of the spherical harmonics
  97852. */
  97853. l11: Vector3;
  97854. /**
  97855. * The l2,-2 coefficients of the spherical harmonics
  97856. */
  97857. l2_2: Vector3;
  97858. /**
  97859. * The l2,-1 coefficients of the spherical harmonics
  97860. */
  97861. l2_1: Vector3;
  97862. /**
  97863. * The l2,0 coefficients of the spherical harmonics
  97864. */
  97865. l20: Vector3;
  97866. /**
  97867. * The l2,1 coefficients of the spherical harmonics
  97868. */
  97869. l21: Vector3;
  97870. /**
  97871. * The l2,2 coefficients of the spherical harmonics
  97872. */
  97873. l22: Vector3;
  97874. /**
  97875. * Adds a light to the spherical harmonics
  97876. * @param direction the direction of the light
  97877. * @param color the color of the light
  97878. * @param deltaSolidAngle the delta solid angle of the light
  97879. */
  97880. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  97881. /**
  97882. * Scales the spherical harmonics by the given amount
  97883. * @param scale the amount to scale
  97884. */
  97885. scaleInPlace(scale: number): void;
  97886. /**
  97887. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  97888. *
  97889. * ```
  97890. * E_lm = A_l * L_lm
  97891. * ```
  97892. *
  97893. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  97894. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  97895. * the scaling factors are given in equation 9.
  97896. */
  97897. convertIncidentRadianceToIrradiance(): void;
  97898. /**
  97899. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  97900. *
  97901. * ```
  97902. * L = (1/pi) * E * rho
  97903. * ```
  97904. *
  97905. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  97906. */
  97907. convertIrradianceToLambertianRadiance(): void;
  97908. /**
  97909. * Integrates the reconstruction coefficients directly in to the SH preventing further
  97910. * required operations at run time.
  97911. *
  97912. * This is simply done by scaling back the SH with Ylm constants parameter.
  97913. * The trigonometric part being applied by the shader at run time.
  97914. */
  97915. preScaleForRendering(): void;
  97916. /**
  97917. * Constructs a spherical harmonics from an array.
  97918. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  97919. * @returns the spherical harmonics
  97920. */
  97921. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  97922. /**
  97923. * Gets the spherical harmonics from polynomial
  97924. * @param polynomial the spherical polynomial
  97925. * @returns the spherical harmonics
  97926. */
  97927. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  97928. }
  97929. /**
  97930. * Class representing spherical polynomial coefficients to the 3rd degree
  97931. */
  97932. export class SphericalPolynomial {
  97933. private _harmonics;
  97934. /**
  97935. * The spherical harmonics used to create the polynomials.
  97936. */
  97937. readonly preScaledHarmonics: SphericalHarmonics;
  97938. /**
  97939. * The x coefficients of the spherical polynomial
  97940. */
  97941. x: Vector3;
  97942. /**
  97943. * The y coefficients of the spherical polynomial
  97944. */
  97945. y: Vector3;
  97946. /**
  97947. * The z coefficients of the spherical polynomial
  97948. */
  97949. z: Vector3;
  97950. /**
  97951. * The xx coefficients of the spherical polynomial
  97952. */
  97953. xx: Vector3;
  97954. /**
  97955. * The yy coefficients of the spherical polynomial
  97956. */
  97957. yy: Vector3;
  97958. /**
  97959. * The zz coefficients of the spherical polynomial
  97960. */
  97961. zz: Vector3;
  97962. /**
  97963. * The xy coefficients of the spherical polynomial
  97964. */
  97965. xy: Vector3;
  97966. /**
  97967. * The yz coefficients of the spherical polynomial
  97968. */
  97969. yz: Vector3;
  97970. /**
  97971. * The zx coefficients of the spherical polynomial
  97972. */
  97973. zx: Vector3;
  97974. /**
  97975. * Adds an ambient color to the spherical polynomial
  97976. * @param color the color to add
  97977. */
  97978. addAmbient(color: Color3): void;
  97979. /**
  97980. * Scales the spherical polynomial by the given amount
  97981. * @param scale the amount to scale
  97982. */
  97983. scaleInPlace(scale: number): void;
  97984. /**
  97985. * Gets the spherical polynomial from harmonics
  97986. * @param harmonics the spherical harmonics
  97987. * @returns the spherical polynomial
  97988. */
  97989. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  97990. /**
  97991. * Constructs a spherical polynomial from an array.
  97992. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  97993. * @returns the spherical polynomial
  97994. */
  97995. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  97996. }
  97997. }
  97998. declare module BABYLON {
  97999. /**
  98000. * Defines the source of the internal texture
  98001. */
  98002. export enum InternalTextureSource {
  98003. /**
  98004. * The source of the texture data is unknown
  98005. */
  98006. Unknown = 0,
  98007. /**
  98008. * Texture data comes from an URL
  98009. */
  98010. Url = 1,
  98011. /**
  98012. * Texture data is only used for temporary storage
  98013. */
  98014. Temp = 2,
  98015. /**
  98016. * Texture data comes from raw data (ArrayBuffer)
  98017. */
  98018. Raw = 3,
  98019. /**
  98020. * Texture content is dynamic (video or dynamic texture)
  98021. */
  98022. Dynamic = 4,
  98023. /**
  98024. * Texture content is generated by rendering to it
  98025. */
  98026. RenderTarget = 5,
  98027. /**
  98028. * Texture content is part of a multi render target process
  98029. */
  98030. MultiRenderTarget = 6,
  98031. /**
  98032. * Texture data comes from a cube data file
  98033. */
  98034. Cube = 7,
  98035. /**
  98036. * Texture data comes from a raw cube data
  98037. */
  98038. CubeRaw = 8,
  98039. /**
  98040. * Texture data come from a prefiltered cube data file
  98041. */
  98042. CubePrefiltered = 9,
  98043. /**
  98044. * Texture content is raw 3D data
  98045. */
  98046. Raw3D = 10,
  98047. /**
  98048. * Texture content is a depth texture
  98049. */
  98050. Depth = 11,
  98051. /**
  98052. * Texture data comes from a raw cube data encoded with RGBD
  98053. */
  98054. CubeRawRGBD = 12
  98055. }
  98056. /**
  98057. * Class used to store data associated with WebGL texture data for the engine
  98058. * This class should not be used directly
  98059. */
  98060. export class InternalTexture {
  98061. /** @hidden */
  98062. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  98063. /**
  98064. * Defines if the texture is ready
  98065. */
  98066. isReady: boolean;
  98067. /**
  98068. * Defines if the texture is a cube texture
  98069. */
  98070. isCube: boolean;
  98071. /**
  98072. * Defines if the texture contains 3D data
  98073. */
  98074. is3D: boolean;
  98075. /**
  98076. * Defines if the texture contains multiview data
  98077. */
  98078. isMultiview: boolean;
  98079. /**
  98080. * Gets the URL used to load this texture
  98081. */
  98082. url: string;
  98083. /**
  98084. * Gets the sampling mode of the texture
  98085. */
  98086. samplingMode: number;
  98087. /**
  98088. * Gets a boolean indicating if the texture needs mipmaps generation
  98089. */
  98090. generateMipMaps: boolean;
  98091. /**
  98092. * Gets the number of samples used by the texture (WebGL2+ only)
  98093. */
  98094. samples: number;
  98095. /**
  98096. * Gets the type of the texture (int, float...)
  98097. */
  98098. type: number;
  98099. /**
  98100. * Gets the format of the texture (RGB, RGBA...)
  98101. */
  98102. format: number;
  98103. /**
  98104. * Observable called when the texture is loaded
  98105. */
  98106. onLoadedObservable: Observable<InternalTexture>;
  98107. /**
  98108. * Gets the width of the texture
  98109. */
  98110. width: number;
  98111. /**
  98112. * Gets the height of the texture
  98113. */
  98114. height: number;
  98115. /**
  98116. * Gets the depth of the texture
  98117. */
  98118. depth: number;
  98119. /**
  98120. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  98121. */
  98122. baseWidth: number;
  98123. /**
  98124. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  98125. */
  98126. baseHeight: number;
  98127. /**
  98128. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  98129. */
  98130. baseDepth: number;
  98131. /**
  98132. * Gets a boolean indicating if the texture is inverted on Y axis
  98133. */
  98134. invertY: boolean;
  98135. /** @hidden */
  98136. _invertVScale: boolean;
  98137. /** @hidden */
  98138. _associatedChannel: number;
  98139. /** @hidden */
  98140. _source: InternalTextureSource;
  98141. /** @hidden */
  98142. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  98143. /** @hidden */
  98144. _bufferView: Nullable<ArrayBufferView>;
  98145. /** @hidden */
  98146. _bufferViewArray: Nullable<ArrayBufferView[]>;
  98147. /** @hidden */
  98148. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  98149. /** @hidden */
  98150. _size: number;
  98151. /** @hidden */
  98152. _extension: string;
  98153. /** @hidden */
  98154. _files: Nullable<string[]>;
  98155. /** @hidden */
  98156. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  98157. /** @hidden */
  98158. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  98159. /** @hidden */
  98160. _framebuffer: Nullable<WebGLFramebuffer>;
  98161. /** @hidden */
  98162. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  98163. /** @hidden */
  98164. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  98165. /** @hidden */
  98166. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  98167. /** @hidden */
  98168. _attachments: Nullable<number[]>;
  98169. /** @hidden */
  98170. _cachedCoordinatesMode: Nullable<number>;
  98171. /** @hidden */
  98172. _cachedWrapU: Nullable<number>;
  98173. /** @hidden */
  98174. _cachedWrapV: Nullable<number>;
  98175. /** @hidden */
  98176. _cachedWrapR: Nullable<number>;
  98177. /** @hidden */
  98178. _cachedAnisotropicFilteringLevel: Nullable<number>;
  98179. /** @hidden */
  98180. _isDisabled: boolean;
  98181. /** @hidden */
  98182. _compression: Nullable<string>;
  98183. /** @hidden */
  98184. _generateStencilBuffer: boolean;
  98185. /** @hidden */
  98186. _generateDepthBuffer: boolean;
  98187. /** @hidden */
  98188. _comparisonFunction: number;
  98189. /** @hidden */
  98190. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  98191. /** @hidden */
  98192. _lodGenerationScale: number;
  98193. /** @hidden */
  98194. _lodGenerationOffset: number;
  98195. /** @hidden */
  98196. _colorTextureArray: Nullable<WebGLTexture>;
  98197. /** @hidden */
  98198. _depthStencilTextureArray: Nullable<WebGLTexture>;
  98199. /** @hidden */
  98200. _lodTextureHigh: Nullable<BaseTexture>;
  98201. /** @hidden */
  98202. _lodTextureMid: Nullable<BaseTexture>;
  98203. /** @hidden */
  98204. _lodTextureLow: Nullable<BaseTexture>;
  98205. /** @hidden */
  98206. _isRGBD: boolean;
  98207. /** @hidden */
  98208. _linearSpecularLOD: boolean;
  98209. /** @hidden */
  98210. _irradianceTexture: Nullable<BaseTexture>;
  98211. /** @hidden */
  98212. _webGLTexture: Nullable<WebGLTexture>;
  98213. /** @hidden */
  98214. _references: number;
  98215. private _engine;
  98216. /**
  98217. * Gets the Engine the texture belongs to.
  98218. * @returns The babylon engine
  98219. */
  98220. getEngine(): ThinEngine;
  98221. /**
  98222. * Gets the data source type of the texture
  98223. */
  98224. readonly source: InternalTextureSource;
  98225. /**
  98226. * Creates a new InternalTexture
  98227. * @param engine defines the engine to use
  98228. * @param source defines the type of data that will be used
  98229. * @param delayAllocation if the texture allocation should be delayed (default: false)
  98230. */
  98231. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  98232. /**
  98233. * Increments the number of references (ie. the number of Texture that point to it)
  98234. */
  98235. incrementReferences(): void;
  98236. /**
  98237. * Change the size of the texture (not the size of the content)
  98238. * @param width defines the new width
  98239. * @param height defines the new height
  98240. * @param depth defines the new depth (1 by default)
  98241. */
  98242. updateSize(width: int, height: int, depth?: int): void;
  98243. /** @hidden */
  98244. _rebuild(): void;
  98245. /** @hidden */
  98246. _swapAndDie(target: InternalTexture): void;
  98247. /**
  98248. * Dispose the current allocated resources
  98249. */
  98250. dispose(): void;
  98251. }
  98252. }
  98253. declare module BABYLON {
  98254. /**
  98255. * Class used to work with sound analyzer using fast fourier transform (FFT)
  98256. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  98257. */
  98258. export class Analyser {
  98259. /**
  98260. * Gets or sets the smoothing
  98261. * @ignorenaming
  98262. */
  98263. SMOOTHING: number;
  98264. /**
  98265. * Gets or sets the FFT table size
  98266. * @ignorenaming
  98267. */
  98268. FFT_SIZE: number;
  98269. /**
  98270. * Gets or sets the bar graph amplitude
  98271. * @ignorenaming
  98272. */
  98273. BARGRAPHAMPLITUDE: number;
  98274. /**
  98275. * Gets or sets the position of the debug canvas
  98276. * @ignorenaming
  98277. */
  98278. DEBUGCANVASPOS: {
  98279. x: number;
  98280. y: number;
  98281. };
  98282. /**
  98283. * Gets or sets the debug canvas size
  98284. * @ignorenaming
  98285. */
  98286. DEBUGCANVASSIZE: {
  98287. width: number;
  98288. height: number;
  98289. };
  98290. private _byteFreqs;
  98291. private _byteTime;
  98292. private _floatFreqs;
  98293. private _webAudioAnalyser;
  98294. private _debugCanvas;
  98295. private _debugCanvasContext;
  98296. private _scene;
  98297. private _registerFunc;
  98298. private _audioEngine;
  98299. /**
  98300. * Creates a new analyser
  98301. * @param scene defines hosting scene
  98302. */
  98303. constructor(scene: Scene);
  98304. /**
  98305. * Get the number of data values you will have to play with for the visualization
  98306. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  98307. * @returns a number
  98308. */
  98309. getFrequencyBinCount(): number;
  98310. /**
  98311. * Gets the current frequency data as a byte array
  98312. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  98313. * @returns a Uint8Array
  98314. */
  98315. getByteFrequencyData(): Uint8Array;
  98316. /**
  98317. * Gets the current waveform as a byte array
  98318. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  98319. * @returns a Uint8Array
  98320. */
  98321. getByteTimeDomainData(): Uint8Array;
  98322. /**
  98323. * Gets the current frequency data as a float array
  98324. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  98325. * @returns a Float32Array
  98326. */
  98327. getFloatFrequencyData(): Float32Array;
  98328. /**
  98329. * Renders the debug canvas
  98330. */
  98331. drawDebugCanvas(): void;
  98332. /**
  98333. * Stops rendering the debug canvas and removes it
  98334. */
  98335. stopDebugCanvas(): void;
  98336. /**
  98337. * Connects two audio nodes
  98338. * @param inputAudioNode defines first node to connect
  98339. * @param outputAudioNode defines second node to connect
  98340. */
  98341. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  98342. /**
  98343. * Releases all associated resources
  98344. */
  98345. dispose(): void;
  98346. }
  98347. }
  98348. declare module BABYLON {
  98349. /**
  98350. * This represents an audio engine and it is responsible
  98351. * to play, synchronize and analyse sounds throughout the application.
  98352. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  98353. */
  98354. export interface IAudioEngine extends IDisposable {
  98355. /**
  98356. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  98357. */
  98358. readonly canUseWebAudio: boolean;
  98359. /**
  98360. * Gets the current AudioContext if available.
  98361. */
  98362. readonly audioContext: Nullable<AudioContext>;
  98363. /**
  98364. * The master gain node defines the global audio volume of your audio engine.
  98365. */
  98366. readonly masterGain: GainNode;
  98367. /**
  98368. * Gets whether or not mp3 are supported by your browser.
  98369. */
  98370. readonly isMP3supported: boolean;
  98371. /**
  98372. * Gets whether or not ogg are supported by your browser.
  98373. */
  98374. readonly isOGGsupported: boolean;
  98375. /**
  98376. * Defines if Babylon should emit a warning if WebAudio is not supported.
  98377. * @ignoreNaming
  98378. */
  98379. WarnedWebAudioUnsupported: boolean;
  98380. /**
  98381. * Defines if the audio engine relies on a custom unlocked button.
  98382. * In this case, the embedded button will not be displayed.
  98383. */
  98384. useCustomUnlockedButton: boolean;
  98385. /**
  98386. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  98387. */
  98388. readonly unlocked: boolean;
  98389. /**
  98390. * Event raised when audio has been unlocked on the browser.
  98391. */
  98392. onAudioUnlockedObservable: Observable<AudioEngine>;
  98393. /**
  98394. * Event raised when audio has been locked on the browser.
  98395. */
  98396. onAudioLockedObservable: Observable<AudioEngine>;
  98397. /**
  98398. * Flags the audio engine in Locked state.
  98399. * This happens due to new browser policies preventing audio to autoplay.
  98400. */
  98401. lock(): void;
  98402. /**
  98403. * Unlocks the audio engine once a user action has been done on the dom.
  98404. * This is helpful to resume play once browser policies have been satisfied.
  98405. */
  98406. unlock(): void;
  98407. }
  98408. /**
  98409. * This represents the default audio engine used in babylon.
  98410. * It is responsible to play, synchronize and analyse sounds throughout the application.
  98411. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  98412. */
  98413. export class AudioEngine implements IAudioEngine {
  98414. private _audioContext;
  98415. private _audioContextInitialized;
  98416. private _muteButton;
  98417. private _hostElement;
  98418. /**
  98419. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  98420. */
  98421. canUseWebAudio: boolean;
  98422. /**
  98423. * The master gain node defines the global audio volume of your audio engine.
  98424. */
  98425. masterGain: GainNode;
  98426. /**
  98427. * Defines if Babylon should emit a warning if WebAudio is not supported.
  98428. * @ignoreNaming
  98429. */
  98430. WarnedWebAudioUnsupported: boolean;
  98431. /**
  98432. * Gets whether or not mp3 are supported by your browser.
  98433. */
  98434. isMP3supported: boolean;
  98435. /**
  98436. * Gets whether or not ogg are supported by your browser.
  98437. */
  98438. isOGGsupported: boolean;
  98439. /**
  98440. * Gets whether audio has been unlocked on the device.
  98441. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  98442. * a user interaction has happened.
  98443. */
  98444. unlocked: boolean;
  98445. /**
  98446. * Defines if the audio engine relies on a custom unlocked button.
  98447. * In this case, the embedded button will not be displayed.
  98448. */
  98449. useCustomUnlockedButton: boolean;
  98450. /**
  98451. * Event raised when audio has been unlocked on the browser.
  98452. */
  98453. onAudioUnlockedObservable: Observable<AudioEngine>;
  98454. /**
  98455. * Event raised when audio has been locked on the browser.
  98456. */
  98457. onAudioLockedObservable: Observable<AudioEngine>;
  98458. /**
  98459. * Gets the current AudioContext if available.
  98460. */
  98461. readonly audioContext: Nullable<AudioContext>;
  98462. private _connectedAnalyser;
  98463. /**
  98464. * Instantiates a new audio engine.
  98465. *
  98466. * There should be only one per page as some browsers restrict the number
  98467. * of audio contexts you can create.
  98468. * @param hostElement defines the host element where to display the mute icon if necessary
  98469. */
  98470. constructor(hostElement?: Nullable<HTMLElement>);
  98471. /**
  98472. * Flags the audio engine in Locked state.
  98473. * This happens due to new browser policies preventing audio to autoplay.
  98474. */
  98475. lock(): void;
  98476. /**
  98477. * Unlocks the audio engine once a user action has been done on the dom.
  98478. * This is helpful to resume play once browser policies have been satisfied.
  98479. */
  98480. unlock(): void;
  98481. private _resumeAudioContext;
  98482. private _initializeAudioContext;
  98483. private _tryToRun;
  98484. private _triggerRunningState;
  98485. private _triggerSuspendedState;
  98486. private _displayMuteButton;
  98487. private _moveButtonToTopLeft;
  98488. private _onResize;
  98489. private _hideMuteButton;
  98490. /**
  98491. * Destroy and release the resources associated with the audio ccontext.
  98492. */
  98493. dispose(): void;
  98494. /**
  98495. * Gets the global volume sets on the master gain.
  98496. * @returns the global volume if set or -1 otherwise
  98497. */
  98498. getGlobalVolume(): number;
  98499. /**
  98500. * Sets the global volume of your experience (sets on the master gain).
  98501. * @param newVolume Defines the new global volume of the application
  98502. */
  98503. setGlobalVolume(newVolume: number): void;
  98504. /**
  98505. * Connect the audio engine to an audio analyser allowing some amazing
  98506. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  98507. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  98508. * @param analyser The analyser to connect to the engine
  98509. */
  98510. connectToAnalyser(analyser: Analyser): void;
  98511. }
  98512. }
  98513. declare module BABYLON {
  98514. /**
  98515. * Interface used to present a loading screen while loading a scene
  98516. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  98517. */
  98518. export interface ILoadingScreen {
  98519. /**
  98520. * Function called to display the loading screen
  98521. */
  98522. displayLoadingUI: () => void;
  98523. /**
  98524. * Function called to hide the loading screen
  98525. */
  98526. hideLoadingUI: () => void;
  98527. /**
  98528. * Gets or sets the color to use for the background
  98529. */
  98530. loadingUIBackgroundColor: string;
  98531. /**
  98532. * Gets or sets the text to display while loading
  98533. */
  98534. loadingUIText: string;
  98535. }
  98536. /**
  98537. * Class used for the default loading screen
  98538. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  98539. */
  98540. export class DefaultLoadingScreen implements ILoadingScreen {
  98541. private _renderingCanvas;
  98542. private _loadingText;
  98543. private _loadingDivBackgroundColor;
  98544. private _loadingDiv;
  98545. private _loadingTextDiv;
  98546. /** Gets or sets the logo url to use for the default loading screen */
  98547. static DefaultLogoUrl: string;
  98548. /** Gets or sets the spinner url to use for the default loading screen */
  98549. static DefaultSpinnerUrl: string;
  98550. /**
  98551. * Creates a new default loading screen
  98552. * @param _renderingCanvas defines the canvas used to render the scene
  98553. * @param _loadingText defines the default text to display
  98554. * @param _loadingDivBackgroundColor defines the default background color
  98555. */
  98556. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  98557. /**
  98558. * Function called to display the loading screen
  98559. */
  98560. displayLoadingUI(): void;
  98561. /**
  98562. * Function called to hide the loading screen
  98563. */
  98564. hideLoadingUI(): void;
  98565. /**
  98566. * Gets or sets the text to display while loading
  98567. */
  98568. loadingUIText: string;
  98569. /**
  98570. * Gets or sets the color to use for the background
  98571. */
  98572. loadingUIBackgroundColor: string;
  98573. private _resizeLoadingUI;
  98574. }
  98575. }
  98576. declare module BABYLON {
  98577. /**
  98578. * Interface for any object that can request an animation frame
  98579. */
  98580. export interface ICustomAnimationFrameRequester {
  98581. /**
  98582. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  98583. */
  98584. renderFunction?: Function;
  98585. /**
  98586. * Called to request the next frame to render to
  98587. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  98588. */
  98589. requestAnimationFrame: Function;
  98590. /**
  98591. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  98592. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  98593. */
  98594. requestID?: number;
  98595. }
  98596. }
  98597. declare module BABYLON {
  98598. /**
  98599. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  98600. */
  98601. export class PerformanceMonitor {
  98602. private _enabled;
  98603. private _rollingFrameTime;
  98604. private _lastFrameTimeMs;
  98605. /**
  98606. * constructor
  98607. * @param frameSampleSize The number of samples required to saturate the sliding window
  98608. */
  98609. constructor(frameSampleSize?: number);
  98610. /**
  98611. * Samples current frame
  98612. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  98613. */
  98614. sampleFrame(timeMs?: number): void;
  98615. /**
  98616. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  98617. */
  98618. readonly averageFrameTime: number;
  98619. /**
  98620. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  98621. */
  98622. readonly averageFrameTimeVariance: number;
  98623. /**
  98624. * Returns the frame time of the most recent frame
  98625. */
  98626. readonly instantaneousFrameTime: number;
  98627. /**
  98628. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  98629. */
  98630. readonly averageFPS: number;
  98631. /**
  98632. * Returns the average framerate in frames per second using the most recent frame time
  98633. */
  98634. readonly instantaneousFPS: number;
  98635. /**
  98636. * Returns true if enough samples have been taken to completely fill the sliding window
  98637. */
  98638. readonly isSaturated: boolean;
  98639. /**
  98640. * Enables contributions to the sliding window sample set
  98641. */
  98642. enable(): void;
  98643. /**
  98644. * Disables contributions to the sliding window sample set
  98645. * Samples will not be interpolated over the disabled period
  98646. */
  98647. disable(): void;
  98648. /**
  98649. * Returns true if sampling is enabled
  98650. */
  98651. readonly isEnabled: boolean;
  98652. /**
  98653. * Resets performance monitor
  98654. */
  98655. reset(): void;
  98656. }
  98657. /**
  98658. * RollingAverage
  98659. *
  98660. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  98661. */
  98662. export class RollingAverage {
  98663. /**
  98664. * Current average
  98665. */
  98666. average: number;
  98667. /**
  98668. * Current variance
  98669. */
  98670. variance: number;
  98671. protected _samples: Array<number>;
  98672. protected _sampleCount: number;
  98673. protected _pos: number;
  98674. protected _m2: number;
  98675. /**
  98676. * constructor
  98677. * @param length The number of samples required to saturate the sliding window
  98678. */
  98679. constructor(length: number);
  98680. /**
  98681. * Adds a sample to the sample set
  98682. * @param v The sample value
  98683. */
  98684. add(v: number): void;
  98685. /**
  98686. * Returns previously added values or null if outside of history or outside the sliding window domain
  98687. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  98688. * @return Value previously recorded with add() or null if outside of range
  98689. */
  98690. history(i: number): number;
  98691. /**
  98692. * Returns true if enough samples have been taken to completely fill the sliding window
  98693. * @return true if sample-set saturated
  98694. */
  98695. isSaturated(): boolean;
  98696. /**
  98697. * Resets the rolling average (equivalent to 0 samples taken so far)
  98698. */
  98699. reset(): void;
  98700. /**
  98701. * Wraps a value around the sample range boundaries
  98702. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  98703. * @return Wrapped position in sample range
  98704. */
  98705. protected _wrapPosition(i: number): number;
  98706. }
  98707. }
  98708. declare module BABYLON {
  98709. /**
  98710. * This class is used to track a performance counter which is number based.
  98711. * The user has access to many properties which give statistics of different nature.
  98712. *
  98713. * The implementer can track two kinds of Performance Counter: time and count.
  98714. * 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.
  98715. * 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.
  98716. */
  98717. export class PerfCounter {
  98718. /**
  98719. * Gets or sets a global boolean to turn on and off all the counters
  98720. */
  98721. static Enabled: boolean;
  98722. /**
  98723. * Returns the smallest value ever
  98724. */
  98725. readonly min: number;
  98726. /**
  98727. * Returns the biggest value ever
  98728. */
  98729. readonly max: number;
  98730. /**
  98731. * Returns the average value since the performance counter is running
  98732. */
  98733. readonly average: number;
  98734. /**
  98735. * Returns the average value of the last second the counter was monitored
  98736. */
  98737. readonly lastSecAverage: number;
  98738. /**
  98739. * Returns the current value
  98740. */
  98741. readonly current: number;
  98742. /**
  98743. * Gets the accumulated total
  98744. */
  98745. readonly total: number;
  98746. /**
  98747. * Gets the total value count
  98748. */
  98749. readonly count: number;
  98750. /**
  98751. * Creates a new counter
  98752. */
  98753. constructor();
  98754. /**
  98755. * Call this method to start monitoring a new frame.
  98756. * 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.
  98757. */
  98758. fetchNewFrame(): void;
  98759. /**
  98760. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  98761. * @param newCount the count value to add to the monitored count
  98762. * @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.
  98763. */
  98764. addCount(newCount: number, fetchResult: boolean): void;
  98765. /**
  98766. * Start monitoring this performance counter
  98767. */
  98768. beginMonitoring(): void;
  98769. /**
  98770. * Compute the time lapsed since the previous beginMonitoring() call.
  98771. * @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
  98772. */
  98773. endMonitoring(newFrame?: boolean): void;
  98774. private _fetchResult;
  98775. private _startMonitoringTime;
  98776. private _min;
  98777. private _max;
  98778. private _average;
  98779. private _current;
  98780. private _totalValueCount;
  98781. private _totalAccumulated;
  98782. private _lastSecAverage;
  98783. private _lastSecAccumulated;
  98784. private _lastSecTime;
  98785. private _lastSecValueCount;
  98786. }
  98787. }
  98788. declare module BABYLON {
  98789. /**
  98790. * Defines the interface used by display changed events
  98791. */
  98792. export interface IDisplayChangedEventArgs {
  98793. /** Gets the vrDisplay object (if any) */
  98794. vrDisplay: Nullable<any>;
  98795. /** Gets a boolean indicating if webVR is supported */
  98796. vrSupported: boolean;
  98797. }
  98798. /**
  98799. * Defines the interface used by objects containing a viewport (like a camera)
  98800. */
  98801. interface IViewportOwnerLike {
  98802. /**
  98803. * Gets or sets the viewport
  98804. */
  98805. viewport: IViewportLike;
  98806. }
  98807. /**
  98808. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  98809. */
  98810. export class Engine extends ThinEngine {
  98811. /** Defines that alpha blending is disabled */
  98812. static readonly ALPHA_DISABLE: number;
  98813. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  98814. static readonly ALPHA_ADD: number;
  98815. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  98816. static readonly ALPHA_COMBINE: number;
  98817. /** Defines that alpha blending to DEST - SRC * DEST */
  98818. static readonly ALPHA_SUBTRACT: number;
  98819. /** Defines that alpha blending to SRC * DEST */
  98820. static readonly ALPHA_MULTIPLY: number;
  98821. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  98822. static readonly ALPHA_MAXIMIZED: number;
  98823. /** Defines that alpha blending to SRC + DEST */
  98824. static readonly ALPHA_ONEONE: number;
  98825. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  98826. static readonly ALPHA_PREMULTIPLIED: number;
  98827. /**
  98828. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  98829. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  98830. */
  98831. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  98832. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  98833. static readonly ALPHA_INTERPOLATE: number;
  98834. /**
  98835. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  98836. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  98837. */
  98838. static readonly ALPHA_SCREENMODE: number;
  98839. /** Defines that the ressource is not delayed*/
  98840. static readonly DELAYLOADSTATE_NONE: number;
  98841. /** Defines that the ressource was successfully delay loaded */
  98842. static readonly DELAYLOADSTATE_LOADED: number;
  98843. /** Defines that the ressource is currently delay loading */
  98844. static readonly DELAYLOADSTATE_LOADING: number;
  98845. /** Defines that the ressource is delayed and has not started loading */
  98846. static readonly DELAYLOADSTATE_NOTLOADED: number;
  98847. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  98848. static readonly NEVER: number;
  98849. /** 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 */
  98850. static readonly ALWAYS: number;
  98851. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  98852. static readonly LESS: number;
  98853. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  98854. static readonly EQUAL: number;
  98855. /** 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 */
  98856. static readonly LEQUAL: number;
  98857. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  98858. static readonly GREATER: number;
  98859. /** 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 */
  98860. static readonly GEQUAL: number;
  98861. /** 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 */
  98862. static readonly NOTEQUAL: number;
  98863. /** Passed to stencilOperation to specify that stencil value must be kept */
  98864. static readonly KEEP: number;
  98865. /** Passed to stencilOperation to specify that stencil value must be replaced */
  98866. static readonly REPLACE: number;
  98867. /** Passed to stencilOperation to specify that stencil value must be incremented */
  98868. static readonly INCR: number;
  98869. /** Passed to stencilOperation to specify that stencil value must be decremented */
  98870. static readonly DECR: number;
  98871. /** Passed to stencilOperation to specify that stencil value must be inverted */
  98872. static readonly INVERT: number;
  98873. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  98874. static readonly INCR_WRAP: number;
  98875. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  98876. static readonly DECR_WRAP: number;
  98877. /** Texture is not repeating outside of 0..1 UVs */
  98878. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  98879. /** Texture is repeating outside of 0..1 UVs */
  98880. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  98881. /** Texture is repeating and mirrored */
  98882. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  98883. /** ALPHA */
  98884. static readonly TEXTUREFORMAT_ALPHA: number;
  98885. /** LUMINANCE */
  98886. static readonly TEXTUREFORMAT_LUMINANCE: number;
  98887. /** LUMINANCE_ALPHA */
  98888. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  98889. /** RGB */
  98890. static readonly TEXTUREFORMAT_RGB: number;
  98891. /** RGBA */
  98892. static readonly TEXTUREFORMAT_RGBA: number;
  98893. /** RED */
  98894. static readonly TEXTUREFORMAT_RED: number;
  98895. /** RED (2nd reference) */
  98896. static readonly TEXTUREFORMAT_R: number;
  98897. /** RG */
  98898. static readonly TEXTUREFORMAT_RG: number;
  98899. /** RED_INTEGER */
  98900. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  98901. /** RED_INTEGER (2nd reference) */
  98902. static readonly TEXTUREFORMAT_R_INTEGER: number;
  98903. /** RG_INTEGER */
  98904. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  98905. /** RGB_INTEGER */
  98906. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  98907. /** RGBA_INTEGER */
  98908. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  98909. /** UNSIGNED_BYTE */
  98910. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  98911. /** UNSIGNED_BYTE (2nd reference) */
  98912. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  98913. /** FLOAT */
  98914. static readonly TEXTURETYPE_FLOAT: number;
  98915. /** HALF_FLOAT */
  98916. static readonly TEXTURETYPE_HALF_FLOAT: number;
  98917. /** BYTE */
  98918. static readonly TEXTURETYPE_BYTE: number;
  98919. /** SHORT */
  98920. static readonly TEXTURETYPE_SHORT: number;
  98921. /** UNSIGNED_SHORT */
  98922. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  98923. /** INT */
  98924. static readonly TEXTURETYPE_INT: number;
  98925. /** UNSIGNED_INT */
  98926. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  98927. /** UNSIGNED_SHORT_4_4_4_4 */
  98928. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  98929. /** UNSIGNED_SHORT_5_5_5_1 */
  98930. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  98931. /** UNSIGNED_SHORT_5_6_5 */
  98932. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  98933. /** UNSIGNED_INT_2_10_10_10_REV */
  98934. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  98935. /** UNSIGNED_INT_24_8 */
  98936. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  98937. /** UNSIGNED_INT_10F_11F_11F_REV */
  98938. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  98939. /** UNSIGNED_INT_5_9_9_9_REV */
  98940. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  98941. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  98942. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  98943. /** nearest is mag = nearest and min = nearest and mip = linear */
  98944. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  98945. /** Bilinear is mag = linear and min = linear and mip = nearest */
  98946. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  98947. /** Trilinear is mag = linear and min = linear and mip = linear */
  98948. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  98949. /** nearest is mag = nearest and min = nearest and mip = linear */
  98950. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  98951. /** Bilinear is mag = linear and min = linear and mip = nearest */
  98952. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  98953. /** Trilinear is mag = linear and min = linear and mip = linear */
  98954. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  98955. /** mag = nearest and min = nearest and mip = nearest */
  98956. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  98957. /** mag = nearest and min = linear and mip = nearest */
  98958. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  98959. /** mag = nearest and min = linear and mip = linear */
  98960. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  98961. /** mag = nearest and min = linear and mip = none */
  98962. static readonly TEXTURE_NEAREST_LINEAR: number;
  98963. /** mag = nearest and min = nearest and mip = none */
  98964. static readonly TEXTURE_NEAREST_NEAREST: number;
  98965. /** mag = linear and min = nearest and mip = nearest */
  98966. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  98967. /** mag = linear and min = nearest and mip = linear */
  98968. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  98969. /** mag = linear and min = linear and mip = none */
  98970. static readonly TEXTURE_LINEAR_LINEAR: number;
  98971. /** mag = linear and min = nearest and mip = none */
  98972. static readonly TEXTURE_LINEAR_NEAREST: number;
  98973. /** Explicit coordinates mode */
  98974. static readonly TEXTURE_EXPLICIT_MODE: number;
  98975. /** Spherical coordinates mode */
  98976. static readonly TEXTURE_SPHERICAL_MODE: number;
  98977. /** Planar coordinates mode */
  98978. static readonly TEXTURE_PLANAR_MODE: number;
  98979. /** Cubic coordinates mode */
  98980. static readonly TEXTURE_CUBIC_MODE: number;
  98981. /** Projection coordinates mode */
  98982. static readonly TEXTURE_PROJECTION_MODE: number;
  98983. /** Skybox coordinates mode */
  98984. static readonly TEXTURE_SKYBOX_MODE: number;
  98985. /** Inverse Cubic coordinates mode */
  98986. static readonly TEXTURE_INVCUBIC_MODE: number;
  98987. /** Equirectangular coordinates mode */
  98988. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  98989. /** Equirectangular Fixed coordinates mode */
  98990. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  98991. /** Equirectangular Fixed Mirrored coordinates mode */
  98992. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  98993. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  98994. static readonly SCALEMODE_FLOOR: number;
  98995. /** Defines that texture rescaling will look for the nearest power of 2 size */
  98996. static readonly SCALEMODE_NEAREST: number;
  98997. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  98998. static readonly SCALEMODE_CEILING: number;
  98999. /**
  99000. * Returns the current npm package of the sdk
  99001. */
  99002. static readonly NpmPackage: string;
  99003. /**
  99004. * Returns the current version of the framework
  99005. */
  99006. static readonly Version: string;
  99007. /** Gets the list of created engines */
  99008. static readonly Instances: Engine[];
  99009. /**
  99010. * Gets the latest created engine
  99011. */
  99012. static readonly LastCreatedEngine: Nullable<Engine>;
  99013. /**
  99014. * Gets the latest created scene
  99015. */
  99016. static readonly LastCreatedScene: Nullable<Scene>;
  99017. /**
  99018. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  99019. * @param flag defines which part of the materials must be marked as dirty
  99020. * @param predicate defines a predicate used to filter which materials should be affected
  99021. */
  99022. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  99023. /**
  99024. * Method called to create the default loading screen.
  99025. * This can be overriden in your own app.
  99026. * @param canvas The rendering canvas element
  99027. * @returns The loading screen
  99028. */
  99029. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  99030. /**
  99031. * Method called to create the default rescale post process on each engine.
  99032. */
  99033. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  99034. /**
  99035. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  99036. **/
  99037. enableOfflineSupport: boolean;
  99038. /**
  99039. * 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)
  99040. **/
  99041. disableManifestCheck: boolean;
  99042. /**
  99043. * Gets the list of created scenes
  99044. */
  99045. scenes: Scene[];
  99046. /**
  99047. * Event raised when a new scene is created
  99048. */
  99049. onNewSceneAddedObservable: Observable<Scene>;
  99050. /**
  99051. * Gets the list of created postprocesses
  99052. */
  99053. postProcesses: PostProcess[];
  99054. /**
  99055. * Gets a boolean indicating if the pointer is currently locked
  99056. */
  99057. isPointerLock: boolean;
  99058. /**
  99059. * Observable event triggered each time the rendering canvas is resized
  99060. */
  99061. onResizeObservable: Observable<Engine>;
  99062. /**
  99063. * Observable event triggered each time the canvas loses focus
  99064. */
  99065. onCanvasBlurObservable: Observable<Engine>;
  99066. /**
  99067. * Observable event triggered each time the canvas gains focus
  99068. */
  99069. onCanvasFocusObservable: Observable<Engine>;
  99070. /**
  99071. * Observable event triggered each time the canvas receives pointerout event
  99072. */
  99073. onCanvasPointerOutObservable: Observable<PointerEvent>;
  99074. /**
  99075. * Observable raised when the engine begins a new frame
  99076. */
  99077. onBeginFrameObservable: Observable<Engine>;
  99078. /**
  99079. * If set, will be used to request the next animation frame for the render loop
  99080. */
  99081. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  99082. /**
  99083. * Observable raised when the engine ends the current frame
  99084. */
  99085. onEndFrameObservable: Observable<Engine>;
  99086. /**
  99087. * Observable raised when the engine is about to compile a shader
  99088. */
  99089. onBeforeShaderCompilationObservable: Observable<Engine>;
  99090. /**
  99091. * Observable raised when the engine has jsut compiled a shader
  99092. */
  99093. onAfterShaderCompilationObservable: Observable<Engine>;
  99094. /**
  99095. * Gets the audio engine
  99096. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99097. * @ignorenaming
  99098. */
  99099. static audioEngine: IAudioEngine;
  99100. /**
  99101. * Default AudioEngine factory responsible of creating the Audio Engine.
  99102. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  99103. */
  99104. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  99105. /**
  99106. * Default offline support factory responsible of creating a tool used to store data locally.
  99107. * By default, this will create a Database object if the workload has been embedded.
  99108. */
  99109. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  99110. private _loadingScreen;
  99111. private _pointerLockRequested;
  99112. private _dummyFramebuffer;
  99113. private _rescalePostProcess;
  99114. /** @hidden */
  99115. protected _alphaMode: number;
  99116. /** @hidden */
  99117. protected _alphaEquation: number;
  99118. private _deterministicLockstep;
  99119. private _lockstepMaxSteps;
  99120. protected readonly _supportsHardwareTextureRescaling: boolean;
  99121. private _fps;
  99122. private _deltaTime;
  99123. /** @hidden */
  99124. _drawCalls: PerfCounter;
  99125. /**
  99126. * Turn this value on if you want to pause FPS computation when in background
  99127. */
  99128. disablePerformanceMonitorInBackground: boolean;
  99129. private _performanceMonitor;
  99130. /**
  99131. * Gets the performance monitor attached to this engine
  99132. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  99133. */
  99134. readonly performanceMonitor: PerformanceMonitor;
  99135. private _onFocus;
  99136. private _onBlur;
  99137. private _onCanvasPointerOut;
  99138. private _onCanvasBlur;
  99139. private _onCanvasFocus;
  99140. private _onFullscreenChange;
  99141. private _onPointerLockChange;
  99142. /**
  99143. * Creates a new engine
  99144. * @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
  99145. * @param antialias defines enable antialiasing (default: false)
  99146. * @param options defines further options to be sent to the getContext() function
  99147. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  99148. */
  99149. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  99150. /**
  99151. * Gets current aspect ratio
  99152. * @param viewportOwner defines the camera to use to get the aspect ratio
  99153. * @param useScreen defines if screen size must be used (or the current render target if any)
  99154. * @returns a number defining the aspect ratio
  99155. */
  99156. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  99157. /**
  99158. * Gets current screen aspect ratio
  99159. * @returns a number defining the aspect ratio
  99160. */
  99161. getScreenAspectRatio(): number;
  99162. /**
  99163. * Gets host document
  99164. * @returns the host document object
  99165. */
  99166. getHostDocument(): Document;
  99167. /**
  99168. * Gets the client rect of the HTML canvas attached with the current webGL context
  99169. * @returns a client rectanglee
  99170. */
  99171. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  99172. /**
  99173. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  99174. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  99175. * @returns true if engine is in deterministic lock step mode
  99176. */
  99177. isDeterministicLockStep(): boolean;
  99178. /**
  99179. * Gets the max steps when engine is running in deterministic lock step
  99180. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  99181. * @returns the max steps
  99182. */
  99183. getLockstepMaxSteps(): number;
  99184. /**
  99185. * Force the mipmap generation for the given render target texture
  99186. * @param texture defines the render target texture to use
  99187. */
  99188. generateMipMapsForCubemap(texture: InternalTexture): void;
  99189. /** States */
  99190. /**
  99191. * Set various states to the webGL context
  99192. * @param culling defines backface culling state
  99193. * @param zOffset defines the value to apply to zOffset (0 by default)
  99194. * @param force defines if states must be applied even if cache is up to date
  99195. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  99196. */
  99197. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  99198. /**
  99199. * Set the z offset to apply to current rendering
  99200. * @param value defines the offset to apply
  99201. */
  99202. setZOffset(value: number): void;
  99203. /**
  99204. * Gets the current value of the zOffset
  99205. * @returns the current zOffset state
  99206. */
  99207. getZOffset(): number;
  99208. /**
  99209. * Enable or disable depth buffering
  99210. * @param enable defines the state to set
  99211. */
  99212. setDepthBuffer(enable: boolean): void;
  99213. /**
  99214. * Gets a boolean indicating if depth writing is enabled
  99215. * @returns the current depth writing state
  99216. */
  99217. getDepthWrite(): boolean;
  99218. /**
  99219. * Enable or disable depth writing
  99220. * @param enable defines the state to set
  99221. */
  99222. setDepthWrite(enable: boolean): void;
  99223. /**
  99224. * Enable or disable color writing
  99225. * @param enable defines the state to set
  99226. */
  99227. setColorWrite(enable: boolean): void;
  99228. /**
  99229. * Gets a boolean indicating if color writing is enabled
  99230. * @returns the current color writing state
  99231. */
  99232. getColorWrite(): boolean;
  99233. /**
  99234. * Sets alpha constants used by some alpha blending modes
  99235. * @param r defines the red component
  99236. * @param g defines the green component
  99237. * @param b defines the blue component
  99238. * @param a defines the alpha component
  99239. */
  99240. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  99241. /**
  99242. * Sets the current alpha mode
  99243. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  99244. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  99245. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  99246. */
  99247. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  99248. /**
  99249. * Gets the current alpha mode
  99250. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  99251. * @returns the current alpha mode
  99252. */
  99253. getAlphaMode(): number;
  99254. /**
  99255. * Sets the current alpha equation
  99256. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  99257. */
  99258. setAlphaEquation(equation: number): void;
  99259. /**
  99260. * Gets the current alpha equation.
  99261. * @returns the current alpha equation
  99262. */
  99263. getAlphaEquation(): number;
  99264. /**
  99265. * Gets a boolean indicating if stencil buffer is enabled
  99266. * @returns the current stencil buffer state
  99267. */
  99268. getStencilBuffer(): boolean;
  99269. /**
  99270. * Enable or disable the stencil buffer
  99271. * @param enable defines if the stencil buffer must be enabled or disabled
  99272. */
  99273. setStencilBuffer(enable: boolean): void;
  99274. /**
  99275. * Gets the current stencil mask
  99276. * @returns a number defining the new stencil mask to use
  99277. */
  99278. getStencilMask(): number;
  99279. /**
  99280. * Sets the current stencil mask
  99281. * @param mask defines the new stencil mask to use
  99282. */
  99283. setStencilMask(mask: number): void;
  99284. /**
  99285. * Gets the current stencil function
  99286. * @returns a number defining the stencil function to use
  99287. */
  99288. getStencilFunction(): number;
  99289. /**
  99290. * Gets the current stencil reference value
  99291. * @returns a number defining the stencil reference value to use
  99292. */
  99293. getStencilFunctionReference(): number;
  99294. /**
  99295. * Gets the current stencil mask
  99296. * @returns a number defining the stencil mask to use
  99297. */
  99298. getStencilFunctionMask(): number;
  99299. /**
  99300. * Sets the current stencil function
  99301. * @param stencilFunc defines the new stencil function to use
  99302. */
  99303. setStencilFunction(stencilFunc: number): void;
  99304. /**
  99305. * Sets the current stencil reference
  99306. * @param reference defines the new stencil reference to use
  99307. */
  99308. setStencilFunctionReference(reference: number): void;
  99309. /**
  99310. * Sets the current stencil mask
  99311. * @param mask defines the new stencil mask to use
  99312. */
  99313. setStencilFunctionMask(mask: number): void;
  99314. /**
  99315. * Gets the current stencil operation when stencil fails
  99316. * @returns a number defining stencil operation to use when stencil fails
  99317. */
  99318. getStencilOperationFail(): number;
  99319. /**
  99320. * Gets the current stencil operation when depth fails
  99321. * @returns a number defining stencil operation to use when depth fails
  99322. */
  99323. getStencilOperationDepthFail(): number;
  99324. /**
  99325. * Gets the current stencil operation when stencil passes
  99326. * @returns a number defining stencil operation to use when stencil passes
  99327. */
  99328. getStencilOperationPass(): number;
  99329. /**
  99330. * Sets the stencil operation to use when stencil fails
  99331. * @param operation defines the stencil operation to use when stencil fails
  99332. */
  99333. setStencilOperationFail(operation: number): void;
  99334. /**
  99335. * Sets the stencil operation to use when depth fails
  99336. * @param operation defines the stencil operation to use when depth fails
  99337. */
  99338. setStencilOperationDepthFail(operation: number): void;
  99339. /**
  99340. * Sets the stencil operation to use when stencil passes
  99341. * @param operation defines the stencil operation to use when stencil passes
  99342. */
  99343. setStencilOperationPass(operation: number): void;
  99344. /**
  99345. * Sets a boolean indicating if the dithering state is enabled or disabled
  99346. * @param value defines the dithering state
  99347. */
  99348. setDitheringState(value: boolean): void;
  99349. /**
  99350. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  99351. * @param value defines the rasterizer state
  99352. */
  99353. setRasterizerState(value: boolean): void;
  99354. /**
  99355. * Gets the current depth function
  99356. * @returns a number defining the depth function
  99357. */
  99358. getDepthFunction(): Nullable<number>;
  99359. /**
  99360. * Sets the current depth function
  99361. * @param depthFunc defines the function to use
  99362. */
  99363. setDepthFunction(depthFunc: number): void;
  99364. /**
  99365. * Sets the current depth function to GREATER
  99366. */
  99367. setDepthFunctionToGreater(): void;
  99368. /**
  99369. * Sets the current depth function to GEQUAL
  99370. */
  99371. setDepthFunctionToGreaterOrEqual(): void;
  99372. /**
  99373. * Sets the current depth function to LESS
  99374. */
  99375. setDepthFunctionToLess(): void;
  99376. /**
  99377. * Sets the current depth function to LEQUAL
  99378. */
  99379. setDepthFunctionToLessOrEqual(): void;
  99380. private _cachedStencilBuffer;
  99381. private _cachedStencilFunction;
  99382. private _cachedStencilMask;
  99383. private _cachedStencilOperationPass;
  99384. private _cachedStencilOperationFail;
  99385. private _cachedStencilOperationDepthFail;
  99386. private _cachedStencilReference;
  99387. /**
  99388. * Caches the the state of the stencil buffer
  99389. */
  99390. cacheStencilState(): void;
  99391. /**
  99392. * Restores the state of the stencil buffer
  99393. */
  99394. restoreStencilState(): void;
  99395. /**
  99396. * Directly set the WebGL Viewport
  99397. * @param x defines the x coordinate of the viewport (in screen space)
  99398. * @param y defines the y coordinate of the viewport (in screen space)
  99399. * @param width defines the width of the viewport (in screen space)
  99400. * @param height defines the height of the viewport (in screen space)
  99401. * @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
  99402. */
  99403. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  99404. /**
  99405. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  99406. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  99407. * @param y defines the y-coordinate of the corner of the clear rectangle
  99408. * @param width defines the width of the clear rectangle
  99409. * @param height defines the height of the clear rectangle
  99410. * @param clearColor defines the clear color
  99411. */
  99412. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  99413. /**
  99414. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  99415. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  99416. * @param y defines the y-coordinate of the corner of the clear rectangle
  99417. * @param width defines the width of the clear rectangle
  99418. * @param height defines the height of the clear rectangle
  99419. */
  99420. enableScissor(x: number, y: number, width: number, height: number): void;
  99421. /**
  99422. * Disable previously set scissor test rectangle
  99423. */
  99424. disableScissor(): void;
  99425. protected _reportDrawCall(): void;
  99426. /**
  99427. * Initializes a webVR display and starts listening to display change events
  99428. * The onVRDisplayChangedObservable will be notified upon these changes
  99429. * @returns The onVRDisplayChangedObservable
  99430. */
  99431. initWebVR(): Observable<IDisplayChangedEventArgs>;
  99432. /** @hidden */
  99433. _prepareVRComponent(): void;
  99434. /** @hidden */
  99435. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  99436. /** @hidden */
  99437. _submitVRFrame(): void;
  99438. /**
  99439. * Call this function to leave webVR mode
  99440. * Will do nothing if webVR is not supported or if there is no webVR device
  99441. * @see http://doc.babylonjs.com/how_to/webvr_camera
  99442. */
  99443. disableVR(): void;
  99444. /**
  99445. * Gets a boolean indicating that the system is in VR mode and is presenting
  99446. * @returns true if VR mode is engaged
  99447. */
  99448. isVRPresenting(): boolean;
  99449. /** @hidden */
  99450. _requestVRFrame(): void;
  99451. /** @hidden */
  99452. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  99453. /**
  99454. * Gets the source code of the vertex shader associated with a specific webGL program
  99455. * @param program defines the program to use
  99456. * @returns a string containing the source code of the vertex shader associated with the program
  99457. */
  99458. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  99459. /**
  99460. * Gets the source code of the fragment shader associated with a specific webGL program
  99461. * @param program defines the program to use
  99462. * @returns a string containing the source code of the fragment shader associated with the program
  99463. */
  99464. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  99465. /**
  99466. * Reads pixels from the current frame buffer. Please note that this function can be slow
  99467. * @param x defines the x coordinate of the rectangle where pixels must be read
  99468. * @param y defines the y coordinate of the rectangle where pixels must be read
  99469. * @param width defines the width of the rectangle where pixels must be read
  99470. * @param height defines the height of the rectangle where pixels must be read
  99471. * @returns a Uint8Array containing RGBA colors
  99472. */
  99473. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  99474. /**
  99475. * Sets a depth stencil texture from a render target to the according uniform.
  99476. * @param channel The texture channel
  99477. * @param uniform The uniform to set
  99478. * @param texture The render target texture containing the depth stencil texture to apply
  99479. */
  99480. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  99481. /**
  99482. * Sets a texture to the webGL context from a postprocess
  99483. * @param channel defines the channel to use
  99484. * @param postProcess defines the source postprocess
  99485. */
  99486. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  99487. /**
  99488. * Binds the output of the passed in post process to the texture channel specified
  99489. * @param channel The channel the texture should be bound to
  99490. * @param postProcess The post process which's output should be bound
  99491. */
  99492. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  99493. /** @hidden */
  99494. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  99495. protected _rebuildBuffers(): void;
  99496. /** @hidden */
  99497. _renderFrame(): void;
  99498. _renderLoop(): void;
  99499. /** @hidden */
  99500. _renderViews(): void;
  99501. /**
  99502. * Toggle full screen mode
  99503. * @param requestPointerLock defines if a pointer lock should be requested from the user
  99504. */
  99505. switchFullscreen(requestPointerLock: boolean): void;
  99506. /**
  99507. * Enters full screen mode
  99508. * @param requestPointerLock defines if a pointer lock should be requested from the user
  99509. */
  99510. enterFullscreen(requestPointerLock: boolean): void;
  99511. /**
  99512. * Exits full screen mode
  99513. */
  99514. exitFullscreen(): void;
  99515. /**
  99516. * Enters Pointerlock mode
  99517. */
  99518. enterPointerlock(): void;
  99519. /**
  99520. * Exits Pointerlock mode
  99521. */
  99522. exitPointerlock(): void;
  99523. /**
  99524. * Begin a new frame
  99525. */
  99526. beginFrame(): void;
  99527. /**
  99528. * Enf the current frame
  99529. */
  99530. endFrame(): void;
  99531. resize(): void;
  99532. /**
  99533. * Set the compressed texture format to use, based on the formats you have, and the formats
  99534. * supported by the hardware / browser.
  99535. *
  99536. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  99537. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  99538. * to API arguments needed to compressed textures. This puts the burden on the container
  99539. * generator to house the arcane code for determining these for current & future formats.
  99540. *
  99541. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  99542. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  99543. *
  99544. * Note: The result of this call is not taken into account when a texture is base64.
  99545. *
  99546. * @param formatsAvailable defines the list of those format families you have created
  99547. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  99548. *
  99549. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  99550. * @returns The extension selected.
  99551. */
  99552. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  99553. /**
  99554. * Force a specific size of the canvas
  99555. * @param width defines the new canvas' width
  99556. * @param height defines the new canvas' height
  99557. */
  99558. setSize(width: number, height: number): void;
  99559. /**
  99560. * Updates a dynamic vertex buffer.
  99561. * @param vertexBuffer the vertex buffer to update
  99562. * @param data the data used to update the vertex buffer
  99563. * @param byteOffset the byte offset of the data
  99564. * @param byteLength the byte length of the data
  99565. */
  99566. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  99567. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  99568. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  99569. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  99570. _releaseTexture(texture: InternalTexture): void;
  99571. /**
  99572. * @hidden
  99573. * Rescales a texture
  99574. * @param source input texutre
  99575. * @param destination destination texture
  99576. * @param scene scene to use to render the resize
  99577. * @param internalFormat format to use when resizing
  99578. * @param onComplete callback to be called when resize has completed
  99579. */
  99580. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  99581. /**
  99582. * Gets the current framerate
  99583. * @returns a number representing the framerate
  99584. */
  99585. getFps(): number;
  99586. /**
  99587. * Gets the time spent between current and previous frame
  99588. * @returns a number representing the delta time in ms
  99589. */
  99590. getDeltaTime(): number;
  99591. private _measureFps;
  99592. /** @hidden */
  99593. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  99594. /**
  99595. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  99596. * @param renderTarget The render target to set the frame buffer for
  99597. */
  99598. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  99599. /**
  99600. * Update a dynamic index buffer
  99601. * @param indexBuffer defines the target index buffer
  99602. * @param indices defines the data to update
  99603. * @param offset defines the offset in the target index buffer where update should start
  99604. */
  99605. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  99606. /**
  99607. * Updates the sample count of a render target texture
  99608. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  99609. * @param texture defines the texture to update
  99610. * @param samples defines the sample count to set
  99611. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  99612. */
  99613. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  99614. /**
  99615. * Updates a depth texture Comparison Mode and Function.
  99616. * If the comparison Function is equal to 0, the mode will be set to none.
  99617. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  99618. * @param texture The texture to set the comparison function for
  99619. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  99620. */
  99621. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  99622. /**
  99623. * Creates a webGL buffer to use with instanciation
  99624. * @param capacity defines the size of the buffer
  99625. * @returns the webGL buffer
  99626. */
  99627. createInstancesBuffer(capacity: number): DataBuffer;
  99628. /**
  99629. * Delete a webGL buffer used with instanciation
  99630. * @param buffer defines the webGL buffer to delete
  99631. */
  99632. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  99633. /** @hidden */
  99634. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  99635. dispose(): void;
  99636. private _disableTouchAction;
  99637. /**
  99638. * Display the loading screen
  99639. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99640. */
  99641. displayLoadingUI(): void;
  99642. /**
  99643. * Hide the loading screen
  99644. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99645. */
  99646. hideLoadingUI(): void;
  99647. /**
  99648. * Gets the current loading screen object
  99649. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99650. */
  99651. /**
  99652. * Sets the current loading screen object
  99653. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99654. */
  99655. loadingScreen: ILoadingScreen;
  99656. /**
  99657. * Sets the current loading screen text
  99658. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99659. */
  99660. loadingUIText: string;
  99661. /**
  99662. * Sets the current loading screen background color
  99663. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99664. */
  99665. loadingUIBackgroundColor: string;
  99666. /** Pointerlock and fullscreen */
  99667. /**
  99668. * Ask the browser to promote the current element to pointerlock mode
  99669. * @param element defines the DOM element to promote
  99670. */
  99671. static _RequestPointerlock(element: HTMLElement): void;
  99672. /**
  99673. * Asks the browser to exit pointerlock mode
  99674. */
  99675. static _ExitPointerlock(): void;
  99676. /**
  99677. * Ask the browser to promote the current element to fullscreen rendering mode
  99678. * @param element defines the DOM element to promote
  99679. */
  99680. static _RequestFullscreen(element: HTMLElement): void;
  99681. /**
  99682. * Asks the browser to exit fullscreen mode
  99683. */
  99684. static _ExitFullscreen(): void;
  99685. }
  99686. }
  99687. declare module BABYLON {
  99688. /**
  99689. * The engine store class is responsible to hold all the instances of Engine and Scene created
  99690. * during the life time of the application.
  99691. */
  99692. export class EngineStore {
  99693. /** Gets the list of created engines */
  99694. static Instances: Engine[];
  99695. /** @hidden */
  99696. static _LastCreatedScene: Nullable<Scene>;
  99697. /**
  99698. * Gets the latest created engine
  99699. */
  99700. static readonly LastCreatedEngine: Nullable<Engine>;
  99701. /**
  99702. * Gets the latest created scene
  99703. */
  99704. static readonly LastCreatedScene: Nullable<Scene>;
  99705. /**
  99706. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  99707. * @ignorenaming
  99708. */
  99709. static UseFallbackTexture: boolean;
  99710. /**
  99711. * Texture content used if a texture cannot loaded
  99712. * @ignorenaming
  99713. */
  99714. static FallbackTexture: string;
  99715. }
  99716. }
  99717. declare module BABYLON {
  99718. /**
  99719. * Helper class that provides a small promise polyfill
  99720. */
  99721. export class PromisePolyfill {
  99722. /**
  99723. * Static function used to check if the polyfill is required
  99724. * If this is the case then the function will inject the polyfill to window.Promise
  99725. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  99726. */
  99727. static Apply(force?: boolean): void;
  99728. }
  99729. }
  99730. declare module BABYLON {
  99731. /**
  99732. * Interface for screenshot methods with describe argument called `size` as object with options
  99733. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  99734. */
  99735. export interface IScreenshotSize {
  99736. /**
  99737. * number in pixels for canvas height
  99738. */
  99739. height?: number;
  99740. /**
  99741. * multiplier allowing render at a higher or lower resolution
  99742. * If value is defined then height and width will be ignored and taken from camera
  99743. */
  99744. precision?: number;
  99745. /**
  99746. * number in pixels for canvas width
  99747. */
  99748. width?: number;
  99749. }
  99750. }
  99751. declare module BABYLON {
  99752. interface IColor4Like {
  99753. r: float;
  99754. g: float;
  99755. b: float;
  99756. a: float;
  99757. }
  99758. /**
  99759. * Class containing a set of static utilities functions
  99760. */
  99761. export class Tools {
  99762. /**
  99763. * Gets or sets the base URL to use to load assets
  99764. */
  99765. static BaseUrl: string;
  99766. /**
  99767. * Enable/Disable Custom HTTP Request Headers globally.
  99768. * default = false
  99769. * @see CustomRequestHeaders
  99770. */
  99771. static UseCustomRequestHeaders: boolean;
  99772. /**
  99773. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  99774. * i.e. when loading files, where the server/service expects an Authorization header
  99775. */
  99776. static CustomRequestHeaders: {
  99777. [key: string]: string;
  99778. };
  99779. /**
  99780. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  99781. */
  99782. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  99783. /**
  99784. * Default behaviour for cors in the application.
  99785. * It can be a string if the expected behavior is identical in the entire app.
  99786. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  99787. */
  99788. static CorsBehavior: string | ((url: string | string[]) => string);
  99789. /**
  99790. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  99791. * @ignorenaming
  99792. */
  99793. static UseFallbackTexture: boolean;
  99794. /**
  99795. * Use this object to register external classes like custom textures or material
  99796. * to allow the laoders to instantiate them
  99797. */
  99798. static RegisteredExternalClasses: {
  99799. [key: string]: Object;
  99800. };
  99801. /**
  99802. * Texture content used if a texture cannot loaded
  99803. * @ignorenaming
  99804. */
  99805. static fallbackTexture: string;
  99806. /**
  99807. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  99808. * @param u defines the coordinate on X axis
  99809. * @param v defines the coordinate on Y axis
  99810. * @param width defines the width of the source data
  99811. * @param height defines the height of the source data
  99812. * @param pixels defines the source byte array
  99813. * @param color defines the output color
  99814. */
  99815. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  99816. /**
  99817. * Interpolates between a and b via alpha
  99818. * @param a The lower value (returned when alpha = 0)
  99819. * @param b The upper value (returned when alpha = 1)
  99820. * @param alpha The interpolation-factor
  99821. * @return The mixed value
  99822. */
  99823. static Mix(a: number, b: number, alpha: number): number;
  99824. /**
  99825. * Tries to instantiate a new object from a given class name
  99826. * @param className defines the class name to instantiate
  99827. * @returns the new object or null if the system was not able to do the instantiation
  99828. */
  99829. static Instantiate(className: string): any;
  99830. /**
  99831. * Provides a slice function that will work even on IE
  99832. * @param data defines the array to slice
  99833. * @param start defines the start of the data (optional)
  99834. * @param end defines the end of the data (optional)
  99835. * @returns the new sliced array
  99836. */
  99837. static Slice<T>(data: T, start?: number, end?: number): T;
  99838. /**
  99839. * Polyfill for setImmediate
  99840. * @param action defines the action to execute after the current execution block
  99841. */
  99842. static SetImmediate(action: () => void): void;
  99843. /**
  99844. * Function indicating if a number is an exponent of 2
  99845. * @param value defines the value to test
  99846. * @returns true if the value is an exponent of 2
  99847. */
  99848. static IsExponentOfTwo(value: number): boolean;
  99849. private static _tmpFloatArray;
  99850. /**
  99851. * Returns the nearest 32-bit single precision float representation of a Number
  99852. * @param value A Number. If the parameter is of a different type, it will get converted
  99853. * to a number or to NaN if it cannot be converted
  99854. * @returns number
  99855. */
  99856. static FloatRound(value: number): number;
  99857. /**
  99858. * Extracts the filename from a path
  99859. * @param path defines the path to use
  99860. * @returns the filename
  99861. */
  99862. static GetFilename(path: string): string;
  99863. /**
  99864. * Extracts the "folder" part of a path (everything before the filename).
  99865. * @param uri The URI to extract the info from
  99866. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  99867. * @returns The "folder" part of the path
  99868. */
  99869. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  99870. /**
  99871. * Extracts text content from a DOM element hierarchy
  99872. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  99873. */
  99874. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  99875. /**
  99876. * Convert an angle in radians to degrees
  99877. * @param angle defines the angle to convert
  99878. * @returns the angle in degrees
  99879. */
  99880. static ToDegrees(angle: number): number;
  99881. /**
  99882. * Convert an angle in degrees to radians
  99883. * @param angle defines the angle to convert
  99884. * @returns the angle in radians
  99885. */
  99886. static ToRadians(angle: number): number;
  99887. /**
  99888. * Returns an array if obj is not an array
  99889. * @param obj defines the object to evaluate as an array
  99890. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  99891. * @returns either obj directly if obj is an array or a new array containing obj
  99892. */
  99893. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  99894. /**
  99895. * Gets the pointer prefix to use
  99896. * @returns "pointer" if touch is enabled. Else returns "mouse"
  99897. */
  99898. static GetPointerPrefix(): string;
  99899. /**
  99900. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  99901. * @param url define the url we are trying
  99902. * @param element define the dom element where to configure the cors policy
  99903. */
  99904. static SetCorsBehavior(url: string | string[], element: {
  99905. crossOrigin: string | null;
  99906. }): void;
  99907. /**
  99908. * Removes unwanted characters from an url
  99909. * @param url defines the url to clean
  99910. * @returns the cleaned url
  99911. */
  99912. static CleanUrl(url: string): string;
  99913. /**
  99914. * Gets or sets a function used to pre-process url before using them to load assets
  99915. */
  99916. static PreprocessUrl: (url: string) => string;
  99917. /**
  99918. * Loads an image as an HTMLImageElement.
  99919. * @param input url string, ArrayBuffer, or Blob to load
  99920. * @param onLoad callback called when the image successfully loads
  99921. * @param onError callback called when the image fails to load
  99922. * @param offlineProvider offline provider for caching
  99923. * @param mimeType optional mime type
  99924. * @returns the HTMLImageElement of the loaded image
  99925. */
  99926. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  99927. /**
  99928. * Loads a file from a url
  99929. * @param url url string, ArrayBuffer, or Blob to load
  99930. * @param onSuccess callback called when the file successfully loads
  99931. * @param onProgress callback called while file is loading (if the server supports this mode)
  99932. * @param offlineProvider defines the offline provider for caching
  99933. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  99934. * @param onError callback called when the file fails to load
  99935. * @returns a file request object
  99936. */
  99937. 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;
  99938. /**
  99939. * Loads a file from a url
  99940. * @param url the file url to load
  99941. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  99942. */
  99943. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  99944. /**
  99945. * Load a script (identified by an url). When the url returns, the
  99946. * content of this file is added into a new script element, attached to the DOM (body element)
  99947. * @param scriptUrl defines the url of the script to laod
  99948. * @param onSuccess defines the callback called when the script is loaded
  99949. * @param onError defines the callback to call if an error occurs
  99950. * @param scriptId defines the id of the script element
  99951. */
  99952. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  99953. /**
  99954. * Load an asynchronous script (identified by an url). When the url returns, the
  99955. * content of this file is added into a new script element, attached to the DOM (body element)
  99956. * @param scriptUrl defines the url of the script to laod
  99957. * @param scriptId defines the id of the script element
  99958. * @returns a promise request object
  99959. */
  99960. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  99961. /**
  99962. * Loads a file from a blob
  99963. * @param fileToLoad defines the blob to use
  99964. * @param callback defines the callback to call when data is loaded
  99965. * @param progressCallback defines the callback to call during loading process
  99966. * @returns a file request object
  99967. */
  99968. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  99969. /**
  99970. * Reads a file from a File object
  99971. * @param file defines the file to load
  99972. * @param onSuccess defines the callback to call when data is loaded
  99973. * @param onProgress defines the callback to call during loading process
  99974. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  99975. * @param onError defines the callback to call when an error occurs
  99976. * @returns a file request object
  99977. */
  99978. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  99979. /**
  99980. * Creates a data url from a given string content
  99981. * @param content defines the content to convert
  99982. * @returns the new data url link
  99983. */
  99984. static FileAsURL(content: string): string;
  99985. /**
  99986. * Format the given number to a specific decimal format
  99987. * @param value defines the number to format
  99988. * @param decimals defines the number of decimals to use
  99989. * @returns the formatted string
  99990. */
  99991. static Format(value: number, decimals?: number): string;
  99992. /**
  99993. * Tries to copy an object by duplicating every property
  99994. * @param source defines the source object
  99995. * @param destination defines the target object
  99996. * @param doNotCopyList defines a list of properties to avoid
  99997. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  99998. */
  99999. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  100000. /**
  100001. * Gets a boolean indicating if the given object has no own property
  100002. * @param obj defines the object to test
  100003. * @returns true if object has no own property
  100004. */
  100005. static IsEmpty(obj: any): boolean;
  100006. /**
  100007. * Function used to register events at window level
  100008. * @param windowElement defines the Window object to use
  100009. * @param events defines the events to register
  100010. */
  100011. static RegisterTopRootEvents(windowElement: Window, events: {
  100012. name: string;
  100013. handler: Nullable<(e: FocusEvent) => any>;
  100014. }[]): void;
  100015. /**
  100016. * Function used to unregister events from window level
  100017. * @param windowElement defines the Window object to use
  100018. * @param events defines the events to unregister
  100019. */
  100020. static UnregisterTopRootEvents(windowElement: Window, events: {
  100021. name: string;
  100022. handler: Nullable<(e: FocusEvent) => any>;
  100023. }[]): void;
  100024. /**
  100025. * @ignore
  100026. */
  100027. static _ScreenshotCanvas: HTMLCanvasElement;
  100028. /**
  100029. * Dumps the current bound framebuffer
  100030. * @param width defines the rendering width
  100031. * @param height defines the rendering height
  100032. * @param engine defines the hosting engine
  100033. * @param successCallback defines the callback triggered once the data are available
  100034. * @param mimeType defines the mime type of the result
  100035. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  100036. */
  100037. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  100038. /**
  100039. * Converts the canvas data to blob.
  100040. * This acts as a polyfill for browsers not supporting the to blob function.
  100041. * @param canvas Defines the canvas to extract the data from
  100042. * @param successCallback Defines the callback triggered once the data are available
  100043. * @param mimeType Defines the mime type of the result
  100044. */
  100045. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  100046. /**
  100047. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  100048. * @param successCallback defines the callback triggered once the data are available
  100049. * @param mimeType defines the mime type of the result
  100050. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  100051. */
  100052. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  100053. /**
  100054. * Downloads a blob in the browser
  100055. * @param blob defines the blob to download
  100056. * @param fileName defines the name of the downloaded file
  100057. */
  100058. static Download(blob: Blob, fileName: string): void;
  100059. /**
  100060. * Captures a screenshot of the current rendering
  100061. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100062. * @param engine defines the rendering engine
  100063. * @param camera defines the source camera
  100064. * @param size This parameter can be set to a single number or to an object with the
  100065. * following (optional) properties: precision, width, height. If a single number is passed,
  100066. * it will be used for both width and height. If an object is passed, the screenshot size
  100067. * will be derived from the parameters. The precision property is a multiplier allowing
  100068. * rendering at a higher or lower resolution
  100069. * @param successCallback defines the callback receives a single parameter which contains the
  100070. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  100071. * src parameter of an <img> to display it
  100072. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  100073. * Check your browser for supported MIME types
  100074. */
  100075. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  100076. /**
  100077. * Captures a screenshot of the current rendering
  100078. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100079. * @param engine defines the rendering engine
  100080. * @param camera defines the source camera
  100081. * @param size This parameter can be set to a single number or to an object with the
  100082. * following (optional) properties: precision, width, height. If a single number is passed,
  100083. * it will be used for both width and height. If an object is passed, the screenshot size
  100084. * will be derived from the parameters. The precision property is a multiplier allowing
  100085. * rendering at a higher or lower resolution
  100086. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  100087. * Check your browser for supported MIME types
  100088. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  100089. * to the src parameter of an <img> to display it
  100090. */
  100091. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  100092. /**
  100093. * Generates an image screenshot from the specified camera.
  100094. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100095. * @param engine The engine to use for rendering
  100096. * @param camera The camera to use for rendering
  100097. * @param size This parameter can be set to a single number or to an object with the
  100098. * following (optional) properties: precision, width, height. If a single number is passed,
  100099. * it will be used for both width and height. If an object is passed, the screenshot size
  100100. * will be derived from the parameters. The precision property is a multiplier allowing
  100101. * rendering at a higher or lower resolution
  100102. * @param successCallback The callback receives a single parameter which contains the
  100103. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  100104. * src parameter of an <img> to display it
  100105. * @param mimeType The MIME type of the screenshot image (default: image/png).
  100106. * Check your browser for supported MIME types
  100107. * @param samples Texture samples (default: 1)
  100108. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  100109. * @param fileName A name for for the downloaded file.
  100110. */
  100111. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  100112. /**
  100113. * Generates an image screenshot from the specified camera.
  100114. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100115. * @param engine The engine to use for rendering
  100116. * @param camera The camera to use for rendering
  100117. * @param size This parameter can be set to a single number or to an object with the
  100118. * following (optional) properties: precision, width, height. If a single number is passed,
  100119. * it will be used for both width and height. If an object is passed, the screenshot size
  100120. * will be derived from the parameters. The precision property is a multiplier allowing
  100121. * rendering at a higher or lower resolution
  100122. * @param mimeType The MIME type of the screenshot image (default: image/png).
  100123. * Check your browser for supported MIME types
  100124. * @param samples Texture samples (default: 1)
  100125. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  100126. * @param fileName A name for for the downloaded file.
  100127. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  100128. * to the src parameter of an <img> to display it
  100129. */
  100130. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  100131. /**
  100132. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  100133. * Be aware Math.random() could cause collisions, but:
  100134. * "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"
  100135. * @returns a pseudo random id
  100136. */
  100137. static RandomId(): string;
  100138. /**
  100139. * Test if the given uri is a base64 string
  100140. * @param uri The uri to test
  100141. * @return True if the uri is a base64 string or false otherwise
  100142. */
  100143. static IsBase64(uri: string): boolean;
  100144. /**
  100145. * Decode the given base64 uri.
  100146. * @param uri The uri to decode
  100147. * @return The decoded base64 data.
  100148. */
  100149. static DecodeBase64(uri: string): ArrayBuffer;
  100150. /**
  100151. * Gets the absolute url.
  100152. * @param url the input url
  100153. * @return the absolute url
  100154. */
  100155. static GetAbsoluteUrl(url: string): string;
  100156. /**
  100157. * No log
  100158. */
  100159. static readonly NoneLogLevel: number;
  100160. /**
  100161. * Only message logs
  100162. */
  100163. static readonly MessageLogLevel: number;
  100164. /**
  100165. * Only warning logs
  100166. */
  100167. static readonly WarningLogLevel: number;
  100168. /**
  100169. * Only error logs
  100170. */
  100171. static readonly ErrorLogLevel: number;
  100172. /**
  100173. * All logs
  100174. */
  100175. static readonly AllLogLevel: number;
  100176. /**
  100177. * Gets a value indicating the number of loading errors
  100178. * @ignorenaming
  100179. */
  100180. static readonly errorsCount: number;
  100181. /**
  100182. * Callback called when a new log is added
  100183. */
  100184. static OnNewCacheEntry: (entry: string) => void;
  100185. /**
  100186. * Log a message to the console
  100187. * @param message defines the message to log
  100188. */
  100189. static Log(message: string): void;
  100190. /**
  100191. * Write a warning message to the console
  100192. * @param message defines the message to log
  100193. */
  100194. static Warn(message: string): void;
  100195. /**
  100196. * Write an error message to the console
  100197. * @param message defines the message to log
  100198. */
  100199. static Error(message: string): void;
  100200. /**
  100201. * Gets current log cache (list of logs)
  100202. */
  100203. static readonly LogCache: string;
  100204. /**
  100205. * Clears the log cache
  100206. */
  100207. static ClearLogCache(): void;
  100208. /**
  100209. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  100210. */
  100211. static LogLevels: number;
  100212. /**
  100213. * Checks if the window object exists
  100214. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  100215. */
  100216. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  100217. /**
  100218. * No performance log
  100219. */
  100220. static readonly PerformanceNoneLogLevel: number;
  100221. /**
  100222. * Use user marks to log performance
  100223. */
  100224. static readonly PerformanceUserMarkLogLevel: number;
  100225. /**
  100226. * Log performance to the console
  100227. */
  100228. static readonly PerformanceConsoleLogLevel: number;
  100229. private static _performance;
  100230. /**
  100231. * Sets the current performance log level
  100232. */
  100233. static PerformanceLogLevel: number;
  100234. private static _StartPerformanceCounterDisabled;
  100235. private static _EndPerformanceCounterDisabled;
  100236. private static _StartUserMark;
  100237. private static _EndUserMark;
  100238. private static _StartPerformanceConsole;
  100239. private static _EndPerformanceConsole;
  100240. /**
  100241. * Starts a performance counter
  100242. */
  100243. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  100244. /**
  100245. * Ends a specific performance coutner
  100246. */
  100247. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  100248. /**
  100249. * Gets either window.performance.now() if supported or Date.now() else
  100250. */
  100251. static readonly Now: number;
  100252. /**
  100253. * This method will return the name of the class used to create the instance of the given object.
  100254. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  100255. * @param object the object to get the class name from
  100256. * @param isType defines if the object is actually a type
  100257. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  100258. */
  100259. static GetClassName(object: any, isType?: boolean): string;
  100260. /**
  100261. * Gets the first element of an array satisfying a given predicate
  100262. * @param array defines the array to browse
  100263. * @param predicate defines the predicate to use
  100264. * @returns null if not found or the element
  100265. */
  100266. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  100267. /**
  100268. * This method will return the name of the full name of the class, including its owning module (if any).
  100269. * 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).
  100270. * @param object the object to get the class name from
  100271. * @param isType defines if the object is actually a type
  100272. * @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.
  100273. * @ignorenaming
  100274. */
  100275. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  100276. /**
  100277. * Returns a promise that resolves after the given amount of time.
  100278. * @param delay Number of milliseconds to delay
  100279. * @returns Promise that resolves after the given amount of time
  100280. */
  100281. static DelayAsync(delay: number): Promise<void>;
  100282. }
  100283. /**
  100284. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  100285. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  100286. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  100287. * @param name The name of the class, case should be preserved
  100288. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  100289. */
  100290. export function className(name: string, module?: string): (target: Object) => void;
  100291. /**
  100292. * An implementation of a loop for asynchronous functions.
  100293. */
  100294. export class AsyncLoop {
  100295. /**
  100296. * Defines the number of iterations for the loop
  100297. */
  100298. iterations: number;
  100299. /**
  100300. * Defines the current index of the loop.
  100301. */
  100302. index: number;
  100303. private _done;
  100304. private _fn;
  100305. private _successCallback;
  100306. /**
  100307. * Constructor.
  100308. * @param iterations the number of iterations.
  100309. * @param func the function to run each iteration
  100310. * @param successCallback the callback that will be called upon succesful execution
  100311. * @param offset starting offset.
  100312. */
  100313. constructor(
  100314. /**
  100315. * Defines the number of iterations for the loop
  100316. */
  100317. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  100318. /**
  100319. * Execute the next iteration. Must be called after the last iteration was finished.
  100320. */
  100321. executeNext(): void;
  100322. /**
  100323. * Break the loop and run the success callback.
  100324. */
  100325. breakLoop(): void;
  100326. /**
  100327. * Create and run an async loop.
  100328. * @param iterations the number of iterations.
  100329. * @param fn the function to run each iteration
  100330. * @param successCallback the callback that will be called upon succesful execution
  100331. * @param offset starting offset.
  100332. * @returns the created async loop object
  100333. */
  100334. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  100335. /**
  100336. * A for-loop that will run a given number of iterations synchronous and the rest async.
  100337. * @param iterations total number of iterations
  100338. * @param syncedIterations number of synchronous iterations in each async iteration.
  100339. * @param fn the function to call each iteration.
  100340. * @param callback a success call back that will be called when iterating stops.
  100341. * @param breakFunction a break condition (optional)
  100342. * @param timeout timeout settings for the setTimeout function. default - 0.
  100343. * @returns the created async loop object
  100344. */
  100345. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  100346. }
  100347. }
  100348. declare module BABYLON {
  100349. /**
  100350. * This class implement a typical dictionary using a string as key and the generic type T as value.
  100351. * The underlying implementation relies on an associative array to ensure the best performances.
  100352. * The value can be anything including 'null' but except 'undefined'
  100353. */
  100354. export class StringDictionary<T> {
  100355. /**
  100356. * This will clear this dictionary and copy the content from the 'source' one.
  100357. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  100358. * @param source the dictionary to take the content from and copy to this dictionary
  100359. */
  100360. copyFrom(source: StringDictionary<T>): void;
  100361. /**
  100362. * Get a value based from its key
  100363. * @param key the given key to get the matching value from
  100364. * @return the value if found, otherwise undefined is returned
  100365. */
  100366. get(key: string): T | undefined;
  100367. /**
  100368. * Get a value from its key or add it if it doesn't exist.
  100369. * This method will ensure you that a given key/data will be present in the dictionary.
  100370. * @param key the given key to get the matching value from
  100371. * @param factory the factory that will create the value if the key is not present in the dictionary.
  100372. * The factory will only be invoked if there's no data for the given key.
  100373. * @return the value corresponding to the key.
  100374. */
  100375. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  100376. /**
  100377. * Get a value from its key if present in the dictionary otherwise add it
  100378. * @param key the key to get the value from
  100379. * @param val if there's no such key/value pair in the dictionary add it with this value
  100380. * @return the value corresponding to the key
  100381. */
  100382. getOrAdd(key: string, val: T): T;
  100383. /**
  100384. * Check if there's a given key in the dictionary
  100385. * @param key the key to check for
  100386. * @return true if the key is present, false otherwise
  100387. */
  100388. contains(key: string): boolean;
  100389. /**
  100390. * Add a new key and its corresponding value
  100391. * @param key the key to add
  100392. * @param value the value corresponding to the key
  100393. * @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
  100394. */
  100395. add(key: string, value: T): boolean;
  100396. /**
  100397. * Update a specific value associated to a key
  100398. * @param key defines the key to use
  100399. * @param value defines the value to store
  100400. * @returns true if the value was updated (or false if the key was not found)
  100401. */
  100402. set(key: string, value: T): boolean;
  100403. /**
  100404. * Get the element of the given key and remove it from the dictionary
  100405. * @param key defines the key to search
  100406. * @returns the value associated with the key or null if not found
  100407. */
  100408. getAndRemove(key: string): Nullable<T>;
  100409. /**
  100410. * Remove a key/value from the dictionary.
  100411. * @param key the key to remove
  100412. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  100413. */
  100414. remove(key: string): boolean;
  100415. /**
  100416. * Clear the whole content of the dictionary
  100417. */
  100418. clear(): void;
  100419. /**
  100420. * Gets the current count
  100421. */
  100422. readonly count: number;
  100423. /**
  100424. * Execute a callback on each key/val of the dictionary.
  100425. * Note that you can remove any element in this dictionary in the callback implementation
  100426. * @param callback the callback to execute on a given key/value pair
  100427. */
  100428. forEach(callback: (key: string, val: T) => void): void;
  100429. /**
  100430. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  100431. * If the callback returns null or undefined the method will iterate to the next key/value pair
  100432. * Note that you can remove any element in this dictionary in the callback implementation
  100433. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  100434. * @returns the first item
  100435. */
  100436. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  100437. private _count;
  100438. private _data;
  100439. }
  100440. }
  100441. declare module BABYLON {
  100442. /** @hidden */
  100443. export interface ICollisionCoordinator {
  100444. createCollider(): Collider;
  100445. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  100446. init(scene: Scene): void;
  100447. }
  100448. /** @hidden */
  100449. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  100450. private _scene;
  100451. private _scaledPosition;
  100452. private _scaledVelocity;
  100453. private _finalPosition;
  100454. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  100455. createCollider(): Collider;
  100456. init(scene: Scene): void;
  100457. private _collideWithWorld;
  100458. }
  100459. }
  100460. declare module BABYLON {
  100461. /**
  100462. * Class used to manage all inputs for the scene.
  100463. */
  100464. export class InputManager {
  100465. /** The distance in pixel that you have to move to prevent some events */
  100466. static DragMovementThreshold: number;
  100467. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  100468. static LongPressDelay: number;
  100469. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  100470. static DoubleClickDelay: number;
  100471. /** If you need to check double click without raising a single click at first click, enable this flag */
  100472. static ExclusiveDoubleClickMode: boolean;
  100473. private _wheelEventName;
  100474. private _onPointerMove;
  100475. private _onPointerDown;
  100476. private _onPointerUp;
  100477. private _initClickEvent;
  100478. private _initActionManager;
  100479. private _delayedSimpleClick;
  100480. private _delayedSimpleClickTimeout;
  100481. private _previousDelayedSimpleClickTimeout;
  100482. private _meshPickProceed;
  100483. private _previousButtonPressed;
  100484. private _currentPickResult;
  100485. private _previousPickResult;
  100486. private _totalPointersPressed;
  100487. private _doubleClickOccured;
  100488. private _pointerOverMesh;
  100489. private _pickedDownMesh;
  100490. private _pickedUpMesh;
  100491. private _pointerX;
  100492. private _pointerY;
  100493. private _unTranslatedPointerX;
  100494. private _unTranslatedPointerY;
  100495. private _startingPointerPosition;
  100496. private _previousStartingPointerPosition;
  100497. private _startingPointerTime;
  100498. private _previousStartingPointerTime;
  100499. private _pointerCaptures;
  100500. private _onKeyDown;
  100501. private _onKeyUp;
  100502. private _onCanvasFocusObserver;
  100503. private _onCanvasBlurObserver;
  100504. private _scene;
  100505. /**
  100506. * Creates a new InputManager
  100507. * @param scene defines the hosting scene
  100508. */
  100509. constructor(scene: Scene);
  100510. /**
  100511. * Gets the mesh that is currently under the pointer
  100512. */
  100513. readonly meshUnderPointer: Nullable<AbstractMesh>;
  100514. /**
  100515. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  100516. */
  100517. readonly unTranslatedPointer: Vector2;
  100518. /**
  100519. * Gets or sets the current on-screen X position of the pointer
  100520. */
  100521. pointerX: number;
  100522. /**
  100523. * Gets or sets the current on-screen Y position of the pointer
  100524. */
  100525. pointerY: number;
  100526. private _updatePointerPosition;
  100527. private _processPointerMove;
  100528. private _setRayOnPointerInfo;
  100529. private _checkPrePointerObservable;
  100530. /**
  100531. * Use this method to simulate a pointer move on a mesh
  100532. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  100533. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  100534. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  100535. */
  100536. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  100537. /**
  100538. * Use this method to simulate a pointer down on a mesh
  100539. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  100540. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  100541. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  100542. */
  100543. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  100544. private _processPointerDown;
  100545. /** @hidden */
  100546. _isPointerSwiping(): boolean;
  100547. /**
  100548. * Use this method to simulate a pointer up on a mesh
  100549. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  100550. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  100551. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  100552. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  100553. */
  100554. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  100555. private _processPointerUp;
  100556. /**
  100557. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  100558. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  100559. * @returns true if the pointer was captured
  100560. */
  100561. isPointerCaptured(pointerId?: number): boolean;
  100562. /**
  100563. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  100564. * @param attachUp defines if you want to attach events to pointerup
  100565. * @param attachDown defines if you want to attach events to pointerdown
  100566. * @param attachMove defines if you want to attach events to pointermove
  100567. */
  100568. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  100569. /**
  100570. * Detaches all event handlers
  100571. */
  100572. detachControl(): void;
  100573. /**
  100574. * Force the value of meshUnderPointer
  100575. * @param mesh defines the mesh to use
  100576. */
  100577. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  100578. /**
  100579. * Gets the mesh under the pointer
  100580. * @returns a Mesh or null if no mesh is under the pointer
  100581. */
  100582. getPointerOverMesh(): Nullable<AbstractMesh>;
  100583. }
  100584. }
  100585. declare module BABYLON {
  100586. /**
  100587. * Helper class used to generate session unique ID
  100588. */
  100589. export class UniqueIdGenerator {
  100590. private static _UniqueIdCounter;
  100591. /**
  100592. * Gets an unique (relatively to the current scene) Id
  100593. */
  100594. static readonly UniqueId: number;
  100595. }
  100596. }
  100597. declare module BABYLON {
  100598. /**
  100599. * This class defines the direct association between an animation and a target
  100600. */
  100601. export class TargetedAnimation {
  100602. /**
  100603. * Animation to perform
  100604. */
  100605. animation: Animation;
  100606. /**
  100607. * Target to animate
  100608. */
  100609. target: any;
  100610. /**
  100611. * Serialize the object
  100612. * @returns the JSON object representing the current entity
  100613. */
  100614. serialize(): any;
  100615. }
  100616. /**
  100617. * Use this class to create coordinated animations on multiple targets
  100618. */
  100619. export class AnimationGroup implements IDisposable {
  100620. /** The name of the animation group */
  100621. name: string;
  100622. private _scene;
  100623. private _targetedAnimations;
  100624. private _animatables;
  100625. private _from;
  100626. private _to;
  100627. private _isStarted;
  100628. private _isPaused;
  100629. private _speedRatio;
  100630. private _loopAnimation;
  100631. /**
  100632. * Gets or sets the unique id of the node
  100633. */
  100634. uniqueId: number;
  100635. /**
  100636. * This observable will notify when one animation have ended
  100637. */
  100638. onAnimationEndObservable: Observable<TargetedAnimation>;
  100639. /**
  100640. * Observer raised when one animation loops
  100641. */
  100642. onAnimationLoopObservable: Observable<TargetedAnimation>;
  100643. /**
  100644. * Observer raised when all animations have looped
  100645. */
  100646. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  100647. /**
  100648. * This observable will notify when all animations have ended.
  100649. */
  100650. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  100651. /**
  100652. * This observable will notify when all animations have paused.
  100653. */
  100654. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  100655. /**
  100656. * This observable will notify when all animations are playing.
  100657. */
  100658. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  100659. /**
  100660. * Gets the first frame
  100661. */
  100662. readonly from: number;
  100663. /**
  100664. * Gets the last frame
  100665. */
  100666. readonly to: number;
  100667. /**
  100668. * Define if the animations are started
  100669. */
  100670. readonly isStarted: boolean;
  100671. /**
  100672. * Gets a value indicating that the current group is playing
  100673. */
  100674. readonly isPlaying: boolean;
  100675. /**
  100676. * Gets or sets the speed ratio to use for all animations
  100677. */
  100678. /**
  100679. * Gets or sets the speed ratio to use for all animations
  100680. */
  100681. speedRatio: number;
  100682. /**
  100683. * Gets or sets if all animations should loop or not
  100684. */
  100685. loopAnimation: boolean;
  100686. /**
  100687. * Gets the targeted animations for this animation group
  100688. */
  100689. readonly targetedAnimations: Array<TargetedAnimation>;
  100690. /**
  100691. * returning the list of animatables controlled by this animation group.
  100692. */
  100693. readonly animatables: Array<Animatable>;
  100694. /**
  100695. * Instantiates a new Animation Group.
  100696. * This helps managing several animations at once.
  100697. * @see http://doc.babylonjs.com/how_to/group
  100698. * @param name Defines the name of the group
  100699. * @param scene Defines the scene the group belongs to
  100700. */
  100701. constructor(
  100702. /** The name of the animation group */
  100703. name: string, scene?: Nullable<Scene>);
  100704. /**
  100705. * Add an animation (with its target) in the group
  100706. * @param animation defines the animation we want to add
  100707. * @param target defines the target of the animation
  100708. * @returns the TargetedAnimation object
  100709. */
  100710. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  100711. /**
  100712. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  100713. * It can add constant keys at begin or end
  100714. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  100715. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  100716. * @returns the animation group
  100717. */
  100718. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  100719. private _animationLoopCount;
  100720. private _animationLoopFlags;
  100721. private _processLoop;
  100722. /**
  100723. * Start all animations on given targets
  100724. * @param loop defines if animations must loop
  100725. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  100726. * @param from defines the from key (optional)
  100727. * @param to defines the to key (optional)
  100728. * @returns the current animation group
  100729. */
  100730. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  100731. /**
  100732. * Pause all animations
  100733. * @returns the animation group
  100734. */
  100735. pause(): AnimationGroup;
  100736. /**
  100737. * Play all animations to initial state
  100738. * This function will start() the animations if they were not started or will restart() them if they were paused
  100739. * @param loop defines if animations must loop
  100740. * @returns the animation group
  100741. */
  100742. play(loop?: boolean): AnimationGroup;
  100743. /**
  100744. * Reset all animations to initial state
  100745. * @returns the animation group
  100746. */
  100747. reset(): AnimationGroup;
  100748. /**
  100749. * Restart animations from key 0
  100750. * @returns the animation group
  100751. */
  100752. restart(): AnimationGroup;
  100753. /**
  100754. * Stop all animations
  100755. * @returns the animation group
  100756. */
  100757. stop(): AnimationGroup;
  100758. /**
  100759. * Set animation weight for all animatables
  100760. * @param weight defines the weight to use
  100761. * @return the animationGroup
  100762. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  100763. */
  100764. setWeightForAllAnimatables(weight: number): AnimationGroup;
  100765. /**
  100766. * Synchronize and normalize all animatables with a source animatable
  100767. * @param root defines the root animatable to synchronize with
  100768. * @return the animationGroup
  100769. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  100770. */
  100771. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  100772. /**
  100773. * Goes to a specific frame in this animation group
  100774. * @param frame the frame number to go to
  100775. * @return the animationGroup
  100776. */
  100777. goToFrame(frame: number): AnimationGroup;
  100778. /**
  100779. * Dispose all associated resources
  100780. */
  100781. dispose(): void;
  100782. private _checkAnimationGroupEnded;
  100783. /**
  100784. * Clone the current animation group and returns a copy
  100785. * @param newName defines the name of the new group
  100786. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  100787. * @returns the new aniamtion group
  100788. */
  100789. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  100790. /**
  100791. * Serializes the animationGroup to an object
  100792. * @returns Serialized object
  100793. */
  100794. serialize(): any;
  100795. /**
  100796. * Returns a new AnimationGroup object parsed from the source provided.
  100797. * @param parsedAnimationGroup defines the source
  100798. * @param scene defines the scene that will receive the animationGroup
  100799. * @returns a new AnimationGroup
  100800. */
  100801. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  100802. /**
  100803. * Returns the string "AnimationGroup"
  100804. * @returns "AnimationGroup"
  100805. */
  100806. getClassName(): string;
  100807. /**
  100808. * Creates a detailled string about the object
  100809. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  100810. * @returns a string representing the object
  100811. */
  100812. toString(fullDetails?: boolean): string;
  100813. }
  100814. }
  100815. declare module BABYLON {
  100816. /**
  100817. * Define an interface for all classes that will hold resources
  100818. */
  100819. export interface IDisposable {
  100820. /**
  100821. * Releases all held resources
  100822. */
  100823. dispose(): void;
  100824. }
  100825. /** Interface defining initialization parameters for Scene class */
  100826. export interface SceneOptions {
  100827. /**
  100828. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  100829. * It will improve performance when the number of geometries becomes important.
  100830. */
  100831. useGeometryUniqueIdsMap?: boolean;
  100832. /**
  100833. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  100834. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  100835. */
  100836. useMaterialMeshMap?: boolean;
  100837. /**
  100838. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  100839. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  100840. */
  100841. useClonedMeshhMap?: boolean;
  100842. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  100843. virtual?: boolean;
  100844. }
  100845. /**
  100846. * Represents a scene to be rendered by the engine.
  100847. * @see http://doc.babylonjs.com/features/scene
  100848. */
  100849. export class Scene extends AbstractScene implements IAnimatable {
  100850. /** The fog is deactivated */
  100851. static readonly FOGMODE_NONE: number;
  100852. /** The fog density is following an exponential function */
  100853. static readonly FOGMODE_EXP: number;
  100854. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  100855. static readonly FOGMODE_EXP2: number;
  100856. /** The fog density is following a linear function. */
  100857. static readonly FOGMODE_LINEAR: number;
  100858. /**
  100859. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  100860. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  100861. */
  100862. static MinDeltaTime: number;
  100863. /**
  100864. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  100865. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  100866. */
  100867. static MaxDeltaTime: number;
  100868. /**
  100869. * Factory used to create the default material.
  100870. * @param name The name of the material to create
  100871. * @param scene The scene to create the material for
  100872. * @returns The default material
  100873. */
  100874. static DefaultMaterialFactory(scene: Scene): Material;
  100875. /**
  100876. * Factory used to create the a collision coordinator.
  100877. * @returns The collision coordinator
  100878. */
  100879. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  100880. /** @hidden */
  100881. _inputManager: InputManager;
  100882. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  100883. cameraToUseForPointers: Nullable<Camera>;
  100884. /** @hidden */
  100885. readonly _isScene: boolean;
  100886. /**
  100887. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  100888. */
  100889. autoClear: boolean;
  100890. /**
  100891. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  100892. */
  100893. autoClearDepthAndStencil: boolean;
  100894. /**
  100895. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  100896. */
  100897. clearColor: Color4;
  100898. /**
  100899. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  100900. */
  100901. ambientColor: Color3;
  100902. /**
  100903. * This is use to store the default BRDF lookup for PBR materials in your scene.
  100904. * It should only be one of the following (if not the default embedded one):
  100905. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  100906. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  100907. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  100908. * The material properties need to be setup according to the type of texture in use.
  100909. */
  100910. environmentBRDFTexture: BaseTexture;
  100911. /** @hidden */
  100912. protected _environmentTexture: Nullable<BaseTexture>;
  100913. /**
  100914. * Texture used in all pbr material as the reflection texture.
  100915. * As in the majority of the scene they are the same (exception for multi room and so on),
  100916. * this is easier to reference from here than from all the materials.
  100917. */
  100918. /**
  100919. * Texture used in all pbr material as the reflection texture.
  100920. * As in the majority of the scene they are the same (exception for multi room and so on),
  100921. * this is easier to set here than in all the materials.
  100922. */
  100923. environmentTexture: Nullable<BaseTexture>;
  100924. /** @hidden */
  100925. protected _environmentIntensity: number;
  100926. /**
  100927. * Intensity of the environment in all pbr material.
  100928. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  100929. * As in the majority of the scene they are the same (exception for multi room and so on),
  100930. * this is easier to reference from here than from all the materials.
  100931. */
  100932. /**
  100933. * Intensity of the environment in all pbr material.
  100934. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  100935. * As in the majority of the scene they are the same (exception for multi room and so on),
  100936. * this is easier to set here than in all the materials.
  100937. */
  100938. environmentIntensity: number;
  100939. /** @hidden */
  100940. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  100941. /**
  100942. * Default image processing configuration used either in the rendering
  100943. * Forward main pass or through the imageProcessingPostProcess if present.
  100944. * As in the majority of the scene they are the same (exception for multi camera),
  100945. * this is easier to reference from here than from all the materials and post process.
  100946. *
  100947. * No setter as we it is a shared configuration, you can set the values instead.
  100948. */
  100949. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  100950. private _forceWireframe;
  100951. /**
  100952. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  100953. */
  100954. forceWireframe: boolean;
  100955. private _forcePointsCloud;
  100956. /**
  100957. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  100958. */
  100959. forcePointsCloud: boolean;
  100960. /**
  100961. * Gets or sets the active clipplane 1
  100962. */
  100963. clipPlane: Nullable<Plane>;
  100964. /**
  100965. * Gets or sets the active clipplane 2
  100966. */
  100967. clipPlane2: Nullable<Plane>;
  100968. /**
  100969. * Gets or sets the active clipplane 3
  100970. */
  100971. clipPlane3: Nullable<Plane>;
  100972. /**
  100973. * Gets or sets the active clipplane 4
  100974. */
  100975. clipPlane4: Nullable<Plane>;
  100976. /**
  100977. * Gets or sets a boolean indicating if animations are enabled
  100978. */
  100979. animationsEnabled: boolean;
  100980. private _animationPropertiesOverride;
  100981. /**
  100982. * Gets or sets the animation properties override
  100983. */
  100984. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  100985. /**
  100986. * Gets or sets a boolean indicating if a constant deltatime has to be used
  100987. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  100988. */
  100989. useConstantAnimationDeltaTime: boolean;
  100990. /**
  100991. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  100992. * Please note that it requires to run a ray cast through the scene on every frame
  100993. */
  100994. constantlyUpdateMeshUnderPointer: boolean;
  100995. /**
  100996. * Defines the HTML cursor to use when hovering over interactive elements
  100997. */
  100998. hoverCursor: string;
  100999. /**
  101000. * Defines the HTML default cursor to use (empty by default)
  101001. */
  101002. defaultCursor: string;
  101003. /**
  101004. * Defines wether cursors are handled by the scene.
  101005. */
  101006. doNotHandleCursors: boolean;
  101007. /**
  101008. * This is used to call preventDefault() on pointer down
  101009. * in order to block unwanted artifacts like system double clicks
  101010. */
  101011. preventDefaultOnPointerDown: boolean;
  101012. /**
  101013. * This is used to call preventDefault() on pointer up
  101014. * in order to block unwanted artifacts like system double clicks
  101015. */
  101016. preventDefaultOnPointerUp: boolean;
  101017. /**
  101018. * Gets or sets user defined metadata
  101019. */
  101020. metadata: any;
  101021. /**
  101022. * For internal use only. Please do not use.
  101023. */
  101024. reservedDataStore: any;
  101025. /**
  101026. * Gets the name of the plugin used to load this scene (null by default)
  101027. */
  101028. loadingPluginName: string;
  101029. /**
  101030. * Use this array to add regular expressions used to disable offline support for specific urls
  101031. */
  101032. disableOfflineSupportExceptionRules: RegExp[];
  101033. /**
  101034. * An event triggered when the scene is disposed.
  101035. */
  101036. onDisposeObservable: Observable<Scene>;
  101037. private _onDisposeObserver;
  101038. /** Sets a function to be executed when this scene is disposed. */
  101039. onDispose: () => void;
  101040. /**
  101041. * An event triggered before rendering the scene (right after animations and physics)
  101042. */
  101043. onBeforeRenderObservable: Observable<Scene>;
  101044. private _onBeforeRenderObserver;
  101045. /** Sets a function to be executed before rendering this scene */
  101046. beforeRender: Nullable<() => void>;
  101047. /**
  101048. * An event triggered after rendering the scene
  101049. */
  101050. onAfterRenderObservable: Observable<Scene>;
  101051. /**
  101052. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  101053. */
  101054. onAfterRenderCameraObservable: Observable<Camera>;
  101055. private _onAfterRenderObserver;
  101056. /** Sets a function to be executed after rendering this scene */
  101057. afterRender: Nullable<() => void>;
  101058. /**
  101059. * An event triggered before animating the scene
  101060. */
  101061. onBeforeAnimationsObservable: Observable<Scene>;
  101062. /**
  101063. * An event triggered after animations processing
  101064. */
  101065. onAfterAnimationsObservable: Observable<Scene>;
  101066. /**
  101067. * An event triggered before draw calls are ready to be sent
  101068. */
  101069. onBeforeDrawPhaseObservable: Observable<Scene>;
  101070. /**
  101071. * An event triggered after draw calls have been sent
  101072. */
  101073. onAfterDrawPhaseObservable: Observable<Scene>;
  101074. /**
  101075. * An event triggered when the scene is ready
  101076. */
  101077. onReadyObservable: Observable<Scene>;
  101078. /**
  101079. * An event triggered before rendering a camera
  101080. */
  101081. onBeforeCameraRenderObservable: Observable<Camera>;
  101082. private _onBeforeCameraRenderObserver;
  101083. /** Sets a function to be executed before rendering a camera*/
  101084. beforeCameraRender: () => void;
  101085. /**
  101086. * An event triggered after rendering a camera
  101087. */
  101088. onAfterCameraRenderObservable: Observable<Camera>;
  101089. private _onAfterCameraRenderObserver;
  101090. /** Sets a function to be executed after rendering a camera*/
  101091. afterCameraRender: () => void;
  101092. /**
  101093. * An event triggered when active meshes evaluation is about to start
  101094. */
  101095. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  101096. /**
  101097. * An event triggered when active meshes evaluation is done
  101098. */
  101099. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  101100. /**
  101101. * An event triggered when particles rendering is about to start
  101102. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  101103. */
  101104. onBeforeParticlesRenderingObservable: Observable<Scene>;
  101105. /**
  101106. * An event triggered when particles rendering is done
  101107. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  101108. */
  101109. onAfterParticlesRenderingObservable: Observable<Scene>;
  101110. /**
  101111. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  101112. */
  101113. onDataLoadedObservable: Observable<Scene>;
  101114. /**
  101115. * An event triggered when a camera is created
  101116. */
  101117. onNewCameraAddedObservable: Observable<Camera>;
  101118. /**
  101119. * An event triggered when a camera is removed
  101120. */
  101121. onCameraRemovedObservable: Observable<Camera>;
  101122. /**
  101123. * An event triggered when a light is created
  101124. */
  101125. onNewLightAddedObservable: Observable<Light>;
  101126. /**
  101127. * An event triggered when a light is removed
  101128. */
  101129. onLightRemovedObservable: Observable<Light>;
  101130. /**
  101131. * An event triggered when a geometry is created
  101132. */
  101133. onNewGeometryAddedObservable: Observable<Geometry>;
  101134. /**
  101135. * An event triggered when a geometry is removed
  101136. */
  101137. onGeometryRemovedObservable: Observable<Geometry>;
  101138. /**
  101139. * An event triggered when a transform node is created
  101140. */
  101141. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  101142. /**
  101143. * An event triggered when a transform node is removed
  101144. */
  101145. onTransformNodeRemovedObservable: Observable<TransformNode>;
  101146. /**
  101147. * An event triggered when a mesh is created
  101148. */
  101149. onNewMeshAddedObservable: Observable<AbstractMesh>;
  101150. /**
  101151. * An event triggered when a mesh is removed
  101152. */
  101153. onMeshRemovedObservable: Observable<AbstractMesh>;
  101154. /**
  101155. * An event triggered when a skeleton is created
  101156. */
  101157. onNewSkeletonAddedObservable: Observable<Skeleton>;
  101158. /**
  101159. * An event triggered when a skeleton is removed
  101160. */
  101161. onSkeletonRemovedObservable: Observable<Skeleton>;
  101162. /**
  101163. * An event triggered when a material is created
  101164. */
  101165. onNewMaterialAddedObservable: Observable<Material>;
  101166. /**
  101167. * An event triggered when a material is removed
  101168. */
  101169. onMaterialRemovedObservable: Observable<Material>;
  101170. /**
  101171. * An event triggered when a texture is created
  101172. */
  101173. onNewTextureAddedObservable: Observable<BaseTexture>;
  101174. /**
  101175. * An event triggered when a texture is removed
  101176. */
  101177. onTextureRemovedObservable: Observable<BaseTexture>;
  101178. /**
  101179. * An event triggered when render targets are about to be rendered
  101180. * Can happen multiple times per frame.
  101181. */
  101182. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  101183. /**
  101184. * An event triggered when render targets were rendered.
  101185. * Can happen multiple times per frame.
  101186. */
  101187. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  101188. /**
  101189. * An event triggered before calculating deterministic simulation step
  101190. */
  101191. onBeforeStepObservable: Observable<Scene>;
  101192. /**
  101193. * An event triggered after calculating deterministic simulation step
  101194. */
  101195. onAfterStepObservable: Observable<Scene>;
  101196. /**
  101197. * An event triggered when the activeCamera property is updated
  101198. */
  101199. onActiveCameraChanged: Observable<Scene>;
  101200. /**
  101201. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  101202. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  101203. * 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)
  101204. */
  101205. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  101206. /**
  101207. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  101208. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  101209. * 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)
  101210. */
  101211. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  101212. /**
  101213. * This Observable will when a mesh has been imported into the scene.
  101214. */
  101215. onMeshImportedObservable: Observable<AbstractMesh>;
  101216. /**
  101217. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  101218. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  101219. */
  101220. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  101221. /** @hidden */
  101222. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  101223. /**
  101224. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  101225. */
  101226. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  101227. /**
  101228. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  101229. */
  101230. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  101231. /**
  101232. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  101233. */
  101234. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  101235. /** Callback called when a pointer move is detected */
  101236. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  101237. /** Callback called when a pointer down is detected */
  101238. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  101239. /** Callback called when a pointer up is detected */
  101240. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  101241. /** Callback called when a pointer pick is detected */
  101242. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  101243. /**
  101244. * 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).
  101245. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  101246. */
  101247. onPrePointerObservable: Observable<PointerInfoPre>;
  101248. /**
  101249. * Observable event triggered each time an input event is received from the rendering canvas
  101250. */
  101251. onPointerObservable: Observable<PointerInfo>;
  101252. /**
  101253. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  101254. */
  101255. readonly unTranslatedPointer: Vector2;
  101256. /**
  101257. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  101258. */
  101259. static DragMovementThreshold: number;
  101260. /**
  101261. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  101262. */
  101263. static LongPressDelay: number;
  101264. /**
  101265. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  101266. */
  101267. static DoubleClickDelay: number;
  101268. /** If you need to check double click without raising a single click at first click, enable this flag */
  101269. static ExclusiveDoubleClickMode: boolean;
  101270. /** @hidden */
  101271. _mirroredCameraPosition: Nullable<Vector3>;
  101272. /**
  101273. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  101274. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  101275. */
  101276. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  101277. /**
  101278. * Observable event triggered each time an keyboard event is received from the hosting window
  101279. */
  101280. onKeyboardObservable: Observable<KeyboardInfo>;
  101281. private _useRightHandedSystem;
  101282. /**
  101283. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  101284. */
  101285. useRightHandedSystem: boolean;
  101286. private _timeAccumulator;
  101287. private _currentStepId;
  101288. private _currentInternalStep;
  101289. /**
  101290. * Sets the step Id used by deterministic lock step
  101291. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101292. * @param newStepId defines the step Id
  101293. */
  101294. setStepId(newStepId: number): void;
  101295. /**
  101296. * Gets the step Id used by deterministic lock step
  101297. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101298. * @returns the step Id
  101299. */
  101300. getStepId(): number;
  101301. /**
  101302. * Gets the internal step used by deterministic lock step
  101303. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101304. * @returns the internal step
  101305. */
  101306. getInternalStep(): number;
  101307. private _fogEnabled;
  101308. /**
  101309. * Gets or sets a boolean indicating if fog is enabled on this scene
  101310. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101311. * (Default is true)
  101312. */
  101313. fogEnabled: boolean;
  101314. private _fogMode;
  101315. /**
  101316. * Gets or sets the fog mode to use
  101317. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101318. * | mode | value |
  101319. * | --- | --- |
  101320. * | FOGMODE_NONE | 0 |
  101321. * | FOGMODE_EXP | 1 |
  101322. * | FOGMODE_EXP2 | 2 |
  101323. * | FOGMODE_LINEAR | 3 |
  101324. */
  101325. fogMode: number;
  101326. /**
  101327. * Gets or sets the fog color to use
  101328. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101329. * (Default is Color3(0.2, 0.2, 0.3))
  101330. */
  101331. fogColor: Color3;
  101332. /**
  101333. * Gets or sets the fog density to use
  101334. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101335. * (Default is 0.1)
  101336. */
  101337. fogDensity: number;
  101338. /**
  101339. * Gets or sets the fog start distance to use
  101340. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101341. * (Default is 0)
  101342. */
  101343. fogStart: number;
  101344. /**
  101345. * Gets or sets the fog end distance to use
  101346. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101347. * (Default is 1000)
  101348. */
  101349. fogEnd: number;
  101350. private _shadowsEnabled;
  101351. /**
  101352. * Gets or sets a boolean indicating if shadows are enabled on this scene
  101353. */
  101354. shadowsEnabled: boolean;
  101355. private _lightsEnabled;
  101356. /**
  101357. * Gets or sets a boolean indicating if lights are enabled on this scene
  101358. */
  101359. lightsEnabled: boolean;
  101360. /** All of the active cameras added to this scene. */
  101361. activeCameras: Camera[];
  101362. /** @hidden */
  101363. _activeCamera: Nullable<Camera>;
  101364. /** Gets or sets the current active camera */
  101365. activeCamera: Nullable<Camera>;
  101366. private _defaultMaterial;
  101367. /** The default material used on meshes when no material is affected */
  101368. /** The default material used on meshes when no material is affected */
  101369. defaultMaterial: Material;
  101370. private _texturesEnabled;
  101371. /**
  101372. * Gets or sets a boolean indicating if textures are enabled on this scene
  101373. */
  101374. texturesEnabled: boolean;
  101375. /**
  101376. * Gets or sets a boolean indicating if particles are enabled on this scene
  101377. */
  101378. particlesEnabled: boolean;
  101379. /**
  101380. * Gets or sets a boolean indicating if sprites are enabled on this scene
  101381. */
  101382. spritesEnabled: boolean;
  101383. private _skeletonsEnabled;
  101384. /**
  101385. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  101386. */
  101387. skeletonsEnabled: boolean;
  101388. /**
  101389. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  101390. */
  101391. lensFlaresEnabled: boolean;
  101392. /**
  101393. * Gets or sets a boolean indicating if collisions are enabled on this scene
  101394. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  101395. */
  101396. collisionsEnabled: boolean;
  101397. private _collisionCoordinator;
  101398. /** @hidden */
  101399. readonly collisionCoordinator: ICollisionCoordinator;
  101400. /**
  101401. * Defines the gravity applied to this scene (used only for collisions)
  101402. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  101403. */
  101404. gravity: Vector3;
  101405. /**
  101406. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  101407. */
  101408. postProcessesEnabled: boolean;
  101409. /**
  101410. * The list of postprocesses added to the scene
  101411. */
  101412. postProcesses: PostProcess[];
  101413. /**
  101414. * Gets the current postprocess manager
  101415. */
  101416. postProcessManager: PostProcessManager;
  101417. /**
  101418. * Gets or sets a boolean indicating if render targets are enabled on this scene
  101419. */
  101420. renderTargetsEnabled: boolean;
  101421. /**
  101422. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  101423. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  101424. */
  101425. dumpNextRenderTargets: boolean;
  101426. /**
  101427. * The list of user defined render targets added to the scene
  101428. */
  101429. customRenderTargets: RenderTargetTexture[];
  101430. /**
  101431. * Defines if texture loading must be delayed
  101432. * If true, textures will only be loaded when they need to be rendered
  101433. */
  101434. useDelayedTextureLoading: boolean;
  101435. /**
  101436. * Gets the list of meshes imported to the scene through SceneLoader
  101437. */
  101438. importedMeshesFiles: String[];
  101439. /**
  101440. * Gets or sets a boolean indicating if probes are enabled on this scene
  101441. */
  101442. probesEnabled: boolean;
  101443. /**
  101444. * Gets or sets the current offline provider to use to store scene data
  101445. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  101446. */
  101447. offlineProvider: IOfflineProvider;
  101448. /**
  101449. * Gets or sets the action manager associated with the scene
  101450. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  101451. */
  101452. actionManager: AbstractActionManager;
  101453. private _meshesForIntersections;
  101454. /**
  101455. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  101456. */
  101457. proceduralTexturesEnabled: boolean;
  101458. private _engine;
  101459. private _totalVertices;
  101460. /** @hidden */
  101461. _activeIndices: PerfCounter;
  101462. /** @hidden */
  101463. _activeParticles: PerfCounter;
  101464. /** @hidden */
  101465. _activeBones: PerfCounter;
  101466. private _animationRatio;
  101467. /** @hidden */
  101468. _animationTimeLast: number;
  101469. /** @hidden */
  101470. _animationTime: number;
  101471. /**
  101472. * Gets or sets a general scale for animation speed
  101473. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  101474. */
  101475. animationTimeScale: number;
  101476. /** @hidden */
  101477. _cachedMaterial: Nullable<Material>;
  101478. /** @hidden */
  101479. _cachedEffect: Nullable<Effect>;
  101480. /** @hidden */
  101481. _cachedVisibility: Nullable<number>;
  101482. private _renderId;
  101483. private _frameId;
  101484. private _executeWhenReadyTimeoutId;
  101485. private _intermediateRendering;
  101486. private _viewUpdateFlag;
  101487. private _projectionUpdateFlag;
  101488. /** @hidden */
  101489. _toBeDisposed: Nullable<IDisposable>[];
  101490. private _activeRequests;
  101491. /** @hidden */
  101492. _pendingData: any[];
  101493. private _isDisposed;
  101494. /**
  101495. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  101496. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  101497. */
  101498. dispatchAllSubMeshesOfActiveMeshes: boolean;
  101499. private _activeMeshes;
  101500. private _processedMaterials;
  101501. private _renderTargets;
  101502. /** @hidden */
  101503. _activeParticleSystems: SmartArray<IParticleSystem>;
  101504. private _activeSkeletons;
  101505. private _softwareSkinnedMeshes;
  101506. private _renderingManager;
  101507. /** @hidden */
  101508. _activeAnimatables: Animatable[];
  101509. private _transformMatrix;
  101510. private _sceneUbo;
  101511. /** @hidden */
  101512. _viewMatrix: Matrix;
  101513. private _projectionMatrix;
  101514. /** @hidden */
  101515. _forcedViewPosition: Nullable<Vector3>;
  101516. /** @hidden */
  101517. _frustumPlanes: Plane[];
  101518. /**
  101519. * Gets the list of frustum planes (built from the active camera)
  101520. */
  101521. readonly frustumPlanes: Plane[];
  101522. /**
  101523. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  101524. * This is useful if there are more lights that the maximum simulteanous authorized
  101525. */
  101526. requireLightSorting: boolean;
  101527. /** @hidden */
  101528. readonly useMaterialMeshMap: boolean;
  101529. /** @hidden */
  101530. readonly useClonedMeshhMap: boolean;
  101531. private _externalData;
  101532. private _uid;
  101533. /**
  101534. * @hidden
  101535. * Backing store of defined scene components.
  101536. */
  101537. _components: ISceneComponent[];
  101538. /**
  101539. * @hidden
  101540. * Backing store of defined scene components.
  101541. */
  101542. _serializableComponents: ISceneSerializableComponent[];
  101543. /**
  101544. * List of components to register on the next registration step.
  101545. */
  101546. private _transientComponents;
  101547. /**
  101548. * Registers the transient components if needed.
  101549. */
  101550. private _registerTransientComponents;
  101551. /**
  101552. * @hidden
  101553. * Add a component to the scene.
  101554. * Note that the ccomponent could be registered on th next frame if this is called after
  101555. * the register component stage.
  101556. * @param component Defines the component to add to the scene
  101557. */
  101558. _addComponent(component: ISceneComponent): void;
  101559. /**
  101560. * @hidden
  101561. * Gets a component from the scene.
  101562. * @param name defines the name of the component to retrieve
  101563. * @returns the component or null if not present
  101564. */
  101565. _getComponent(name: string): Nullable<ISceneComponent>;
  101566. /**
  101567. * @hidden
  101568. * Defines the actions happening before camera updates.
  101569. */
  101570. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  101571. /**
  101572. * @hidden
  101573. * Defines the actions happening before clear the canvas.
  101574. */
  101575. _beforeClearStage: Stage<SimpleStageAction>;
  101576. /**
  101577. * @hidden
  101578. * Defines the actions when collecting render targets for the frame.
  101579. */
  101580. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  101581. /**
  101582. * @hidden
  101583. * Defines the actions happening for one camera in the frame.
  101584. */
  101585. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  101586. /**
  101587. * @hidden
  101588. * Defines the actions happening during the per mesh ready checks.
  101589. */
  101590. _isReadyForMeshStage: Stage<MeshStageAction>;
  101591. /**
  101592. * @hidden
  101593. * Defines the actions happening before evaluate active mesh checks.
  101594. */
  101595. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  101596. /**
  101597. * @hidden
  101598. * Defines the actions happening during the evaluate sub mesh checks.
  101599. */
  101600. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  101601. /**
  101602. * @hidden
  101603. * Defines the actions happening during the active mesh stage.
  101604. */
  101605. _activeMeshStage: Stage<ActiveMeshStageAction>;
  101606. /**
  101607. * @hidden
  101608. * Defines the actions happening during the per camera render target step.
  101609. */
  101610. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  101611. /**
  101612. * @hidden
  101613. * Defines the actions happening just before the active camera is drawing.
  101614. */
  101615. _beforeCameraDrawStage: Stage<CameraStageAction>;
  101616. /**
  101617. * @hidden
  101618. * Defines the actions happening just before a render target is drawing.
  101619. */
  101620. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  101621. /**
  101622. * @hidden
  101623. * Defines the actions happening just before a rendering group is drawing.
  101624. */
  101625. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  101626. /**
  101627. * @hidden
  101628. * Defines the actions happening just before a mesh is drawing.
  101629. */
  101630. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  101631. /**
  101632. * @hidden
  101633. * Defines the actions happening just after a mesh has been drawn.
  101634. */
  101635. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  101636. /**
  101637. * @hidden
  101638. * Defines the actions happening just after a rendering group has been drawn.
  101639. */
  101640. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  101641. /**
  101642. * @hidden
  101643. * Defines the actions happening just after the active camera has been drawn.
  101644. */
  101645. _afterCameraDrawStage: Stage<CameraStageAction>;
  101646. /**
  101647. * @hidden
  101648. * Defines the actions happening just after a render target has been drawn.
  101649. */
  101650. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  101651. /**
  101652. * @hidden
  101653. * Defines the actions happening just after rendering all cameras and computing intersections.
  101654. */
  101655. _afterRenderStage: Stage<SimpleStageAction>;
  101656. /**
  101657. * @hidden
  101658. * Defines the actions happening when a pointer move event happens.
  101659. */
  101660. _pointerMoveStage: Stage<PointerMoveStageAction>;
  101661. /**
  101662. * @hidden
  101663. * Defines the actions happening when a pointer down event happens.
  101664. */
  101665. _pointerDownStage: Stage<PointerUpDownStageAction>;
  101666. /**
  101667. * @hidden
  101668. * Defines the actions happening when a pointer up event happens.
  101669. */
  101670. _pointerUpStage: Stage<PointerUpDownStageAction>;
  101671. /**
  101672. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  101673. */
  101674. private geometriesByUniqueId;
  101675. /**
  101676. * Creates a new Scene
  101677. * @param engine defines the engine to use to render this scene
  101678. * @param options defines the scene options
  101679. */
  101680. constructor(engine: Engine, options?: SceneOptions);
  101681. /**
  101682. * Gets a string idenfifying the name of the class
  101683. * @returns "Scene" string
  101684. */
  101685. getClassName(): string;
  101686. private _defaultMeshCandidates;
  101687. /**
  101688. * @hidden
  101689. */
  101690. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  101691. private _defaultSubMeshCandidates;
  101692. /**
  101693. * @hidden
  101694. */
  101695. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  101696. /**
  101697. * Sets the default candidate providers for the scene.
  101698. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  101699. * and getCollidingSubMeshCandidates to their default function
  101700. */
  101701. setDefaultCandidateProviders(): void;
  101702. /**
  101703. * Gets the mesh that is currently under the pointer
  101704. */
  101705. readonly meshUnderPointer: Nullable<AbstractMesh>;
  101706. /**
  101707. * Gets or sets the current on-screen X position of the pointer
  101708. */
  101709. pointerX: number;
  101710. /**
  101711. * Gets or sets the current on-screen Y position of the pointer
  101712. */
  101713. pointerY: number;
  101714. /**
  101715. * Gets the cached material (ie. the latest rendered one)
  101716. * @returns the cached material
  101717. */
  101718. getCachedMaterial(): Nullable<Material>;
  101719. /**
  101720. * Gets the cached effect (ie. the latest rendered one)
  101721. * @returns the cached effect
  101722. */
  101723. getCachedEffect(): Nullable<Effect>;
  101724. /**
  101725. * Gets the cached visibility state (ie. the latest rendered one)
  101726. * @returns the cached visibility state
  101727. */
  101728. getCachedVisibility(): Nullable<number>;
  101729. /**
  101730. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  101731. * @param material defines the current material
  101732. * @param effect defines the current effect
  101733. * @param visibility defines the current visibility state
  101734. * @returns true if one parameter is not cached
  101735. */
  101736. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  101737. /**
  101738. * Gets the engine associated with the scene
  101739. * @returns an Engine
  101740. */
  101741. getEngine(): Engine;
  101742. /**
  101743. * Gets the total number of vertices rendered per frame
  101744. * @returns the total number of vertices rendered per frame
  101745. */
  101746. getTotalVertices(): number;
  101747. /**
  101748. * Gets the performance counter for total vertices
  101749. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  101750. */
  101751. readonly totalVerticesPerfCounter: PerfCounter;
  101752. /**
  101753. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  101754. * @returns the total number of active indices rendered per frame
  101755. */
  101756. getActiveIndices(): number;
  101757. /**
  101758. * Gets the performance counter for active indices
  101759. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  101760. */
  101761. readonly totalActiveIndicesPerfCounter: PerfCounter;
  101762. /**
  101763. * Gets the total number of active particles rendered per frame
  101764. * @returns the total number of active particles rendered per frame
  101765. */
  101766. getActiveParticles(): number;
  101767. /**
  101768. * Gets the performance counter for active particles
  101769. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  101770. */
  101771. readonly activeParticlesPerfCounter: PerfCounter;
  101772. /**
  101773. * Gets the total number of active bones rendered per frame
  101774. * @returns the total number of active bones rendered per frame
  101775. */
  101776. getActiveBones(): number;
  101777. /**
  101778. * Gets the performance counter for active bones
  101779. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  101780. */
  101781. readonly activeBonesPerfCounter: PerfCounter;
  101782. /**
  101783. * Gets the array of active meshes
  101784. * @returns an array of AbstractMesh
  101785. */
  101786. getActiveMeshes(): SmartArray<AbstractMesh>;
  101787. /**
  101788. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  101789. * @returns a number
  101790. */
  101791. getAnimationRatio(): number;
  101792. /**
  101793. * Gets an unique Id for the current render phase
  101794. * @returns a number
  101795. */
  101796. getRenderId(): number;
  101797. /**
  101798. * Gets an unique Id for the current frame
  101799. * @returns a number
  101800. */
  101801. getFrameId(): number;
  101802. /** Call this function if you want to manually increment the render Id*/
  101803. incrementRenderId(): void;
  101804. private _createUbo;
  101805. /**
  101806. * Use this method to simulate a pointer move on a mesh
  101807. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101808. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101809. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101810. * @returns the current scene
  101811. */
  101812. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  101813. /**
  101814. * Use this method to simulate a pointer down on a mesh
  101815. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101816. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101817. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101818. * @returns the current scene
  101819. */
  101820. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  101821. /**
  101822. * Use this method to simulate a pointer up on a mesh
  101823. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101824. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101825. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101826. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  101827. * @returns the current scene
  101828. */
  101829. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  101830. /**
  101831. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  101832. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  101833. * @returns true if the pointer was captured
  101834. */
  101835. isPointerCaptured(pointerId?: number): boolean;
  101836. /**
  101837. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  101838. * @param attachUp defines if you want to attach events to pointerup
  101839. * @param attachDown defines if you want to attach events to pointerdown
  101840. * @param attachMove defines if you want to attach events to pointermove
  101841. */
  101842. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  101843. /** Detaches all event handlers*/
  101844. detachControl(): void;
  101845. /**
  101846. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  101847. * Delay loaded resources are not taking in account
  101848. * @return true if all required resources are ready
  101849. */
  101850. isReady(): boolean;
  101851. /** Resets all cached information relative to material (including effect and visibility) */
  101852. resetCachedMaterial(): void;
  101853. /**
  101854. * Registers a function to be called before every frame render
  101855. * @param func defines the function to register
  101856. */
  101857. registerBeforeRender(func: () => void): void;
  101858. /**
  101859. * Unregisters a function called before every frame render
  101860. * @param func defines the function to unregister
  101861. */
  101862. unregisterBeforeRender(func: () => void): void;
  101863. /**
  101864. * Registers a function to be called after every frame render
  101865. * @param func defines the function to register
  101866. */
  101867. registerAfterRender(func: () => void): void;
  101868. /**
  101869. * Unregisters a function called after every frame render
  101870. * @param func defines the function to unregister
  101871. */
  101872. unregisterAfterRender(func: () => void): void;
  101873. private _executeOnceBeforeRender;
  101874. /**
  101875. * The provided function will run before render once and will be disposed afterwards.
  101876. * A timeout delay can be provided so that the function will be executed in N ms.
  101877. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  101878. * @param func The function to be executed.
  101879. * @param timeout optional delay in ms
  101880. */
  101881. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  101882. /** @hidden */
  101883. _addPendingData(data: any): void;
  101884. /** @hidden */
  101885. _removePendingData(data: any): void;
  101886. /**
  101887. * Returns the number of items waiting to be loaded
  101888. * @returns the number of items waiting to be loaded
  101889. */
  101890. getWaitingItemsCount(): number;
  101891. /**
  101892. * Returns a boolean indicating if the scene is still loading data
  101893. */
  101894. readonly isLoading: boolean;
  101895. /**
  101896. * Registers a function to be executed when the scene is ready
  101897. * @param {Function} func - the function to be executed
  101898. */
  101899. executeWhenReady(func: () => void): void;
  101900. /**
  101901. * Returns a promise that resolves when the scene is ready
  101902. * @returns A promise that resolves when the scene is ready
  101903. */
  101904. whenReadyAsync(): Promise<void>;
  101905. /** @hidden */
  101906. _checkIsReady(): void;
  101907. /**
  101908. * Gets all animatable attached to the scene
  101909. */
  101910. readonly animatables: Animatable[];
  101911. /**
  101912. * Resets the last animation time frame.
  101913. * Useful to override when animations start running when loading a scene for the first time.
  101914. */
  101915. resetLastAnimationTimeFrame(): void;
  101916. /**
  101917. * Gets the current view matrix
  101918. * @returns a Matrix
  101919. */
  101920. getViewMatrix(): Matrix;
  101921. /**
  101922. * Gets the current projection matrix
  101923. * @returns a Matrix
  101924. */
  101925. getProjectionMatrix(): Matrix;
  101926. /**
  101927. * Gets the current transform matrix
  101928. * @returns a Matrix made of View * Projection
  101929. */
  101930. getTransformMatrix(): Matrix;
  101931. /**
  101932. * Sets the current transform matrix
  101933. * @param viewL defines the View matrix to use
  101934. * @param projectionL defines the Projection matrix to use
  101935. * @param viewR defines the right View matrix to use (if provided)
  101936. * @param projectionR defines the right Projection matrix to use (if provided)
  101937. */
  101938. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  101939. /**
  101940. * Gets the uniform buffer used to store scene data
  101941. * @returns a UniformBuffer
  101942. */
  101943. getSceneUniformBuffer(): UniformBuffer;
  101944. /**
  101945. * Gets an unique (relatively to the current scene) Id
  101946. * @returns an unique number for the scene
  101947. */
  101948. getUniqueId(): number;
  101949. /**
  101950. * Add a mesh to the list of scene's meshes
  101951. * @param newMesh defines the mesh to add
  101952. * @param recursive if all child meshes should also be added to the scene
  101953. */
  101954. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  101955. /**
  101956. * Remove a mesh for the list of scene's meshes
  101957. * @param toRemove defines the mesh to remove
  101958. * @param recursive if all child meshes should also be removed from the scene
  101959. * @returns the index where the mesh was in the mesh list
  101960. */
  101961. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  101962. /**
  101963. * Add a transform node to the list of scene's transform nodes
  101964. * @param newTransformNode defines the transform node to add
  101965. */
  101966. addTransformNode(newTransformNode: TransformNode): void;
  101967. /**
  101968. * Remove a transform node for the list of scene's transform nodes
  101969. * @param toRemove defines the transform node to remove
  101970. * @returns the index where the transform node was in the transform node list
  101971. */
  101972. removeTransformNode(toRemove: TransformNode): number;
  101973. /**
  101974. * Remove a skeleton for the list of scene's skeletons
  101975. * @param toRemove defines the skeleton to remove
  101976. * @returns the index where the skeleton was in the skeleton list
  101977. */
  101978. removeSkeleton(toRemove: Skeleton): number;
  101979. /**
  101980. * Remove a morph target for the list of scene's morph targets
  101981. * @param toRemove defines the morph target to remove
  101982. * @returns the index where the morph target was in the morph target list
  101983. */
  101984. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  101985. /**
  101986. * Remove a light for the list of scene's lights
  101987. * @param toRemove defines the light to remove
  101988. * @returns the index where the light was in the light list
  101989. */
  101990. removeLight(toRemove: Light): number;
  101991. /**
  101992. * Remove a camera for the list of scene's cameras
  101993. * @param toRemove defines the camera to remove
  101994. * @returns the index where the camera was in the camera list
  101995. */
  101996. removeCamera(toRemove: Camera): number;
  101997. /**
  101998. * Remove a particle system for the list of scene's particle systems
  101999. * @param toRemove defines the particle system to remove
  102000. * @returns the index where the particle system was in the particle system list
  102001. */
  102002. removeParticleSystem(toRemove: IParticleSystem): number;
  102003. /**
  102004. * Remove a animation for the list of scene's animations
  102005. * @param toRemove defines the animation to remove
  102006. * @returns the index where the animation was in the animation list
  102007. */
  102008. removeAnimation(toRemove: Animation): number;
  102009. /**
  102010. * Will stop the animation of the given target
  102011. * @param target - the target
  102012. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  102013. * @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)
  102014. */
  102015. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  102016. /**
  102017. * Removes the given animation group from this scene.
  102018. * @param toRemove The animation group to remove
  102019. * @returns The index of the removed animation group
  102020. */
  102021. removeAnimationGroup(toRemove: AnimationGroup): number;
  102022. /**
  102023. * Removes the given multi-material from this scene.
  102024. * @param toRemove The multi-material to remove
  102025. * @returns The index of the removed multi-material
  102026. */
  102027. removeMultiMaterial(toRemove: MultiMaterial): number;
  102028. /**
  102029. * Removes the given material from this scene.
  102030. * @param toRemove The material to remove
  102031. * @returns The index of the removed material
  102032. */
  102033. removeMaterial(toRemove: Material): number;
  102034. /**
  102035. * Removes the given action manager from this scene.
  102036. * @param toRemove The action manager to remove
  102037. * @returns The index of the removed action manager
  102038. */
  102039. removeActionManager(toRemove: AbstractActionManager): number;
  102040. /**
  102041. * Removes the given texture from this scene.
  102042. * @param toRemove The texture to remove
  102043. * @returns The index of the removed texture
  102044. */
  102045. removeTexture(toRemove: BaseTexture): number;
  102046. /**
  102047. * Adds the given light to this scene
  102048. * @param newLight The light to add
  102049. */
  102050. addLight(newLight: Light): void;
  102051. /**
  102052. * Sorts the list list based on light priorities
  102053. */
  102054. sortLightsByPriority(): void;
  102055. /**
  102056. * Adds the given camera to this scene
  102057. * @param newCamera The camera to add
  102058. */
  102059. addCamera(newCamera: Camera): void;
  102060. /**
  102061. * Adds the given skeleton to this scene
  102062. * @param newSkeleton The skeleton to add
  102063. */
  102064. addSkeleton(newSkeleton: Skeleton): void;
  102065. /**
  102066. * Adds the given particle system to this scene
  102067. * @param newParticleSystem The particle system to add
  102068. */
  102069. addParticleSystem(newParticleSystem: IParticleSystem): void;
  102070. /**
  102071. * Adds the given animation to this scene
  102072. * @param newAnimation The animation to add
  102073. */
  102074. addAnimation(newAnimation: Animation): void;
  102075. /**
  102076. * Adds the given animation group to this scene.
  102077. * @param newAnimationGroup The animation group to add
  102078. */
  102079. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  102080. /**
  102081. * Adds the given multi-material to this scene
  102082. * @param newMultiMaterial The multi-material to add
  102083. */
  102084. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  102085. /**
  102086. * Adds the given material to this scene
  102087. * @param newMaterial The material to add
  102088. */
  102089. addMaterial(newMaterial: Material): void;
  102090. /**
  102091. * Adds the given morph target to this scene
  102092. * @param newMorphTargetManager The morph target to add
  102093. */
  102094. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  102095. /**
  102096. * Adds the given geometry to this scene
  102097. * @param newGeometry The geometry to add
  102098. */
  102099. addGeometry(newGeometry: Geometry): void;
  102100. /**
  102101. * Adds the given action manager to this scene
  102102. * @param newActionManager The action manager to add
  102103. */
  102104. addActionManager(newActionManager: AbstractActionManager): void;
  102105. /**
  102106. * Adds the given texture to this scene.
  102107. * @param newTexture The texture to add
  102108. */
  102109. addTexture(newTexture: BaseTexture): void;
  102110. /**
  102111. * Switch active camera
  102112. * @param newCamera defines the new active camera
  102113. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  102114. */
  102115. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  102116. /**
  102117. * sets the active camera of the scene using its ID
  102118. * @param id defines the camera's ID
  102119. * @return the new active camera or null if none found.
  102120. */
  102121. setActiveCameraByID(id: string): Nullable<Camera>;
  102122. /**
  102123. * sets the active camera of the scene using its name
  102124. * @param name defines the camera's name
  102125. * @returns the new active camera or null if none found.
  102126. */
  102127. setActiveCameraByName(name: string): Nullable<Camera>;
  102128. /**
  102129. * get an animation group using its name
  102130. * @param name defines the material's name
  102131. * @return the animation group or null if none found.
  102132. */
  102133. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  102134. /**
  102135. * Get a material using its unique id
  102136. * @param uniqueId defines the material's unique id
  102137. * @return the material or null if none found.
  102138. */
  102139. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  102140. /**
  102141. * get a material using its id
  102142. * @param id defines the material's ID
  102143. * @return the material or null if none found.
  102144. */
  102145. getMaterialByID(id: string): Nullable<Material>;
  102146. /**
  102147. * Gets a the last added material using a given id
  102148. * @param id defines the material's ID
  102149. * @return the last material with the given id or null if none found.
  102150. */
  102151. getLastMaterialByID(id: string): Nullable<Material>;
  102152. /**
  102153. * Gets a material using its name
  102154. * @param name defines the material's name
  102155. * @return the material or null if none found.
  102156. */
  102157. getMaterialByName(name: string): Nullable<Material>;
  102158. /**
  102159. * Get a texture using its unique id
  102160. * @param uniqueId defines the texture's unique id
  102161. * @return the texture or null if none found.
  102162. */
  102163. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  102164. /**
  102165. * Gets a camera using its id
  102166. * @param id defines the id to look for
  102167. * @returns the camera or null if not found
  102168. */
  102169. getCameraByID(id: string): Nullable<Camera>;
  102170. /**
  102171. * Gets a camera using its unique id
  102172. * @param uniqueId defines the unique id to look for
  102173. * @returns the camera or null if not found
  102174. */
  102175. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  102176. /**
  102177. * Gets a camera using its name
  102178. * @param name defines the camera's name
  102179. * @return the camera or null if none found.
  102180. */
  102181. getCameraByName(name: string): Nullable<Camera>;
  102182. /**
  102183. * Gets a bone using its id
  102184. * @param id defines the bone's id
  102185. * @return the bone or null if not found
  102186. */
  102187. getBoneByID(id: string): Nullable<Bone>;
  102188. /**
  102189. * Gets a bone using its id
  102190. * @param name defines the bone's name
  102191. * @return the bone or null if not found
  102192. */
  102193. getBoneByName(name: string): Nullable<Bone>;
  102194. /**
  102195. * Gets a light node using its name
  102196. * @param name defines the the light's name
  102197. * @return the light or null if none found.
  102198. */
  102199. getLightByName(name: string): Nullable<Light>;
  102200. /**
  102201. * Gets a light node using its id
  102202. * @param id defines the light's id
  102203. * @return the light or null if none found.
  102204. */
  102205. getLightByID(id: string): Nullable<Light>;
  102206. /**
  102207. * Gets a light node using its scene-generated unique ID
  102208. * @param uniqueId defines the light's unique id
  102209. * @return the light or null if none found.
  102210. */
  102211. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  102212. /**
  102213. * Gets a particle system by id
  102214. * @param id defines the particle system id
  102215. * @return the corresponding system or null if none found
  102216. */
  102217. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  102218. /**
  102219. * Gets a geometry using its ID
  102220. * @param id defines the geometry's id
  102221. * @return the geometry or null if none found.
  102222. */
  102223. getGeometryByID(id: string): Nullable<Geometry>;
  102224. private _getGeometryByUniqueID;
  102225. /**
  102226. * Add a new geometry to this scene
  102227. * @param geometry defines the geometry to be added to the scene.
  102228. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  102229. * @return a boolean defining if the geometry was added or not
  102230. */
  102231. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  102232. /**
  102233. * Removes an existing geometry
  102234. * @param geometry defines the geometry to be removed from the scene
  102235. * @return a boolean defining if the geometry was removed or not
  102236. */
  102237. removeGeometry(geometry: Geometry): boolean;
  102238. /**
  102239. * Gets the list of geometries attached to the scene
  102240. * @returns an array of Geometry
  102241. */
  102242. getGeometries(): Geometry[];
  102243. /**
  102244. * Gets the first added mesh found of a given ID
  102245. * @param id defines the id to search for
  102246. * @return the mesh found or null if not found at all
  102247. */
  102248. getMeshByID(id: string): Nullable<AbstractMesh>;
  102249. /**
  102250. * Gets a list of meshes using their id
  102251. * @param id defines the id to search for
  102252. * @returns a list of meshes
  102253. */
  102254. getMeshesByID(id: string): Array<AbstractMesh>;
  102255. /**
  102256. * Gets the first added transform node found of a given ID
  102257. * @param id defines the id to search for
  102258. * @return the found transform node or null if not found at all.
  102259. */
  102260. getTransformNodeByID(id: string): Nullable<TransformNode>;
  102261. /**
  102262. * Gets a transform node with its auto-generated unique id
  102263. * @param uniqueId efines the unique id to search for
  102264. * @return the found transform node or null if not found at all.
  102265. */
  102266. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  102267. /**
  102268. * Gets a list of transform nodes using their id
  102269. * @param id defines the id to search for
  102270. * @returns a list of transform nodes
  102271. */
  102272. getTransformNodesByID(id: string): Array<TransformNode>;
  102273. /**
  102274. * Gets a mesh with its auto-generated unique id
  102275. * @param uniqueId defines the unique id to search for
  102276. * @return the found mesh or null if not found at all.
  102277. */
  102278. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  102279. /**
  102280. * Gets a the last added mesh using a given id
  102281. * @param id defines the id to search for
  102282. * @return the found mesh or null if not found at all.
  102283. */
  102284. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  102285. /**
  102286. * Gets a the last added node (Mesh, Camera, Light) using a given id
  102287. * @param id defines the id to search for
  102288. * @return the found node or null if not found at all
  102289. */
  102290. getLastEntryByID(id: string): Nullable<Node>;
  102291. /**
  102292. * Gets a node (Mesh, Camera, Light) using a given id
  102293. * @param id defines the id to search for
  102294. * @return the found node or null if not found at all
  102295. */
  102296. getNodeByID(id: string): Nullable<Node>;
  102297. /**
  102298. * Gets a node (Mesh, Camera, Light) using a given name
  102299. * @param name defines the name to search for
  102300. * @return the found node or null if not found at all.
  102301. */
  102302. getNodeByName(name: string): Nullable<Node>;
  102303. /**
  102304. * Gets a mesh using a given name
  102305. * @param name defines the name to search for
  102306. * @return the found mesh or null if not found at all.
  102307. */
  102308. getMeshByName(name: string): Nullable<AbstractMesh>;
  102309. /**
  102310. * Gets a transform node using a given name
  102311. * @param name defines the name to search for
  102312. * @return the found transform node or null if not found at all.
  102313. */
  102314. getTransformNodeByName(name: string): Nullable<TransformNode>;
  102315. /**
  102316. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  102317. * @param id defines the id to search for
  102318. * @return the found skeleton or null if not found at all.
  102319. */
  102320. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  102321. /**
  102322. * Gets a skeleton using a given auto generated unique id
  102323. * @param uniqueId defines the unique id to search for
  102324. * @return the found skeleton or null if not found at all.
  102325. */
  102326. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  102327. /**
  102328. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  102329. * @param id defines the id to search for
  102330. * @return the found skeleton or null if not found at all.
  102331. */
  102332. getSkeletonById(id: string): Nullable<Skeleton>;
  102333. /**
  102334. * Gets a skeleton using a given name
  102335. * @param name defines the name to search for
  102336. * @return the found skeleton or null if not found at all.
  102337. */
  102338. getSkeletonByName(name: string): Nullable<Skeleton>;
  102339. /**
  102340. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  102341. * @param id defines the id to search for
  102342. * @return the found morph target manager or null if not found at all.
  102343. */
  102344. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  102345. /**
  102346. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  102347. * @param id defines the id to search for
  102348. * @return the found morph target or null if not found at all.
  102349. */
  102350. getMorphTargetById(id: string): Nullable<MorphTarget>;
  102351. /**
  102352. * Gets a boolean indicating if the given mesh is active
  102353. * @param mesh defines the mesh to look for
  102354. * @returns true if the mesh is in the active list
  102355. */
  102356. isActiveMesh(mesh: AbstractMesh): boolean;
  102357. /**
  102358. * Return a unique id as a string which can serve as an identifier for the scene
  102359. */
  102360. readonly uid: string;
  102361. /**
  102362. * Add an externaly attached data from its key.
  102363. * This method call will fail and return false, if such key already exists.
  102364. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  102365. * @param key the unique key that identifies the data
  102366. * @param data the data object to associate to the key for this Engine instance
  102367. * @return true if no such key were already present and the data was added successfully, false otherwise
  102368. */
  102369. addExternalData<T>(key: string, data: T): boolean;
  102370. /**
  102371. * Get an externaly attached data from its key
  102372. * @param key the unique key that identifies the data
  102373. * @return the associated data, if present (can be null), or undefined if not present
  102374. */
  102375. getExternalData<T>(key: string): Nullable<T>;
  102376. /**
  102377. * Get an externaly attached data from its key, create it using a factory if it's not already present
  102378. * @param key the unique key that identifies the data
  102379. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  102380. * @return the associated data, can be null if the factory returned null.
  102381. */
  102382. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  102383. /**
  102384. * Remove an externaly attached data from the Engine instance
  102385. * @param key the unique key that identifies the data
  102386. * @return true if the data was successfully removed, false if it doesn't exist
  102387. */
  102388. removeExternalData(key: string): boolean;
  102389. private _evaluateSubMesh;
  102390. /**
  102391. * Clear the processed materials smart array preventing retention point in material dispose.
  102392. */
  102393. freeProcessedMaterials(): void;
  102394. private _preventFreeActiveMeshesAndRenderingGroups;
  102395. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  102396. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  102397. * when disposing several meshes in a row or a hierarchy of meshes.
  102398. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  102399. */
  102400. blockfreeActiveMeshesAndRenderingGroups: boolean;
  102401. /**
  102402. * Clear the active meshes smart array preventing retention point in mesh dispose.
  102403. */
  102404. freeActiveMeshes(): void;
  102405. /**
  102406. * Clear the info related to rendering groups preventing retention points during dispose.
  102407. */
  102408. freeRenderingGroups(): void;
  102409. /** @hidden */
  102410. _isInIntermediateRendering(): boolean;
  102411. /**
  102412. * Lambda returning the list of potentially active meshes.
  102413. */
  102414. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  102415. /**
  102416. * Lambda returning the list of potentially active sub meshes.
  102417. */
  102418. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  102419. /**
  102420. * Lambda returning the list of potentially intersecting sub meshes.
  102421. */
  102422. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  102423. /**
  102424. * Lambda returning the list of potentially colliding sub meshes.
  102425. */
  102426. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  102427. private _activeMeshesFrozen;
  102428. /**
  102429. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  102430. * @returns the current scene
  102431. */
  102432. freezeActiveMeshes(): Scene;
  102433. /**
  102434. * Use this function to restart evaluating active meshes on every frame
  102435. * @returns the current scene
  102436. */
  102437. unfreezeActiveMeshes(): Scene;
  102438. private _evaluateActiveMeshes;
  102439. private _activeMesh;
  102440. /**
  102441. * Update the transform matrix to update from the current active camera
  102442. * @param force defines a boolean used to force the update even if cache is up to date
  102443. */
  102444. updateTransformMatrix(force?: boolean): void;
  102445. private _bindFrameBuffer;
  102446. /** @hidden */
  102447. _allowPostProcessClearColor: boolean;
  102448. /** @hidden */
  102449. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  102450. private _processSubCameras;
  102451. private _checkIntersections;
  102452. /** @hidden */
  102453. _advancePhysicsEngineStep(step: number): void;
  102454. /**
  102455. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  102456. */
  102457. getDeterministicFrameTime: () => number;
  102458. /** @hidden */
  102459. _animate(): void;
  102460. /** Execute all animations (for a frame) */
  102461. animate(): void;
  102462. /**
  102463. * Render the scene
  102464. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  102465. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  102466. */
  102467. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  102468. /**
  102469. * Freeze all materials
  102470. * A frozen material will not be updatable but should be faster to render
  102471. */
  102472. freezeMaterials(): void;
  102473. /**
  102474. * Unfreeze all materials
  102475. * A frozen material will not be updatable but should be faster to render
  102476. */
  102477. unfreezeMaterials(): void;
  102478. /**
  102479. * Releases all held ressources
  102480. */
  102481. dispose(): void;
  102482. /**
  102483. * Gets if the scene is already disposed
  102484. */
  102485. readonly isDisposed: boolean;
  102486. /**
  102487. * Call this function to reduce memory footprint of the scene.
  102488. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  102489. */
  102490. clearCachedVertexData(): void;
  102491. /**
  102492. * This function will remove the local cached buffer data from texture.
  102493. * It will save memory but will prevent the texture from being rebuilt
  102494. */
  102495. cleanCachedTextureBuffer(): void;
  102496. /**
  102497. * Get the world extend vectors with an optional filter
  102498. *
  102499. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  102500. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  102501. */
  102502. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  102503. min: Vector3;
  102504. max: Vector3;
  102505. };
  102506. /**
  102507. * Creates a ray that can be used to pick in the scene
  102508. * @param x defines the x coordinate of the origin (on-screen)
  102509. * @param y defines the y coordinate of the origin (on-screen)
  102510. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  102511. * @param camera defines the camera to use for the picking
  102512. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  102513. * @returns a Ray
  102514. */
  102515. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  102516. /**
  102517. * Creates a ray that can be used to pick in the scene
  102518. * @param x defines the x coordinate of the origin (on-screen)
  102519. * @param y defines the y coordinate of the origin (on-screen)
  102520. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  102521. * @param result defines the ray where to store the picking ray
  102522. * @param camera defines the camera to use for the picking
  102523. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  102524. * @returns the current scene
  102525. */
  102526. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  102527. /**
  102528. * Creates a ray that can be used to pick in the scene
  102529. * @param x defines the x coordinate of the origin (on-screen)
  102530. * @param y defines the y coordinate of the origin (on-screen)
  102531. * @param camera defines the camera to use for the picking
  102532. * @returns a Ray
  102533. */
  102534. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  102535. /**
  102536. * Creates a ray that can be used to pick in the scene
  102537. * @param x defines the x coordinate of the origin (on-screen)
  102538. * @param y defines the y coordinate of the origin (on-screen)
  102539. * @param result defines the ray where to store the picking ray
  102540. * @param camera defines the camera to use for the picking
  102541. * @returns the current scene
  102542. */
  102543. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  102544. /** Launch a ray to try to pick a mesh in the scene
  102545. * @param x position on screen
  102546. * @param y position on screen
  102547. * @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
  102548. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  102549. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  102550. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  102551. * @returns a PickingInfo
  102552. */
  102553. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  102554. /** Use the given ray to pick a mesh in the scene
  102555. * @param ray The ray to use to pick meshes
  102556. * @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
  102557. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  102558. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  102559. * @returns a PickingInfo
  102560. */
  102561. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  102562. /**
  102563. * Launch a ray to try to pick a mesh in the scene
  102564. * @param x X position on screen
  102565. * @param y Y position on screen
  102566. * @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
  102567. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  102568. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  102569. * @returns an array of PickingInfo
  102570. */
  102571. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  102572. /**
  102573. * Launch a ray to try to pick a mesh in the scene
  102574. * @param ray Ray to use
  102575. * @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
  102576. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  102577. * @returns an array of PickingInfo
  102578. */
  102579. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  102580. /**
  102581. * Force the value of meshUnderPointer
  102582. * @param mesh defines the mesh to use
  102583. */
  102584. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  102585. /**
  102586. * Gets the mesh under the pointer
  102587. * @returns a Mesh or null if no mesh is under the pointer
  102588. */
  102589. getPointerOverMesh(): Nullable<AbstractMesh>;
  102590. /** @hidden */
  102591. _rebuildGeometries(): void;
  102592. /** @hidden */
  102593. _rebuildTextures(): void;
  102594. private _getByTags;
  102595. /**
  102596. * Get a list of meshes by tags
  102597. * @param tagsQuery defines the tags query to use
  102598. * @param forEach defines a predicate used to filter results
  102599. * @returns an array of Mesh
  102600. */
  102601. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  102602. /**
  102603. * Get a list of cameras by tags
  102604. * @param tagsQuery defines the tags query to use
  102605. * @param forEach defines a predicate used to filter results
  102606. * @returns an array of Camera
  102607. */
  102608. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  102609. /**
  102610. * Get a list of lights by tags
  102611. * @param tagsQuery defines the tags query to use
  102612. * @param forEach defines a predicate used to filter results
  102613. * @returns an array of Light
  102614. */
  102615. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  102616. /**
  102617. * Get a list of materials by tags
  102618. * @param tagsQuery defines the tags query to use
  102619. * @param forEach defines a predicate used to filter results
  102620. * @returns an array of Material
  102621. */
  102622. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  102623. /**
  102624. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  102625. * This allowed control for front to back rendering or reversly depending of the special needs.
  102626. *
  102627. * @param renderingGroupId The rendering group id corresponding to its index
  102628. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  102629. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  102630. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  102631. */
  102632. 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;
  102633. /**
  102634. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  102635. *
  102636. * @param renderingGroupId The rendering group id corresponding to its index
  102637. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  102638. * @param depth Automatically clears depth between groups if true and autoClear is true.
  102639. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  102640. */
  102641. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  102642. /**
  102643. * Gets the current auto clear configuration for one rendering group of the rendering
  102644. * manager.
  102645. * @param index the rendering group index to get the information for
  102646. * @returns The auto clear setup for the requested rendering group
  102647. */
  102648. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  102649. private _blockMaterialDirtyMechanism;
  102650. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  102651. blockMaterialDirtyMechanism: boolean;
  102652. /**
  102653. * Will flag all materials as dirty to trigger new shader compilation
  102654. * @param flag defines the flag used to specify which material part must be marked as dirty
  102655. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  102656. */
  102657. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  102658. /** @hidden */
  102659. _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;
  102660. /** @hidden */
  102661. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  102662. /** @hidden */
  102663. _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;
  102664. /** @hidden */
  102665. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  102666. /** @hidden */
  102667. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  102668. /** @hidden */
  102669. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  102670. }
  102671. }
  102672. declare module BABYLON {
  102673. /**
  102674. * Set of assets to keep when moving a scene into an asset container.
  102675. */
  102676. export class KeepAssets extends AbstractScene {
  102677. }
  102678. /**
  102679. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  102680. */
  102681. export class InstantiatedEntries {
  102682. /**
  102683. * List of new root nodes (eg. nodes with no parent)
  102684. */
  102685. rootNodes: TransformNode[];
  102686. /**
  102687. * List of new skeletons
  102688. */
  102689. skeletons: Skeleton[];
  102690. /**
  102691. * List of new animation groups
  102692. */
  102693. animationGroups: AnimationGroup[];
  102694. }
  102695. /**
  102696. * Container with a set of assets that can be added or removed from a scene.
  102697. */
  102698. export class AssetContainer extends AbstractScene {
  102699. /**
  102700. * The scene the AssetContainer belongs to.
  102701. */
  102702. scene: Scene;
  102703. /**
  102704. * Instantiates an AssetContainer.
  102705. * @param scene The scene the AssetContainer belongs to.
  102706. */
  102707. constructor(scene: Scene);
  102708. /**
  102709. * Instantiate or clone all meshes and add the new ones to the scene.
  102710. * Skeletons and animation groups will all be cloned
  102711. * @param nameFunction defines an optional function used to get new names for clones
  102712. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  102713. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  102714. */
  102715. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  102716. /**
  102717. * Adds all the assets from the container to the scene.
  102718. */
  102719. addAllToScene(): void;
  102720. /**
  102721. * Removes all the assets in the container from the scene
  102722. */
  102723. removeAllFromScene(): void;
  102724. /**
  102725. * Disposes all the assets in the container
  102726. */
  102727. dispose(): void;
  102728. private _moveAssets;
  102729. /**
  102730. * Removes all the assets contained in the scene and adds them to the container.
  102731. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  102732. */
  102733. moveAllFromScene(keepAssets?: KeepAssets): void;
  102734. /**
  102735. * 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.
  102736. * @returns the root mesh
  102737. */
  102738. createRootMesh(): Mesh;
  102739. }
  102740. }
  102741. declare module BABYLON {
  102742. /**
  102743. * Defines how the parser contract is defined.
  102744. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  102745. */
  102746. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  102747. /**
  102748. * Defines how the individual parser contract is defined.
  102749. * These parser can parse an individual asset
  102750. */
  102751. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  102752. /**
  102753. * Base class of the scene acting as a container for the different elements composing a scene.
  102754. * This class is dynamically extended by the different components of the scene increasing
  102755. * flexibility and reducing coupling
  102756. */
  102757. export abstract class AbstractScene {
  102758. /**
  102759. * Stores the list of available parsers in the application.
  102760. */
  102761. private static _BabylonFileParsers;
  102762. /**
  102763. * Stores the list of available individual parsers in the application.
  102764. */
  102765. private static _IndividualBabylonFileParsers;
  102766. /**
  102767. * Adds a parser in the list of available ones
  102768. * @param name Defines the name of the parser
  102769. * @param parser Defines the parser to add
  102770. */
  102771. static AddParser(name: string, parser: BabylonFileParser): void;
  102772. /**
  102773. * Gets a general parser from the list of avaialble ones
  102774. * @param name Defines the name of the parser
  102775. * @returns the requested parser or null
  102776. */
  102777. static GetParser(name: string): Nullable<BabylonFileParser>;
  102778. /**
  102779. * Adds n individual parser in the list of available ones
  102780. * @param name Defines the name of the parser
  102781. * @param parser Defines the parser to add
  102782. */
  102783. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  102784. /**
  102785. * Gets an individual parser from the list of avaialble ones
  102786. * @param name Defines the name of the parser
  102787. * @returns the requested parser or null
  102788. */
  102789. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  102790. /**
  102791. * Parser json data and populate both a scene and its associated container object
  102792. * @param jsonData Defines the data to parse
  102793. * @param scene Defines the scene to parse the data for
  102794. * @param container Defines the container attached to the parsing sequence
  102795. * @param rootUrl Defines the root url of the data
  102796. */
  102797. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  102798. /**
  102799. * Gets the list of root nodes (ie. nodes with no parent)
  102800. */
  102801. rootNodes: Node[];
  102802. /** All of the cameras added to this scene
  102803. * @see http://doc.babylonjs.com/babylon101/cameras
  102804. */
  102805. cameras: Camera[];
  102806. /**
  102807. * All of the lights added to this scene
  102808. * @see http://doc.babylonjs.com/babylon101/lights
  102809. */
  102810. lights: Light[];
  102811. /**
  102812. * All of the (abstract) meshes added to this scene
  102813. */
  102814. meshes: AbstractMesh[];
  102815. /**
  102816. * The list of skeletons added to the scene
  102817. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  102818. */
  102819. skeletons: Skeleton[];
  102820. /**
  102821. * All of the particle systems added to this scene
  102822. * @see http://doc.babylonjs.com/babylon101/particles
  102823. */
  102824. particleSystems: IParticleSystem[];
  102825. /**
  102826. * Gets a list of Animations associated with the scene
  102827. */
  102828. animations: Animation[];
  102829. /**
  102830. * All of the animation groups added to this scene
  102831. * @see http://doc.babylonjs.com/how_to/group
  102832. */
  102833. animationGroups: AnimationGroup[];
  102834. /**
  102835. * All of the multi-materials added to this scene
  102836. * @see http://doc.babylonjs.com/how_to/multi_materials
  102837. */
  102838. multiMaterials: MultiMaterial[];
  102839. /**
  102840. * All of the materials added to this scene
  102841. * In the context of a Scene, it is not supposed to be modified manually.
  102842. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  102843. * Note also that the order of the Material within the array is not significant and might change.
  102844. * @see http://doc.babylonjs.com/babylon101/materials
  102845. */
  102846. materials: Material[];
  102847. /**
  102848. * The list of morph target managers added to the scene
  102849. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  102850. */
  102851. morphTargetManagers: MorphTargetManager[];
  102852. /**
  102853. * The list of geometries used in the scene.
  102854. */
  102855. geometries: Geometry[];
  102856. /**
  102857. * All of the tranform nodes added to this scene
  102858. * In the context of a Scene, it is not supposed to be modified manually.
  102859. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  102860. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  102861. * @see http://doc.babylonjs.com/how_to/transformnode
  102862. */
  102863. transformNodes: TransformNode[];
  102864. /**
  102865. * ActionManagers available on the scene.
  102866. */
  102867. actionManagers: AbstractActionManager[];
  102868. /**
  102869. * Textures to keep.
  102870. */
  102871. textures: BaseTexture[];
  102872. /**
  102873. * Environment texture for the scene
  102874. */
  102875. environmentTexture: Nullable<BaseTexture>;
  102876. }
  102877. }
  102878. declare module BABYLON {
  102879. /**
  102880. * Interface used to define options for Sound class
  102881. */
  102882. export interface ISoundOptions {
  102883. /**
  102884. * Does the sound autoplay once loaded.
  102885. */
  102886. autoplay?: boolean;
  102887. /**
  102888. * Does the sound loop after it finishes playing once.
  102889. */
  102890. loop?: boolean;
  102891. /**
  102892. * Sound's volume
  102893. */
  102894. volume?: number;
  102895. /**
  102896. * Is it a spatial sound?
  102897. */
  102898. spatialSound?: boolean;
  102899. /**
  102900. * Maximum distance to hear that sound
  102901. */
  102902. maxDistance?: number;
  102903. /**
  102904. * Uses user defined attenuation function
  102905. */
  102906. useCustomAttenuation?: boolean;
  102907. /**
  102908. * Define the roll off factor of spatial sounds.
  102909. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102910. */
  102911. rolloffFactor?: number;
  102912. /**
  102913. * Define the reference distance the sound should be heard perfectly.
  102914. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102915. */
  102916. refDistance?: number;
  102917. /**
  102918. * Define the distance attenuation model the sound will follow.
  102919. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102920. */
  102921. distanceModel?: string;
  102922. /**
  102923. * Defines the playback speed (1 by default)
  102924. */
  102925. playbackRate?: number;
  102926. /**
  102927. * Defines if the sound is from a streaming source
  102928. */
  102929. streaming?: boolean;
  102930. /**
  102931. * Defines an optional length (in seconds) inside the sound file
  102932. */
  102933. length?: number;
  102934. /**
  102935. * Defines an optional offset (in seconds) inside the sound file
  102936. */
  102937. offset?: number;
  102938. /**
  102939. * If true, URLs will not be required to state the audio file codec to use.
  102940. */
  102941. skipCodecCheck?: boolean;
  102942. }
  102943. /**
  102944. * Defines a sound that can be played in the application.
  102945. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  102946. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  102947. */
  102948. export class Sound {
  102949. /**
  102950. * The name of the sound in the scene.
  102951. */
  102952. name: string;
  102953. /**
  102954. * Does the sound autoplay once loaded.
  102955. */
  102956. autoplay: boolean;
  102957. /**
  102958. * Does the sound loop after it finishes playing once.
  102959. */
  102960. loop: boolean;
  102961. /**
  102962. * Does the sound use a custom attenuation curve to simulate the falloff
  102963. * happening when the source gets further away from the camera.
  102964. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  102965. */
  102966. useCustomAttenuation: boolean;
  102967. /**
  102968. * The sound track id this sound belongs to.
  102969. */
  102970. soundTrackId: number;
  102971. /**
  102972. * Is this sound currently played.
  102973. */
  102974. isPlaying: boolean;
  102975. /**
  102976. * Is this sound currently paused.
  102977. */
  102978. isPaused: boolean;
  102979. /**
  102980. * Does this sound enables spatial sound.
  102981. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102982. */
  102983. spatialSound: boolean;
  102984. /**
  102985. * Define the reference distance the sound should be heard perfectly.
  102986. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102987. */
  102988. refDistance: number;
  102989. /**
  102990. * Define the roll off factor of spatial sounds.
  102991. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102992. */
  102993. rolloffFactor: number;
  102994. /**
  102995. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  102996. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102997. */
  102998. maxDistance: number;
  102999. /**
  103000. * Define the distance attenuation model the sound will follow.
  103001. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103002. */
  103003. distanceModel: string;
  103004. /**
  103005. * @hidden
  103006. * Back Compat
  103007. **/
  103008. onended: () => any;
  103009. /**
  103010. * Observable event when the current playing sound finishes.
  103011. */
  103012. onEndedObservable: Observable<Sound>;
  103013. private _panningModel;
  103014. private _playbackRate;
  103015. private _streaming;
  103016. private _startTime;
  103017. private _startOffset;
  103018. private _position;
  103019. /** @hidden */
  103020. _positionInEmitterSpace: boolean;
  103021. private _localDirection;
  103022. private _volume;
  103023. private _isReadyToPlay;
  103024. private _isDirectional;
  103025. private _readyToPlayCallback;
  103026. private _audioBuffer;
  103027. private _soundSource;
  103028. private _streamingSource;
  103029. private _soundPanner;
  103030. private _soundGain;
  103031. private _inputAudioNode;
  103032. private _outputAudioNode;
  103033. private _coneInnerAngle;
  103034. private _coneOuterAngle;
  103035. private _coneOuterGain;
  103036. private _scene;
  103037. private _connectedTransformNode;
  103038. private _customAttenuationFunction;
  103039. private _registerFunc;
  103040. private _isOutputConnected;
  103041. private _htmlAudioElement;
  103042. private _urlType;
  103043. private _length?;
  103044. private _offset?;
  103045. /** @hidden */
  103046. static _SceneComponentInitialization: (scene: Scene) => void;
  103047. /**
  103048. * Create a sound and attach it to a scene
  103049. * @param name Name of your sound
  103050. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  103051. * @param scene defines the scene the sound belongs to
  103052. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  103053. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  103054. */
  103055. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  103056. /**
  103057. * Release the sound and its associated resources
  103058. */
  103059. dispose(): void;
  103060. /**
  103061. * Gets if the sounds is ready to be played or not.
  103062. * @returns true if ready, otherwise false
  103063. */
  103064. isReady(): boolean;
  103065. private _soundLoaded;
  103066. /**
  103067. * Sets the data of the sound from an audiobuffer
  103068. * @param audioBuffer The audioBuffer containing the data
  103069. */
  103070. setAudioBuffer(audioBuffer: AudioBuffer): void;
  103071. /**
  103072. * Updates the current sounds options such as maxdistance, loop...
  103073. * @param options A JSON object containing values named as the object properties
  103074. */
  103075. updateOptions(options: ISoundOptions): void;
  103076. private _createSpatialParameters;
  103077. private _updateSpatialParameters;
  103078. /**
  103079. * Switch the panning model to HRTF:
  103080. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  103081. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103082. */
  103083. switchPanningModelToHRTF(): void;
  103084. /**
  103085. * Switch the panning model to Equal Power:
  103086. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  103087. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103088. */
  103089. switchPanningModelToEqualPower(): void;
  103090. private _switchPanningModel;
  103091. /**
  103092. * Connect this sound to a sound track audio node like gain...
  103093. * @param soundTrackAudioNode the sound track audio node to connect to
  103094. */
  103095. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  103096. /**
  103097. * Transform this sound into a directional source
  103098. * @param coneInnerAngle Size of the inner cone in degree
  103099. * @param coneOuterAngle Size of the outer cone in degree
  103100. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  103101. */
  103102. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  103103. /**
  103104. * Gets or sets the inner angle for the directional cone.
  103105. */
  103106. /**
  103107. * Gets or sets the inner angle for the directional cone.
  103108. */
  103109. directionalConeInnerAngle: number;
  103110. /**
  103111. * Gets or sets the outer angle for the directional cone.
  103112. */
  103113. /**
  103114. * Gets or sets the outer angle for the directional cone.
  103115. */
  103116. directionalConeOuterAngle: number;
  103117. /**
  103118. * Sets the position of the emitter if spatial sound is enabled
  103119. * @param newPosition Defines the new posisiton
  103120. */
  103121. setPosition(newPosition: Vector3): void;
  103122. /**
  103123. * Sets the local direction of the emitter if spatial sound is enabled
  103124. * @param newLocalDirection Defines the new local direction
  103125. */
  103126. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  103127. private _updateDirection;
  103128. /** @hidden */
  103129. updateDistanceFromListener(): void;
  103130. /**
  103131. * Sets a new custom attenuation function for the sound.
  103132. * @param callback Defines the function used for the attenuation
  103133. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  103134. */
  103135. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  103136. /**
  103137. * Play the sound
  103138. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  103139. * @param offset (optional) Start the sound at a specific time in seconds
  103140. * @param length (optional) Sound duration (in seconds)
  103141. */
  103142. play(time?: number, offset?: number, length?: number): void;
  103143. private _onended;
  103144. /**
  103145. * Stop the sound
  103146. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  103147. */
  103148. stop(time?: number): void;
  103149. /**
  103150. * Put the sound in pause
  103151. */
  103152. pause(): void;
  103153. /**
  103154. * Sets a dedicated volume for this sounds
  103155. * @param newVolume Define the new volume of the sound
  103156. * @param time Define time for gradual change to new volume
  103157. */
  103158. setVolume(newVolume: number, time?: number): void;
  103159. /**
  103160. * Set the sound play back rate
  103161. * @param newPlaybackRate Define the playback rate the sound should be played at
  103162. */
  103163. setPlaybackRate(newPlaybackRate: number): void;
  103164. /**
  103165. * Gets the volume of the sound.
  103166. * @returns the volume of the sound
  103167. */
  103168. getVolume(): number;
  103169. /**
  103170. * Attach the sound to a dedicated mesh
  103171. * @param transformNode The transform node to connect the sound with
  103172. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  103173. */
  103174. attachToMesh(transformNode: TransformNode): void;
  103175. /**
  103176. * Detach the sound from the previously attached mesh
  103177. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  103178. */
  103179. detachFromMesh(): void;
  103180. private _onRegisterAfterWorldMatrixUpdate;
  103181. /**
  103182. * Clone the current sound in the scene.
  103183. * @returns the new sound clone
  103184. */
  103185. clone(): Nullable<Sound>;
  103186. /**
  103187. * Gets the current underlying audio buffer containing the data
  103188. * @returns the audio buffer
  103189. */
  103190. getAudioBuffer(): Nullable<AudioBuffer>;
  103191. /**
  103192. * Serializes the Sound in a JSON representation
  103193. * @returns the JSON representation of the sound
  103194. */
  103195. serialize(): any;
  103196. /**
  103197. * Parse a JSON representation of a sound to innstantiate in a given scene
  103198. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  103199. * @param scene Define the scene the new parsed sound should be created in
  103200. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  103201. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  103202. * @returns the newly parsed sound
  103203. */
  103204. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  103205. }
  103206. }
  103207. declare module BABYLON {
  103208. /**
  103209. * This defines an action helpful to play a defined sound on a triggered action.
  103210. */
  103211. export class PlaySoundAction extends Action {
  103212. private _sound;
  103213. /**
  103214. * Instantiate the action
  103215. * @param triggerOptions defines the trigger options
  103216. * @param sound defines the sound to play
  103217. * @param condition defines the trigger related conditions
  103218. */
  103219. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  103220. /** @hidden */
  103221. _prepare(): void;
  103222. /**
  103223. * Execute the action and play the sound.
  103224. */
  103225. execute(): void;
  103226. /**
  103227. * Serializes the actions and its related information.
  103228. * @param parent defines the object to serialize in
  103229. * @returns the serialized object
  103230. */
  103231. serialize(parent: any): any;
  103232. }
  103233. /**
  103234. * This defines an action helpful to stop a defined sound on a triggered action.
  103235. */
  103236. export class StopSoundAction extends Action {
  103237. private _sound;
  103238. /**
  103239. * Instantiate the action
  103240. * @param triggerOptions defines the trigger options
  103241. * @param sound defines the sound to stop
  103242. * @param condition defines the trigger related conditions
  103243. */
  103244. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  103245. /** @hidden */
  103246. _prepare(): void;
  103247. /**
  103248. * Execute the action and stop the sound.
  103249. */
  103250. execute(): void;
  103251. /**
  103252. * Serializes the actions and its related information.
  103253. * @param parent defines the object to serialize in
  103254. * @returns the serialized object
  103255. */
  103256. serialize(parent: any): any;
  103257. }
  103258. }
  103259. declare module BABYLON {
  103260. /**
  103261. * This defines an action responsible to change the value of a property
  103262. * by interpolating between its current value and the newly set one once triggered.
  103263. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  103264. */
  103265. export class InterpolateValueAction extends Action {
  103266. /**
  103267. * Defines the path of the property where the value should be interpolated
  103268. */
  103269. propertyPath: string;
  103270. /**
  103271. * Defines the target value at the end of the interpolation.
  103272. */
  103273. value: any;
  103274. /**
  103275. * Defines the time it will take for the property to interpolate to the value.
  103276. */
  103277. duration: number;
  103278. /**
  103279. * Defines if the other scene animations should be stopped when the action has been triggered
  103280. */
  103281. stopOtherAnimations?: boolean;
  103282. /**
  103283. * Defines a callback raised once the interpolation animation has been done.
  103284. */
  103285. onInterpolationDone?: () => void;
  103286. /**
  103287. * Observable triggered once the interpolation animation has been done.
  103288. */
  103289. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  103290. private _target;
  103291. private _effectiveTarget;
  103292. private _property;
  103293. /**
  103294. * Instantiate the action
  103295. * @param triggerOptions defines the trigger options
  103296. * @param target defines the object containing the value to interpolate
  103297. * @param propertyPath defines the path to the property in the target object
  103298. * @param value defines the target value at the end of the interpolation
  103299. * @param duration deines the time it will take for the property to interpolate to the value.
  103300. * @param condition defines the trigger related conditions
  103301. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  103302. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  103303. */
  103304. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  103305. /** @hidden */
  103306. _prepare(): void;
  103307. /**
  103308. * Execute the action starts the value interpolation.
  103309. */
  103310. execute(): void;
  103311. /**
  103312. * Serializes the actions and its related information.
  103313. * @param parent defines the object to serialize in
  103314. * @returns the serialized object
  103315. */
  103316. serialize(parent: any): any;
  103317. }
  103318. }
  103319. declare module BABYLON {
  103320. /**
  103321. * Options allowed during the creation of a sound track.
  103322. */
  103323. export interface ISoundTrackOptions {
  103324. /**
  103325. * The volume the sound track should take during creation
  103326. */
  103327. volume?: number;
  103328. /**
  103329. * Define if the sound track is the main sound track of the scene
  103330. */
  103331. mainTrack?: boolean;
  103332. }
  103333. /**
  103334. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  103335. * It will be also used in a future release to apply effects on a specific track.
  103336. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  103337. */
  103338. export class SoundTrack {
  103339. /**
  103340. * The unique identifier of the sound track in the scene.
  103341. */
  103342. id: number;
  103343. /**
  103344. * The list of sounds included in the sound track.
  103345. */
  103346. soundCollection: Array<Sound>;
  103347. private _outputAudioNode;
  103348. private _scene;
  103349. private _isMainTrack;
  103350. private _connectedAnalyser;
  103351. private _options;
  103352. private _isInitialized;
  103353. /**
  103354. * Creates a new sound track.
  103355. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  103356. * @param scene Define the scene the sound track belongs to
  103357. * @param options
  103358. */
  103359. constructor(scene: Scene, options?: ISoundTrackOptions);
  103360. private _initializeSoundTrackAudioGraph;
  103361. /**
  103362. * Release the sound track and its associated resources
  103363. */
  103364. dispose(): void;
  103365. /**
  103366. * Adds a sound to this sound track
  103367. * @param sound define the cound to add
  103368. * @ignoreNaming
  103369. */
  103370. AddSound(sound: Sound): void;
  103371. /**
  103372. * Removes a sound to this sound track
  103373. * @param sound define the cound to remove
  103374. * @ignoreNaming
  103375. */
  103376. RemoveSound(sound: Sound): void;
  103377. /**
  103378. * Set a global volume for the full sound track.
  103379. * @param newVolume Define the new volume of the sound track
  103380. */
  103381. setVolume(newVolume: number): void;
  103382. /**
  103383. * Switch the panning model to HRTF:
  103384. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  103385. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103386. */
  103387. switchPanningModelToHRTF(): void;
  103388. /**
  103389. * Switch the panning model to Equal Power:
  103390. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  103391. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103392. */
  103393. switchPanningModelToEqualPower(): void;
  103394. /**
  103395. * Connect the sound track to an audio analyser allowing some amazing
  103396. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  103397. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  103398. * @param analyser The analyser to connect to the engine
  103399. */
  103400. connectToAnalyser(analyser: Analyser): void;
  103401. }
  103402. }
  103403. declare module BABYLON {
  103404. interface AbstractScene {
  103405. /**
  103406. * The list of sounds used in the scene.
  103407. */
  103408. sounds: Nullable<Array<Sound>>;
  103409. }
  103410. interface Scene {
  103411. /**
  103412. * @hidden
  103413. * Backing field
  103414. */
  103415. _mainSoundTrack: SoundTrack;
  103416. /**
  103417. * The main sound track played by the scene.
  103418. * It cotains your primary collection of sounds.
  103419. */
  103420. mainSoundTrack: SoundTrack;
  103421. /**
  103422. * The list of sound tracks added to the scene
  103423. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103424. */
  103425. soundTracks: Nullable<Array<SoundTrack>>;
  103426. /**
  103427. * Gets a sound using a given name
  103428. * @param name defines the name to search for
  103429. * @return the found sound or null if not found at all.
  103430. */
  103431. getSoundByName(name: string): Nullable<Sound>;
  103432. /**
  103433. * Gets or sets if audio support is enabled
  103434. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103435. */
  103436. audioEnabled: boolean;
  103437. /**
  103438. * Gets or sets if audio will be output to headphones
  103439. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103440. */
  103441. headphone: boolean;
  103442. /**
  103443. * Gets or sets custom audio listener position provider
  103444. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103445. */
  103446. audioListenerPositionProvider: Nullable<() => Vector3>;
  103447. /**
  103448. * Gets or sets a refresh rate when using 3D audio positioning
  103449. */
  103450. audioPositioningRefreshRate: number;
  103451. }
  103452. /**
  103453. * Defines the sound scene component responsible to manage any sounds
  103454. * in a given scene.
  103455. */
  103456. export class AudioSceneComponent implements ISceneSerializableComponent {
  103457. /**
  103458. * The component name helpfull to identify the component in the list of scene components.
  103459. */
  103460. readonly name: string;
  103461. /**
  103462. * The scene the component belongs to.
  103463. */
  103464. scene: Scene;
  103465. private _audioEnabled;
  103466. /**
  103467. * Gets whether audio is enabled or not.
  103468. * Please use related enable/disable method to switch state.
  103469. */
  103470. readonly audioEnabled: boolean;
  103471. private _headphone;
  103472. /**
  103473. * Gets whether audio is outputing to headphone or not.
  103474. * Please use the according Switch methods to change output.
  103475. */
  103476. readonly headphone: boolean;
  103477. /**
  103478. * Gets or sets a refresh rate when using 3D audio positioning
  103479. */
  103480. audioPositioningRefreshRate: number;
  103481. private _audioListenerPositionProvider;
  103482. /**
  103483. * Gets the current audio listener position provider
  103484. */
  103485. /**
  103486. * Sets a custom listener position for all sounds in the scene
  103487. * By default, this is the position of the first active camera
  103488. */
  103489. audioListenerPositionProvider: Nullable<() => Vector3>;
  103490. /**
  103491. * Creates a new instance of the component for the given scene
  103492. * @param scene Defines the scene to register the component in
  103493. */
  103494. constructor(scene: Scene);
  103495. /**
  103496. * Registers the component in a given scene
  103497. */
  103498. register(): void;
  103499. /**
  103500. * Rebuilds the elements related to this component in case of
  103501. * context lost for instance.
  103502. */
  103503. rebuild(): void;
  103504. /**
  103505. * Serializes the component data to the specified json object
  103506. * @param serializationObject The object to serialize to
  103507. */
  103508. serialize(serializationObject: any): void;
  103509. /**
  103510. * Adds all the elements from the container to the scene
  103511. * @param container the container holding the elements
  103512. */
  103513. addFromContainer(container: AbstractScene): void;
  103514. /**
  103515. * Removes all the elements in the container from the scene
  103516. * @param container contains the elements to remove
  103517. * @param dispose if the removed element should be disposed (default: false)
  103518. */
  103519. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  103520. /**
  103521. * Disposes the component and the associated ressources.
  103522. */
  103523. dispose(): void;
  103524. /**
  103525. * Disables audio in the associated scene.
  103526. */
  103527. disableAudio(): void;
  103528. /**
  103529. * Enables audio in the associated scene.
  103530. */
  103531. enableAudio(): void;
  103532. /**
  103533. * Switch audio to headphone output.
  103534. */
  103535. switchAudioModeForHeadphones(): void;
  103536. /**
  103537. * Switch audio to normal speakers.
  103538. */
  103539. switchAudioModeForNormalSpeakers(): void;
  103540. private _cachedCameraDirection;
  103541. private _cachedCameraPosition;
  103542. private _lastCheck;
  103543. private _afterRender;
  103544. }
  103545. }
  103546. declare module BABYLON {
  103547. /**
  103548. * Wraps one or more Sound objects and selects one with random weight for playback.
  103549. */
  103550. export class WeightedSound {
  103551. /** When true a Sound will be selected and played when the current playing Sound completes. */
  103552. loop: boolean;
  103553. private _coneInnerAngle;
  103554. private _coneOuterAngle;
  103555. private _volume;
  103556. /** A Sound is currently playing. */
  103557. isPlaying: boolean;
  103558. /** A Sound is currently paused. */
  103559. isPaused: boolean;
  103560. private _sounds;
  103561. private _weights;
  103562. private _currentIndex?;
  103563. /**
  103564. * Creates a new WeightedSound from the list of sounds given.
  103565. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  103566. * @param sounds Array of Sounds that will be selected from.
  103567. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  103568. */
  103569. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  103570. /**
  103571. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  103572. */
  103573. /**
  103574. * The size of cone in degress for a directional sound in which there will be no attenuation.
  103575. */
  103576. directionalConeInnerAngle: number;
  103577. /**
  103578. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  103579. * Listener angles between innerAngle and outerAngle will falloff linearly.
  103580. */
  103581. /**
  103582. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  103583. * Listener angles between innerAngle and outerAngle will falloff linearly.
  103584. */
  103585. directionalConeOuterAngle: number;
  103586. /**
  103587. * Playback volume.
  103588. */
  103589. /**
  103590. * Playback volume.
  103591. */
  103592. volume: number;
  103593. private _onended;
  103594. /**
  103595. * Suspend playback
  103596. */
  103597. pause(): void;
  103598. /**
  103599. * Stop playback
  103600. */
  103601. stop(): void;
  103602. /**
  103603. * Start playback.
  103604. * @param startOffset Position the clip head at a specific time in seconds.
  103605. */
  103606. play(startOffset?: number): void;
  103607. }
  103608. }
  103609. declare module BABYLON {
  103610. /**
  103611. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  103612. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  103613. */
  103614. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  103615. /**
  103616. * Gets the name of the behavior.
  103617. */
  103618. readonly name: string;
  103619. /**
  103620. * The easing function used by animations
  103621. */
  103622. static EasingFunction: BackEase;
  103623. /**
  103624. * The easing mode used by animations
  103625. */
  103626. static EasingMode: number;
  103627. /**
  103628. * The duration of the animation, in milliseconds
  103629. */
  103630. transitionDuration: number;
  103631. /**
  103632. * Length of the distance animated by the transition when lower radius is reached
  103633. */
  103634. lowerRadiusTransitionRange: number;
  103635. /**
  103636. * Length of the distance animated by the transition when upper radius is reached
  103637. */
  103638. upperRadiusTransitionRange: number;
  103639. private _autoTransitionRange;
  103640. /**
  103641. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  103642. */
  103643. /**
  103644. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  103645. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  103646. */
  103647. autoTransitionRange: boolean;
  103648. private _attachedCamera;
  103649. private _onAfterCheckInputsObserver;
  103650. private _onMeshTargetChangedObserver;
  103651. /**
  103652. * Initializes the behavior.
  103653. */
  103654. init(): void;
  103655. /**
  103656. * Attaches the behavior to its arc rotate camera.
  103657. * @param camera Defines the camera to attach the behavior to
  103658. */
  103659. attach(camera: ArcRotateCamera): void;
  103660. /**
  103661. * Detaches the behavior from its current arc rotate camera.
  103662. */
  103663. detach(): void;
  103664. private _radiusIsAnimating;
  103665. private _radiusBounceTransition;
  103666. private _animatables;
  103667. private _cachedWheelPrecision;
  103668. /**
  103669. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  103670. * @param radiusLimit The limit to check against.
  103671. * @return Bool to indicate if at limit.
  103672. */
  103673. private _isRadiusAtLimit;
  103674. /**
  103675. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  103676. * @param radiusDelta The delta by which to animate to. Can be negative.
  103677. */
  103678. private _applyBoundRadiusAnimation;
  103679. /**
  103680. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  103681. */
  103682. protected _clearAnimationLocks(): void;
  103683. /**
  103684. * Stops and removes all animations that have been applied to the camera
  103685. */
  103686. stopAllAnimations(): void;
  103687. }
  103688. }
  103689. declare module BABYLON {
  103690. /**
  103691. * 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.
  103692. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  103693. */
  103694. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  103695. /**
  103696. * Gets the name of the behavior.
  103697. */
  103698. readonly name: string;
  103699. private _mode;
  103700. private _radiusScale;
  103701. private _positionScale;
  103702. private _defaultElevation;
  103703. private _elevationReturnTime;
  103704. private _elevationReturnWaitTime;
  103705. private _zoomStopsAnimation;
  103706. private _framingTime;
  103707. /**
  103708. * The easing function used by animations
  103709. */
  103710. static EasingFunction: ExponentialEase;
  103711. /**
  103712. * The easing mode used by animations
  103713. */
  103714. static EasingMode: number;
  103715. /**
  103716. * Sets the current mode used by the behavior
  103717. */
  103718. /**
  103719. * Gets current mode used by the behavior.
  103720. */
  103721. mode: number;
  103722. /**
  103723. * Sets the scale applied to the radius (1 by default)
  103724. */
  103725. /**
  103726. * Gets the scale applied to the radius
  103727. */
  103728. radiusScale: number;
  103729. /**
  103730. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  103731. */
  103732. /**
  103733. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  103734. */
  103735. positionScale: number;
  103736. /**
  103737. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  103738. * behaviour is triggered, in radians.
  103739. */
  103740. /**
  103741. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  103742. * behaviour is triggered, in radians.
  103743. */
  103744. defaultElevation: number;
  103745. /**
  103746. * Sets the time (in milliseconds) taken to return to the default beta position.
  103747. * Negative value indicates camera should not return to default.
  103748. */
  103749. /**
  103750. * Gets the time (in milliseconds) taken to return to the default beta position.
  103751. * Negative value indicates camera should not return to default.
  103752. */
  103753. elevationReturnTime: number;
  103754. /**
  103755. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  103756. */
  103757. /**
  103758. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  103759. */
  103760. elevationReturnWaitTime: number;
  103761. /**
  103762. * Sets the flag that indicates if user zooming should stop animation.
  103763. */
  103764. /**
  103765. * Gets the flag that indicates if user zooming should stop animation.
  103766. */
  103767. zoomStopsAnimation: boolean;
  103768. /**
  103769. * Sets the transition time when framing the mesh, in milliseconds
  103770. */
  103771. /**
  103772. * Gets the transition time when framing the mesh, in milliseconds
  103773. */
  103774. framingTime: number;
  103775. /**
  103776. * Define if the behavior should automatically change the configured
  103777. * camera limits and sensibilities.
  103778. */
  103779. autoCorrectCameraLimitsAndSensibility: boolean;
  103780. private _onPrePointerObservableObserver;
  103781. private _onAfterCheckInputsObserver;
  103782. private _onMeshTargetChangedObserver;
  103783. private _attachedCamera;
  103784. private _isPointerDown;
  103785. private _lastInteractionTime;
  103786. /**
  103787. * Initializes the behavior.
  103788. */
  103789. init(): void;
  103790. /**
  103791. * Attaches the behavior to its arc rotate camera.
  103792. * @param camera Defines the camera to attach the behavior to
  103793. */
  103794. attach(camera: ArcRotateCamera): void;
  103795. /**
  103796. * Detaches the behavior from its current arc rotate camera.
  103797. */
  103798. detach(): void;
  103799. private _animatables;
  103800. private _betaIsAnimating;
  103801. private _betaTransition;
  103802. private _radiusTransition;
  103803. private _vectorTransition;
  103804. /**
  103805. * Targets the given mesh and updates zoom level accordingly.
  103806. * @param mesh The mesh to target.
  103807. * @param radius Optional. If a cached radius position already exists, overrides default.
  103808. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  103809. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  103810. * @param onAnimationEnd Callback triggered at the end of the framing animation
  103811. */
  103812. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  103813. /**
  103814. * Targets the given mesh with its children and updates zoom level accordingly.
  103815. * @param mesh The mesh to target.
  103816. * @param radius Optional. If a cached radius position already exists, overrides default.
  103817. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  103818. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  103819. * @param onAnimationEnd Callback triggered at the end of the framing animation
  103820. */
  103821. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  103822. /**
  103823. * Targets the given meshes with their children and updates zoom level accordingly.
  103824. * @param meshes The mesh to target.
  103825. * @param radius Optional. If a cached radius position already exists, overrides default.
  103826. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  103827. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  103828. * @param onAnimationEnd Callback triggered at the end of the framing animation
  103829. */
  103830. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  103831. /**
  103832. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  103833. * @param minimumWorld Determines the smaller position of the bounding box extend
  103834. * @param maximumWorld Determines the bigger position of the bounding box extend
  103835. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  103836. * @param onAnimationEnd Callback triggered at the end of the framing animation
  103837. */
  103838. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  103839. /**
  103840. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  103841. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  103842. * frustum width.
  103843. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  103844. * to fully enclose the mesh in the viewing frustum.
  103845. */
  103846. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  103847. /**
  103848. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  103849. * is automatically returned to its default position (expected to be above ground plane).
  103850. */
  103851. private _maintainCameraAboveGround;
  103852. /**
  103853. * Returns the frustum slope based on the canvas ratio and camera FOV
  103854. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  103855. */
  103856. private _getFrustumSlope;
  103857. /**
  103858. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  103859. */
  103860. private _clearAnimationLocks;
  103861. /**
  103862. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  103863. */
  103864. private _applyUserInteraction;
  103865. /**
  103866. * Stops and removes all animations that have been applied to the camera
  103867. */
  103868. stopAllAnimations(): void;
  103869. /**
  103870. * Gets a value indicating if the user is moving the camera
  103871. */
  103872. readonly isUserIsMoving: boolean;
  103873. /**
  103874. * The camera can move all the way towards the mesh.
  103875. */
  103876. static IgnoreBoundsSizeMode: number;
  103877. /**
  103878. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  103879. */
  103880. static FitFrustumSidesMode: number;
  103881. }
  103882. }
  103883. declare module BABYLON {
  103884. /**
  103885. * Base class for Camera Pointer Inputs.
  103886. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  103887. * for example usage.
  103888. */
  103889. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  103890. /**
  103891. * Defines the camera the input is attached to.
  103892. */
  103893. abstract camera: Camera;
  103894. /**
  103895. * Whether keyboard modifier keys are pressed at time of last mouse event.
  103896. */
  103897. protected _altKey: boolean;
  103898. protected _ctrlKey: boolean;
  103899. protected _metaKey: boolean;
  103900. protected _shiftKey: boolean;
  103901. /**
  103902. * Which mouse buttons were pressed at time of last mouse event.
  103903. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  103904. */
  103905. protected _buttonsPressed: number;
  103906. /**
  103907. * Defines the buttons associated with the input to handle camera move.
  103908. */
  103909. buttons: number[];
  103910. /**
  103911. * Attach the input controls to a specific dom element to get the input from.
  103912. * @param element Defines the element the controls should be listened from
  103913. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  103914. */
  103915. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  103916. /**
  103917. * Detach the current controls from the specified dom element.
  103918. * @param element Defines the element to stop listening the inputs from
  103919. */
  103920. detachControl(element: Nullable<HTMLElement>): void;
  103921. /**
  103922. * Gets the class name of the current input.
  103923. * @returns the class name
  103924. */
  103925. getClassName(): string;
  103926. /**
  103927. * Get the friendly name associated with the input class.
  103928. * @returns the input friendly name
  103929. */
  103930. getSimpleName(): string;
  103931. /**
  103932. * Called on pointer POINTERDOUBLETAP event.
  103933. * Override this method to provide functionality on POINTERDOUBLETAP event.
  103934. */
  103935. protected onDoubleTap(type: string): void;
  103936. /**
  103937. * Called on pointer POINTERMOVE event if only a single touch is active.
  103938. * Override this method to provide functionality.
  103939. */
  103940. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  103941. /**
  103942. * Called on pointer POINTERMOVE event if multiple touches are active.
  103943. * Override this method to provide functionality.
  103944. */
  103945. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  103946. /**
  103947. * Called on JS contextmenu event.
  103948. * Override this method to provide functionality.
  103949. */
  103950. protected onContextMenu(evt: PointerEvent): void;
  103951. /**
  103952. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  103953. * press.
  103954. * Override this method to provide functionality.
  103955. */
  103956. protected onButtonDown(evt: PointerEvent): void;
  103957. /**
  103958. * Called each time a new POINTERUP event occurs. Ie, for each button
  103959. * release.
  103960. * Override this method to provide functionality.
  103961. */
  103962. protected onButtonUp(evt: PointerEvent): void;
  103963. /**
  103964. * Called when window becomes inactive.
  103965. * Override this method to provide functionality.
  103966. */
  103967. protected onLostFocus(): void;
  103968. private _pointerInput;
  103969. private _observer;
  103970. private _onLostFocus;
  103971. private pointA;
  103972. private pointB;
  103973. }
  103974. }
  103975. declare module BABYLON {
  103976. /**
  103977. * Manage the pointers inputs to control an arc rotate camera.
  103978. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  103979. */
  103980. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  103981. /**
  103982. * Defines the camera the input is attached to.
  103983. */
  103984. camera: ArcRotateCamera;
  103985. /**
  103986. * Gets the class name of the current input.
  103987. * @returns the class name
  103988. */
  103989. getClassName(): string;
  103990. /**
  103991. * Defines the buttons associated with the input to handle camera move.
  103992. */
  103993. buttons: number[];
  103994. /**
  103995. * Defines the pointer angular sensibility along the X axis or how fast is
  103996. * the camera rotating.
  103997. */
  103998. angularSensibilityX: number;
  103999. /**
  104000. * Defines the pointer angular sensibility along the Y axis or how fast is
  104001. * the camera rotating.
  104002. */
  104003. angularSensibilityY: number;
  104004. /**
  104005. * Defines the pointer pinch precision or how fast is the camera zooming.
  104006. */
  104007. pinchPrecision: number;
  104008. /**
  104009. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  104010. * from 0.
  104011. * It defines the percentage of current camera.radius to use as delta when
  104012. * pinch zoom is used.
  104013. */
  104014. pinchDeltaPercentage: number;
  104015. /**
  104016. * Defines the pointer panning sensibility or how fast is the camera moving.
  104017. */
  104018. panningSensibility: number;
  104019. /**
  104020. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  104021. */
  104022. multiTouchPanning: boolean;
  104023. /**
  104024. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  104025. * zoom (pinch) through multitouch.
  104026. */
  104027. multiTouchPanAndZoom: boolean;
  104028. /**
  104029. * Revers pinch action direction.
  104030. */
  104031. pinchInwards: boolean;
  104032. private _isPanClick;
  104033. private _twoFingerActivityCount;
  104034. private _isPinching;
  104035. /**
  104036. * Called on pointer POINTERMOVE event if only a single touch is active.
  104037. */
  104038. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  104039. /**
  104040. * Called on pointer POINTERDOUBLETAP event.
  104041. */
  104042. protected onDoubleTap(type: string): void;
  104043. /**
  104044. * Called on pointer POINTERMOVE event if multiple touches are active.
  104045. */
  104046. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  104047. /**
  104048. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  104049. * press.
  104050. */
  104051. protected onButtonDown(evt: PointerEvent): void;
  104052. /**
  104053. * Called each time a new POINTERUP event occurs. Ie, for each button
  104054. * release.
  104055. */
  104056. protected onButtonUp(evt: PointerEvent): void;
  104057. /**
  104058. * Called when window becomes inactive.
  104059. */
  104060. protected onLostFocus(): void;
  104061. }
  104062. }
  104063. declare module BABYLON {
  104064. /**
  104065. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  104066. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104067. */
  104068. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  104069. /**
  104070. * Defines the camera the input is attached to.
  104071. */
  104072. camera: ArcRotateCamera;
  104073. /**
  104074. * Defines the list of key codes associated with the up action (increase alpha)
  104075. */
  104076. keysUp: number[];
  104077. /**
  104078. * Defines the list of key codes associated with the down action (decrease alpha)
  104079. */
  104080. keysDown: number[];
  104081. /**
  104082. * Defines the list of key codes associated with the left action (increase beta)
  104083. */
  104084. keysLeft: number[];
  104085. /**
  104086. * Defines the list of key codes associated with the right action (decrease beta)
  104087. */
  104088. keysRight: number[];
  104089. /**
  104090. * Defines the list of key codes associated with the reset action.
  104091. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  104092. */
  104093. keysReset: number[];
  104094. /**
  104095. * Defines the panning sensibility of the inputs.
  104096. * (How fast is the camera paning)
  104097. */
  104098. panningSensibility: number;
  104099. /**
  104100. * Defines the zooming sensibility of the inputs.
  104101. * (How fast is the camera zooming)
  104102. */
  104103. zoomingSensibility: number;
  104104. /**
  104105. * Defines wether maintaining the alt key down switch the movement mode from
  104106. * orientation to zoom.
  104107. */
  104108. useAltToZoom: boolean;
  104109. /**
  104110. * Rotation speed of the camera
  104111. */
  104112. angularSpeed: number;
  104113. private _keys;
  104114. private _ctrlPressed;
  104115. private _altPressed;
  104116. private _onCanvasBlurObserver;
  104117. private _onKeyboardObserver;
  104118. private _engine;
  104119. private _scene;
  104120. /**
  104121. * Attach the input controls to a specific dom element to get the input from.
  104122. * @param element Defines the element the controls should be listened from
  104123. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104124. */
  104125. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  104126. /**
  104127. * Detach the current controls from the specified dom element.
  104128. * @param element Defines the element to stop listening the inputs from
  104129. */
  104130. detachControl(element: Nullable<HTMLElement>): void;
  104131. /**
  104132. * Update the current camera state depending on the inputs that have been used this frame.
  104133. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  104134. */
  104135. checkInputs(): void;
  104136. /**
  104137. * Gets the class name of the current intput.
  104138. * @returns the class name
  104139. */
  104140. getClassName(): string;
  104141. /**
  104142. * Get the friendly name associated with the input class.
  104143. * @returns the input friendly name
  104144. */
  104145. getSimpleName(): string;
  104146. }
  104147. }
  104148. declare module BABYLON {
  104149. /**
  104150. * Manage the mouse wheel inputs to control an arc rotate camera.
  104151. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104152. */
  104153. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  104154. /**
  104155. * Defines the camera the input is attached to.
  104156. */
  104157. camera: ArcRotateCamera;
  104158. /**
  104159. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  104160. */
  104161. wheelPrecision: number;
  104162. /**
  104163. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  104164. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  104165. */
  104166. wheelDeltaPercentage: number;
  104167. private _wheel;
  104168. private _observer;
  104169. private computeDeltaFromMouseWheelLegacyEvent;
  104170. /**
  104171. * Attach the input controls to a specific dom element to get the input from.
  104172. * @param element Defines the element the controls should be listened from
  104173. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104174. */
  104175. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  104176. /**
  104177. * Detach the current controls from the specified dom element.
  104178. * @param element Defines the element to stop listening the inputs from
  104179. */
  104180. detachControl(element: Nullable<HTMLElement>): void;
  104181. /**
  104182. * Gets the class name of the current intput.
  104183. * @returns the class name
  104184. */
  104185. getClassName(): string;
  104186. /**
  104187. * Get the friendly name associated with the input class.
  104188. * @returns the input friendly name
  104189. */
  104190. getSimpleName(): string;
  104191. }
  104192. }
  104193. declare module BABYLON {
  104194. /**
  104195. * Default Inputs manager for the ArcRotateCamera.
  104196. * It groups all the default supported inputs for ease of use.
  104197. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104198. */
  104199. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  104200. /**
  104201. * Instantiates a new ArcRotateCameraInputsManager.
  104202. * @param camera Defines the camera the inputs belong to
  104203. */
  104204. constructor(camera: ArcRotateCamera);
  104205. /**
  104206. * Add mouse wheel input support to the input manager.
  104207. * @returns the current input manager
  104208. */
  104209. addMouseWheel(): ArcRotateCameraInputsManager;
  104210. /**
  104211. * Add pointers input support to the input manager.
  104212. * @returns the current input manager
  104213. */
  104214. addPointers(): ArcRotateCameraInputsManager;
  104215. /**
  104216. * Add keyboard input support to the input manager.
  104217. * @returns the current input manager
  104218. */
  104219. addKeyboard(): ArcRotateCameraInputsManager;
  104220. }
  104221. }
  104222. declare module BABYLON {
  104223. /**
  104224. * This represents an orbital type of camera.
  104225. *
  104226. * 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.
  104227. * 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.
  104228. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  104229. */
  104230. export class ArcRotateCamera extends TargetCamera {
  104231. /**
  104232. * Defines the rotation angle of the camera along the longitudinal axis.
  104233. */
  104234. alpha: number;
  104235. /**
  104236. * Defines the rotation angle of the camera along the latitudinal axis.
  104237. */
  104238. beta: number;
  104239. /**
  104240. * Defines the radius of the camera from it s target point.
  104241. */
  104242. radius: number;
  104243. protected _target: Vector3;
  104244. protected _targetHost: Nullable<AbstractMesh>;
  104245. /**
  104246. * Defines the target point of the camera.
  104247. * The camera looks towards it form the radius distance.
  104248. */
  104249. target: Vector3;
  104250. /**
  104251. * Define the current local position of the camera in the scene
  104252. */
  104253. position: Vector3;
  104254. protected _upVector: Vector3;
  104255. protected _upToYMatrix: Matrix;
  104256. protected _YToUpMatrix: Matrix;
  104257. /**
  104258. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  104259. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  104260. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  104261. */
  104262. upVector: Vector3;
  104263. /**
  104264. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  104265. */
  104266. setMatUp(): void;
  104267. /**
  104268. * Current inertia value on the longitudinal axis.
  104269. * The bigger this number the longer it will take for the camera to stop.
  104270. */
  104271. inertialAlphaOffset: number;
  104272. /**
  104273. * Current inertia value on the latitudinal axis.
  104274. * The bigger this number the longer it will take for the camera to stop.
  104275. */
  104276. inertialBetaOffset: number;
  104277. /**
  104278. * Current inertia value on the radius axis.
  104279. * The bigger this number the longer it will take for the camera to stop.
  104280. */
  104281. inertialRadiusOffset: number;
  104282. /**
  104283. * Minimum allowed angle on the longitudinal axis.
  104284. * This can help limiting how the Camera is able to move in the scene.
  104285. */
  104286. lowerAlphaLimit: Nullable<number>;
  104287. /**
  104288. * Maximum allowed angle on the longitudinal axis.
  104289. * This can help limiting how the Camera is able to move in the scene.
  104290. */
  104291. upperAlphaLimit: Nullable<number>;
  104292. /**
  104293. * Minimum allowed angle on the latitudinal axis.
  104294. * This can help limiting how the Camera is able to move in the scene.
  104295. */
  104296. lowerBetaLimit: number;
  104297. /**
  104298. * Maximum allowed angle on the latitudinal axis.
  104299. * This can help limiting how the Camera is able to move in the scene.
  104300. */
  104301. upperBetaLimit: number;
  104302. /**
  104303. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  104304. * This can help limiting how the Camera is able to move in the scene.
  104305. */
  104306. lowerRadiusLimit: Nullable<number>;
  104307. /**
  104308. * Maximum allowed distance of the camera to the target (The camera can not get further).
  104309. * This can help limiting how the Camera is able to move in the scene.
  104310. */
  104311. upperRadiusLimit: Nullable<number>;
  104312. /**
  104313. * Defines the current inertia value used during panning of the camera along the X axis.
  104314. */
  104315. inertialPanningX: number;
  104316. /**
  104317. * Defines the current inertia value used during panning of the camera along the Y axis.
  104318. */
  104319. inertialPanningY: number;
  104320. /**
  104321. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  104322. * Basically if your fingers moves away from more than this distance you will be considered
  104323. * in pinch mode.
  104324. */
  104325. pinchToPanMaxDistance: number;
  104326. /**
  104327. * Defines the maximum distance the camera can pan.
  104328. * This could help keeping the cammera always in your scene.
  104329. */
  104330. panningDistanceLimit: Nullable<number>;
  104331. /**
  104332. * Defines the target of the camera before paning.
  104333. */
  104334. panningOriginTarget: Vector3;
  104335. /**
  104336. * Defines the value of the inertia used during panning.
  104337. * 0 would mean stop inertia and one would mean no decelleration at all.
  104338. */
  104339. panningInertia: number;
  104340. /**
  104341. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  104342. */
  104343. angularSensibilityX: number;
  104344. /**
  104345. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  104346. */
  104347. angularSensibilityY: number;
  104348. /**
  104349. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  104350. */
  104351. pinchPrecision: number;
  104352. /**
  104353. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  104354. * It will be used instead of pinchDeltaPrecision if different from 0.
  104355. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  104356. */
  104357. pinchDeltaPercentage: number;
  104358. /**
  104359. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  104360. */
  104361. panningSensibility: number;
  104362. /**
  104363. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  104364. */
  104365. keysUp: number[];
  104366. /**
  104367. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  104368. */
  104369. keysDown: number[];
  104370. /**
  104371. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  104372. */
  104373. keysLeft: number[];
  104374. /**
  104375. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  104376. */
  104377. keysRight: number[];
  104378. /**
  104379. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  104380. */
  104381. wheelPrecision: number;
  104382. /**
  104383. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  104384. * It will be used instead of pinchDeltaPrecision if different from 0.
  104385. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  104386. */
  104387. wheelDeltaPercentage: number;
  104388. /**
  104389. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  104390. */
  104391. zoomOnFactor: number;
  104392. /**
  104393. * Defines a screen offset for the camera position.
  104394. */
  104395. targetScreenOffset: Vector2;
  104396. /**
  104397. * Allows the camera to be completely reversed.
  104398. * If false the camera can not arrive upside down.
  104399. */
  104400. allowUpsideDown: boolean;
  104401. /**
  104402. * Define if double tap/click is used to restore the previously saved state of the camera.
  104403. */
  104404. useInputToRestoreState: boolean;
  104405. /** @hidden */
  104406. _viewMatrix: Matrix;
  104407. /** @hidden */
  104408. _useCtrlForPanning: boolean;
  104409. /** @hidden */
  104410. _panningMouseButton: number;
  104411. /**
  104412. * Defines the input associated to the camera.
  104413. */
  104414. inputs: ArcRotateCameraInputsManager;
  104415. /** @hidden */
  104416. _reset: () => void;
  104417. /**
  104418. * Defines the allowed panning axis.
  104419. */
  104420. panningAxis: Vector3;
  104421. protected _localDirection: Vector3;
  104422. protected _transformedDirection: Vector3;
  104423. private _bouncingBehavior;
  104424. /**
  104425. * Gets the bouncing behavior of the camera if it has been enabled.
  104426. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  104427. */
  104428. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  104429. /**
  104430. * Defines if the bouncing behavior of the camera is enabled on the camera.
  104431. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  104432. */
  104433. useBouncingBehavior: boolean;
  104434. private _framingBehavior;
  104435. /**
  104436. * Gets the framing behavior of the camera if it has been enabled.
  104437. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  104438. */
  104439. readonly framingBehavior: Nullable<FramingBehavior>;
  104440. /**
  104441. * Defines if the framing behavior of the camera is enabled on the camera.
  104442. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  104443. */
  104444. useFramingBehavior: boolean;
  104445. private _autoRotationBehavior;
  104446. /**
  104447. * Gets the auto rotation behavior of the camera if it has been enabled.
  104448. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  104449. */
  104450. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  104451. /**
  104452. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  104453. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  104454. */
  104455. useAutoRotationBehavior: boolean;
  104456. /**
  104457. * Observable triggered when the mesh target has been changed on the camera.
  104458. */
  104459. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  104460. /**
  104461. * Event raised when the camera is colliding with a mesh.
  104462. */
  104463. onCollide: (collidedMesh: AbstractMesh) => void;
  104464. /**
  104465. * Defines whether the camera should check collision with the objects oh the scene.
  104466. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  104467. */
  104468. checkCollisions: boolean;
  104469. /**
  104470. * Defines the collision radius of the camera.
  104471. * This simulates a sphere around the camera.
  104472. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  104473. */
  104474. collisionRadius: Vector3;
  104475. protected _collider: Collider;
  104476. protected _previousPosition: Vector3;
  104477. protected _collisionVelocity: Vector3;
  104478. protected _newPosition: Vector3;
  104479. protected _previousAlpha: number;
  104480. protected _previousBeta: number;
  104481. protected _previousRadius: number;
  104482. protected _collisionTriggered: boolean;
  104483. protected _targetBoundingCenter: Nullable<Vector3>;
  104484. private _computationVector;
  104485. /**
  104486. * Instantiates a new ArcRotateCamera in a given scene
  104487. * @param name Defines the name of the camera
  104488. * @param alpha Defines the camera rotation along the logitudinal axis
  104489. * @param beta Defines the camera rotation along the latitudinal axis
  104490. * @param radius Defines the camera distance from its target
  104491. * @param target Defines the camera target
  104492. * @param scene Defines the scene the camera belongs to
  104493. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  104494. */
  104495. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  104496. /** @hidden */
  104497. _initCache(): void;
  104498. /** @hidden */
  104499. _updateCache(ignoreParentClass?: boolean): void;
  104500. protected _getTargetPosition(): Vector3;
  104501. private _storedAlpha;
  104502. private _storedBeta;
  104503. private _storedRadius;
  104504. private _storedTarget;
  104505. private _storedTargetScreenOffset;
  104506. /**
  104507. * Stores the current state of the camera (alpha, beta, radius and target)
  104508. * @returns the camera itself
  104509. */
  104510. storeState(): Camera;
  104511. /**
  104512. * @hidden
  104513. * Restored camera state. You must call storeState() first
  104514. */
  104515. _restoreStateValues(): boolean;
  104516. /** @hidden */
  104517. _isSynchronizedViewMatrix(): boolean;
  104518. /**
  104519. * Attached controls to the current camera.
  104520. * @param element Defines the element the controls should be listened from
  104521. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104522. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  104523. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  104524. */
  104525. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  104526. /**
  104527. * Detach the current controls from the camera.
  104528. * The camera will stop reacting to inputs.
  104529. * @param element Defines the element to stop listening the inputs from
  104530. */
  104531. detachControl(element: HTMLElement): void;
  104532. /** @hidden */
  104533. _checkInputs(): void;
  104534. protected _checkLimits(): void;
  104535. /**
  104536. * Rebuilds angles (alpha, beta) and radius from the give position and target
  104537. */
  104538. rebuildAnglesAndRadius(): void;
  104539. /**
  104540. * Use a position to define the current camera related information like alpha, beta and radius
  104541. * @param position Defines the position to set the camera at
  104542. */
  104543. setPosition(position: Vector3): void;
  104544. /**
  104545. * Defines the target the camera should look at.
  104546. * This will automatically adapt alpha beta and radius to fit within the new target.
  104547. * @param target Defines the new target as a Vector or a mesh
  104548. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  104549. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  104550. */
  104551. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  104552. /** @hidden */
  104553. _getViewMatrix(): Matrix;
  104554. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  104555. /**
  104556. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  104557. * @param meshes Defines the mesh to zoom on
  104558. * @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)
  104559. */
  104560. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  104561. /**
  104562. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  104563. * The target will be changed but the radius
  104564. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  104565. * @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)
  104566. */
  104567. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  104568. min: Vector3;
  104569. max: Vector3;
  104570. distance: number;
  104571. }, doNotUpdateMaxZ?: boolean): void;
  104572. /**
  104573. * @override
  104574. * Override Camera.createRigCamera
  104575. */
  104576. createRigCamera(name: string, cameraIndex: number): Camera;
  104577. /**
  104578. * @hidden
  104579. * @override
  104580. * Override Camera._updateRigCameras
  104581. */
  104582. _updateRigCameras(): void;
  104583. /**
  104584. * Destroy the camera and release the current resources hold by it.
  104585. */
  104586. dispose(): void;
  104587. /**
  104588. * Gets the current object class name.
  104589. * @return the class name
  104590. */
  104591. getClassName(): string;
  104592. }
  104593. }
  104594. declare module BABYLON {
  104595. /**
  104596. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  104597. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  104598. */
  104599. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  104600. /**
  104601. * Gets the name of the behavior.
  104602. */
  104603. readonly name: string;
  104604. private _zoomStopsAnimation;
  104605. private _idleRotationSpeed;
  104606. private _idleRotationWaitTime;
  104607. private _idleRotationSpinupTime;
  104608. /**
  104609. * Sets the flag that indicates if user zooming should stop animation.
  104610. */
  104611. /**
  104612. * Gets the flag that indicates if user zooming should stop animation.
  104613. */
  104614. zoomStopsAnimation: boolean;
  104615. /**
  104616. * Sets the default speed at which the camera rotates around the model.
  104617. */
  104618. /**
  104619. * Gets the default speed at which the camera rotates around the model.
  104620. */
  104621. idleRotationSpeed: number;
  104622. /**
  104623. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  104624. */
  104625. /**
  104626. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  104627. */
  104628. idleRotationWaitTime: number;
  104629. /**
  104630. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  104631. */
  104632. /**
  104633. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  104634. */
  104635. idleRotationSpinupTime: number;
  104636. /**
  104637. * Gets a value indicating if the camera is currently rotating because of this behavior
  104638. */
  104639. readonly rotationInProgress: boolean;
  104640. private _onPrePointerObservableObserver;
  104641. private _onAfterCheckInputsObserver;
  104642. private _attachedCamera;
  104643. private _isPointerDown;
  104644. private _lastFrameTime;
  104645. private _lastInteractionTime;
  104646. private _cameraRotationSpeed;
  104647. /**
  104648. * Initializes the behavior.
  104649. */
  104650. init(): void;
  104651. /**
  104652. * Attaches the behavior to its arc rotate camera.
  104653. * @param camera Defines the camera to attach the behavior to
  104654. */
  104655. attach(camera: ArcRotateCamera): void;
  104656. /**
  104657. * Detaches the behavior from its current arc rotate camera.
  104658. */
  104659. detach(): void;
  104660. /**
  104661. * Returns true if user is scrolling.
  104662. * @return true if user is scrolling.
  104663. */
  104664. private _userIsZooming;
  104665. private _lastFrameRadius;
  104666. private _shouldAnimationStopForInteraction;
  104667. /**
  104668. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  104669. */
  104670. private _applyUserInteraction;
  104671. private _userIsMoving;
  104672. }
  104673. }
  104674. declare module BABYLON {
  104675. /**
  104676. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  104677. */
  104678. export class AttachToBoxBehavior implements Behavior<Mesh> {
  104679. private ui;
  104680. /**
  104681. * The name of the behavior
  104682. */
  104683. name: string;
  104684. /**
  104685. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  104686. */
  104687. distanceAwayFromFace: number;
  104688. /**
  104689. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  104690. */
  104691. distanceAwayFromBottomOfFace: number;
  104692. private _faceVectors;
  104693. private _target;
  104694. private _scene;
  104695. private _onRenderObserver;
  104696. private _tmpMatrix;
  104697. private _tmpVector;
  104698. /**
  104699. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  104700. * @param ui The transform node that should be attched to the mesh
  104701. */
  104702. constructor(ui: TransformNode);
  104703. /**
  104704. * Initializes the behavior
  104705. */
  104706. init(): void;
  104707. private _closestFace;
  104708. private _zeroVector;
  104709. private _lookAtTmpMatrix;
  104710. private _lookAtToRef;
  104711. /**
  104712. * Attaches the AttachToBoxBehavior to the passed in mesh
  104713. * @param target The mesh that the specified node will be attached to
  104714. */
  104715. attach(target: Mesh): void;
  104716. /**
  104717. * Detaches the behavior from the mesh
  104718. */
  104719. detach(): void;
  104720. }
  104721. }
  104722. declare module BABYLON {
  104723. /**
  104724. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  104725. */
  104726. export class FadeInOutBehavior implements Behavior<Mesh> {
  104727. /**
  104728. * Time in milliseconds to delay before fading in (Default: 0)
  104729. */
  104730. delay: number;
  104731. /**
  104732. * Time in milliseconds for the mesh to fade in (Default: 300)
  104733. */
  104734. fadeInTime: number;
  104735. private _millisecondsPerFrame;
  104736. private _hovered;
  104737. private _hoverValue;
  104738. private _ownerNode;
  104739. /**
  104740. * Instatiates the FadeInOutBehavior
  104741. */
  104742. constructor();
  104743. /**
  104744. * The name of the behavior
  104745. */
  104746. readonly name: string;
  104747. /**
  104748. * Initializes the behavior
  104749. */
  104750. init(): void;
  104751. /**
  104752. * Attaches the fade behavior on the passed in mesh
  104753. * @param ownerNode The mesh that will be faded in/out once attached
  104754. */
  104755. attach(ownerNode: Mesh): void;
  104756. /**
  104757. * Detaches the behavior from the mesh
  104758. */
  104759. detach(): void;
  104760. /**
  104761. * Triggers the mesh to begin fading in or out
  104762. * @param value if the object should fade in or out (true to fade in)
  104763. */
  104764. fadeIn(value: boolean): void;
  104765. private _update;
  104766. private _setAllVisibility;
  104767. }
  104768. }
  104769. declare module BABYLON {
  104770. /**
  104771. * Class containing a set of static utilities functions for managing Pivots
  104772. * @hidden
  104773. */
  104774. export class PivotTools {
  104775. private static _PivotCached;
  104776. private static _OldPivotPoint;
  104777. private static _PivotTranslation;
  104778. private static _PivotTmpVector;
  104779. /** @hidden */
  104780. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  104781. /** @hidden */
  104782. static _RestorePivotPoint(mesh: AbstractMesh): void;
  104783. }
  104784. }
  104785. declare module BABYLON {
  104786. /**
  104787. * Class containing static functions to help procedurally build meshes
  104788. */
  104789. export class PlaneBuilder {
  104790. /**
  104791. * Creates a plane mesh
  104792. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  104793. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  104794. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  104795. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  104796. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  104797. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  104798. * @param name defines the name of the mesh
  104799. * @param options defines the options used to create the mesh
  104800. * @param scene defines the hosting scene
  104801. * @returns the plane mesh
  104802. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  104803. */
  104804. static CreatePlane(name: string, options: {
  104805. size?: number;
  104806. width?: number;
  104807. height?: number;
  104808. sideOrientation?: number;
  104809. frontUVs?: Vector4;
  104810. backUVs?: Vector4;
  104811. updatable?: boolean;
  104812. sourcePlane?: Plane;
  104813. }, scene?: Nullable<Scene>): Mesh;
  104814. }
  104815. }
  104816. declare module BABYLON {
  104817. /**
  104818. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  104819. */
  104820. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  104821. private static _AnyMouseID;
  104822. /**
  104823. * Abstract mesh the behavior is set on
  104824. */
  104825. attachedNode: AbstractMesh;
  104826. private _dragPlane;
  104827. private _scene;
  104828. private _pointerObserver;
  104829. private _beforeRenderObserver;
  104830. private static _planeScene;
  104831. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  104832. /**
  104833. * 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)
  104834. */
  104835. maxDragAngle: number;
  104836. /**
  104837. * @hidden
  104838. */
  104839. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  104840. /**
  104841. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  104842. */
  104843. currentDraggingPointerID: number;
  104844. /**
  104845. * The last position where the pointer hit the drag plane in world space
  104846. */
  104847. lastDragPosition: Vector3;
  104848. /**
  104849. * If the behavior is currently in a dragging state
  104850. */
  104851. dragging: boolean;
  104852. /**
  104853. * 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)
  104854. */
  104855. dragDeltaRatio: number;
  104856. /**
  104857. * If the drag plane orientation should be updated during the dragging (Default: true)
  104858. */
  104859. updateDragPlane: boolean;
  104860. private _debugMode;
  104861. private _moving;
  104862. /**
  104863. * Fires each time the attached mesh is dragged with the pointer
  104864. * * delta between last drag position and current drag position in world space
  104865. * * dragDistance along the drag axis
  104866. * * dragPlaneNormal normal of the current drag plane used during the drag
  104867. * * dragPlanePoint in world space where the drag intersects the drag plane
  104868. */
  104869. onDragObservable: Observable<{
  104870. delta: Vector3;
  104871. dragPlanePoint: Vector3;
  104872. dragPlaneNormal: Vector3;
  104873. dragDistance: number;
  104874. pointerId: number;
  104875. }>;
  104876. /**
  104877. * Fires each time a drag begins (eg. mouse down on mesh)
  104878. */
  104879. onDragStartObservable: Observable<{
  104880. dragPlanePoint: Vector3;
  104881. pointerId: number;
  104882. }>;
  104883. /**
  104884. * Fires each time a drag ends (eg. mouse release after drag)
  104885. */
  104886. onDragEndObservable: Observable<{
  104887. dragPlanePoint: Vector3;
  104888. pointerId: number;
  104889. }>;
  104890. /**
  104891. * If the attached mesh should be moved when dragged
  104892. */
  104893. moveAttached: boolean;
  104894. /**
  104895. * If the drag behavior will react to drag events (Default: true)
  104896. */
  104897. enabled: boolean;
  104898. /**
  104899. * If pointer events should start and release the drag (Default: true)
  104900. */
  104901. startAndReleaseDragOnPointerEvents: boolean;
  104902. /**
  104903. * If camera controls should be detached during the drag
  104904. */
  104905. detachCameraControls: boolean;
  104906. /**
  104907. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  104908. */
  104909. useObjectOrienationForDragging: boolean;
  104910. private _options;
  104911. /**
  104912. * Creates a pointer drag behavior that can be attached to a mesh
  104913. * @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)
  104914. */
  104915. constructor(options?: {
  104916. dragAxis?: Vector3;
  104917. dragPlaneNormal?: Vector3;
  104918. });
  104919. /**
  104920. * Predicate to determine if it is valid to move the object to a new position when it is moved
  104921. */
  104922. validateDrag: (targetPosition: Vector3) => boolean;
  104923. /**
  104924. * The name of the behavior
  104925. */
  104926. readonly name: string;
  104927. /**
  104928. * Initializes the behavior
  104929. */
  104930. init(): void;
  104931. private _tmpVector;
  104932. private _alternatePickedPoint;
  104933. private _worldDragAxis;
  104934. private _targetPosition;
  104935. private _attachedElement;
  104936. /**
  104937. * Attaches the drag behavior the passed in mesh
  104938. * @param ownerNode The mesh that will be dragged around once attached
  104939. * @param predicate Predicate to use for pick filtering
  104940. */
  104941. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  104942. /**
  104943. * Force relase the drag action by code.
  104944. */
  104945. releaseDrag(): void;
  104946. private _startDragRay;
  104947. private _lastPointerRay;
  104948. /**
  104949. * Simulates the start of a pointer drag event on the behavior
  104950. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  104951. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  104952. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  104953. */
  104954. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  104955. private _startDrag;
  104956. private _dragDelta;
  104957. private _moveDrag;
  104958. private _pickWithRayOnDragPlane;
  104959. private _pointA;
  104960. private _pointB;
  104961. private _pointC;
  104962. private _lineA;
  104963. private _lineB;
  104964. private _localAxis;
  104965. private _lookAt;
  104966. private _updateDragPlanePosition;
  104967. /**
  104968. * Detaches the behavior from the mesh
  104969. */
  104970. detach(): void;
  104971. }
  104972. }
  104973. declare module BABYLON {
  104974. /**
  104975. * A behavior that when attached to a mesh will allow the mesh to be scaled
  104976. */
  104977. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  104978. private _dragBehaviorA;
  104979. private _dragBehaviorB;
  104980. private _startDistance;
  104981. private _initialScale;
  104982. private _targetScale;
  104983. private _ownerNode;
  104984. private _sceneRenderObserver;
  104985. /**
  104986. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  104987. */
  104988. constructor();
  104989. /**
  104990. * The name of the behavior
  104991. */
  104992. readonly name: string;
  104993. /**
  104994. * Initializes the behavior
  104995. */
  104996. init(): void;
  104997. private _getCurrentDistance;
  104998. /**
  104999. * Attaches the scale behavior the passed in mesh
  105000. * @param ownerNode The mesh that will be scaled around once attached
  105001. */
  105002. attach(ownerNode: Mesh): void;
  105003. /**
  105004. * Detaches the behavior from the mesh
  105005. */
  105006. detach(): void;
  105007. }
  105008. }
  105009. declare module BABYLON {
  105010. /**
  105011. * 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
  105012. */
  105013. export class SixDofDragBehavior implements Behavior<Mesh> {
  105014. private static _virtualScene;
  105015. private _ownerNode;
  105016. private _sceneRenderObserver;
  105017. private _scene;
  105018. private _targetPosition;
  105019. private _virtualOriginMesh;
  105020. private _virtualDragMesh;
  105021. private _pointerObserver;
  105022. private _moving;
  105023. private _startingOrientation;
  105024. /**
  105025. * 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)
  105026. */
  105027. private zDragFactor;
  105028. /**
  105029. * If the object should rotate to face the drag origin
  105030. */
  105031. rotateDraggedObject: boolean;
  105032. /**
  105033. * If the behavior is currently in a dragging state
  105034. */
  105035. dragging: boolean;
  105036. /**
  105037. * 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)
  105038. */
  105039. dragDeltaRatio: number;
  105040. /**
  105041. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  105042. */
  105043. currentDraggingPointerID: number;
  105044. /**
  105045. * If camera controls should be detached during the drag
  105046. */
  105047. detachCameraControls: boolean;
  105048. /**
  105049. * Fires each time a drag starts
  105050. */
  105051. onDragStartObservable: Observable<{}>;
  105052. /**
  105053. * Fires each time a drag ends (eg. mouse release after drag)
  105054. */
  105055. onDragEndObservable: Observable<{}>;
  105056. /**
  105057. * 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
  105058. */
  105059. constructor();
  105060. /**
  105061. * The name of the behavior
  105062. */
  105063. readonly name: string;
  105064. /**
  105065. * Initializes the behavior
  105066. */
  105067. init(): void;
  105068. /**
  105069. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  105070. */
  105071. private readonly _pointerCamera;
  105072. /**
  105073. * Attaches the scale behavior the passed in mesh
  105074. * @param ownerNode The mesh that will be scaled around once attached
  105075. */
  105076. attach(ownerNode: Mesh): void;
  105077. /**
  105078. * Detaches the behavior from the mesh
  105079. */
  105080. detach(): void;
  105081. }
  105082. }
  105083. declare module BABYLON {
  105084. /**
  105085. * Class used to apply inverse kinematics to bones
  105086. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  105087. */
  105088. export class BoneIKController {
  105089. private static _tmpVecs;
  105090. private static _tmpQuat;
  105091. private static _tmpMats;
  105092. /**
  105093. * Gets or sets the target mesh
  105094. */
  105095. targetMesh: AbstractMesh;
  105096. /** Gets or sets the mesh used as pole */
  105097. poleTargetMesh: AbstractMesh;
  105098. /**
  105099. * Gets or sets the bone used as pole
  105100. */
  105101. poleTargetBone: Nullable<Bone>;
  105102. /**
  105103. * Gets or sets the target position
  105104. */
  105105. targetPosition: Vector3;
  105106. /**
  105107. * Gets or sets the pole target position
  105108. */
  105109. poleTargetPosition: Vector3;
  105110. /**
  105111. * Gets or sets the pole target local offset
  105112. */
  105113. poleTargetLocalOffset: Vector3;
  105114. /**
  105115. * Gets or sets the pole angle
  105116. */
  105117. poleAngle: number;
  105118. /**
  105119. * Gets or sets the mesh associated with the controller
  105120. */
  105121. mesh: AbstractMesh;
  105122. /**
  105123. * 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)
  105124. */
  105125. slerpAmount: number;
  105126. private _bone1Quat;
  105127. private _bone1Mat;
  105128. private _bone2Ang;
  105129. private _bone1;
  105130. private _bone2;
  105131. private _bone1Length;
  105132. private _bone2Length;
  105133. private _maxAngle;
  105134. private _maxReach;
  105135. private _rightHandedSystem;
  105136. private _bendAxis;
  105137. private _slerping;
  105138. private _adjustRoll;
  105139. /**
  105140. * Gets or sets maximum allowed angle
  105141. */
  105142. maxAngle: number;
  105143. /**
  105144. * Creates a new BoneIKController
  105145. * @param mesh defines the mesh to control
  105146. * @param bone defines the bone to control
  105147. * @param options defines options to set up the controller
  105148. */
  105149. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  105150. targetMesh?: AbstractMesh;
  105151. poleTargetMesh?: AbstractMesh;
  105152. poleTargetBone?: Bone;
  105153. poleTargetLocalOffset?: Vector3;
  105154. poleAngle?: number;
  105155. bendAxis?: Vector3;
  105156. maxAngle?: number;
  105157. slerpAmount?: number;
  105158. });
  105159. private _setMaxAngle;
  105160. /**
  105161. * Force the controller to update the bones
  105162. */
  105163. update(): void;
  105164. }
  105165. }
  105166. declare module BABYLON {
  105167. /**
  105168. * Class used to make a bone look toward a point in space
  105169. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  105170. */
  105171. export class BoneLookController {
  105172. private static _tmpVecs;
  105173. private static _tmpQuat;
  105174. private static _tmpMats;
  105175. /**
  105176. * The target Vector3 that the bone will look at
  105177. */
  105178. target: Vector3;
  105179. /**
  105180. * The mesh that the bone is attached to
  105181. */
  105182. mesh: AbstractMesh;
  105183. /**
  105184. * The bone that will be looking to the target
  105185. */
  105186. bone: Bone;
  105187. /**
  105188. * The up axis of the coordinate system that is used when the bone is rotated
  105189. */
  105190. upAxis: Vector3;
  105191. /**
  105192. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  105193. */
  105194. upAxisSpace: Space;
  105195. /**
  105196. * Used to make an adjustment to the yaw of the bone
  105197. */
  105198. adjustYaw: number;
  105199. /**
  105200. * Used to make an adjustment to the pitch of the bone
  105201. */
  105202. adjustPitch: number;
  105203. /**
  105204. * Used to make an adjustment to the roll of the bone
  105205. */
  105206. adjustRoll: number;
  105207. /**
  105208. * 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)
  105209. */
  105210. slerpAmount: number;
  105211. private _minYaw;
  105212. private _maxYaw;
  105213. private _minPitch;
  105214. private _maxPitch;
  105215. private _minYawSin;
  105216. private _minYawCos;
  105217. private _maxYawSin;
  105218. private _maxYawCos;
  105219. private _midYawConstraint;
  105220. private _minPitchTan;
  105221. private _maxPitchTan;
  105222. private _boneQuat;
  105223. private _slerping;
  105224. private _transformYawPitch;
  105225. private _transformYawPitchInv;
  105226. private _firstFrameSkipped;
  105227. private _yawRange;
  105228. private _fowardAxis;
  105229. /**
  105230. * Gets or sets the minimum yaw angle that the bone can look to
  105231. */
  105232. minYaw: number;
  105233. /**
  105234. * Gets or sets the maximum yaw angle that the bone can look to
  105235. */
  105236. maxYaw: number;
  105237. /**
  105238. * Gets or sets the minimum pitch angle that the bone can look to
  105239. */
  105240. minPitch: number;
  105241. /**
  105242. * Gets or sets the maximum pitch angle that the bone can look to
  105243. */
  105244. maxPitch: number;
  105245. /**
  105246. * Create a BoneLookController
  105247. * @param mesh the mesh that the bone belongs to
  105248. * @param bone the bone that will be looking to the target
  105249. * @param target the target Vector3 to look at
  105250. * @param options optional settings:
  105251. * * maxYaw: the maximum angle the bone will yaw to
  105252. * * minYaw: the minimum angle the bone will yaw to
  105253. * * maxPitch: the maximum angle the bone will pitch to
  105254. * * minPitch: the minimum angle the bone will yaw to
  105255. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  105256. * * upAxis: the up axis of the coordinate system
  105257. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  105258. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  105259. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  105260. * * adjustYaw: used to make an adjustment to the yaw of the bone
  105261. * * adjustPitch: used to make an adjustment to the pitch of the bone
  105262. * * adjustRoll: used to make an adjustment to the roll of the bone
  105263. **/
  105264. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  105265. maxYaw?: number;
  105266. minYaw?: number;
  105267. maxPitch?: number;
  105268. minPitch?: number;
  105269. slerpAmount?: number;
  105270. upAxis?: Vector3;
  105271. upAxisSpace?: Space;
  105272. yawAxis?: Vector3;
  105273. pitchAxis?: Vector3;
  105274. adjustYaw?: number;
  105275. adjustPitch?: number;
  105276. adjustRoll?: number;
  105277. });
  105278. /**
  105279. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  105280. */
  105281. update(): void;
  105282. private _getAngleDiff;
  105283. private _getAngleBetween;
  105284. private _isAngleBetween;
  105285. }
  105286. }
  105287. declare module BABYLON {
  105288. /**
  105289. * Manage the gamepad inputs to control an arc rotate camera.
  105290. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105291. */
  105292. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  105293. /**
  105294. * Defines the camera the input is attached to.
  105295. */
  105296. camera: ArcRotateCamera;
  105297. /**
  105298. * Defines the gamepad the input is gathering event from.
  105299. */
  105300. gamepad: Nullable<Gamepad>;
  105301. /**
  105302. * Defines the gamepad rotation sensiblity.
  105303. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  105304. */
  105305. gamepadRotationSensibility: number;
  105306. /**
  105307. * Defines the gamepad move sensiblity.
  105308. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  105309. */
  105310. gamepadMoveSensibility: number;
  105311. private _yAxisScale;
  105312. /**
  105313. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  105314. */
  105315. invertYAxis: boolean;
  105316. private _onGamepadConnectedObserver;
  105317. private _onGamepadDisconnectedObserver;
  105318. /**
  105319. * Attach the input controls to a specific dom element to get the input from.
  105320. * @param element Defines the element the controls should be listened from
  105321. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105322. */
  105323. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105324. /**
  105325. * Detach the current controls from the specified dom element.
  105326. * @param element Defines the element to stop listening the inputs from
  105327. */
  105328. detachControl(element: Nullable<HTMLElement>): void;
  105329. /**
  105330. * Update the current camera state depending on the inputs that have been used this frame.
  105331. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  105332. */
  105333. checkInputs(): void;
  105334. /**
  105335. * Gets the class name of the current intput.
  105336. * @returns the class name
  105337. */
  105338. getClassName(): string;
  105339. /**
  105340. * Get the friendly name associated with the input class.
  105341. * @returns the input friendly name
  105342. */
  105343. getSimpleName(): string;
  105344. }
  105345. }
  105346. declare module BABYLON {
  105347. interface ArcRotateCameraInputsManager {
  105348. /**
  105349. * Add orientation input support to the input manager.
  105350. * @returns the current input manager
  105351. */
  105352. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  105353. }
  105354. /**
  105355. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  105356. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105357. */
  105358. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  105359. /**
  105360. * Defines the camera the input is attached to.
  105361. */
  105362. camera: ArcRotateCamera;
  105363. /**
  105364. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  105365. */
  105366. alphaCorrection: number;
  105367. /**
  105368. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  105369. */
  105370. gammaCorrection: number;
  105371. private _alpha;
  105372. private _gamma;
  105373. private _dirty;
  105374. private _deviceOrientationHandler;
  105375. /**
  105376. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  105377. */
  105378. constructor();
  105379. /**
  105380. * Attach the input controls to a specific dom element to get the input from.
  105381. * @param element Defines the element the controls should be listened from
  105382. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105383. */
  105384. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105385. /** @hidden */
  105386. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  105387. /**
  105388. * Update the current camera state depending on the inputs that have been used this frame.
  105389. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  105390. */
  105391. checkInputs(): void;
  105392. /**
  105393. * Detach the current controls from the specified dom element.
  105394. * @param element Defines the element to stop listening the inputs from
  105395. */
  105396. detachControl(element: Nullable<HTMLElement>): void;
  105397. /**
  105398. * Gets the class name of the current intput.
  105399. * @returns the class name
  105400. */
  105401. getClassName(): string;
  105402. /**
  105403. * Get the friendly name associated with the input class.
  105404. * @returns the input friendly name
  105405. */
  105406. getSimpleName(): string;
  105407. }
  105408. }
  105409. declare module BABYLON {
  105410. /**
  105411. * Listen to mouse events to control the camera.
  105412. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105413. */
  105414. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  105415. /**
  105416. * Defines the camera the input is attached to.
  105417. */
  105418. camera: FlyCamera;
  105419. /**
  105420. * Defines if touch is enabled. (Default is true.)
  105421. */
  105422. touchEnabled: boolean;
  105423. /**
  105424. * Defines the buttons associated with the input to handle camera rotation.
  105425. */
  105426. buttons: number[];
  105427. /**
  105428. * Assign buttons for Yaw control.
  105429. */
  105430. buttonsYaw: number[];
  105431. /**
  105432. * Assign buttons for Pitch control.
  105433. */
  105434. buttonsPitch: number[];
  105435. /**
  105436. * Assign buttons for Roll control.
  105437. */
  105438. buttonsRoll: number[];
  105439. /**
  105440. * Detect if any button is being pressed while mouse is moved.
  105441. * -1 = Mouse locked.
  105442. * 0 = Left button.
  105443. * 1 = Middle Button.
  105444. * 2 = Right Button.
  105445. */
  105446. activeButton: number;
  105447. /**
  105448. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  105449. * Higher values reduce its sensitivity.
  105450. */
  105451. angularSensibility: number;
  105452. private _mousemoveCallback;
  105453. private _observer;
  105454. private _rollObserver;
  105455. private previousPosition;
  105456. private noPreventDefault;
  105457. private element;
  105458. /**
  105459. * Listen to mouse events to control the camera.
  105460. * @param touchEnabled Define if touch is enabled. (Default is true.)
  105461. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105462. */
  105463. constructor(touchEnabled?: boolean);
  105464. /**
  105465. * Attach the mouse control to the HTML DOM element.
  105466. * @param element Defines the element that listens to the input events.
  105467. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  105468. */
  105469. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105470. /**
  105471. * Detach the current controls from the specified dom element.
  105472. * @param element Defines the element to stop listening the inputs from
  105473. */
  105474. detachControl(element: Nullable<HTMLElement>): void;
  105475. /**
  105476. * Gets the class name of the current input.
  105477. * @returns the class name.
  105478. */
  105479. getClassName(): string;
  105480. /**
  105481. * Get the friendly name associated with the input class.
  105482. * @returns the input's friendly name.
  105483. */
  105484. getSimpleName(): string;
  105485. private _pointerInput;
  105486. private _onMouseMove;
  105487. /**
  105488. * Rotate camera by mouse offset.
  105489. */
  105490. private rotateCamera;
  105491. }
  105492. }
  105493. declare module BABYLON {
  105494. /**
  105495. * Default Inputs manager for the FlyCamera.
  105496. * It groups all the default supported inputs for ease of use.
  105497. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105498. */
  105499. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  105500. /**
  105501. * Instantiates a new FlyCameraInputsManager.
  105502. * @param camera Defines the camera the inputs belong to.
  105503. */
  105504. constructor(camera: FlyCamera);
  105505. /**
  105506. * Add keyboard input support to the input manager.
  105507. * @returns the new FlyCameraKeyboardMoveInput().
  105508. */
  105509. addKeyboard(): FlyCameraInputsManager;
  105510. /**
  105511. * Add mouse input support to the input manager.
  105512. * @param touchEnabled Enable touch screen support.
  105513. * @returns the new FlyCameraMouseInput().
  105514. */
  105515. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  105516. }
  105517. }
  105518. declare module BABYLON {
  105519. /**
  105520. * This is a flying camera, designed for 3D movement and rotation in all directions,
  105521. * such as in a 3D Space Shooter or a Flight Simulator.
  105522. */
  105523. export class FlyCamera extends TargetCamera {
  105524. /**
  105525. * Define the collision ellipsoid of the camera.
  105526. * This is helpful for simulating a camera body, like a player's body.
  105527. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  105528. */
  105529. ellipsoid: Vector3;
  105530. /**
  105531. * Define an offset for the position of the ellipsoid around the camera.
  105532. * This can be helpful if the camera is attached away from the player's body center,
  105533. * such as at its head.
  105534. */
  105535. ellipsoidOffset: Vector3;
  105536. /**
  105537. * Enable or disable collisions of the camera with the rest of the scene objects.
  105538. */
  105539. checkCollisions: boolean;
  105540. /**
  105541. * Enable or disable gravity on the camera.
  105542. */
  105543. applyGravity: boolean;
  105544. /**
  105545. * Define the current direction the camera is moving to.
  105546. */
  105547. cameraDirection: Vector3;
  105548. /**
  105549. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  105550. * This overrides and empties cameraRotation.
  105551. */
  105552. rotationQuaternion: Quaternion;
  105553. /**
  105554. * Track Roll to maintain the wanted Rolling when looking around.
  105555. */
  105556. _trackRoll: number;
  105557. /**
  105558. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  105559. */
  105560. rollCorrect: number;
  105561. /**
  105562. * Mimic a banked turn, Rolling the camera when Yawing.
  105563. * It's recommended to use rollCorrect = 10 for faster banking correction.
  105564. */
  105565. bankedTurn: boolean;
  105566. /**
  105567. * Limit in radians for how much Roll banking will add. (Default: 90°)
  105568. */
  105569. bankedTurnLimit: number;
  105570. /**
  105571. * Value of 0 disables the banked Roll.
  105572. * Value of 1 is equal to the Yaw angle in radians.
  105573. */
  105574. bankedTurnMultiplier: number;
  105575. /**
  105576. * The inputs manager loads all the input sources, such as keyboard and mouse.
  105577. */
  105578. inputs: FlyCameraInputsManager;
  105579. /**
  105580. * Gets the input sensibility for mouse input.
  105581. * Higher values reduce sensitivity.
  105582. */
  105583. /**
  105584. * Sets the input sensibility for a mouse input.
  105585. * Higher values reduce sensitivity.
  105586. */
  105587. angularSensibility: number;
  105588. /**
  105589. * Get the keys for camera movement forward.
  105590. */
  105591. /**
  105592. * Set the keys for camera movement forward.
  105593. */
  105594. keysForward: number[];
  105595. /**
  105596. * Get the keys for camera movement backward.
  105597. */
  105598. keysBackward: number[];
  105599. /**
  105600. * Get the keys for camera movement up.
  105601. */
  105602. /**
  105603. * Set the keys for camera movement up.
  105604. */
  105605. keysUp: number[];
  105606. /**
  105607. * Get the keys for camera movement down.
  105608. */
  105609. /**
  105610. * Set the keys for camera movement down.
  105611. */
  105612. keysDown: number[];
  105613. /**
  105614. * Get the keys for camera movement left.
  105615. */
  105616. /**
  105617. * Set the keys for camera movement left.
  105618. */
  105619. keysLeft: number[];
  105620. /**
  105621. * Set the keys for camera movement right.
  105622. */
  105623. /**
  105624. * Set the keys for camera movement right.
  105625. */
  105626. keysRight: number[];
  105627. /**
  105628. * Event raised when the camera collides with a mesh in the scene.
  105629. */
  105630. onCollide: (collidedMesh: AbstractMesh) => void;
  105631. private _collider;
  105632. private _needMoveForGravity;
  105633. private _oldPosition;
  105634. private _diffPosition;
  105635. private _newPosition;
  105636. /** @hidden */
  105637. _localDirection: Vector3;
  105638. /** @hidden */
  105639. _transformedDirection: Vector3;
  105640. /**
  105641. * Instantiates a FlyCamera.
  105642. * This is a flying camera, designed for 3D movement and rotation in all directions,
  105643. * such as in a 3D Space Shooter or a Flight Simulator.
  105644. * @param name Define the name of the camera in the scene.
  105645. * @param position Define the starting position of the camera in the scene.
  105646. * @param scene Define the scene the camera belongs to.
  105647. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  105648. */
  105649. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  105650. /**
  105651. * Attach a control to the HTML DOM element.
  105652. * @param element Defines the element that listens to the input events.
  105653. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  105654. */
  105655. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105656. /**
  105657. * Detach a control from the HTML DOM element.
  105658. * The camera will stop reacting to that input.
  105659. * @param element Defines the element that listens to the input events.
  105660. */
  105661. detachControl(element: HTMLElement): void;
  105662. private _collisionMask;
  105663. /**
  105664. * Get the mask that the camera ignores in collision events.
  105665. */
  105666. /**
  105667. * Set the mask that the camera ignores in collision events.
  105668. */
  105669. collisionMask: number;
  105670. /** @hidden */
  105671. _collideWithWorld(displacement: Vector3): void;
  105672. /** @hidden */
  105673. private _onCollisionPositionChange;
  105674. /** @hidden */
  105675. _checkInputs(): void;
  105676. /** @hidden */
  105677. _decideIfNeedsToMove(): boolean;
  105678. /** @hidden */
  105679. _updatePosition(): void;
  105680. /**
  105681. * Restore the Roll to its target value at the rate specified.
  105682. * @param rate - Higher means slower restoring.
  105683. * @hidden
  105684. */
  105685. restoreRoll(rate: number): void;
  105686. /**
  105687. * Destroy the camera and release the current resources held by it.
  105688. */
  105689. dispose(): void;
  105690. /**
  105691. * Get the current object class name.
  105692. * @returns the class name.
  105693. */
  105694. getClassName(): string;
  105695. }
  105696. }
  105697. declare module BABYLON {
  105698. /**
  105699. * Listen to keyboard events to control the camera.
  105700. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105701. */
  105702. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  105703. /**
  105704. * Defines the camera the input is attached to.
  105705. */
  105706. camera: FlyCamera;
  105707. /**
  105708. * The list of keyboard keys used to control the forward move of the camera.
  105709. */
  105710. keysForward: number[];
  105711. /**
  105712. * The list of keyboard keys used to control the backward move of the camera.
  105713. */
  105714. keysBackward: number[];
  105715. /**
  105716. * The list of keyboard keys used to control the forward move of the camera.
  105717. */
  105718. keysUp: number[];
  105719. /**
  105720. * The list of keyboard keys used to control the backward move of the camera.
  105721. */
  105722. keysDown: number[];
  105723. /**
  105724. * The list of keyboard keys used to control the right strafe move of the camera.
  105725. */
  105726. keysRight: number[];
  105727. /**
  105728. * The list of keyboard keys used to control the left strafe move of the camera.
  105729. */
  105730. keysLeft: number[];
  105731. private _keys;
  105732. private _onCanvasBlurObserver;
  105733. private _onKeyboardObserver;
  105734. private _engine;
  105735. private _scene;
  105736. /**
  105737. * Attach the input controls to a specific dom element to get the input from.
  105738. * @param element Defines the element the controls should be listened from
  105739. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105740. */
  105741. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105742. /**
  105743. * Detach the current controls from the specified dom element.
  105744. * @param element Defines the element to stop listening the inputs from
  105745. */
  105746. detachControl(element: Nullable<HTMLElement>): void;
  105747. /**
  105748. * Gets the class name of the current intput.
  105749. * @returns the class name
  105750. */
  105751. getClassName(): string;
  105752. /** @hidden */
  105753. _onLostFocus(e: FocusEvent): void;
  105754. /**
  105755. * Get the friendly name associated with the input class.
  105756. * @returns the input friendly name
  105757. */
  105758. getSimpleName(): string;
  105759. /**
  105760. * Update the current camera state depending on the inputs that have been used this frame.
  105761. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  105762. */
  105763. checkInputs(): void;
  105764. }
  105765. }
  105766. declare module BABYLON {
  105767. /**
  105768. * Manage the mouse wheel inputs to control a follow camera.
  105769. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105770. */
  105771. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  105772. /**
  105773. * Defines the camera the input is attached to.
  105774. */
  105775. camera: FollowCamera;
  105776. /**
  105777. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  105778. */
  105779. axisControlRadius: boolean;
  105780. /**
  105781. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  105782. */
  105783. axisControlHeight: boolean;
  105784. /**
  105785. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  105786. */
  105787. axisControlRotation: boolean;
  105788. /**
  105789. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  105790. * relation to mouseWheel events.
  105791. */
  105792. wheelPrecision: number;
  105793. /**
  105794. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  105795. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  105796. */
  105797. wheelDeltaPercentage: number;
  105798. private _wheel;
  105799. private _observer;
  105800. /**
  105801. * Attach the input controls to a specific dom element to get the input from.
  105802. * @param element Defines the element the controls should be listened from
  105803. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105804. */
  105805. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105806. /**
  105807. * Detach the current controls from the specified dom element.
  105808. * @param element Defines the element to stop listening the inputs from
  105809. */
  105810. detachControl(element: Nullable<HTMLElement>): void;
  105811. /**
  105812. * Gets the class name of the current intput.
  105813. * @returns the class name
  105814. */
  105815. getClassName(): string;
  105816. /**
  105817. * Get the friendly name associated with the input class.
  105818. * @returns the input friendly name
  105819. */
  105820. getSimpleName(): string;
  105821. }
  105822. }
  105823. declare module BABYLON {
  105824. /**
  105825. * Manage the pointers inputs to control an follow camera.
  105826. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105827. */
  105828. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  105829. /**
  105830. * Defines the camera the input is attached to.
  105831. */
  105832. camera: FollowCamera;
  105833. /**
  105834. * Gets the class name of the current input.
  105835. * @returns the class name
  105836. */
  105837. getClassName(): string;
  105838. /**
  105839. * Defines the pointer angular sensibility along the X axis or how fast is
  105840. * the camera rotating.
  105841. * A negative number will reverse the axis direction.
  105842. */
  105843. angularSensibilityX: number;
  105844. /**
  105845. * Defines the pointer angular sensibility along the Y axis or how fast is
  105846. * the camera rotating.
  105847. * A negative number will reverse the axis direction.
  105848. */
  105849. angularSensibilityY: number;
  105850. /**
  105851. * Defines the pointer pinch precision or how fast is the camera zooming.
  105852. * A negative number will reverse the axis direction.
  105853. */
  105854. pinchPrecision: number;
  105855. /**
  105856. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  105857. * from 0.
  105858. * It defines the percentage of current camera.radius to use as delta when
  105859. * pinch zoom is used.
  105860. */
  105861. pinchDeltaPercentage: number;
  105862. /**
  105863. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  105864. */
  105865. axisXControlRadius: boolean;
  105866. /**
  105867. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  105868. */
  105869. axisXControlHeight: boolean;
  105870. /**
  105871. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  105872. */
  105873. axisXControlRotation: boolean;
  105874. /**
  105875. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  105876. */
  105877. axisYControlRadius: boolean;
  105878. /**
  105879. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  105880. */
  105881. axisYControlHeight: boolean;
  105882. /**
  105883. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  105884. */
  105885. axisYControlRotation: boolean;
  105886. /**
  105887. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  105888. */
  105889. axisPinchControlRadius: boolean;
  105890. /**
  105891. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  105892. */
  105893. axisPinchControlHeight: boolean;
  105894. /**
  105895. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  105896. */
  105897. axisPinchControlRotation: boolean;
  105898. /**
  105899. * Log error messages if basic misconfiguration has occurred.
  105900. */
  105901. warningEnable: boolean;
  105902. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  105903. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  105904. private _warningCounter;
  105905. private _warning;
  105906. }
  105907. }
  105908. declare module BABYLON {
  105909. /**
  105910. * Default Inputs manager for the FollowCamera.
  105911. * It groups all the default supported inputs for ease of use.
  105912. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105913. */
  105914. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  105915. /**
  105916. * Instantiates a new FollowCameraInputsManager.
  105917. * @param camera Defines the camera the inputs belong to
  105918. */
  105919. constructor(camera: FollowCamera);
  105920. /**
  105921. * Add keyboard input support to the input manager.
  105922. * @returns the current input manager
  105923. */
  105924. addKeyboard(): FollowCameraInputsManager;
  105925. /**
  105926. * Add mouse wheel input support to the input manager.
  105927. * @returns the current input manager
  105928. */
  105929. addMouseWheel(): FollowCameraInputsManager;
  105930. /**
  105931. * Add pointers input support to the input manager.
  105932. * @returns the current input manager
  105933. */
  105934. addPointers(): FollowCameraInputsManager;
  105935. /**
  105936. * Add orientation input support to the input manager.
  105937. * @returns the current input manager
  105938. */
  105939. addVRDeviceOrientation(): FollowCameraInputsManager;
  105940. }
  105941. }
  105942. declare module BABYLON {
  105943. /**
  105944. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  105945. * an arc rotate version arcFollowCamera are available.
  105946. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  105947. */
  105948. export class FollowCamera extends TargetCamera {
  105949. /**
  105950. * Distance the follow camera should follow an object at
  105951. */
  105952. radius: number;
  105953. /**
  105954. * Minimum allowed distance of the camera to the axis of rotation
  105955. * (The camera can not get closer).
  105956. * This can help limiting how the Camera is able to move in the scene.
  105957. */
  105958. lowerRadiusLimit: Nullable<number>;
  105959. /**
  105960. * Maximum allowed distance of the camera to the axis of rotation
  105961. * (The camera can not get further).
  105962. * This can help limiting how the Camera is able to move in the scene.
  105963. */
  105964. upperRadiusLimit: Nullable<number>;
  105965. /**
  105966. * Define a rotation offset between the camera and the object it follows
  105967. */
  105968. rotationOffset: number;
  105969. /**
  105970. * Minimum allowed angle to camera position relative to target object.
  105971. * This can help limiting how the Camera is able to move in the scene.
  105972. */
  105973. lowerRotationOffsetLimit: Nullable<number>;
  105974. /**
  105975. * Maximum allowed angle to camera position relative to target object.
  105976. * This can help limiting how the Camera is able to move in the scene.
  105977. */
  105978. upperRotationOffsetLimit: Nullable<number>;
  105979. /**
  105980. * Define a height offset between the camera and the object it follows.
  105981. * It can help following an object from the top (like a car chaing a plane)
  105982. */
  105983. heightOffset: number;
  105984. /**
  105985. * Minimum allowed height of camera position relative to target object.
  105986. * This can help limiting how the Camera is able to move in the scene.
  105987. */
  105988. lowerHeightOffsetLimit: Nullable<number>;
  105989. /**
  105990. * Maximum allowed height of camera position relative to target object.
  105991. * This can help limiting how the Camera is able to move in the scene.
  105992. */
  105993. upperHeightOffsetLimit: Nullable<number>;
  105994. /**
  105995. * Define how fast the camera can accelerate to follow it s target.
  105996. */
  105997. cameraAcceleration: number;
  105998. /**
  105999. * Define the speed limit of the camera following an object.
  106000. */
  106001. maxCameraSpeed: number;
  106002. /**
  106003. * Define the target of the camera.
  106004. */
  106005. lockedTarget: Nullable<AbstractMesh>;
  106006. /**
  106007. * Defines the input associated with the camera.
  106008. */
  106009. inputs: FollowCameraInputsManager;
  106010. /**
  106011. * Instantiates the follow camera.
  106012. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106013. * @param name Define the name of the camera in the scene
  106014. * @param position Define the position of the camera
  106015. * @param scene Define the scene the camera belong to
  106016. * @param lockedTarget Define the target of the camera
  106017. */
  106018. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  106019. private _follow;
  106020. /**
  106021. * Attached controls to the current camera.
  106022. * @param element Defines the element the controls should be listened from
  106023. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106024. */
  106025. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106026. /**
  106027. * Detach the current controls from the camera.
  106028. * The camera will stop reacting to inputs.
  106029. * @param element Defines the element to stop listening the inputs from
  106030. */
  106031. detachControl(element: HTMLElement): void;
  106032. /** @hidden */
  106033. _checkInputs(): void;
  106034. private _checkLimits;
  106035. /**
  106036. * Gets the camera class name.
  106037. * @returns the class name
  106038. */
  106039. getClassName(): string;
  106040. }
  106041. /**
  106042. * Arc Rotate version of the follow camera.
  106043. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  106044. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106045. */
  106046. export class ArcFollowCamera extends TargetCamera {
  106047. /** The longitudinal angle of the camera */
  106048. alpha: number;
  106049. /** The latitudinal angle of the camera */
  106050. beta: number;
  106051. /** The radius of the camera from its target */
  106052. radius: number;
  106053. /** Define the camera target (the messh it should follow) */
  106054. target: Nullable<AbstractMesh>;
  106055. private _cartesianCoordinates;
  106056. /**
  106057. * Instantiates a new ArcFollowCamera
  106058. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106059. * @param name Define the name of the camera
  106060. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  106061. * @param beta Define the rotation angle of the camera around the elevation axis
  106062. * @param radius Define the radius of the camera from its target point
  106063. * @param target Define the target of the camera
  106064. * @param scene Define the scene the camera belongs to
  106065. */
  106066. constructor(name: string,
  106067. /** The longitudinal angle of the camera */
  106068. alpha: number,
  106069. /** The latitudinal angle of the camera */
  106070. beta: number,
  106071. /** The radius of the camera from its target */
  106072. radius: number,
  106073. /** Define the camera target (the messh it should follow) */
  106074. target: Nullable<AbstractMesh>, scene: Scene);
  106075. private _follow;
  106076. /** @hidden */
  106077. _checkInputs(): void;
  106078. /**
  106079. * Returns the class name of the object.
  106080. * It is mostly used internally for serialization purposes.
  106081. */
  106082. getClassName(): string;
  106083. }
  106084. }
  106085. declare module BABYLON {
  106086. /**
  106087. * Manage the keyboard inputs to control the movement of a follow camera.
  106088. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106089. */
  106090. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  106091. /**
  106092. * Defines the camera the input is attached to.
  106093. */
  106094. camera: FollowCamera;
  106095. /**
  106096. * Defines the list of key codes associated with the up action (increase heightOffset)
  106097. */
  106098. keysHeightOffsetIncr: number[];
  106099. /**
  106100. * Defines the list of key codes associated with the down action (decrease heightOffset)
  106101. */
  106102. keysHeightOffsetDecr: number[];
  106103. /**
  106104. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  106105. */
  106106. keysHeightOffsetModifierAlt: boolean;
  106107. /**
  106108. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  106109. */
  106110. keysHeightOffsetModifierCtrl: boolean;
  106111. /**
  106112. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  106113. */
  106114. keysHeightOffsetModifierShift: boolean;
  106115. /**
  106116. * Defines the list of key codes associated with the left action (increase rotationOffset)
  106117. */
  106118. keysRotationOffsetIncr: number[];
  106119. /**
  106120. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  106121. */
  106122. keysRotationOffsetDecr: number[];
  106123. /**
  106124. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  106125. */
  106126. keysRotationOffsetModifierAlt: boolean;
  106127. /**
  106128. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  106129. */
  106130. keysRotationOffsetModifierCtrl: boolean;
  106131. /**
  106132. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  106133. */
  106134. keysRotationOffsetModifierShift: boolean;
  106135. /**
  106136. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  106137. */
  106138. keysRadiusIncr: number[];
  106139. /**
  106140. * Defines the list of key codes associated with the zoom-out action (increase radius)
  106141. */
  106142. keysRadiusDecr: number[];
  106143. /**
  106144. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  106145. */
  106146. keysRadiusModifierAlt: boolean;
  106147. /**
  106148. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  106149. */
  106150. keysRadiusModifierCtrl: boolean;
  106151. /**
  106152. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  106153. */
  106154. keysRadiusModifierShift: boolean;
  106155. /**
  106156. * Defines the rate of change of heightOffset.
  106157. */
  106158. heightSensibility: number;
  106159. /**
  106160. * Defines the rate of change of rotationOffset.
  106161. */
  106162. rotationSensibility: number;
  106163. /**
  106164. * Defines the rate of change of radius.
  106165. */
  106166. radiusSensibility: number;
  106167. private _keys;
  106168. private _ctrlPressed;
  106169. private _altPressed;
  106170. private _shiftPressed;
  106171. private _onCanvasBlurObserver;
  106172. private _onKeyboardObserver;
  106173. private _engine;
  106174. private _scene;
  106175. /**
  106176. * Attach the input controls to a specific dom element to get the input from.
  106177. * @param element Defines the element the controls should be listened from
  106178. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106179. */
  106180. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106181. /**
  106182. * Detach the current controls from the specified dom element.
  106183. * @param element Defines the element to stop listening the inputs from
  106184. */
  106185. detachControl(element: Nullable<HTMLElement>): void;
  106186. /**
  106187. * Update the current camera state depending on the inputs that have been used this frame.
  106188. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106189. */
  106190. checkInputs(): void;
  106191. /**
  106192. * Gets the class name of the current input.
  106193. * @returns the class name
  106194. */
  106195. getClassName(): string;
  106196. /**
  106197. * Get the friendly name associated with the input class.
  106198. * @returns the input friendly name
  106199. */
  106200. getSimpleName(): string;
  106201. /**
  106202. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  106203. * allow modification of the heightOffset value.
  106204. */
  106205. private _modifierHeightOffset;
  106206. /**
  106207. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  106208. * allow modification of the rotationOffset value.
  106209. */
  106210. private _modifierRotationOffset;
  106211. /**
  106212. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  106213. * allow modification of the radius value.
  106214. */
  106215. private _modifierRadius;
  106216. }
  106217. }
  106218. declare module BABYLON {
  106219. interface FreeCameraInputsManager {
  106220. /**
  106221. * @hidden
  106222. */
  106223. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  106224. /**
  106225. * Add orientation input support to the input manager.
  106226. * @returns the current input manager
  106227. */
  106228. addDeviceOrientation(): FreeCameraInputsManager;
  106229. }
  106230. /**
  106231. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  106232. * Screen rotation is taken into account.
  106233. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106234. */
  106235. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  106236. private _camera;
  106237. private _screenOrientationAngle;
  106238. private _constantTranform;
  106239. private _screenQuaternion;
  106240. private _alpha;
  106241. private _beta;
  106242. private _gamma;
  106243. /**
  106244. * Can be used to detect if a device orientation sensor is availible on a device
  106245. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  106246. * @returns a promise that will resolve on orientation change
  106247. */
  106248. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  106249. /**
  106250. * @hidden
  106251. */
  106252. _onDeviceOrientationChangedObservable: Observable<void>;
  106253. /**
  106254. * Instantiates a new input
  106255. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106256. */
  106257. constructor();
  106258. /**
  106259. * Define the camera controlled by the input.
  106260. */
  106261. camera: FreeCamera;
  106262. /**
  106263. * Attach the input controls to a specific dom element to get the input from.
  106264. * @param element Defines the element the controls should be listened from
  106265. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106266. */
  106267. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106268. private _orientationChanged;
  106269. private _deviceOrientation;
  106270. /**
  106271. * Detach the current controls from the specified dom element.
  106272. * @param element Defines the element to stop listening the inputs from
  106273. */
  106274. detachControl(element: Nullable<HTMLElement>): void;
  106275. /**
  106276. * Update the current camera state depending on the inputs that have been used this frame.
  106277. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106278. */
  106279. checkInputs(): void;
  106280. /**
  106281. * Gets the class name of the current intput.
  106282. * @returns the class name
  106283. */
  106284. getClassName(): string;
  106285. /**
  106286. * Get the friendly name associated with the input class.
  106287. * @returns the input friendly name
  106288. */
  106289. getSimpleName(): string;
  106290. }
  106291. }
  106292. declare module BABYLON {
  106293. /**
  106294. * Manage the gamepad inputs to control a free camera.
  106295. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106296. */
  106297. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  106298. /**
  106299. * Define the camera the input is attached to.
  106300. */
  106301. camera: FreeCamera;
  106302. /**
  106303. * Define the Gamepad controlling the input
  106304. */
  106305. gamepad: Nullable<Gamepad>;
  106306. /**
  106307. * Defines the gamepad rotation sensiblity.
  106308. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  106309. */
  106310. gamepadAngularSensibility: number;
  106311. /**
  106312. * Defines the gamepad move sensiblity.
  106313. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  106314. */
  106315. gamepadMoveSensibility: number;
  106316. private _yAxisScale;
  106317. /**
  106318. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  106319. */
  106320. invertYAxis: boolean;
  106321. private _onGamepadConnectedObserver;
  106322. private _onGamepadDisconnectedObserver;
  106323. private _cameraTransform;
  106324. private _deltaTransform;
  106325. private _vector3;
  106326. private _vector2;
  106327. /**
  106328. * Attach the input controls to a specific dom element to get the input from.
  106329. * @param element Defines the element the controls should be listened from
  106330. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106331. */
  106332. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106333. /**
  106334. * Detach the current controls from the specified dom element.
  106335. * @param element Defines the element to stop listening the inputs from
  106336. */
  106337. detachControl(element: Nullable<HTMLElement>): void;
  106338. /**
  106339. * Update the current camera state depending on the inputs that have been used this frame.
  106340. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106341. */
  106342. checkInputs(): void;
  106343. /**
  106344. * Gets the class name of the current intput.
  106345. * @returns the class name
  106346. */
  106347. getClassName(): string;
  106348. /**
  106349. * Get the friendly name associated with the input class.
  106350. * @returns the input friendly name
  106351. */
  106352. getSimpleName(): string;
  106353. }
  106354. }
  106355. declare module BABYLON {
  106356. /**
  106357. * Defines the potential axis of a Joystick
  106358. */
  106359. export enum JoystickAxis {
  106360. /** X axis */
  106361. X = 0,
  106362. /** Y axis */
  106363. Y = 1,
  106364. /** Z axis */
  106365. Z = 2
  106366. }
  106367. /**
  106368. * Class used to define virtual joystick (used in touch mode)
  106369. */
  106370. export class VirtualJoystick {
  106371. /**
  106372. * Gets or sets a boolean indicating that left and right values must be inverted
  106373. */
  106374. reverseLeftRight: boolean;
  106375. /**
  106376. * Gets or sets a boolean indicating that up and down values must be inverted
  106377. */
  106378. reverseUpDown: boolean;
  106379. /**
  106380. * Gets the offset value for the position (ie. the change of the position value)
  106381. */
  106382. deltaPosition: Vector3;
  106383. /**
  106384. * Gets a boolean indicating if the virtual joystick was pressed
  106385. */
  106386. pressed: boolean;
  106387. /**
  106388. * Canvas the virtual joystick will render onto, default z-index of this is 5
  106389. */
  106390. static Canvas: Nullable<HTMLCanvasElement>;
  106391. private static _globalJoystickIndex;
  106392. private static vjCanvasContext;
  106393. private static vjCanvasWidth;
  106394. private static vjCanvasHeight;
  106395. private static halfWidth;
  106396. private _action;
  106397. private _axisTargetedByLeftAndRight;
  106398. private _axisTargetedByUpAndDown;
  106399. private _joystickSensibility;
  106400. private _inversedSensibility;
  106401. private _joystickPointerID;
  106402. private _joystickColor;
  106403. private _joystickPointerPos;
  106404. private _joystickPreviousPointerPos;
  106405. private _joystickPointerStartPos;
  106406. private _deltaJoystickVector;
  106407. private _leftJoystick;
  106408. private _touches;
  106409. private _onPointerDownHandlerRef;
  106410. private _onPointerMoveHandlerRef;
  106411. private _onPointerUpHandlerRef;
  106412. private _onResize;
  106413. /**
  106414. * Creates a new virtual joystick
  106415. * @param leftJoystick defines that the joystick is for left hand (false by default)
  106416. */
  106417. constructor(leftJoystick?: boolean);
  106418. /**
  106419. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  106420. * @param newJoystickSensibility defines the new sensibility
  106421. */
  106422. setJoystickSensibility(newJoystickSensibility: number): void;
  106423. private _onPointerDown;
  106424. private _onPointerMove;
  106425. private _onPointerUp;
  106426. /**
  106427. * Change the color of the virtual joystick
  106428. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  106429. */
  106430. setJoystickColor(newColor: string): void;
  106431. /**
  106432. * Defines a callback to call when the joystick is touched
  106433. * @param action defines the callback
  106434. */
  106435. setActionOnTouch(action: () => any): void;
  106436. /**
  106437. * Defines which axis you'd like to control for left & right
  106438. * @param axis defines the axis to use
  106439. */
  106440. setAxisForLeftRight(axis: JoystickAxis): void;
  106441. /**
  106442. * Defines which axis you'd like to control for up & down
  106443. * @param axis defines the axis to use
  106444. */
  106445. setAxisForUpDown(axis: JoystickAxis): void;
  106446. private _drawVirtualJoystick;
  106447. /**
  106448. * Release internal HTML canvas
  106449. */
  106450. releaseCanvas(): void;
  106451. }
  106452. }
  106453. declare module BABYLON {
  106454. interface FreeCameraInputsManager {
  106455. /**
  106456. * Add virtual joystick input support to the input manager.
  106457. * @returns the current input manager
  106458. */
  106459. addVirtualJoystick(): FreeCameraInputsManager;
  106460. }
  106461. /**
  106462. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  106463. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106464. */
  106465. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  106466. /**
  106467. * Defines the camera the input is attached to.
  106468. */
  106469. camera: FreeCamera;
  106470. private _leftjoystick;
  106471. private _rightjoystick;
  106472. /**
  106473. * Gets the left stick of the virtual joystick.
  106474. * @returns The virtual Joystick
  106475. */
  106476. getLeftJoystick(): VirtualJoystick;
  106477. /**
  106478. * Gets the right stick of the virtual joystick.
  106479. * @returns The virtual Joystick
  106480. */
  106481. getRightJoystick(): VirtualJoystick;
  106482. /**
  106483. * Update the current camera state depending on the inputs that have been used this frame.
  106484. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106485. */
  106486. checkInputs(): void;
  106487. /**
  106488. * Attach the input controls to a specific dom element to get the input from.
  106489. * @param element Defines the element the controls should be listened from
  106490. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106491. */
  106492. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106493. /**
  106494. * Detach the current controls from the specified dom element.
  106495. * @param element Defines the element to stop listening the inputs from
  106496. */
  106497. detachControl(element: Nullable<HTMLElement>): void;
  106498. /**
  106499. * Gets the class name of the current intput.
  106500. * @returns the class name
  106501. */
  106502. getClassName(): string;
  106503. /**
  106504. * Get the friendly name associated with the input class.
  106505. * @returns the input friendly name
  106506. */
  106507. getSimpleName(): string;
  106508. }
  106509. }
  106510. declare module BABYLON {
  106511. /**
  106512. * This represents a FPS type of camera controlled by touch.
  106513. * This is like a universal camera minus the Gamepad controls.
  106514. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  106515. */
  106516. export class TouchCamera extends FreeCamera {
  106517. /**
  106518. * Defines the touch sensibility for rotation.
  106519. * The higher the faster.
  106520. */
  106521. touchAngularSensibility: number;
  106522. /**
  106523. * Defines the touch sensibility for move.
  106524. * The higher the faster.
  106525. */
  106526. touchMoveSensibility: number;
  106527. /**
  106528. * Instantiates a new touch camera.
  106529. * This represents a FPS type of camera controlled by touch.
  106530. * This is like a universal camera minus the Gamepad controls.
  106531. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  106532. * @param name Define the name of the camera in the scene
  106533. * @param position Define the start position of the camera in the scene
  106534. * @param scene Define the scene the camera belongs to
  106535. */
  106536. constructor(name: string, position: Vector3, scene: Scene);
  106537. /**
  106538. * Gets the current object class name.
  106539. * @return the class name
  106540. */
  106541. getClassName(): string;
  106542. /** @hidden */
  106543. _setupInputs(): void;
  106544. }
  106545. }
  106546. declare module BABYLON {
  106547. /**
  106548. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  106549. * being tilted forward or back and left or right.
  106550. */
  106551. export class DeviceOrientationCamera extends FreeCamera {
  106552. private _initialQuaternion;
  106553. private _quaternionCache;
  106554. private _tmpDragQuaternion;
  106555. private _disablePointerInputWhenUsingDeviceOrientation;
  106556. /**
  106557. * Creates a new device orientation camera
  106558. * @param name The name of the camera
  106559. * @param position The start position camera
  106560. * @param scene The scene the camera belongs to
  106561. */
  106562. constructor(name: string, position: Vector3, scene: Scene);
  106563. /**
  106564. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  106565. */
  106566. disablePointerInputWhenUsingDeviceOrientation: boolean;
  106567. private _dragFactor;
  106568. /**
  106569. * Enabled turning on the y axis when the orientation sensor is active
  106570. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  106571. */
  106572. enableHorizontalDragging(dragFactor?: number): void;
  106573. /**
  106574. * Gets the current instance class name ("DeviceOrientationCamera").
  106575. * This helps avoiding instanceof at run time.
  106576. * @returns the class name
  106577. */
  106578. getClassName(): string;
  106579. /**
  106580. * @hidden
  106581. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  106582. */
  106583. _checkInputs(): void;
  106584. /**
  106585. * Reset the camera to its default orientation on the specified axis only.
  106586. * @param axis The axis to reset
  106587. */
  106588. resetToCurrentRotation(axis?: Axis): void;
  106589. }
  106590. }
  106591. declare module BABYLON {
  106592. /**
  106593. * Defines supported buttons for XBox360 compatible gamepads
  106594. */
  106595. export enum Xbox360Button {
  106596. /** A */
  106597. A = 0,
  106598. /** B */
  106599. B = 1,
  106600. /** X */
  106601. X = 2,
  106602. /** Y */
  106603. Y = 3,
  106604. /** Start */
  106605. Start = 4,
  106606. /** Back */
  106607. Back = 5,
  106608. /** Left button */
  106609. LB = 6,
  106610. /** Right button */
  106611. RB = 7,
  106612. /** Left stick */
  106613. LeftStick = 8,
  106614. /** Right stick */
  106615. RightStick = 9
  106616. }
  106617. /** Defines values for XBox360 DPad */
  106618. export enum Xbox360Dpad {
  106619. /** Up */
  106620. Up = 0,
  106621. /** Down */
  106622. Down = 1,
  106623. /** Left */
  106624. Left = 2,
  106625. /** Right */
  106626. Right = 3
  106627. }
  106628. /**
  106629. * Defines a XBox360 gamepad
  106630. */
  106631. export class Xbox360Pad extends Gamepad {
  106632. private _leftTrigger;
  106633. private _rightTrigger;
  106634. private _onlefttriggerchanged;
  106635. private _onrighttriggerchanged;
  106636. private _onbuttondown;
  106637. private _onbuttonup;
  106638. private _ondpaddown;
  106639. private _ondpadup;
  106640. /** Observable raised when a button is pressed */
  106641. onButtonDownObservable: Observable<Xbox360Button>;
  106642. /** Observable raised when a button is released */
  106643. onButtonUpObservable: Observable<Xbox360Button>;
  106644. /** Observable raised when a pad is pressed */
  106645. onPadDownObservable: Observable<Xbox360Dpad>;
  106646. /** Observable raised when a pad is released */
  106647. onPadUpObservable: Observable<Xbox360Dpad>;
  106648. private _buttonA;
  106649. private _buttonB;
  106650. private _buttonX;
  106651. private _buttonY;
  106652. private _buttonBack;
  106653. private _buttonStart;
  106654. private _buttonLB;
  106655. private _buttonRB;
  106656. private _buttonLeftStick;
  106657. private _buttonRightStick;
  106658. private _dPadUp;
  106659. private _dPadDown;
  106660. private _dPadLeft;
  106661. private _dPadRight;
  106662. private _isXboxOnePad;
  106663. /**
  106664. * Creates a new XBox360 gamepad object
  106665. * @param id defines the id of this gamepad
  106666. * @param index defines its index
  106667. * @param gamepad defines the internal HTML gamepad object
  106668. * @param xboxOne defines if it is a XBox One gamepad
  106669. */
  106670. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  106671. /**
  106672. * Defines the callback to call when left trigger is pressed
  106673. * @param callback defines the callback to use
  106674. */
  106675. onlefttriggerchanged(callback: (value: number) => void): void;
  106676. /**
  106677. * Defines the callback to call when right trigger is pressed
  106678. * @param callback defines the callback to use
  106679. */
  106680. onrighttriggerchanged(callback: (value: number) => void): void;
  106681. /**
  106682. * Gets the left trigger value
  106683. */
  106684. /**
  106685. * Sets the left trigger value
  106686. */
  106687. leftTrigger: number;
  106688. /**
  106689. * Gets the right trigger value
  106690. */
  106691. /**
  106692. * Sets the right trigger value
  106693. */
  106694. rightTrigger: number;
  106695. /**
  106696. * Defines the callback to call when a button is pressed
  106697. * @param callback defines the callback to use
  106698. */
  106699. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  106700. /**
  106701. * Defines the callback to call when a button is released
  106702. * @param callback defines the callback to use
  106703. */
  106704. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  106705. /**
  106706. * Defines the callback to call when a pad is pressed
  106707. * @param callback defines the callback to use
  106708. */
  106709. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  106710. /**
  106711. * Defines the callback to call when a pad is released
  106712. * @param callback defines the callback to use
  106713. */
  106714. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  106715. private _setButtonValue;
  106716. private _setDPadValue;
  106717. /**
  106718. * Gets the value of the `A` button
  106719. */
  106720. /**
  106721. * Sets the value of the `A` button
  106722. */
  106723. buttonA: number;
  106724. /**
  106725. * Gets the value of the `B` button
  106726. */
  106727. /**
  106728. * Sets the value of the `B` button
  106729. */
  106730. buttonB: number;
  106731. /**
  106732. * Gets the value of the `X` button
  106733. */
  106734. /**
  106735. * Sets the value of the `X` button
  106736. */
  106737. buttonX: number;
  106738. /**
  106739. * Gets the value of the `Y` button
  106740. */
  106741. /**
  106742. * Sets the value of the `Y` button
  106743. */
  106744. buttonY: number;
  106745. /**
  106746. * Gets the value of the `Start` button
  106747. */
  106748. /**
  106749. * Sets the value of the `Start` button
  106750. */
  106751. buttonStart: number;
  106752. /**
  106753. * Gets the value of the `Back` button
  106754. */
  106755. /**
  106756. * Sets the value of the `Back` button
  106757. */
  106758. buttonBack: number;
  106759. /**
  106760. * Gets the value of the `Left` button
  106761. */
  106762. /**
  106763. * Sets the value of the `Left` button
  106764. */
  106765. buttonLB: number;
  106766. /**
  106767. * Gets the value of the `Right` button
  106768. */
  106769. /**
  106770. * Sets the value of the `Right` button
  106771. */
  106772. buttonRB: number;
  106773. /**
  106774. * Gets the value of the Left joystick
  106775. */
  106776. /**
  106777. * Sets the value of the Left joystick
  106778. */
  106779. buttonLeftStick: number;
  106780. /**
  106781. * Gets the value of the Right joystick
  106782. */
  106783. /**
  106784. * Sets the value of the Right joystick
  106785. */
  106786. buttonRightStick: number;
  106787. /**
  106788. * Gets the value of D-pad up
  106789. */
  106790. /**
  106791. * Sets the value of D-pad up
  106792. */
  106793. dPadUp: number;
  106794. /**
  106795. * Gets the value of D-pad down
  106796. */
  106797. /**
  106798. * Sets the value of D-pad down
  106799. */
  106800. dPadDown: number;
  106801. /**
  106802. * Gets the value of D-pad left
  106803. */
  106804. /**
  106805. * Sets the value of D-pad left
  106806. */
  106807. dPadLeft: number;
  106808. /**
  106809. * Gets the value of D-pad right
  106810. */
  106811. /**
  106812. * Sets the value of D-pad right
  106813. */
  106814. dPadRight: number;
  106815. /**
  106816. * Force the gamepad to synchronize with device values
  106817. */
  106818. update(): void;
  106819. /**
  106820. * Disposes the gamepad
  106821. */
  106822. dispose(): void;
  106823. }
  106824. }
  106825. declare module BABYLON {
  106826. /**
  106827. * Defines supported buttons for DualShock compatible gamepads
  106828. */
  106829. export enum DualShockButton {
  106830. /** Cross */
  106831. Cross = 0,
  106832. /** Circle */
  106833. Circle = 1,
  106834. /** Square */
  106835. Square = 2,
  106836. /** Triangle */
  106837. Triangle = 3,
  106838. /** Options */
  106839. Options = 4,
  106840. /** Share */
  106841. Share = 5,
  106842. /** L1 */
  106843. L1 = 6,
  106844. /** R1 */
  106845. R1 = 7,
  106846. /** Left stick */
  106847. LeftStick = 8,
  106848. /** Right stick */
  106849. RightStick = 9
  106850. }
  106851. /** Defines values for DualShock DPad */
  106852. export enum DualShockDpad {
  106853. /** Up */
  106854. Up = 0,
  106855. /** Down */
  106856. Down = 1,
  106857. /** Left */
  106858. Left = 2,
  106859. /** Right */
  106860. Right = 3
  106861. }
  106862. /**
  106863. * Defines a DualShock gamepad
  106864. */
  106865. export class DualShockPad extends Gamepad {
  106866. private _leftTrigger;
  106867. private _rightTrigger;
  106868. private _onlefttriggerchanged;
  106869. private _onrighttriggerchanged;
  106870. private _onbuttondown;
  106871. private _onbuttonup;
  106872. private _ondpaddown;
  106873. private _ondpadup;
  106874. /** Observable raised when a button is pressed */
  106875. onButtonDownObservable: Observable<DualShockButton>;
  106876. /** Observable raised when a button is released */
  106877. onButtonUpObservable: Observable<DualShockButton>;
  106878. /** Observable raised when a pad is pressed */
  106879. onPadDownObservable: Observable<DualShockDpad>;
  106880. /** Observable raised when a pad is released */
  106881. onPadUpObservable: Observable<DualShockDpad>;
  106882. private _buttonCross;
  106883. private _buttonCircle;
  106884. private _buttonSquare;
  106885. private _buttonTriangle;
  106886. private _buttonShare;
  106887. private _buttonOptions;
  106888. private _buttonL1;
  106889. private _buttonR1;
  106890. private _buttonLeftStick;
  106891. private _buttonRightStick;
  106892. private _dPadUp;
  106893. private _dPadDown;
  106894. private _dPadLeft;
  106895. private _dPadRight;
  106896. /**
  106897. * Creates a new DualShock gamepad object
  106898. * @param id defines the id of this gamepad
  106899. * @param index defines its index
  106900. * @param gamepad defines the internal HTML gamepad object
  106901. */
  106902. constructor(id: string, index: number, gamepad: any);
  106903. /**
  106904. * Defines the callback to call when left trigger is pressed
  106905. * @param callback defines the callback to use
  106906. */
  106907. onlefttriggerchanged(callback: (value: number) => void): void;
  106908. /**
  106909. * Defines the callback to call when right trigger is pressed
  106910. * @param callback defines the callback to use
  106911. */
  106912. onrighttriggerchanged(callback: (value: number) => void): void;
  106913. /**
  106914. * Gets the left trigger value
  106915. */
  106916. /**
  106917. * Sets the left trigger value
  106918. */
  106919. leftTrigger: number;
  106920. /**
  106921. * Gets the right trigger value
  106922. */
  106923. /**
  106924. * Sets the right trigger value
  106925. */
  106926. rightTrigger: number;
  106927. /**
  106928. * Defines the callback to call when a button is pressed
  106929. * @param callback defines the callback to use
  106930. */
  106931. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  106932. /**
  106933. * Defines the callback to call when a button is released
  106934. * @param callback defines the callback to use
  106935. */
  106936. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  106937. /**
  106938. * Defines the callback to call when a pad is pressed
  106939. * @param callback defines the callback to use
  106940. */
  106941. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  106942. /**
  106943. * Defines the callback to call when a pad is released
  106944. * @param callback defines the callback to use
  106945. */
  106946. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  106947. private _setButtonValue;
  106948. private _setDPadValue;
  106949. /**
  106950. * Gets the value of the `Cross` button
  106951. */
  106952. /**
  106953. * Sets the value of the `Cross` button
  106954. */
  106955. buttonCross: number;
  106956. /**
  106957. * Gets the value of the `Circle` button
  106958. */
  106959. /**
  106960. * Sets the value of the `Circle` button
  106961. */
  106962. buttonCircle: number;
  106963. /**
  106964. * Gets the value of the `Square` button
  106965. */
  106966. /**
  106967. * Sets the value of the `Square` button
  106968. */
  106969. buttonSquare: number;
  106970. /**
  106971. * Gets the value of the `Triangle` button
  106972. */
  106973. /**
  106974. * Sets the value of the `Triangle` button
  106975. */
  106976. buttonTriangle: number;
  106977. /**
  106978. * Gets the value of the `Options` button
  106979. */
  106980. /**
  106981. * Sets the value of the `Options` button
  106982. */
  106983. buttonOptions: number;
  106984. /**
  106985. * Gets the value of the `Share` button
  106986. */
  106987. /**
  106988. * Sets the value of the `Share` button
  106989. */
  106990. buttonShare: number;
  106991. /**
  106992. * Gets the value of the `L1` button
  106993. */
  106994. /**
  106995. * Sets the value of the `L1` button
  106996. */
  106997. buttonL1: number;
  106998. /**
  106999. * Gets the value of the `R1` button
  107000. */
  107001. /**
  107002. * Sets the value of the `R1` button
  107003. */
  107004. buttonR1: number;
  107005. /**
  107006. * Gets the value of the Left joystick
  107007. */
  107008. /**
  107009. * Sets the value of the Left joystick
  107010. */
  107011. buttonLeftStick: number;
  107012. /**
  107013. * Gets the value of the Right joystick
  107014. */
  107015. /**
  107016. * Sets the value of the Right joystick
  107017. */
  107018. buttonRightStick: number;
  107019. /**
  107020. * Gets the value of D-pad up
  107021. */
  107022. /**
  107023. * Sets the value of D-pad up
  107024. */
  107025. dPadUp: number;
  107026. /**
  107027. * Gets the value of D-pad down
  107028. */
  107029. /**
  107030. * Sets the value of D-pad down
  107031. */
  107032. dPadDown: number;
  107033. /**
  107034. * Gets the value of D-pad left
  107035. */
  107036. /**
  107037. * Sets the value of D-pad left
  107038. */
  107039. dPadLeft: number;
  107040. /**
  107041. * Gets the value of D-pad right
  107042. */
  107043. /**
  107044. * Sets the value of D-pad right
  107045. */
  107046. dPadRight: number;
  107047. /**
  107048. * Force the gamepad to synchronize with device values
  107049. */
  107050. update(): void;
  107051. /**
  107052. * Disposes the gamepad
  107053. */
  107054. dispose(): void;
  107055. }
  107056. }
  107057. declare module BABYLON {
  107058. /**
  107059. * Manager for handling gamepads
  107060. */
  107061. export class GamepadManager {
  107062. private _scene?;
  107063. private _babylonGamepads;
  107064. private _oneGamepadConnected;
  107065. /** @hidden */
  107066. _isMonitoring: boolean;
  107067. private _gamepadEventSupported;
  107068. private _gamepadSupport;
  107069. /**
  107070. * observable to be triggered when the gamepad controller has been connected
  107071. */
  107072. onGamepadConnectedObservable: Observable<Gamepad>;
  107073. /**
  107074. * observable to be triggered when the gamepad controller has been disconnected
  107075. */
  107076. onGamepadDisconnectedObservable: Observable<Gamepad>;
  107077. private _onGamepadConnectedEvent;
  107078. private _onGamepadDisconnectedEvent;
  107079. /**
  107080. * Initializes the gamepad manager
  107081. * @param _scene BabylonJS scene
  107082. */
  107083. constructor(_scene?: Scene | undefined);
  107084. /**
  107085. * The gamepads in the game pad manager
  107086. */
  107087. readonly gamepads: Gamepad[];
  107088. /**
  107089. * Get the gamepad controllers based on type
  107090. * @param type The type of gamepad controller
  107091. * @returns Nullable gamepad
  107092. */
  107093. getGamepadByType(type?: number): Nullable<Gamepad>;
  107094. /**
  107095. * Disposes the gamepad manager
  107096. */
  107097. dispose(): void;
  107098. private _addNewGamepad;
  107099. private _startMonitoringGamepads;
  107100. private _stopMonitoringGamepads;
  107101. /** @hidden */
  107102. _checkGamepadsStatus(): void;
  107103. private _updateGamepadObjects;
  107104. }
  107105. }
  107106. declare module BABYLON {
  107107. interface Scene {
  107108. /** @hidden */
  107109. _gamepadManager: Nullable<GamepadManager>;
  107110. /**
  107111. * Gets the gamepad manager associated with the scene
  107112. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  107113. */
  107114. gamepadManager: GamepadManager;
  107115. }
  107116. /**
  107117. * Interface representing a free camera inputs manager
  107118. */
  107119. interface FreeCameraInputsManager {
  107120. /**
  107121. * Adds gamepad input support to the FreeCameraInputsManager.
  107122. * @returns the FreeCameraInputsManager
  107123. */
  107124. addGamepad(): FreeCameraInputsManager;
  107125. }
  107126. /**
  107127. * Interface representing an arc rotate camera inputs manager
  107128. */
  107129. interface ArcRotateCameraInputsManager {
  107130. /**
  107131. * Adds gamepad input support to the ArcRotateCamera InputManager.
  107132. * @returns the camera inputs manager
  107133. */
  107134. addGamepad(): ArcRotateCameraInputsManager;
  107135. }
  107136. /**
  107137. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  107138. */
  107139. export class GamepadSystemSceneComponent implements ISceneComponent {
  107140. /**
  107141. * The component name helpfull to identify the component in the list of scene components.
  107142. */
  107143. readonly name: string;
  107144. /**
  107145. * The scene the component belongs to.
  107146. */
  107147. scene: Scene;
  107148. /**
  107149. * Creates a new instance of the component for the given scene
  107150. * @param scene Defines the scene to register the component in
  107151. */
  107152. constructor(scene: Scene);
  107153. /**
  107154. * Registers the component in a given scene
  107155. */
  107156. register(): void;
  107157. /**
  107158. * Rebuilds the elements related to this component in case of
  107159. * context lost for instance.
  107160. */
  107161. rebuild(): void;
  107162. /**
  107163. * Disposes the component and the associated ressources
  107164. */
  107165. dispose(): void;
  107166. private _beforeCameraUpdate;
  107167. }
  107168. }
  107169. declare module BABYLON {
  107170. /**
  107171. * 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,
  107172. * which still works and will still be found in many Playgrounds.
  107173. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107174. */
  107175. export class UniversalCamera extends TouchCamera {
  107176. /**
  107177. * Defines the gamepad rotation sensiblity.
  107178. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  107179. */
  107180. gamepadAngularSensibility: number;
  107181. /**
  107182. * Defines the gamepad move sensiblity.
  107183. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  107184. */
  107185. gamepadMoveSensibility: number;
  107186. /**
  107187. * 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,
  107188. * which still works and will still be found in many Playgrounds.
  107189. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107190. * @param name Define the name of the camera in the scene
  107191. * @param position Define the start position of the camera in the scene
  107192. * @param scene Define the scene the camera belongs to
  107193. */
  107194. constructor(name: string, position: Vector3, scene: Scene);
  107195. /**
  107196. * Gets the current object class name.
  107197. * @return the class name
  107198. */
  107199. getClassName(): string;
  107200. }
  107201. }
  107202. declare module BABYLON {
  107203. /**
  107204. * This represents a FPS type of camera. This is only here for back compat purpose.
  107205. * Please use the UniversalCamera instead as both are identical.
  107206. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107207. */
  107208. export class GamepadCamera extends UniversalCamera {
  107209. /**
  107210. * Instantiates a new Gamepad Camera
  107211. * This represents a FPS type of camera. This is only here for back compat purpose.
  107212. * Please use the UniversalCamera instead as both are identical.
  107213. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107214. * @param name Define the name of the camera in the scene
  107215. * @param position Define the start position of the camera in the scene
  107216. * @param scene Define the scene the camera belongs to
  107217. */
  107218. constructor(name: string, position: Vector3, scene: Scene);
  107219. /**
  107220. * Gets the current object class name.
  107221. * @return the class name
  107222. */
  107223. getClassName(): string;
  107224. }
  107225. }
  107226. declare module BABYLON {
  107227. /** @hidden */
  107228. export var passPixelShader: {
  107229. name: string;
  107230. shader: string;
  107231. };
  107232. }
  107233. declare module BABYLON {
  107234. /** @hidden */
  107235. export var passCubePixelShader: {
  107236. name: string;
  107237. shader: string;
  107238. };
  107239. }
  107240. declare module BABYLON {
  107241. /**
  107242. * PassPostProcess which produces an output the same as it's input
  107243. */
  107244. export class PassPostProcess extends PostProcess {
  107245. /**
  107246. * Creates the PassPostProcess
  107247. * @param name The name of the effect.
  107248. * @param options The required width/height ratio to downsize to before computing the render pass.
  107249. * @param camera The camera to apply the render pass to.
  107250. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  107251. * @param engine The engine which the post process will be applied. (default: current engine)
  107252. * @param reusable If the post process can be reused on the same frame. (default: false)
  107253. * @param textureType The type of texture to be used when performing the post processing.
  107254. * @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)
  107255. */
  107256. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  107257. }
  107258. /**
  107259. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  107260. */
  107261. export class PassCubePostProcess extends PostProcess {
  107262. private _face;
  107263. /**
  107264. * Gets or sets the cube face to display.
  107265. * * 0 is +X
  107266. * * 1 is -X
  107267. * * 2 is +Y
  107268. * * 3 is -Y
  107269. * * 4 is +Z
  107270. * * 5 is -Z
  107271. */
  107272. face: number;
  107273. /**
  107274. * Creates the PassCubePostProcess
  107275. * @param name The name of the effect.
  107276. * @param options The required width/height ratio to downsize to before computing the render pass.
  107277. * @param camera The camera to apply the render pass to.
  107278. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  107279. * @param engine The engine which the post process will be applied. (default: current engine)
  107280. * @param reusable If the post process can be reused on the same frame. (default: false)
  107281. * @param textureType The type of texture to be used when performing the post processing.
  107282. * @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)
  107283. */
  107284. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  107285. }
  107286. }
  107287. declare module BABYLON {
  107288. /** @hidden */
  107289. export var anaglyphPixelShader: {
  107290. name: string;
  107291. shader: string;
  107292. };
  107293. }
  107294. declare module BABYLON {
  107295. /**
  107296. * Postprocess used to generate anaglyphic rendering
  107297. */
  107298. export class AnaglyphPostProcess extends PostProcess {
  107299. private _passedProcess;
  107300. /**
  107301. * Creates a new AnaglyphPostProcess
  107302. * @param name defines postprocess name
  107303. * @param options defines creation options or target ratio scale
  107304. * @param rigCameras defines cameras using this postprocess
  107305. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  107306. * @param engine defines hosting engine
  107307. * @param reusable defines if the postprocess will be reused multiple times per frame
  107308. */
  107309. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  107310. }
  107311. }
  107312. declare module BABYLON {
  107313. /**
  107314. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  107315. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107316. */
  107317. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  107318. /**
  107319. * Creates a new AnaglyphArcRotateCamera
  107320. * @param name defines camera name
  107321. * @param alpha defines alpha angle (in radians)
  107322. * @param beta defines beta angle (in radians)
  107323. * @param radius defines radius
  107324. * @param target defines camera target
  107325. * @param interaxialDistance defines distance between each color axis
  107326. * @param scene defines the hosting scene
  107327. */
  107328. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  107329. /**
  107330. * Gets camera class name
  107331. * @returns AnaglyphArcRotateCamera
  107332. */
  107333. getClassName(): string;
  107334. }
  107335. }
  107336. declare module BABYLON {
  107337. /**
  107338. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  107339. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107340. */
  107341. export class AnaglyphFreeCamera extends FreeCamera {
  107342. /**
  107343. * Creates a new AnaglyphFreeCamera
  107344. * @param name defines camera name
  107345. * @param position defines initial position
  107346. * @param interaxialDistance defines distance between each color axis
  107347. * @param scene defines the hosting scene
  107348. */
  107349. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  107350. /**
  107351. * Gets camera class name
  107352. * @returns AnaglyphFreeCamera
  107353. */
  107354. getClassName(): string;
  107355. }
  107356. }
  107357. declare module BABYLON {
  107358. /**
  107359. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  107360. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107361. */
  107362. export class AnaglyphGamepadCamera extends GamepadCamera {
  107363. /**
  107364. * Creates a new AnaglyphGamepadCamera
  107365. * @param name defines camera name
  107366. * @param position defines initial position
  107367. * @param interaxialDistance defines distance between each color axis
  107368. * @param scene defines the hosting scene
  107369. */
  107370. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  107371. /**
  107372. * Gets camera class name
  107373. * @returns AnaglyphGamepadCamera
  107374. */
  107375. getClassName(): string;
  107376. }
  107377. }
  107378. declare module BABYLON {
  107379. /**
  107380. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  107381. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107382. */
  107383. export class AnaglyphUniversalCamera extends UniversalCamera {
  107384. /**
  107385. * Creates a new AnaglyphUniversalCamera
  107386. * @param name defines camera name
  107387. * @param position defines initial position
  107388. * @param interaxialDistance defines distance between each color axis
  107389. * @param scene defines the hosting scene
  107390. */
  107391. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  107392. /**
  107393. * Gets camera class name
  107394. * @returns AnaglyphUniversalCamera
  107395. */
  107396. getClassName(): string;
  107397. }
  107398. }
  107399. declare module BABYLON {
  107400. /** @hidden */
  107401. export var stereoscopicInterlacePixelShader: {
  107402. name: string;
  107403. shader: string;
  107404. };
  107405. }
  107406. declare module BABYLON {
  107407. /**
  107408. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  107409. */
  107410. export class StereoscopicInterlacePostProcess extends PostProcess {
  107411. private _stepSize;
  107412. private _passedProcess;
  107413. /**
  107414. * Initializes a StereoscopicInterlacePostProcess
  107415. * @param name The name of the effect.
  107416. * @param rigCameras The rig cameras to be appled to the post process
  107417. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  107418. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  107419. * @param engine The engine which the post process will be applied. (default: current engine)
  107420. * @param reusable If the post process can be reused on the same frame. (default: false)
  107421. */
  107422. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  107423. }
  107424. }
  107425. declare module BABYLON {
  107426. /**
  107427. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  107428. * @see http://doc.babylonjs.com/features/cameras
  107429. */
  107430. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  107431. /**
  107432. * Creates a new StereoscopicArcRotateCamera
  107433. * @param name defines camera name
  107434. * @param alpha defines alpha angle (in radians)
  107435. * @param beta defines beta angle (in radians)
  107436. * @param radius defines radius
  107437. * @param target defines camera target
  107438. * @param interaxialDistance defines distance between each color axis
  107439. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107440. * @param scene defines the hosting scene
  107441. */
  107442. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107443. /**
  107444. * Gets camera class name
  107445. * @returns StereoscopicArcRotateCamera
  107446. */
  107447. getClassName(): string;
  107448. }
  107449. }
  107450. declare module BABYLON {
  107451. /**
  107452. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  107453. * @see http://doc.babylonjs.com/features/cameras
  107454. */
  107455. export class StereoscopicFreeCamera extends FreeCamera {
  107456. /**
  107457. * Creates a new StereoscopicFreeCamera
  107458. * @param name defines camera name
  107459. * @param position defines initial position
  107460. * @param interaxialDistance defines distance between each color axis
  107461. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107462. * @param scene defines the hosting scene
  107463. */
  107464. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107465. /**
  107466. * Gets camera class name
  107467. * @returns StereoscopicFreeCamera
  107468. */
  107469. getClassName(): string;
  107470. }
  107471. }
  107472. declare module BABYLON {
  107473. /**
  107474. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  107475. * @see http://doc.babylonjs.com/features/cameras
  107476. */
  107477. export class StereoscopicGamepadCamera extends GamepadCamera {
  107478. /**
  107479. * Creates a new StereoscopicGamepadCamera
  107480. * @param name defines camera name
  107481. * @param position defines initial position
  107482. * @param interaxialDistance defines distance between each color axis
  107483. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107484. * @param scene defines the hosting scene
  107485. */
  107486. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107487. /**
  107488. * Gets camera class name
  107489. * @returns StereoscopicGamepadCamera
  107490. */
  107491. getClassName(): string;
  107492. }
  107493. }
  107494. declare module BABYLON {
  107495. /**
  107496. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  107497. * @see http://doc.babylonjs.com/features/cameras
  107498. */
  107499. export class StereoscopicUniversalCamera extends UniversalCamera {
  107500. /**
  107501. * Creates a new StereoscopicUniversalCamera
  107502. * @param name defines camera name
  107503. * @param position defines initial position
  107504. * @param interaxialDistance defines distance between each color axis
  107505. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107506. * @param scene defines the hosting scene
  107507. */
  107508. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107509. /**
  107510. * Gets camera class name
  107511. * @returns StereoscopicUniversalCamera
  107512. */
  107513. getClassName(): string;
  107514. }
  107515. }
  107516. declare module BABYLON {
  107517. /**
  107518. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  107519. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  107520. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  107521. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  107522. */
  107523. export class VirtualJoysticksCamera extends FreeCamera {
  107524. /**
  107525. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  107526. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  107527. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  107528. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  107529. * @param name Define the name of the camera in the scene
  107530. * @param position Define the start position of the camera in the scene
  107531. * @param scene Define the scene the camera belongs to
  107532. */
  107533. constructor(name: string, position: Vector3, scene: Scene);
  107534. /**
  107535. * Gets the current object class name.
  107536. * @return the class name
  107537. */
  107538. getClassName(): string;
  107539. }
  107540. }
  107541. declare module BABYLON {
  107542. /**
  107543. * This represents all the required metrics to create a VR camera.
  107544. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  107545. */
  107546. export class VRCameraMetrics {
  107547. /**
  107548. * Define the horizontal resolution off the screen.
  107549. */
  107550. hResolution: number;
  107551. /**
  107552. * Define the vertical resolution off the screen.
  107553. */
  107554. vResolution: number;
  107555. /**
  107556. * Define the horizontal screen size.
  107557. */
  107558. hScreenSize: number;
  107559. /**
  107560. * Define the vertical screen size.
  107561. */
  107562. vScreenSize: number;
  107563. /**
  107564. * Define the vertical screen center position.
  107565. */
  107566. vScreenCenter: number;
  107567. /**
  107568. * Define the distance of the eyes to the screen.
  107569. */
  107570. eyeToScreenDistance: number;
  107571. /**
  107572. * Define the distance between both lenses
  107573. */
  107574. lensSeparationDistance: number;
  107575. /**
  107576. * Define the distance between both viewer's eyes.
  107577. */
  107578. interpupillaryDistance: number;
  107579. /**
  107580. * Define the distortion factor of the VR postprocess.
  107581. * Please, touch with care.
  107582. */
  107583. distortionK: number[];
  107584. /**
  107585. * Define the chromatic aberration correction factors for the VR post process.
  107586. */
  107587. chromaAbCorrection: number[];
  107588. /**
  107589. * Define the scale factor of the post process.
  107590. * The smaller the better but the slower.
  107591. */
  107592. postProcessScaleFactor: number;
  107593. /**
  107594. * Define an offset for the lens center.
  107595. */
  107596. lensCenterOffset: number;
  107597. /**
  107598. * Define if the current vr camera should compensate the distortion of the lense or not.
  107599. */
  107600. compensateDistortion: boolean;
  107601. /**
  107602. * Defines if multiview should be enabled when rendering (Default: false)
  107603. */
  107604. multiviewEnabled: boolean;
  107605. /**
  107606. * Gets the rendering aspect ratio based on the provided resolutions.
  107607. */
  107608. readonly aspectRatio: number;
  107609. /**
  107610. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  107611. */
  107612. readonly aspectRatioFov: number;
  107613. /**
  107614. * @hidden
  107615. */
  107616. readonly leftHMatrix: Matrix;
  107617. /**
  107618. * @hidden
  107619. */
  107620. readonly rightHMatrix: Matrix;
  107621. /**
  107622. * @hidden
  107623. */
  107624. readonly leftPreViewMatrix: Matrix;
  107625. /**
  107626. * @hidden
  107627. */
  107628. readonly rightPreViewMatrix: Matrix;
  107629. /**
  107630. * Get the default VRMetrics based on the most generic setup.
  107631. * @returns the default vr metrics
  107632. */
  107633. static GetDefault(): VRCameraMetrics;
  107634. }
  107635. }
  107636. declare module BABYLON {
  107637. /** @hidden */
  107638. export var vrDistortionCorrectionPixelShader: {
  107639. name: string;
  107640. shader: string;
  107641. };
  107642. }
  107643. declare module BABYLON {
  107644. /**
  107645. * VRDistortionCorrectionPostProcess used for mobile VR
  107646. */
  107647. export class VRDistortionCorrectionPostProcess extends PostProcess {
  107648. private _isRightEye;
  107649. private _distortionFactors;
  107650. private _postProcessScaleFactor;
  107651. private _lensCenterOffset;
  107652. private _scaleIn;
  107653. private _scaleFactor;
  107654. private _lensCenter;
  107655. /**
  107656. * Initializes the VRDistortionCorrectionPostProcess
  107657. * @param name The name of the effect.
  107658. * @param camera The camera to apply the render pass to.
  107659. * @param isRightEye If this is for the right eye distortion
  107660. * @param vrMetrics All the required metrics for the VR camera
  107661. */
  107662. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  107663. }
  107664. }
  107665. declare module BABYLON {
  107666. /**
  107667. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  107668. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  107669. */
  107670. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  107671. /**
  107672. * Creates a new VRDeviceOrientationArcRotateCamera
  107673. * @param name defines camera name
  107674. * @param alpha defines the camera rotation along the logitudinal axis
  107675. * @param beta defines the camera rotation along the latitudinal axis
  107676. * @param radius defines the camera distance from its target
  107677. * @param target defines the camera target
  107678. * @param scene defines the scene the camera belongs to
  107679. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  107680. * @param vrCameraMetrics defines the vr metrics associated to the camera
  107681. */
  107682. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  107683. /**
  107684. * Gets camera class name
  107685. * @returns VRDeviceOrientationArcRotateCamera
  107686. */
  107687. getClassName(): string;
  107688. }
  107689. }
  107690. declare module BABYLON {
  107691. /**
  107692. * Camera used to simulate VR rendering (based on FreeCamera)
  107693. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  107694. */
  107695. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  107696. /**
  107697. * Creates a new VRDeviceOrientationFreeCamera
  107698. * @param name defines camera name
  107699. * @param position defines the start position of the camera
  107700. * @param scene defines the scene the camera belongs to
  107701. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  107702. * @param vrCameraMetrics defines the vr metrics associated to the camera
  107703. */
  107704. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  107705. /**
  107706. * Gets camera class name
  107707. * @returns VRDeviceOrientationFreeCamera
  107708. */
  107709. getClassName(): string;
  107710. }
  107711. }
  107712. declare module BABYLON {
  107713. /**
  107714. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  107715. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  107716. */
  107717. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  107718. /**
  107719. * Creates a new VRDeviceOrientationGamepadCamera
  107720. * @param name defines camera name
  107721. * @param position defines the start position of the camera
  107722. * @param scene defines the scene the camera belongs to
  107723. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  107724. * @param vrCameraMetrics defines the vr metrics associated to the camera
  107725. */
  107726. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  107727. /**
  107728. * Gets camera class name
  107729. * @returns VRDeviceOrientationGamepadCamera
  107730. */
  107731. getClassName(): string;
  107732. }
  107733. }
  107734. declare module BABYLON {
  107735. /**
  107736. * Base class of materials working in push mode in babylon JS
  107737. * @hidden
  107738. */
  107739. export class PushMaterial extends Material {
  107740. protected _activeEffect: Effect;
  107741. protected _normalMatrix: Matrix;
  107742. /**
  107743. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  107744. * This means that the material can keep using a previous shader while a new one is being compiled.
  107745. * This is mostly used when shader parallel compilation is supported (true by default)
  107746. */
  107747. allowShaderHotSwapping: boolean;
  107748. constructor(name: string, scene: Scene);
  107749. getEffect(): Effect;
  107750. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  107751. /**
  107752. * Binds the given world matrix to the active effect
  107753. *
  107754. * @param world the matrix to bind
  107755. */
  107756. bindOnlyWorldMatrix(world: Matrix): void;
  107757. /**
  107758. * Binds the given normal matrix to the active effect
  107759. *
  107760. * @param normalMatrix the matrix to bind
  107761. */
  107762. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  107763. bind(world: Matrix, mesh?: Mesh): void;
  107764. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  107765. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  107766. }
  107767. }
  107768. declare module BABYLON {
  107769. /**
  107770. * This groups all the flags used to control the materials channel.
  107771. */
  107772. export class MaterialFlags {
  107773. private static _DiffuseTextureEnabled;
  107774. /**
  107775. * Are diffuse textures enabled in the application.
  107776. */
  107777. static DiffuseTextureEnabled: boolean;
  107778. private static _AmbientTextureEnabled;
  107779. /**
  107780. * Are ambient textures enabled in the application.
  107781. */
  107782. static AmbientTextureEnabled: boolean;
  107783. private static _OpacityTextureEnabled;
  107784. /**
  107785. * Are opacity textures enabled in the application.
  107786. */
  107787. static OpacityTextureEnabled: boolean;
  107788. private static _ReflectionTextureEnabled;
  107789. /**
  107790. * Are reflection textures enabled in the application.
  107791. */
  107792. static ReflectionTextureEnabled: boolean;
  107793. private static _EmissiveTextureEnabled;
  107794. /**
  107795. * Are emissive textures enabled in the application.
  107796. */
  107797. static EmissiveTextureEnabled: boolean;
  107798. private static _SpecularTextureEnabled;
  107799. /**
  107800. * Are specular textures enabled in the application.
  107801. */
  107802. static SpecularTextureEnabled: boolean;
  107803. private static _BumpTextureEnabled;
  107804. /**
  107805. * Are bump textures enabled in the application.
  107806. */
  107807. static BumpTextureEnabled: boolean;
  107808. private static _LightmapTextureEnabled;
  107809. /**
  107810. * Are lightmap textures enabled in the application.
  107811. */
  107812. static LightmapTextureEnabled: boolean;
  107813. private static _RefractionTextureEnabled;
  107814. /**
  107815. * Are refraction textures enabled in the application.
  107816. */
  107817. static RefractionTextureEnabled: boolean;
  107818. private static _ColorGradingTextureEnabled;
  107819. /**
  107820. * Are color grading textures enabled in the application.
  107821. */
  107822. static ColorGradingTextureEnabled: boolean;
  107823. private static _FresnelEnabled;
  107824. /**
  107825. * Are fresnels enabled in the application.
  107826. */
  107827. static FresnelEnabled: boolean;
  107828. private static _ClearCoatTextureEnabled;
  107829. /**
  107830. * Are clear coat textures enabled in the application.
  107831. */
  107832. static ClearCoatTextureEnabled: boolean;
  107833. private static _ClearCoatBumpTextureEnabled;
  107834. /**
  107835. * Are clear coat bump textures enabled in the application.
  107836. */
  107837. static ClearCoatBumpTextureEnabled: boolean;
  107838. private static _ClearCoatTintTextureEnabled;
  107839. /**
  107840. * Are clear coat tint textures enabled in the application.
  107841. */
  107842. static ClearCoatTintTextureEnabled: boolean;
  107843. private static _SheenTextureEnabled;
  107844. /**
  107845. * Are sheen textures enabled in the application.
  107846. */
  107847. static SheenTextureEnabled: boolean;
  107848. private static _AnisotropicTextureEnabled;
  107849. /**
  107850. * Are anisotropic textures enabled in the application.
  107851. */
  107852. static AnisotropicTextureEnabled: boolean;
  107853. private static _ThicknessTextureEnabled;
  107854. /**
  107855. * Are thickness textures enabled in the application.
  107856. */
  107857. static ThicknessTextureEnabled: boolean;
  107858. }
  107859. }
  107860. declare module BABYLON {
  107861. /** @hidden */
  107862. export var defaultFragmentDeclaration: {
  107863. name: string;
  107864. shader: string;
  107865. };
  107866. }
  107867. declare module BABYLON {
  107868. /** @hidden */
  107869. export var defaultUboDeclaration: {
  107870. name: string;
  107871. shader: string;
  107872. };
  107873. }
  107874. declare module BABYLON {
  107875. /** @hidden */
  107876. export var lightFragmentDeclaration: {
  107877. name: string;
  107878. shader: string;
  107879. };
  107880. }
  107881. declare module BABYLON {
  107882. /** @hidden */
  107883. export var lightUboDeclaration: {
  107884. name: string;
  107885. shader: string;
  107886. };
  107887. }
  107888. declare module BABYLON {
  107889. /** @hidden */
  107890. export var lightsFragmentFunctions: {
  107891. name: string;
  107892. shader: string;
  107893. };
  107894. }
  107895. declare module BABYLON {
  107896. /** @hidden */
  107897. export var shadowsFragmentFunctions: {
  107898. name: string;
  107899. shader: string;
  107900. };
  107901. }
  107902. declare module BABYLON {
  107903. /** @hidden */
  107904. export var fresnelFunction: {
  107905. name: string;
  107906. shader: string;
  107907. };
  107908. }
  107909. declare module BABYLON {
  107910. /** @hidden */
  107911. export var reflectionFunction: {
  107912. name: string;
  107913. shader: string;
  107914. };
  107915. }
  107916. declare module BABYLON {
  107917. /** @hidden */
  107918. export var bumpFragmentFunctions: {
  107919. name: string;
  107920. shader: string;
  107921. };
  107922. }
  107923. declare module BABYLON {
  107924. /** @hidden */
  107925. export var logDepthDeclaration: {
  107926. name: string;
  107927. shader: string;
  107928. };
  107929. }
  107930. declare module BABYLON {
  107931. /** @hidden */
  107932. export var bumpFragment: {
  107933. name: string;
  107934. shader: string;
  107935. };
  107936. }
  107937. declare module BABYLON {
  107938. /** @hidden */
  107939. export var depthPrePass: {
  107940. name: string;
  107941. shader: string;
  107942. };
  107943. }
  107944. declare module BABYLON {
  107945. /** @hidden */
  107946. export var lightFragment: {
  107947. name: string;
  107948. shader: string;
  107949. };
  107950. }
  107951. declare module BABYLON {
  107952. /** @hidden */
  107953. export var logDepthFragment: {
  107954. name: string;
  107955. shader: string;
  107956. };
  107957. }
  107958. declare module BABYLON {
  107959. /** @hidden */
  107960. export var defaultPixelShader: {
  107961. name: string;
  107962. shader: string;
  107963. };
  107964. }
  107965. declare module BABYLON {
  107966. /** @hidden */
  107967. export var defaultVertexDeclaration: {
  107968. name: string;
  107969. shader: string;
  107970. };
  107971. }
  107972. declare module BABYLON {
  107973. /** @hidden */
  107974. export var bumpVertexDeclaration: {
  107975. name: string;
  107976. shader: string;
  107977. };
  107978. }
  107979. declare module BABYLON {
  107980. /** @hidden */
  107981. export var bumpVertex: {
  107982. name: string;
  107983. shader: string;
  107984. };
  107985. }
  107986. declare module BABYLON {
  107987. /** @hidden */
  107988. export var fogVertex: {
  107989. name: string;
  107990. shader: string;
  107991. };
  107992. }
  107993. declare module BABYLON {
  107994. /** @hidden */
  107995. export var shadowsVertex: {
  107996. name: string;
  107997. shader: string;
  107998. };
  107999. }
  108000. declare module BABYLON {
  108001. /** @hidden */
  108002. export var pointCloudVertex: {
  108003. name: string;
  108004. shader: string;
  108005. };
  108006. }
  108007. declare module BABYLON {
  108008. /** @hidden */
  108009. export var logDepthVertex: {
  108010. name: string;
  108011. shader: string;
  108012. };
  108013. }
  108014. declare module BABYLON {
  108015. /** @hidden */
  108016. export var defaultVertexShader: {
  108017. name: string;
  108018. shader: string;
  108019. };
  108020. }
  108021. declare module BABYLON {
  108022. /** @hidden */
  108023. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  108024. MAINUV1: boolean;
  108025. MAINUV2: boolean;
  108026. DIFFUSE: boolean;
  108027. DIFFUSEDIRECTUV: number;
  108028. AMBIENT: boolean;
  108029. AMBIENTDIRECTUV: number;
  108030. OPACITY: boolean;
  108031. OPACITYDIRECTUV: number;
  108032. OPACITYRGB: boolean;
  108033. REFLECTION: boolean;
  108034. EMISSIVE: boolean;
  108035. EMISSIVEDIRECTUV: number;
  108036. SPECULAR: boolean;
  108037. SPECULARDIRECTUV: number;
  108038. BUMP: boolean;
  108039. BUMPDIRECTUV: number;
  108040. PARALLAX: boolean;
  108041. PARALLAXOCCLUSION: boolean;
  108042. SPECULAROVERALPHA: boolean;
  108043. CLIPPLANE: boolean;
  108044. CLIPPLANE2: boolean;
  108045. CLIPPLANE3: boolean;
  108046. CLIPPLANE4: boolean;
  108047. ALPHATEST: boolean;
  108048. DEPTHPREPASS: boolean;
  108049. ALPHAFROMDIFFUSE: boolean;
  108050. POINTSIZE: boolean;
  108051. FOG: boolean;
  108052. SPECULARTERM: boolean;
  108053. DIFFUSEFRESNEL: boolean;
  108054. OPACITYFRESNEL: boolean;
  108055. REFLECTIONFRESNEL: boolean;
  108056. REFRACTIONFRESNEL: boolean;
  108057. EMISSIVEFRESNEL: boolean;
  108058. FRESNEL: boolean;
  108059. NORMAL: boolean;
  108060. UV1: boolean;
  108061. UV2: boolean;
  108062. VERTEXCOLOR: boolean;
  108063. VERTEXALPHA: boolean;
  108064. NUM_BONE_INFLUENCERS: number;
  108065. BonesPerMesh: number;
  108066. BONETEXTURE: boolean;
  108067. INSTANCES: boolean;
  108068. GLOSSINESS: boolean;
  108069. ROUGHNESS: boolean;
  108070. EMISSIVEASILLUMINATION: boolean;
  108071. LINKEMISSIVEWITHDIFFUSE: boolean;
  108072. REFLECTIONFRESNELFROMSPECULAR: boolean;
  108073. LIGHTMAP: boolean;
  108074. LIGHTMAPDIRECTUV: number;
  108075. OBJECTSPACE_NORMALMAP: boolean;
  108076. USELIGHTMAPASSHADOWMAP: boolean;
  108077. REFLECTIONMAP_3D: boolean;
  108078. REFLECTIONMAP_SPHERICAL: boolean;
  108079. REFLECTIONMAP_PLANAR: boolean;
  108080. REFLECTIONMAP_CUBIC: boolean;
  108081. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  108082. REFLECTIONMAP_PROJECTION: boolean;
  108083. REFLECTIONMAP_SKYBOX: boolean;
  108084. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  108085. REFLECTIONMAP_EXPLICIT: boolean;
  108086. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  108087. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  108088. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  108089. INVERTCUBICMAP: boolean;
  108090. LOGARITHMICDEPTH: boolean;
  108091. REFRACTION: boolean;
  108092. REFRACTIONMAP_3D: boolean;
  108093. REFLECTIONOVERALPHA: boolean;
  108094. TWOSIDEDLIGHTING: boolean;
  108095. SHADOWFLOAT: boolean;
  108096. MORPHTARGETS: boolean;
  108097. MORPHTARGETS_NORMAL: boolean;
  108098. MORPHTARGETS_TANGENT: boolean;
  108099. MORPHTARGETS_UV: boolean;
  108100. NUM_MORPH_INFLUENCERS: number;
  108101. NONUNIFORMSCALING: boolean;
  108102. PREMULTIPLYALPHA: boolean;
  108103. IMAGEPROCESSING: boolean;
  108104. VIGNETTE: boolean;
  108105. VIGNETTEBLENDMODEMULTIPLY: boolean;
  108106. VIGNETTEBLENDMODEOPAQUE: boolean;
  108107. TONEMAPPING: boolean;
  108108. TONEMAPPING_ACES: boolean;
  108109. CONTRAST: boolean;
  108110. COLORCURVES: boolean;
  108111. COLORGRADING: boolean;
  108112. COLORGRADING3D: boolean;
  108113. SAMPLER3DGREENDEPTH: boolean;
  108114. SAMPLER3DBGRMAP: boolean;
  108115. IMAGEPROCESSINGPOSTPROCESS: boolean;
  108116. MULTIVIEW: boolean;
  108117. /**
  108118. * If the reflection texture on this material is in linear color space
  108119. * @hidden
  108120. */
  108121. IS_REFLECTION_LINEAR: boolean;
  108122. /**
  108123. * If the refraction texture on this material is in linear color space
  108124. * @hidden
  108125. */
  108126. IS_REFRACTION_LINEAR: boolean;
  108127. EXPOSURE: boolean;
  108128. constructor();
  108129. setReflectionMode(modeToEnable: string): void;
  108130. }
  108131. /**
  108132. * This is the default material used in Babylon. It is the best trade off between quality
  108133. * and performances.
  108134. * @see http://doc.babylonjs.com/babylon101/materials
  108135. */
  108136. export class StandardMaterial extends PushMaterial {
  108137. private _diffuseTexture;
  108138. /**
  108139. * The basic texture of the material as viewed under a light.
  108140. */
  108141. diffuseTexture: Nullable<BaseTexture>;
  108142. private _ambientTexture;
  108143. /**
  108144. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  108145. */
  108146. ambientTexture: Nullable<BaseTexture>;
  108147. private _opacityTexture;
  108148. /**
  108149. * Define the transparency of the material from a texture.
  108150. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  108151. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  108152. */
  108153. opacityTexture: Nullable<BaseTexture>;
  108154. private _reflectionTexture;
  108155. /**
  108156. * Define the texture used to display the reflection.
  108157. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108158. */
  108159. reflectionTexture: Nullable<BaseTexture>;
  108160. private _emissiveTexture;
  108161. /**
  108162. * Define texture of the material as if self lit.
  108163. * This will be mixed in the final result even in the absence of light.
  108164. */
  108165. emissiveTexture: Nullable<BaseTexture>;
  108166. private _specularTexture;
  108167. /**
  108168. * Define how the color and intensity of the highlight given by the light in the material.
  108169. */
  108170. specularTexture: Nullable<BaseTexture>;
  108171. private _bumpTexture;
  108172. /**
  108173. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  108174. * 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.
  108175. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  108176. */
  108177. bumpTexture: Nullable<BaseTexture>;
  108178. private _lightmapTexture;
  108179. /**
  108180. * Complex lighting can be computationally expensive to compute at runtime.
  108181. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  108182. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  108183. */
  108184. lightmapTexture: Nullable<BaseTexture>;
  108185. private _refractionTexture;
  108186. /**
  108187. * Define the texture used to display the refraction.
  108188. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108189. */
  108190. refractionTexture: Nullable<BaseTexture>;
  108191. /**
  108192. * The color of the material lit by the environmental background lighting.
  108193. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  108194. */
  108195. ambientColor: Color3;
  108196. /**
  108197. * The basic color of the material as viewed under a light.
  108198. */
  108199. diffuseColor: Color3;
  108200. /**
  108201. * Define how the color and intensity of the highlight given by the light in the material.
  108202. */
  108203. specularColor: Color3;
  108204. /**
  108205. * Define the color of the material as if self lit.
  108206. * This will be mixed in the final result even in the absence of light.
  108207. */
  108208. emissiveColor: Color3;
  108209. /**
  108210. * Defines how sharp are the highlights in the material.
  108211. * The bigger the value the sharper giving a more glossy feeling to the result.
  108212. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  108213. */
  108214. specularPower: number;
  108215. private _useAlphaFromDiffuseTexture;
  108216. /**
  108217. * Does the transparency come from the diffuse texture alpha channel.
  108218. */
  108219. useAlphaFromDiffuseTexture: boolean;
  108220. private _useEmissiveAsIllumination;
  108221. /**
  108222. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  108223. */
  108224. useEmissiveAsIllumination: boolean;
  108225. private _linkEmissiveWithDiffuse;
  108226. /**
  108227. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  108228. * the emissive level when the final color is close to one.
  108229. */
  108230. linkEmissiveWithDiffuse: boolean;
  108231. private _useSpecularOverAlpha;
  108232. /**
  108233. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  108234. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  108235. */
  108236. useSpecularOverAlpha: boolean;
  108237. private _useReflectionOverAlpha;
  108238. /**
  108239. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  108240. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  108241. */
  108242. useReflectionOverAlpha: boolean;
  108243. private _disableLighting;
  108244. /**
  108245. * Does lights from the scene impacts this material.
  108246. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  108247. */
  108248. disableLighting: boolean;
  108249. private _useObjectSpaceNormalMap;
  108250. /**
  108251. * Allows using an object space normal map (instead of tangent space).
  108252. */
  108253. useObjectSpaceNormalMap: boolean;
  108254. private _useParallax;
  108255. /**
  108256. * Is parallax enabled or not.
  108257. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  108258. */
  108259. useParallax: boolean;
  108260. private _useParallaxOcclusion;
  108261. /**
  108262. * Is parallax occlusion enabled or not.
  108263. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  108264. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  108265. */
  108266. useParallaxOcclusion: boolean;
  108267. /**
  108268. * 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.
  108269. */
  108270. parallaxScaleBias: number;
  108271. private _roughness;
  108272. /**
  108273. * Helps to define how blurry the reflections should appears in the material.
  108274. */
  108275. roughness: number;
  108276. /**
  108277. * In case of refraction, define the value of the index of refraction.
  108278. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108279. */
  108280. indexOfRefraction: number;
  108281. /**
  108282. * Invert the refraction texture alongside the y axis.
  108283. * It can be useful with procedural textures or probe for instance.
  108284. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108285. */
  108286. invertRefractionY: boolean;
  108287. /**
  108288. * Defines the alpha limits in alpha test mode.
  108289. */
  108290. alphaCutOff: number;
  108291. private _useLightmapAsShadowmap;
  108292. /**
  108293. * In case of light mapping, define whether the map contains light or shadow informations.
  108294. */
  108295. useLightmapAsShadowmap: boolean;
  108296. private _diffuseFresnelParameters;
  108297. /**
  108298. * Define the diffuse fresnel parameters of the material.
  108299. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108300. */
  108301. diffuseFresnelParameters: FresnelParameters;
  108302. private _opacityFresnelParameters;
  108303. /**
  108304. * Define the opacity fresnel parameters of the material.
  108305. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108306. */
  108307. opacityFresnelParameters: FresnelParameters;
  108308. private _reflectionFresnelParameters;
  108309. /**
  108310. * Define the reflection fresnel parameters of the material.
  108311. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108312. */
  108313. reflectionFresnelParameters: FresnelParameters;
  108314. private _refractionFresnelParameters;
  108315. /**
  108316. * Define the refraction fresnel parameters of the material.
  108317. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108318. */
  108319. refractionFresnelParameters: FresnelParameters;
  108320. private _emissiveFresnelParameters;
  108321. /**
  108322. * Define the emissive fresnel parameters of the material.
  108323. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108324. */
  108325. emissiveFresnelParameters: FresnelParameters;
  108326. private _useReflectionFresnelFromSpecular;
  108327. /**
  108328. * If true automatically deducts the fresnels values from the material specularity.
  108329. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108330. */
  108331. useReflectionFresnelFromSpecular: boolean;
  108332. private _useGlossinessFromSpecularMapAlpha;
  108333. /**
  108334. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  108335. */
  108336. useGlossinessFromSpecularMapAlpha: boolean;
  108337. private _maxSimultaneousLights;
  108338. /**
  108339. * Defines the maximum number of lights that can be used in the material
  108340. */
  108341. maxSimultaneousLights: number;
  108342. private _invertNormalMapX;
  108343. /**
  108344. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  108345. */
  108346. invertNormalMapX: boolean;
  108347. private _invertNormalMapY;
  108348. /**
  108349. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  108350. */
  108351. invertNormalMapY: boolean;
  108352. private _twoSidedLighting;
  108353. /**
  108354. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  108355. */
  108356. twoSidedLighting: boolean;
  108357. /**
  108358. * Default configuration related to image processing available in the standard Material.
  108359. */
  108360. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  108361. /**
  108362. * Gets the image processing configuration used either in this material.
  108363. */
  108364. /**
  108365. * Sets the Default image processing configuration used either in the this material.
  108366. *
  108367. * If sets to null, the scene one is in use.
  108368. */
  108369. imageProcessingConfiguration: ImageProcessingConfiguration;
  108370. /**
  108371. * Keep track of the image processing observer to allow dispose and replace.
  108372. */
  108373. private _imageProcessingObserver;
  108374. /**
  108375. * Attaches a new image processing configuration to the Standard Material.
  108376. * @param configuration
  108377. */
  108378. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  108379. /**
  108380. * Gets wether the color curves effect is enabled.
  108381. */
  108382. /**
  108383. * Sets wether the color curves effect is enabled.
  108384. */
  108385. cameraColorCurvesEnabled: boolean;
  108386. /**
  108387. * Gets wether the color grading effect is enabled.
  108388. */
  108389. /**
  108390. * Gets wether the color grading effect is enabled.
  108391. */
  108392. cameraColorGradingEnabled: boolean;
  108393. /**
  108394. * Gets wether tonemapping is enabled or not.
  108395. */
  108396. /**
  108397. * Sets wether tonemapping is enabled or not
  108398. */
  108399. cameraToneMappingEnabled: boolean;
  108400. /**
  108401. * The camera exposure used on this material.
  108402. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  108403. * This corresponds to a photographic exposure.
  108404. */
  108405. /**
  108406. * The camera exposure used on this material.
  108407. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  108408. * This corresponds to a photographic exposure.
  108409. */
  108410. cameraExposure: number;
  108411. /**
  108412. * Gets The camera contrast used on this material.
  108413. */
  108414. /**
  108415. * Sets The camera contrast used on this material.
  108416. */
  108417. cameraContrast: number;
  108418. /**
  108419. * Gets the Color Grading 2D Lookup Texture.
  108420. */
  108421. /**
  108422. * Sets the Color Grading 2D Lookup Texture.
  108423. */
  108424. cameraColorGradingTexture: Nullable<BaseTexture>;
  108425. /**
  108426. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  108427. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  108428. * 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;
  108429. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  108430. */
  108431. /**
  108432. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  108433. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  108434. * 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;
  108435. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  108436. */
  108437. cameraColorCurves: Nullable<ColorCurves>;
  108438. /**
  108439. * Custom callback helping to override the default shader used in the material.
  108440. */
  108441. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  108442. protected _renderTargets: SmartArray<RenderTargetTexture>;
  108443. protected _worldViewProjectionMatrix: Matrix;
  108444. protected _globalAmbientColor: Color3;
  108445. protected _useLogarithmicDepth: boolean;
  108446. protected _rebuildInParallel: boolean;
  108447. /**
  108448. * Instantiates a new standard material.
  108449. * This is the default material used in Babylon. It is the best trade off between quality
  108450. * and performances.
  108451. * @see http://doc.babylonjs.com/babylon101/materials
  108452. * @param name Define the name of the material in the scene
  108453. * @param scene Define the scene the material belong to
  108454. */
  108455. constructor(name: string, scene: Scene);
  108456. /**
  108457. * Gets a boolean indicating that current material needs to register RTT
  108458. */
  108459. readonly hasRenderTargetTextures: boolean;
  108460. /**
  108461. * Gets the current class name of the material e.g. "StandardMaterial"
  108462. * Mainly use in serialization.
  108463. * @returns the class name
  108464. */
  108465. getClassName(): string;
  108466. /**
  108467. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  108468. * You can try switching to logarithmic depth.
  108469. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  108470. */
  108471. useLogarithmicDepth: boolean;
  108472. /**
  108473. * Specifies if the material will require alpha blending
  108474. * @returns a boolean specifying if alpha blending is needed
  108475. */
  108476. needAlphaBlending(): boolean;
  108477. /**
  108478. * Specifies if this material should be rendered in alpha test mode
  108479. * @returns a boolean specifying if an alpha test is needed.
  108480. */
  108481. needAlphaTesting(): boolean;
  108482. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  108483. /**
  108484. * Get the texture used for alpha test purpose.
  108485. * @returns the diffuse texture in case of the standard material.
  108486. */
  108487. getAlphaTestTexture(): Nullable<BaseTexture>;
  108488. /**
  108489. * Get if the submesh is ready to be used and all its information available.
  108490. * Child classes can use it to update shaders
  108491. * @param mesh defines the mesh to check
  108492. * @param subMesh defines which submesh to check
  108493. * @param useInstances specifies that instances should be used
  108494. * @returns a boolean indicating that the submesh is ready or not
  108495. */
  108496. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  108497. /**
  108498. * Builds the material UBO layouts.
  108499. * Used internally during the effect preparation.
  108500. */
  108501. buildUniformLayout(): void;
  108502. /**
  108503. * Unbinds the material from the mesh
  108504. */
  108505. unbind(): void;
  108506. /**
  108507. * Binds the submesh to this material by preparing the effect and shader to draw
  108508. * @param world defines the world transformation matrix
  108509. * @param mesh defines the mesh containing the submesh
  108510. * @param subMesh defines the submesh to bind the material to
  108511. */
  108512. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  108513. /**
  108514. * Get the list of animatables in the material.
  108515. * @returns the list of animatables object used in the material
  108516. */
  108517. getAnimatables(): IAnimatable[];
  108518. /**
  108519. * Gets the active textures from the material
  108520. * @returns an array of textures
  108521. */
  108522. getActiveTextures(): BaseTexture[];
  108523. /**
  108524. * Specifies if the material uses a texture
  108525. * @param texture defines the texture to check against the material
  108526. * @returns a boolean specifying if the material uses the texture
  108527. */
  108528. hasTexture(texture: BaseTexture): boolean;
  108529. /**
  108530. * Disposes the material
  108531. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  108532. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  108533. */
  108534. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  108535. /**
  108536. * Makes a duplicate of the material, and gives it a new name
  108537. * @param name defines the new name for the duplicated material
  108538. * @returns the cloned material
  108539. */
  108540. clone(name: string): StandardMaterial;
  108541. /**
  108542. * Serializes this material in a JSON representation
  108543. * @returns the serialized material object
  108544. */
  108545. serialize(): any;
  108546. /**
  108547. * Creates a standard material from parsed material data
  108548. * @param source defines the JSON representation of the material
  108549. * @param scene defines the hosting scene
  108550. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  108551. * @returns a new standard material
  108552. */
  108553. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  108554. /**
  108555. * Are diffuse textures enabled in the application.
  108556. */
  108557. static DiffuseTextureEnabled: boolean;
  108558. /**
  108559. * Are ambient textures enabled in the application.
  108560. */
  108561. static AmbientTextureEnabled: boolean;
  108562. /**
  108563. * Are opacity textures enabled in the application.
  108564. */
  108565. static OpacityTextureEnabled: boolean;
  108566. /**
  108567. * Are reflection textures enabled in the application.
  108568. */
  108569. static ReflectionTextureEnabled: boolean;
  108570. /**
  108571. * Are emissive textures enabled in the application.
  108572. */
  108573. static EmissiveTextureEnabled: boolean;
  108574. /**
  108575. * Are specular textures enabled in the application.
  108576. */
  108577. static SpecularTextureEnabled: boolean;
  108578. /**
  108579. * Are bump textures enabled in the application.
  108580. */
  108581. static BumpTextureEnabled: boolean;
  108582. /**
  108583. * Are lightmap textures enabled in the application.
  108584. */
  108585. static LightmapTextureEnabled: boolean;
  108586. /**
  108587. * Are refraction textures enabled in the application.
  108588. */
  108589. static RefractionTextureEnabled: boolean;
  108590. /**
  108591. * Are color grading textures enabled in the application.
  108592. */
  108593. static ColorGradingTextureEnabled: boolean;
  108594. /**
  108595. * Are fresnels enabled in the application.
  108596. */
  108597. static FresnelEnabled: boolean;
  108598. }
  108599. }
  108600. declare module BABYLON {
  108601. /** @hidden */
  108602. export var imageProcessingPixelShader: {
  108603. name: string;
  108604. shader: string;
  108605. };
  108606. }
  108607. declare module BABYLON {
  108608. /**
  108609. * ImageProcessingPostProcess
  108610. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  108611. */
  108612. export class ImageProcessingPostProcess extends PostProcess {
  108613. /**
  108614. * Default configuration related to image processing available in the PBR Material.
  108615. */
  108616. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  108617. /**
  108618. * Gets the image processing configuration used either in this material.
  108619. */
  108620. /**
  108621. * Sets the Default image processing configuration used either in the this material.
  108622. *
  108623. * If sets to null, the scene one is in use.
  108624. */
  108625. imageProcessingConfiguration: ImageProcessingConfiguration;
  108626. /**
  108627. * Keep track of the image processing observer to allow dispose and replace.
  108628. */
  108629. private _imageProcessingObserver;
  108630. /**
  108631. * Attaches a new image processing configuration to the PBR Material.
  108632. * @param configuration
  108633. */
  108634. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  108635. /**
  108636. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  108637. */
  108638. /**
  108639. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  108640. */
  108641. colorCurves: Nullable<ColorCurves>;
  108642. /**
  108643. * Gets wether the color curves effect is enabled.
  108644. */
  108645. /**
  108646. * Sets wether the color curves effect is enabled.
  108647. */
  108648. colorCurvesEnabled: boolean;
  108649. /**
  108650. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  108651. */
  108652. /**
  108653. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  108654. */
  108655. colorGradingTexture: Nullable<BaseTexture>;
  108656. /**
  108657. * Gets wether the color grading effect is enabled.
  108658. */
  108659. /**
  108660. * Gets wether the color grading effect is enabled.
  108661. */
  108662. colorGradingEnabled: boolean;
  108663. /**
  108664. * Gets exposure used in the effect.
  108665. */
  108666. /**
  108667. * Sets exposure used in the effect.
  108668. */
  108669. exposure: number;
  108670. /**
  108671. * Gets wether tonemapping is enabled or not.
  108672. */
  108673. /**
  108674. * Sets wether tonemapping is enabled or not
  108675. */
  108676. toneMappingEnabled: boolean;
  108677. /**
  108678. * Gets the type of tone mapping effect.
  108679. */
  108680. /**
  108681. * Sets the type of tone mapping effect.
  108682. */
  108683. toneMappingType: number;
  108684. /**
  108685. * Gets contrast used in the effect.
  108686. */
  108687. /**
  108688. * Sets contrast used in the effect.
  108689. */
  108690. contrast: number;
  108691. /**
  108692. * Gets Vignette stretch size.
  108693. */
  108694. /**
  108695. * Sets Vignette stretch size.
  108696. */
  108697. vignetteStretch: number;
  108698. /**
  108699. * Gets Vignette centre X Offset.
  108700. */
  108701. /**
  108702. * Sets Vignette centre X Offset.
  108703. */
  108704. vignetteCentreX: number;
  108705. /**
  108706. * Gets Vignette centre Y Offset.
  108707. */
  108708. /**
  108709. * Sets Vignette centre Y Offset.
  108710. */
  108711. vignetteCentreY: number;
  108712. /**
  108713. * Gets Vignette weight or intensity of the vignette effect.
  108714. */
  108715. /**
  108716. * Sets Vignette weight or intensity of the vignette effect.
  108717. */
  108718. vignetteWeight: number;
  108719. /**
  108720. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  108721. * if vignetteEnabled is set to true.
  108722. */
  108723. /**
  108724. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  108725. * if vignetteEnabled is set to true.
  108726. */
  108727. vignetteColor: Color4;
  108728. /**
  108729. * Gets Camera field of view used by the Vignette effect.
  108730. */
  108731. /**
  108732. * Sets Camera field of view used by the Vignette effect.
  108733. */
  108734. vignetteCameraFov: number;
  108735. /**
  108736. * Gets the vignette blend mode allowing different kind of effect.
  108737. */
  108738. /**
  108739. * Sets the vignette blend mode allowing different kind of effect.
  108740. */
  108741. vignetteBlendMode: number;
  108742. /**
  108743. * Gets wether the vignette effect is enabled.
  108744. */
  108745. /**
  108746. * Sets wether the vignette effect is enabled.
  108747. */
  108748. vignetteEnabled: boolean;
  108749. private _fromLinearSpace;
  108750. /**
  108751. * Gets wether the input of the processing is in Gamma or Linear Space.
  108752. */
  108753. /**
  108754. * Sets wether the input of the processing is in Gamma or Linear Space.
  108755. */
  108756. fromLinearSpace: boolean;
  108757. /**
  108758. * Defines cache preventing GC.
  108759. */
  108760. private _defines;
  108761. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  108762. /**
  108763. * "ImageProcessingPostProcess"
  108764. * @returns "ImageProcessingPostProcess"
  108765. */
  108766. getClassName(): string;
  108767. protected _updateParameters(): void;
  108768. dispose(camera?: Camera): void;
  108769. }
  108770. }
  108771. declare module BABYLON {
  108772. /**
  108773. * Class containing static functions to help procedurally build meshes
  108774. */
  108775. export class GroundBuilder {
  108776. /**
  108777. * Creates a ground mesh
  108778. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  108779. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  108780. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108781. * @param name defines the name of the mesh
  108782. * @param options defines the options used to create the mesh
  108783. * @param scene defines the hosting scene
  108784. * @returns the ground mesh
  108785. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  108786. */
  108787. static CreateGround(name: string, options: {
  108788. width?: number;
  108789. height?: number;
  108790. subdivisions?: number;
  108791. subdivisionsX?: number;
  108792. subdivisionsY?: number;
  108793. updatable?: boolean;
  108794. }, scene: any): Mesh;
  108795. /**
  108796. * Creates a tiled ground mesh
  108797. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  108798. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  108799. * * 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
  108800. * * 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
  108801. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108802. * @param name defines the name of the mesh
  108803. * @param options defines the options used to create the mesh
  108804. * @param scene defines the hosting scene
  108805. * @returns the tiled ground mesh
  108806. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  108807. */
  108808. static CreateTiledGround(name: string, options: {
  108809. xmin: number;
  108810. zmin: number;
  108811. xmax: number;
  108812. zmax: number;
  108813. subdivisions?: {
  108814. w: number;
  108815. h: number;
  108816. };
  108817. precision?: {
  108818. w: number;
  108819. h: number;
  108820. };
  108821. updatable?: boolean;
  108822. }, scene?: Nullable<Scene>): Mesh;
  108823. /**
  108824. * Creates a ground mesh from a height map
  108825. * * The parameter `url` sets the URL of the height map image resource.
  108826. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  108827. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  108828. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  108829. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  108830. * * 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.
  108831. * * 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).
  108832. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108833. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108834. * @param name defines the name of the mesh
  108835. * @param url defines the url to the height map
  108836. * @param options defines the options used to create the mesh
  108837. * @param scene defines the hosting scene
  108838. * @returns the ground mesh
  108839. * @see https://doc.babylonjs.com/babylon101/height_map
  108840. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  108841. */
  108842. static CreateGroundFromHeightMap(name: string, url: string, options: {
  108843. width?: number;
  108844. height?: number;
  108845. subdivisions?: number;
  108846. minHeight?: number;
  108847. maxHeight?: number;
  108848. colorFilter?: Color3;
  108849. alphaFilter?: number;
  108850. updatable?: boolean;
  108851. onReady?: (mesh: GroundMesh) => void;
  108852. }, scene?: Nullable<Scene>): GroundMesh;
  108853. }
  108854. }
  108855. declare module BABYLON {
  108856. /**
  108857. * Class containing static functions to help procedurally build meshes
  108858. */
  108859. export class TorusBuilder {
  108860. /**
  108861. * Creates a torus mesh
  108862. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  108863. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  108864. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  108865. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  108866. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108867. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108868. * @param name defines the name of the mesh
  108869. * @param options defines the options used to create the mesh
  108870. * @param scene defines the hosting scene
  108871. * @returns the torus mesh
  108872. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  108873. */
  108874. static CreateTorus(name: string, options: {
  108875. diameter?: number;
  108876. thickness?: number;
  108877. tessellation?: number;
  108878. updatable?: boolean;
  108879. sideOrientation?: number;
  108880. frontUVs?: Vector4;
  108881. backUVs?: Vector4;
  108882. }, scene: any): Mesh;
  108883. }
  108884. }
  108885. declare module BABYLON {
  108886. /**
  108887. * Class containing static functions to help procedurally build meshes
  108888. */
  108889. export class CylinderBuilder {
  108890. /**
  108891. * Creates a cylinder or a cone mesh
  108892. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  108893. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  108894. * * 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.
  108895. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  108896. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  108897. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  108898. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  108899. * * 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).
  108900. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  108901. * * 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).
  108902. * * 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
  108903. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  108904. * * 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
  108905. * * 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.
  108906. * * If `enclose` is false, a ring surface is one element.
  108907. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  108908. * * 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
  108909. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  108910. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108911. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108912. * @param name defines the name of the mesh
  108913. * @param options defines the options used to create the mesh
  108914. * @param scene defines the hosting scene
  108915. * @returns the cylinder mesh
  108916. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  108917. */
  108918. static CreateCylinder(name: string, options: {
  108919. height?: number;
  108920. diameterTop?: number;
  108921. diameterBottom?: number;
  108922. diameter?: number;
  108923. tessellation?: number;
  108924. subdivisions?: number;
  108925. arc?: number;
  108926. faceColors?: Color4[];
  108927. faceUV?: Vector4[];
  108928. updatable?: boolean;
  108929. hasRings?: boolean;
  108930. enclose?: boolean;
  108931. cap?: number;
  108932. sideOrientation?: number;
  108933. frontUVs?: Vector4;
  108934. backUVs?: Vector4;
  108935. }, scene: any): Mesh;
  108936. }
  108937. }
  108938. declare module BABYLON {
  108939. /**
  108940. * Options to modify the vr teleportation behavior.
  108941. */
  108942. export interface VRTeleportationOptions {
  108943. /**
  108944. * The name of the mesh which should be used as the teleportation floor. (default: null)
  108945. */
  108946. floorMeshName?: string;
  108947. /**
  108948. * A list of meshes to be used as the teleportation floor. (default: empty)
  108949. */
  108950. floorMeshes?: Mesh[];
  108951. }
  108952. /**
  108953. * Options to modify the vr experience helper's behavior.
  108954. */
  108955. export interface VRExperienceHelperOptions extends WebVROptions {
  108956. /**
  108957. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  108958. */
  108959. createDeviceOrientationCamera?: boolean;
  108960. /**
  108961. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  108962. */
  108963. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  108964. /**
  108965. * Uses the main button on the controller to toggle the laser casted. (default: true)
  108966. */
  108967. laserToggle?: boolean;
  108968. /**
  108969. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  108970. */
  108971. floorMeshes?: Mesh[];
  108972. /**
  108973. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  108974. */
  108975. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  108976. }
  108977. /**
  108978. * Event containing information after VR has been entered
  108979. */
  108980. export class OnAfterEnteringVRObservableEvent {
  108981. /**
  108982. * If entering vr was successful
  108983. */
  108984. success: boolean;
  108985. }
  108986. /**
  108987. * Helps to quickly add VR support to an existing scene.
  108988. * See http://doc.babylonjs.com/how_to/webvr_helper
  108989. */
  108990. export class VRExperienceHelper {
  108991. /** Options to modify the vr experience helper's behavior. */
  108992. webVROptions: VRExperienceHelperOptions;
  108993. private _scene;
  108994. private _position;
  108995. private _btnVR;
  108996. private _btnVRDisplayed;
  108997. private _webVRsupported;
  108998. private _webVRready;
  108999. private _webVRrequesting;
  109000. private _webVRpresenting;
  109001. private _hasEnteredVR;
  109002. private _fullscreenVRpresenting;
  109003. private _canvas;
  109004. private _webVRCamera;
  109005. private _vrDeviceOrientationCamera;
  109006. private _deviceOrientationCamera;
  109007. private _existingCamera;
  109008. private _onKeyDown;
  109009. private _onVrDisplayPresentChange;
  109010. private _onVRDisplayChanged;
  109011. private _onVRRequestPresentStart;
  109012. private _onVRRequestPresentComplete;
  109013. /**
  109014. * 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)
  109015. */
  109016. enableGazeEvenWhenNoPointerLock: boolean;
  109017. /**
  109018. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  109019. */
  109020. exitVROnDoubleTap: boolean;
  109021. /**
  109022. * Observable raised right before entering VR.
  109023. */
  109024. onEnteringVRObservable: Observable<VRExperienceHelper>;
  109025. /**
  109026. * Observable raised when entering VR has completed.
  109027. */
  109028. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  109029. /**
  109030. * Observable raised when exiting VR.
  109031. */
  109032. onExitingVRObservable: Observable<VRExperienceHelper>;
  109033. /**
  109034. * Observable raised when controller mesh is loaded.
  109035. */
  109036. onControllerMeshLoadedObservable: Observable<WebVRController>;
  109037. /** Return this.onEnteringVRObservable
  109038. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  109039. */
  109040. readonly onEnteringVR: Observable<VRExperienceHelper>;
  109041. /** Return this.onExitingVRObservable
  109042. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  109043. */
  109044. readonly onExitingVR: Observable<VRExperienceHelper>;
  109045. /** Return this.onControllerMeshLoadedObservable
  109046. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  109047. */
  109048. readonly onControllerMeshLoaded: Observable<WebVRController>;
  109049. private _rayLength;
  109050. private _useCustomVRButton;
  109051. private _teleportationRequested;
  109052. private _teleportActive;
  109053. private _floorMeshName;
  109054. private _floorMeshesCollection;
  109055. private _rotationAllowed;
  109056. private _teleportBackwardsVector;
  109057. private _teleportationTarget;
  109058. private _isDefaultTeleportationTarget;
  109059. private _postProcessMove;
  109060. private _teleportationFillColor;
  109061. private _teleportationBorderColor;
  109062. private _rotationAngle;
  109063. private _haloCenter;
  109064. private _cameraGazer;
  109065. private _padSensibilityUp;
  109066. private _padSensibilityDown;
  109067. private _leftController;
  109068. private _rightController;
  109069. /**
  109070. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  109071. */
  109072. onNewMeshSelected: Observable<AbstractMesh>;
  109073. /**
  109074. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  109075. * This observable will provide the mesh and the controller used to select the mesh
  109076. */
  109077. onMeshSelectedWithController: Observable<{
  109078. mesh: AbstractMesh;
  109079. controller: WebVRController;
  109080. }>;
  109081. /**
  109082. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  109083. */
  109084. onNewMeshPicked: Observable<PickingInfo>;
  109085. private _circleEase;
  109086. /**
  109087. * Observable raised before camera teleportation
  109088. */
  109089. onBeforeCameraTeleport: Observable<Vector3>;
  109090. /**
  109091. * Observable raised after camera teleportation
  109092. */
  109093. onAfterCameraTeleport: Observable<Vector3>;
  109094. /**
  109095. * Observable raised when current selected mesh gets unselected
  109096. */
  109097. onSelectedMeshUnselected: Observable<AbstractMesh>;
  109098. private _raySelectionPredicate;
  109099. /**
  109100. * To be optionaly changed by user to define custom ray selection
  109101. */
  109102. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  109103. /**
  109104. * To be optionaly changed by user to define custom selection logic (after ray selection)
  109105. */
  109106. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  109107. /**
  109108. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  109109. */
  109110. teleportationEnabled: boolean;
  109111. private _defaultHeight;
  109112. private _teleportationInitialized;
  109113. private _interactionsEnabled;
  109114. private _interactionsRequested;
  109115. private _displayGaze;
  109116. private _displayLaserPointer;
  109117. /**
  109118. * The mesh used to display where the user is going to teleport.
  109119. */
  109120. /**
  109121. * Sets the mesh to be used to display where the user is going to teleport.
  109122. */
  109123. teleportationTarget: Mesh;
  109124. /**
  109125. * 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
  109126. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  109127. * See http://doc.babylonjs.com/resources/baking_transformations
  109128. */
  109129. gazeTrackerMesh: Mesh;
  109130. /**
  109131. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  109132. */
  109133. updateGazeTrackerScale: boolean;
  109134. /**
  109135. * If the gaze trackers color should be updated when selecting meshes
  109136. */
  109137. updateGazeTrackerColor: boolean;
  109138. /**
  109139. * If the controller laser color should be updated when selecting meshes
  109140. */
  109141. updateControllerLaserColor: boolean;
  109142. /**
  109143. * The gaze tracking mesh corresponding to the left controller
  109144. */
  109145. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  109146. /**
  109147. * The gaze tracking mesh corresponding to the right controller
  109148. */
  109149. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  109150. /**
  109151. * If the ray of the gaze should be displayed.
  109152. */
  109153. /**
  109154. * Sets if the ray of the gaze should be displayed.
  109155. */
  109156. displayGaze: boolean;
  109157. /**
  109158. * If the ray of the LaserPointer should be displayed.
  109159. */
  109160. /**
  109161. * Sets if the ray of the LaserPointer should be displayed.
  109162. */
  109163. displayLaserPointer: boolean;
  109164. /**
  109165. * The deviceOrientationCamera used as the camera when not in VR.
  109166. */
  109167. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  109168. /**
  109169. * Based on the current WebVR support, returns the current VR camera used.
  109170. */
  109171. readonly currentVRCamera: Nullable<Camera>;
  109172. /**
  109173. * The webVRCamera which is used when in VR.
  109174. */
  109175. readonly webVRCamera: WebVRFreeCamera;
  109176. /**
  109177. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  109178. */
  109179. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  109180. /**
  109181. * The html button that is used to trigger entering into VR.
  109182. */
  109183. readonly vrButton: Nullable<HTMLButtonElement>;
  109184. private readonly _teleportationRequestInitiated;
  109185. /**
  109186. * Defines wether or not Pointer lock should be requested when switching to
  109187. * full screen.
  109188. */
  109189. requestPointerLockOnFullScreen: boolean;
  109190. /**
  109191. * Instantiates a VRExperienceHelper.
  109192. * Helps to quickly add VR support to an existing scene.
  109193. * @param scene The scene the VRExperienceHelper belongs to.
  109194. * @param webVROptions Options to modify the vr experience helper's behavior.
  109195. */
  109196. constructor(scene: Scene,
  109197. /** Options to modify the vr experience helper's behavior. */
  109198. webVROptions?: VRExperienceHelperOptions);
  109199. private _onDefaultMeshLoaded;
  109200. private _onResize;
  109201. private _onFullscreenChange;
  109202. /**
  109203. * Gets a value indicating if we are currently in VR mode.
  109204. */
  109205. readonly isInVRMode: boolean;
  109206. private onVrDisplayPresentChange;
  109207. private onVRDisplayChanged;
  109208. private moveButtonToBottomRight;
  109209. private displayVRButton;
  109210. private updateButtonVisibility;
  109211. private _cachedAngularSensibility;
  109212. /**
  109213. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  109214. * Otherwise, will use the fullscreen API.
  109215. */
  109216. enterVR(): void;
  109217. /**
  109218. * Attempt to exit VR, or fullscreen.
  109219. */
  109220. exitVR(): void;
  109221. /**
  109222. * The position of the vr experience helper.
  109223. */
  109224. /**
  109225. * Sets the position of the vr experience helper.
  109226. */
  109227. position: Vector3;
  109228. /**
  109229. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  109230. */
  109231. enableInteractions(): void;
  109232. private readonly _noControllerIsActive;
  109233. private beforeRender;
  109234. private _isTeleportationFloor;
  109235. /**
  109236. * Adds a floor mesh to be used for teleportation.
  109237. * @param floorMesh the mesh to be used for teleportation.
  109238. */
  109239. addFloorMesh(floorMesh: Mesh): void;
  109240. /**
  109241. * Removes a floor mesh from being used for teleportation.
  109242. * @param floorMesh the mesh to be removed.
  109243. */
  109244. removeFloorMesh(floorMesh: Mesh): void;
  109245. /**
  109246. * Enables interactions and teleportation using the VR controllers and gaze.
  109247. * @param vrTeleportationOptions options to modify teleportation behavior.
  109248. */
  109249. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  109250. private _onNewGamepadConnected;
  109251. private _tryEnableInteractionOnController;
  109252. private _onNewGamepadDisconnected;
  109253. private _enableInteractionOnController;
  109254. private _checkTeleportWithRay;
  109255. private _checkRotate;
  109256. private _checkTeleportBackwards;
  109257. private _enableTeleportationOnController;
  109258. private _createTeleportationCircles;
  109259. private _displayTeleportationTarget;
  109260. private _hideTeleportationTarget;
  109261. private _rotateCamera;
  109262. private _moveTeleportationSelectorTo;
  109263. private _workingVector;
  109264. private _workingQuaternion;
  109265. private _workingMatrix;
  109266. /**
  109267. * Teleports the users feet to the desired location
  109268. * @param location The location where the user's feet should be placed
  109269. */
  109270. teleportCamera(location: Vector3): void;
  109271. private _convertNormalToDirectionOfRay;
  109272. private _castRayAndSelectObject;
  109273. private _notifySelectedMeshUnselected;
  109274. /**
  109275. * Sets the color of the laser ray from the vr controllers.
  109276. * @param color new color for the ray.
  109277. */
  109278. changeLaserColor(color: Color3): void;
  109279. /**
  109280. * Sets the color of the ray from the vr headsets gaze.
  109281. * @param color new color for the ray.
  109282. */
  109283. changeGazeColor(color: Color3): void;
  109284. /**
  109285. * Exits VR and disposes of the vr experience helper
  109286. */
  109287. dispose(): void;
  109288. /**
  109289. * Gets the name of the VRExperienceHelper class
  109290. * @returns "VRExperienceHelper"
  109291. */
  109292. getClassName(): string;
  109293. }
  109294. }
  109295. declare module BABYLON {
  109296. /**
  109297. * States of the webXR experience
  109298. */
  109299. export enum WebXRState {
  109300. /**
  109301. * Transitioning to being in XR mode
  109302. */
  109303. ENTERING_XR = 0,
  109304. /**
  109305. * Transitioning to non XR mode
  109306. */
  109307. EXITING_XR = 1,
  109308. /**
  109309. * In XR mode and presenting
  109310. */
  109311. IN_XR = 2,
  109312. /**
  109313. * Not entered XR mode
  109314. */
  109315. NOT_IN_XR = 3
  109316. }
  109317. /**
  109318. * Abstraction of the XR render target
  109319. */
  109320. export interface WebXRRenderTarget extends IDisposable {
  109321. /**
  109322. * xrpresent context of the canvas which can be used to display/mirror xr content
  109323. */
  109324. canvasContext: WebGLRenderingContext;
  109325. /**
  109326. * xr layer for the canvas
  109327. */
  109328. xrLayer: Nullable<XRWebGLLayer>;
  109329. /**
  109330. * Initializes the xr layer for the session
  109331. * @param xrSession xr session
  109332. * @returns a promise that will resolve once the XR Layer has been created
  109333. */
  109334. initializeXRLayerAsync(xrSession: XRSession): Promise<void>;
  109335. }
  109336. }
  109337. declare module BABYLON {
  109338. /**
  109339. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  109340. */
  109341. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  109342. private _engine;
  109343. private _canvas;
  109344. /**
  109345. * xrpresent context of the canvas which can be used to display/mirror xr content
  109346. */
  109347. canvasContext: WebGLRenderingContext;
  109348. /**
  109349. * xr layer for the canvas
  109350. */
  109351. xrLayer: Nullable<XRWebGLLayer>;
  109352. /**
  109353. * Initializes the xr layer for the session
  109354. * @param xrSession xr session
  109355. * @returns a promise that will resolve once the XR Layer has been created
  109356. */
  109357. initializeXRLayerAsync(xrSession: any): any;
  109358. /**
  109359. * Initializes the canvas to be added/removed upon entering/exiting xr
  109360. * @param engine the Babylon engine
  109361. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  109362. * @param onStateChangedObservable the mechanism by which the canvas will be added/removed based on XR state
  109363. */
  109364. constructor(engine: ThinEngine, canvas?: HTMLCanvasElement, onStateChangedObservable?: Observable<WebXRState>);
  109365. /**
  109366. * Disposes of the object
  109367. */
  109368. dispose(): void;
  109369. private _setManagedOutputCanvas;
  109370. private _addCanvas;
  109371. private _removeCanvas;
  109372. }
  109373. }
  109374. declare module BABYLON {
  109375. /**
  109376. * Manages an XRSession to work with Babylon's engine
  109377. * @see https://doc.babylonjs.com/how_to/webxr
  109378. */
  109379. export class WebXRSessionManager implements IDisposable {
  109380. private scene;
  109381. /**
  109382. * Fires every time a new xrFrame arrives which can be used to update the camera
  109383. */
  109384. onXRFrameObservable: Observable<any>;
  109385. /**
  109386. * Fires when the xr session is ended either by the device or manually done
  109387. */
  109388. onXRSessionEnded: Observable<any>;
  109389. /**
  109390. * Underlying xr session
  109391. */
  109392. session: XRSession;
  109393. /**
  109394. * Type of reference space used when creating the session
  109395. */
  109396. referenceSpace: XRReferenceSpace;
  109397. /**
  109398. * Current XR frame
  109399. */
  109400. currentFrame: Nullable<XRFrame>;
  109401. private _xrNavigator;
  109402. private baseLayer;
  109403. private _rttProvider;
  109404. private _sessionEnded;
  109405. /**
  109406. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  109407. * @param scene The scene which the session should be created for
  109408. */
  109409. constructor(scene: Scene);
  109410. /**
  109411. * Initializes the manager
  109412. * After initialization enterXR can be called to start an XR session
  109413. * @returns Promise which resolves after it is initialized
  109414. */
  109415. initializeAsync(): Promise<void>;
  109416. /**
  109417. * Initializes an xr session
  109418. * @param xrSessionMode mode to initialize
  109419. * @param optionalFeatures defines optional values to pass to the session builder
  109420. * @returns a promise which will resolve once the session has been initialized
  109421. */
  109422. initializeSessionAsync(xrSessionMode: XRSessionMode, optionalFeatures?: any): any;
  109423. /**
  109424. * Sets the reference space on the xr session
  109425. * @param referenceSpace space to set
  109426. * @returns a promise that will resolve once the reference space has been set
  109427. */
  109428. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  109429. /**
  109430. * Updates the render state of the session
  109431. * @param state state to set
  109432. * @returns a promise that resolves once the render state has been updated
  109433. */
  109434. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  109435. /**
  109436. * Starts rendering to the xr layer
  109437. * @returns a promise that will resolve once rendering has started
  109438. */
  109439. startRenderingToXRAsync(): Promise<void>;
  109440. /**
  109441. * Gets the correct render target texture to be rendered this frame for this eye
  109442. * @param eye the eye for which to get the render target
  109443. * @returns the render target for the specified eye
  109444. */
  109445. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  109446. /**
  109447. * Stops the xrSession and restores the renderloop
  109448. * @returns Promise which resolves after it exits XR
  109449. */
  109450. exitXRAsync(): Promise<void>;
  109451. /**
  109452. * Checks if a session would be supported for the creation options specified
  109453. * @param sessionMode session mode to check if supported eg. immersive-vr
  109454. * @returns true if supported
  109455. */
  109456. supportsSessionAsync(sessionMode: XRSessionMode): any;
  109457. /**
  109458. * Creates a WebXRRenderTarget object for the XR session
  109459. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  109460. * @returns a WebXR render target to which the session can render
  109461. */
  109462. getWebXRRenderTarget(onStateChangedObservable?: Observable<WebXRState>): WebXRRenderTarget;
  109463. /**
  109464. * @hidden
  109465. * Converts the render layer of xrSession to a render target
  109466. * @param session session to create render target for
  109467. * @param scene scene the new render target should be created for
  109468. */
  109469. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  109470. /**
  109471. * Disposes of the session manager
  109472. */
  109473. dispose(): void;
  109474. }
  109475. }
  109476. declare module BABYLON {
  109477. /**
  109478. * WebXR Camera which holds the views for the xrSession
  109479. * @see https://doc.babylonjs.com/how_to/webxr
  109480. */
  109481. export class WebXRCamera extends FreeCamera {
  109482. private static _TmpMatrix;
  109483. /**
  109484. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  109485. * @param name the name of the camera
  109486. * @param scene the scene to add the camera to
  109487. */
  109488. constructor(name: string, scene: Scene);
  109489. private _updateNumberOfRigCameras;
  109490. /** @hidden */
  109491. _updateForDualEyeDebugging(): void;
  109492. /**
  109493. * Updates the cameras position from the current pose information of the XR session
  109494. * @param xrSessionManager the session containing pose information
  109495. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  109496. */
  109497. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  109498. }
  109499. }
  109500. declare module BABYLON {
  109501. /**
  109502. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  109503. * @see https://doc.babylonjs.com/how_to/webxr
  109504. */
  109505. export class WebXRExperienceHelper implements IDisposable {
  109506. private scene;
  109507. /**
  109508. * Container which stores the xr camera and controllers as children. This can be used to move the camera/user as the camera's position is updated by the xr device
  109509. */
  109510. container: AbstractMesh;
  109511. /**
  109512. * Camera used to render xr content
  109513. */
  109514. camera: WebXRCamera;
  109515. /**
  109516. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  109517. */
  109518. state: WebXRState;
  109519. private _setState;
  109520. private static _TmpVector;
  109521. /**
  109522. * Fires when the state of the experience helper has changed
  109523. */
  109524. onStateChangedObservable: Observable<WebXRState>;
  109525. /** Session manager used to keep track of xr session */
  109526. sessionManager: WebXRSessionManager;
  109527. private _nonVRCamera;
  109528. private _originalSceneAutoClear;
  109529. private _supported;
  109530. /**
  109531. * Creates the experience helper
  109532. * @param scene the scene to attach the experience helper to
  109533. * @returns a promise for the experience helper
  109534. */
  109535. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  109536. /**
  109537. * Creates a WebXRExperienceHelper
  109538. * @param scene The scene the helper should be created in
  109539. */
  109540. private constructor();
  109541. /**
  109542. * Exits XR mode and returns the scene to its original state
  109543. * @returns promise that resolves after xr mode has exited
  109544. */
  109545. exitXRAsync(): Promise<void>;
  109546. /**
  109547. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  109548. * @param sessionMode options for the XR session
  109549. * @param referenceSpaceType frame of reference of the XR session
  109550. * @param renderTarget the output canvas that will be used to enter XR mode
  109551. * @returns promise that resolves after xr mode has entered
  109552. */
  109553. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget: WebXRRenderTarget): any;
  109554. /**
  109555. * Updates the global position of the camera by moving the camera's container
  109556. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  109557. * @param position The desired global position of the camera
  109558. */
  109559. setPositionOfCameraUsingContainer(position: Vector3): void;
  109560. /**
  109561. * Rotates the xr camera by rotating the camera's container around the camera's position
  109562. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  109563. * @param rotation the desired quaternion rotation to apply to the camera
  109564. */
  109565. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  109566. /**
  109567. * Disposes of the experience helper
  109568. */
  109569. dispose(): void;
  109570. }
  109571. }
  109572. declare module BABYLON {
  109573. /**
  109574. * Button which can be used to enter a different mode of XR
  109575. */
  109576. export class WebXREnterExitUIButton {
  109577. /** button element */
  109578. element: HTMLElement;
  109579. /** XR initialization options for the button */
  109580. sessionMode: XRSessionMode;
  109581. /** Reference space type */
  109582. referenceSpaceType: XRReferenceSpaceType;
  109583. /**
  109584. * Creates a WebXREnterExitUIButton
  109585. * @param element button element
  109586. * @param sessionMode XR initialization session mode
  109587. * @param referenceSpaceType the type of reference space to be used
  109588. */
  109589. constructor(
  109590. /** button element */
  109591. element: HTMLElement,
  109592. /** XR initialization options for the button */
  109593. sessionMode: XRSessionMode,
  109594. /** Reference space type */
  109595. referenceSpaceType: XRReferenceSpaceType);
  109596. /**
  109597. * Overwritable function which can be used to update the button's visuals when the state changes
  109598. * @param activeButton the current active button in the UI
  109599. */
  109600. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  109601. }
  109602. /**
  109603. * Options to create the webXR UI
  109604. */
  109605. export class WebXREnterExitUIOptions {
  109606. /**
  109607. * Context to enter xr with
  109608. */
  109609. renderTarget?: Nullable<WebXRRenderTarget>;
  109610. /**
  109611. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  109612. */
  109613. customButtons?: Array<WebXREnterExitUIButton>;
  109614. }
  109615. /**
  109616. * UI to allow the user to enter/exit XR mode
  109617. */
  109618. export class WebXREnterExitUI implements IDisposable {
  109619. private scene;
  109620. private _overlay;
  109621. private _buttons;
  109622. private _activeButton;
  109623. /**
  109624. * Fired every time the active button is changed.
  109625. *
  109626. * When xr is entered via a button that launches xr that button will be the callback parameter
  109627. *
  109628. * When exiting xr the callback parameter will be null)
  109629. */
  109630. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  109631. /**
  109632. * Creates UI to allow the user to enter/exit XR mode
  109633. * @param scene the scene to add the ui to
  109634. * @param helper the xr experience helper to enter/exit xr with
  109635. * @param options options to configure the UI
  109636. * @returns the created ui
  109637. */
  109638. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  109639. private constructor();
  109640. private _updateButtons;
  109641. /**
  109642. * Disposes of the object
  109643. */
  109644. dispose(): void;
  109645. }
  109646. }
  109647. declare module BABYLON {
  109648. /**
  109649. * Represents an XR input
  109650. */
  109651. export class WebXRController {
  109652. private scene;
  109653. /** The underlying input source for the controller */
  109654. inputSource: XRInputSource;
  109655. private parentContainer;
  109656. /**
  109657. * 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
  109658. */
  109659. grip?: AbstractMesh;
  109660. /**
  109661. * Pointer which can be used to select objects or attach a visible laser to
  109662. */
  109663. pointer: AbstractMesh;
  109664. private _gamepadMode;
  109665. /**
  109666. * If available, this is the gamepad object related to this controller.
  109667. * Using this object it is possible to get click events and trackpad changes of the
  109668. * webxr controller that is currently being used.
  109669. */
  109670. gamepadController?: WebVRController;
  109671. /**
  109672. * Event that fires when the controller is removed/disposed
  109673. */
  109674. onDisposeObservable: Observable<{}>;
  109675. private _tmpMatrix;
  109676. private _tmpQuaternion;
  109677. private _tmpVector;
  109678. /**
  109679. * Creates the controller
  109680. * @see https://doc.babylonjs.com/how_to/webxr
  109681. * @param scene the scene which the controller should be associated to
  109682. * @param inputSource the underlying input source for the controller
  109683. * @param parentContainer parent that the controller meshes should be children of
  109684. */
  109685. constructor(scene: Scene,
  109686. /** The underlying input source for the controller */
  109687. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  109688. /**
  109689. * Updates the controller pose based on the given XRFrame
  109690. * @param xrFrame xr frame to update the pose with
  109691. * @param referenceSpace reference space to use
  109692. */
  109693. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  109694. /**
  109695. * Gets a world space ray coming from the controller
  109696. * @param result the resulting ray
  109697. */
  109698. getWorldPointerRayToRef(result: Ray): void;
  109699. /**
  109700. * Get the scene associated with this controller
  109701. * @returns the scene object
  109702. */
  109703. getScene(): Scene;
  109704. /**
  109705. * Disposes of the object
  109706. */
  109707. dispose(): void;
  109708. }
  109709. }
  109710. declare module BABYLON {
  109711. /**
  109712. * XR input used to track XR inputs such as controllers/rays
  109713. */
  109714. export class WebXRInput implements IDisposable {
  109715. /**
  109716. * Base experience the input listens to
  109717. */
  109718. baseExperience: WebXRExperienceHelper;
  109719. /**
  109720. * XR controllers being tracked
  109721. */
  109722. controllers: Array<WebXRController>;
  109723. private _frameObserver;
  109724. private _stateObserver;
  109725. /**
  109726. * Event when a controller has been connected/added
  109727. */
  109728. onControllerAddedObservable: Observable<WebXRController>;
  109729. /**
  109730. * Event when a controller has been removed/disconnected
  109731. */
  109732. onControllerRemovedObservable: Observable<WebXRController>;
  109733. /**
  109734. * Initializes the WebXRInput
  109735. * @param baseExperience experience helper which the input should be created for
  109736. */
  109737. constructor(
  109738. /**
  109739. * Base experience the input listens to
  109740. */
  109741. baseExperience: WebXRExperienceHelper);
  109742. private _onInputSourcesChange;
  109743. private _addAndRemoveControllers;
  109744. /**
  109745. * Disposes of the object
  109746. */
  109747. dispose(): void;
  109748. }
  109749. }
  109750. declare module BABYLON {
  109751. /**
  109752. * Enables teleportation
  109753. */
  109754. export class WebXRControllerTeleportation {
  109755. private _teleportationFillColor;
  109756. private _teleportationBorderColor;
  109757. private _tmpRay;
  109758. private _tmpVector;
  109759. /**
  109760. * Creates a WebXRControllerTeleportation
  109761. * @param input input manager to add teleportation to
  109762. * @param floorMeshes floormeshes which can be teleported to
  109763. */
  109764. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  109765. }
  109766. }
  109767. declare module BABYLON {
  109768. /**
  109769. * Handles pointer input automatically for the pointer of XR controllers
  109770. */
  109771. export class WebXRControllerPointerSelection {
  109772. private static _idCounter;
  109773. private _tmpRay;
  109774. /**
  109775. * Creates a WebXRControllerPointerSelection
  109776. * @param input input manager to setup pointer selection
  109777. */
  109778. constructor(input: WebXRInput);
  109779. private _convertNormalToDirectionOfRay;
  109780. private _updatePointerDistance;
  109781. }
  109782. }
  109783. declare module BABYLON {
  109784. /**
  109785. * Class used to represent data loading progression
  109786. */
  109787. export class SceneLoaderProgressEvent {
  109788. /** defines if data length to load can be evaluated */
  109789. readonly lengthComputable: boolean;
  109790. /** defines the loaded data length */
  109791. readonly loaded: number;
  109792. /** defines the data length to load */
  109793. readonly total: number;
  109794. /**
  109795. * Create a new progress event
  109796. * @param lengthComputable defines if data length to load can be evaluated
  109797. * @param loaded defines the loaded data length
  109798. * @param total defines the data length to load
  109799. */
  109800. constructor(
  109801. /** defines if data length to load can be evaluated */
  109802. lengthComputable: boolean,
  109803. /** defines the loaded data length */
  109804. loaded: number,
  109805. /** defines the data length to load */
  109806. total: number);
  109807. /**
  109808. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  109809. * @param event defines the source event
  109810. * @returns a new SceneLoaderProgressEvent
  109811. */
  109812. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  109813. }
  109814. /**
  109815. * Interface used by SceneLoader plugins to define supported file extensions
  109816. */
  109817. export interface ISceneLoaderPluginExtensions {
  109818. /**
  109819. * Defines the list of supported extensions
  109820. */
  109821. [extension: string]: {
  109822. isBinary: boolean;
  109823. };
  109824. }
  109825. /**
  109826. * Interface used by SceneLoader plugin factory
  109827. */
  109828. export interface ISceneLoaderPluginFactory {
  109829. /**
  109830. * Defines the name of the factory
  109831. */
  109832. name: string;
  109833. /**
  109834. * Function called to create a new plugin
  109835. * @return the new plugin
  109836. */
  109837. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  109838. /**
  109839. * The callback that returns true if the data can be directly loaded.
  109840. * @param data string containing the file data
  109841. * @returns if the data can be loaded directly
  109842. */
  109843. canDirectLoad?(data: string): boolean;
  109844. }
  109845. /**
  109846. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  109847. */
  109848. export interface ISceneLoaderPluginBase {
  109849. /**
  109850. * The friendly name of this plugin.
  109851. */
  109852. name: string;
  109853. /**
  109854. * The file extensions supported by this plugin.
  109855. */
  109856. extensions: string | ISceneLoaderPluginExtensions;
  109857. /**
  109858. * The callback called when loading from a url.
  109859. * @param scene scene loading this url
  109860. * @param url url to load
  109861. * @param onSuccess callback called when the file successfully loads
  109862. * @param onProgress callback called while file is loading (if the server supports this mode)
  109863. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  109864. * @param onError callback called when the file fails to load
  109865. * @returns a file request object
  109866. */
  109867. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  109868. /**
  109869. * The callback called when loading from a file object.
  109870. * @param scene scene loading this file
  109871. * @param file defines the file to load
  109872. * @param onSuccess defines the callback to call when data is loaded
  109873. * @param onProgress defines the callback to call during loading process
  109874. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  109875. * @param onError defines the callback to call when an error occurs
  109876. * @returns a file request object
  109877. */
  109878. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  109879. /**
  109880. * The callback that returns true if the data can be directly loaded.
  109881. * @param data string containing the file data
  109882. * @returns if the data can be loaded directly
  109883. */
  109884. canDirectLoad?(data: string): boolean;
  109885. /**
  109886. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  109887. * @param scene scene loading this data
  109888. * @param data string containing the data
  109889. * @returns data to pass to the plugin
  109890. */
  109891. directLoad?(scene: Scene, data: string): any;
  109892. /**
  109893. * The callback that allows custom handling of the root url based on the response url.
  109894. * @param rootUrl the original root url
  109895. * @param responseURL the response url if available
  109896. * @returns the new root url
  109897. */
  109898. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  109899. }
  109900. /**
  109901. * Interface used to define a SceneLoader plugin
  109902. */
  109903. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  109904. /**
  109905. * Import meshes into a scene.
  109906. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  109907. * @param scene The scene to import into
  109908. * @param data The data to import
  109909. * @param rootUrl The root url for scene and resources
  109910. * @param meshes The meshes array to import into
  109911. * @param particleSystems The particle systems array to import into
  109912. * @param skeletons The skeletons array to import into
  109913. * @param onError The callback when import fails
  109914. * @returns True if successful or false otherwise
  109915. */
  109916. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  109917. /**
  109918. * Load into a scene.
  109919. * @param scene The scene to load into
  109920. * @param data The data to import
  109921. * @param rootUrl The root url for scene and resources
  109922. * @param onError The callback when import fails
  109923. * @returns True if successful or false otherwise
  109924. */
  109925. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  109926. /**
  109927. * Load into an asset container.
  109928. * @param scene The scene to load into
  109929. * @param data The data to import
  109930. * @param rootUrl The root url for scene and resources
  109931. * @param onError The callback when import fails
  109932. * @returns The loaded asset container
  109933. */
  109934. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  109935. }
  109936. /**
  109937. * Interface used to define an async SceneLoader plugin
  109938. */
  109939. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  109940. /**
  109941. * Import meshes into a scene.
  109942. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  109943. * @param scene The scene to import into
  109944. * @param data The data to import
  109945. * @param rootUrl The root url for scene and resources
  109946. * @param onProgress The callback when the load progresses
  109947. * @param fileName Defines the name of the file to load
  109948. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  109949. */
  109950. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  109951. meshes: AbstractMesh[];
  109952. particleSystems: IParticleSystem[];
  109953. skeletons: Skeleton[];
  109954. animationGroups: AnimationGroup[];
  109955. }>;
  109956. /**
  109957. * Load into a scene.
  109958. * @param scene The scene to load into
  109959. * @param data The data to import
  109960. * @param rootUrl The root url for scene and resources
  109961. * @param onProgress The callback when the load progresses
  109962. * @param fileName Defines the name of the file to load
  109963. * @returns Nothing
  109964. */
  109965. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  109966. /**
  109967. * Load into an asset container.
  109968. * @param scene The scene to load into
  109969. * @param data The data to import
  109970. * @param rootUrl The root url for scene and resources
  109971. * @param onProgress The callback when the load progresses
  109972. * @param fileName Defines the name of the file to load
  109973. * @returns The loaded asset container
  109974. */
  109975. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  109976. }
  109977. /**
  109978. * Class used to load scene from various file formats using registered plugins
  109979. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  109980. */
  109981. export class SceneLoader {
  109982. /**
  109983. * No logging while loading
  109984. */
  109985. static readonly NO_LOGGING: number;
  109986. /**
  109987. * Minimal logging while loading
  109988. */
  109989. static readonly MINIMAL_LOGGING: number;
  109990. /**
  109991. * Summary logging while loading
  109992. */
  109993. static readonly SUMMARY_LOGGING: number;
  109994. /**
  109995. * Detailled logging while loading
  109996. */
  109997. static readonly DETAILED_LOGGING: number;
  109998. /**
  109999. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  110000. */
  110001. static ForceFullSceneLoadingForIncremental: boolean;
  110002. /**
  110003. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  110004. */
  110005. static ShowLoadingScreen: boolean;
  110006. /**
  110007. * Defines the current logging level (while loading the scene)
  110008. * @ignorenaming
  110009. */
  110010. static loggingLevel: number;
  110011. /**
  110012. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  110013. */
  110014. static CleanBoneMatrixWeights: boolean;
  110015. /**
  110016. * Event raised when a plugin is used to load a scene
  110017. */
  110018. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110019. private static _registeredPlugins;
  110020. private static _getDefaultPlugin;
  110021. private static _getPluginForExtension;
  110022. private static _getPluginForDirectLoad;
  110023. private static _getPluginForFilename;
  110024. private static _getDirectLoad;
  110025. private static _loadData;
  110026. private static _getFileInfo;
  110027. /**
  110028. * Gets a plugin that can load the given extension
  110029. * @param extension defines the extension to load
  110030. * @returns a plugin or null if none works
  110031. */
  110032. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  110033. /**
  110034. * Gets a boolean indicating that the given extension can be loaded
  110035. * @param extension defines the extension to load
  110036. * @returns true if the extension is supported
  110037. */
  110038. static IsPluginForExtensionAvailable(extension: string): boolean;
  110039. /**
  110040. * Adds a new plugin to the list of registered plugins
  110041. * @param plugin defines the plugin to add
  110042. */
  110043. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  110044. /**
  110045. * Import meshes into a scene
  110046. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110047. * @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)
  110048. * @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)
  110049. * @param scene the instance of BABYLON.Scene to append to
  110050. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  110051. * @param onProgress a callback with a progress event for each file being loaded
  110052. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110053. * @param pluginExtension the extension used to determine the plugin
  110054. * @returns The loaded plugin
  110055. */
  110056. 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: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110057. /**
  110058. * Import meshes into a scene
  110059. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110060. * @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)
  110061. * @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)
  110062. * @param scene the instance of BABYLON.Scene to append to
  110063. * @param onProgress a callback with a progress event for each file being loaded
  110064. * @param pluginExtension the extension used to determine the plugin
  110065. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  110066. */
  110067. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  110068. meshes: AbstractMesh[];
  110069. particleSystems: IParticleSystem[];
  110070. skeletons: Skeleton[];
  110071. animationGroups: AnimationGroup[];
  110072. }>;
  110073. /**
  110074. * Load a scene
  110075. * @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)
  110076. * @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)
  110077. * @param engine is the instance of BABYLON.Engine to use to create the scene
  110078. * @param onSuccess a callback with the scene when import succeeds
  110079. * @param onProgress a callback with a progress event for each file being loaded
  110080. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110081. * @param pluginExtension the extension used to determine the plugin
  110082. * @returns The loaded plugin
  110083. */
  110084. static Load(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110085. /**
  110086. * Load a scene
  110087. * @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)
  110088. * @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)
  110089. * @param engine is the instance of BABYLON.Engine to use to create the scene
  110090. * @param onProgress a callback with a progress event for each file being loaded
  110091. * @param pluginExtension the extension used to determine the plugin
  110092. * @returns The loaded scene
  110093. */
  110094. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  110095. /**
  110096. * Append a scene
  110097. * @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)
  110098. * @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)
  110099. * @param scene is the instance of BABYLON.Scene to append to
  110100. * @param onSuccess a callback with the scene when import succeeds
  110101. * @param onProgress a callback with a progress event for each file being loaded
  110102. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110103. * @param pluginExtension the extension used to determine the plugin
  110104. * @returns The loaded plugin
  110105. */
  110106. static Append(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110107. /**
  110108. * Append a scene
  110109. * @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)
  110110. * @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)
  110111. * @param scene is the instance of BABYLON.Scene to append to
  110112. * @param onProgress a callback with a progress event for each file being loaded
  110113. * @param pluginExtension the extension used to determine the plugin
  110114. * @returns The given scene
  110115. */
  110116. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  110117. /**
  110118. * Load a scene into an asset container
  110119. * @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)
  110120. * @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)
  110121. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  110122. * @param onSuccess a callback with the scene when import succeeds
  110123. * @param onProgress a callback with a progress event for each file being loaded
  110124. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110125. * @param pluginExtension the extension used to determine the plugin
  110126. * @returns The loaded plugin
  110127. */
  110128. static LoadAssetContainer(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110129. /**
  110130. * Load a scene into an asset container
  110131. * @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)
  110132. * @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)
  110133. * @param scene is the instance of Scene to append to
  110134. * @param onProgress a callback with a progress event for each file being loaded
  110135. * @param pluginExtension the extension used to determine the plugin
  110136. * @returns The loaded asset container
  110137. */
  110138. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  110139. }
  110140. }
  110141. declare module BABYLON {
  110142. /**
  110143. * Generic Controller
  110144. */
  110145. export class GenericController extends WebVRController {
  110146. /**
  110147. * Base Url for the controller model.
  110148. */
  110149. static readonly MODEL_BASE_URL: string;
  110150. /**
  110151. * File name for the controller model.
  110152. */
  110153. static readonly MODEL_FILENAME: string;
  110154. /**
  110155. * Creates a new GenericController from a gamepad
  110156. * @param vrGamepad the gamepad that the controller should be created from
  110157. */
  110158. constructor(vrGamepad: any);
  110159. /**
  110160. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110161. * @param scene scene in which to add meshes
  110162. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110163. */
  110164. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  110165. /**
  110166. * Called once for each button that changed state since the last frame
  110167. * @param buttonIdx Which button index changed
  110168. * @param state New state of the button
  110169. * @param changes Which properties on the state changed since last frame
  110170. */
  110171. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110172. }
  110173. }
  110174. declare module BABYLON {
  110175. /**
  110176. * Defines the WindowsMotionController object that the state of the windows motion controller
  110177. */
  110178. export class WindowsMotionController extends WebVRController {
  110179. /**
  110180. * The base url used to load the left and right controller models
  110181. */
  110182. static MODEL_BASE_URL: string;
  110183. /**
  110184. * The name of the left controller model file
  110185. */
  110186. static MODEL_LEFT_FILENAME: string;
  110187. /**
  110188. * The name of the right controller model file
  110189. */
  110190. static MODEL_RIGHT_FILENAME: string;
  110191. /**
  110192. * The controller name prefix for this controller type
  110193. */
  110194. static readonly GAMEPAD_ID_PREFIX: string;
  110195. /**
  110196. * The controller id pattern for this controller type
  110197. */
  110198. private static readonly GAMEPAD_ID_PATTERN;
  110199. private _loadedMeshInfo;
  110200. private readonly _mapping;
  110201. /**
  110202. * Fired when the trackpad on this controller is clicked
  110203. */
  110204. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  110205. /**
  110206. * Fired when the trackpad on this controller is modified
  110207. */
  110208. onTrackpadValuesChangedObservable: Observable<StickValues>;
  110209. /**
  110210. * The current x and y values of this controller's trackpad
  110211. */
  110212. trackpad: StickValues;
  110213. /**
  110214. * Creates a new WindowsMotionController from a gamepad
  110215. * @param vrGamepad the gamepad that the controller should be created from
  110216. */
  110217. constructor(vrGamepad: any);
  110218. /**
  110219. * Fired when the trigger on this controller is modified
  110220. */
  110221. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110222. /**
  110223. * Fired when the menu button on this controller is modified
  110224. */
  110225. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110226. /**
  110227. * Fired when the grip button on this controller is modified
  110228. */
  110229. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110230. /**
  110231. * Fired when the thumbstick button on this controller is modified
  110232. */
  110233. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110234. /**
  110235. * Fired when the touchpad button on this controller is modified
  110236. */
  110237. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110238. /**
  110239. * Fired when the touchpad values on this controller are modified
  110240. */
  110241. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  110242. private _updateTrackpad;
  110243. /**
  110244. * Called once per frame by the engine.
  110245. */
  110246. update(): void;
  110247. /**
  110248. * Called once for each button that changed state since the last frame
  110249. * @param buttonIdx Which button index changed
  110250. * @param state New state of the button
  110251. * @param changes Which properties on the state changed since last frame
  110252. */
  110253. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110254. /**
  110255. * Moves the buttons on the controller mesh based on their current state
  110256. * @param buttonName the name of the button to move
  110257. * @param buttonValue the value of the button which determines the buttons new position
  110258. */
  110259. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  110260. /**
  110261. * Moves the axis on the controller mesh based on its current state
  110262. * @param axis the index of the axis
  110263. * @param axisValue the value of the axis which determines the meshes new position
  110264. * @hidden
  110265. */
  110266. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  110267. /**
  110268. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110269. * @param scene scene in which to add meshes
  110270. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110271. */
  110272. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  110273. /**
  110274. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  110275. * can be transformed by button presses and axes values, based on this._mapping.
  110276. *
  110277. * @param scene scene in which the meshes exist
  110278. * @param meshes list of meshes that make up the controller model to process
  110279. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  110280. */
  110281. private processModel;
  110282. private createMeshInfo;
  110283. /**
  110284. * Gets the ray of the controller in the direction the controller is pointing
  110285. * @param length the length the resulting ray should be
  110286. * @returns a ray in the direction the controller is pointing
  110287. */
  110288. getForwardRay(length?: number): Ray;
  110289. /**
  110290. * Disposes of the controller
  110291. */
  110292. dispose(): void;
  110293. }
  110294. }
  110295. declare module BABYLON {
  110296. /**
  110297. * Oculus Touch Controller
  110298. */
  110299. export class OculusTouchController extends WebVRController {
  110300. /**
  110301. * Base Url for the controller model.
  110302. */
  110303. static MODEL_BASE_URL: string;
  110304. /**
  110305. * File name for the left controller model.
  110306. */
  110307. static MODEL_LEFT_FILENAME: string;
  110308. /**
  110309. * File name for the right controller model.
  110310. */
  110311. static MODEL_RIGHT_FILENAME: string;
  110312. /**
  110313. * Base Url for the Quest controller model.
  110314. */
  110315. static QUEST_MODEL_BASE_URL: string;
  110316. /**
  110317. * @hidden
  110318. * If the controllers are running on a device that needs the updated Quest controller models
  110319. */
  110320. static _IsQuest: boolean;
  110321. /**
  110322. * Fired when the secondary trigger on this controller is modified
  110323. */
  110324. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  110325. /**
  110326. * Fired when the thumb rest on this controller is modified
  110327. */
  110328. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  110329. /**
  110330. * Creates a new OculusTouchController from a gamepad
  110331. * @param vrGamepad the gamepad that the controller should be created from
  110332. */
  110333. constructor(vrGamepad: any);
  110334. /**
  110335. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110336. * @param scene scene in which to add meshes
  110337. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110338. */
  110339. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  110340. /**
  110341. * Fired when the A button on this controller is modified
  110342. */
  110343. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110344. /**
  110345. * Fired when the B button on this controller is modified
  110346. */
  110347. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110348. /**
  110349. * Fired when the X button on this controller is modified
  110350. */
  110351. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110352. /**
  110353. * Fired when the Y button on this controller is modified
  110354. */
  110355. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110356. /**
  110357. * Called once for each button that changed state since the last frame
  110358. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  110359. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  110360. * 2) secondary trigger (same)
  110361. * 3) A (right) X (left), touch, pressed = value
  110362. * 4) B / Y
  110363. * 5) thumb rest
  110364. * @param buttonIdx Which button index changed
  110365. * @param state New state of the button
  110366. * @param changes Which properties on the state changed since last frame
  110367. */
  110368. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110369. }
  110370. }
  110371. declare module BABYLON {
  110372. /**
  110373. * Vive Controller
  110374. */
  110375. export class ViveController extends WebVRController {
  110376. /**
  110377. * Base Url for the controller model.
  110378. */
  110379. static MODEL_BASE_URL: string;
  110380. /**
  110381. * File name for the controller model.
  110382. */
  110383. static MODEL_FILENAME: string;
  110384. /**
  110385. * Creates a new ViveController from a gamepad
  110386. * @param vrGamepad the gamepad that the controller should be created from
  110387. */
  110388. constructor(vrGamepad: any);
  110389. /**
  110390. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110391. * @param scene scene in which to add meshes
  110392. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110393. */
  110394. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  110395. /**
  110396. * Fired when the left button on this controller is modified
  110397. */
  110398. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110399. /**
  110400. * Fired when the right button on this controller is modified
  110401. */
  110402. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110403. /**
  110404. * Fired when the menu button on this controller is modified
  110405. */
  110406. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110407. /**
  110408. * Called once for each button that changed state since the last frame
  110409. * Vive mapping:
  110410. * 0: touchpad
  110411. * 1: trigger
  110412. * 2: left AND right buttons
  110413. * 3: menu button
  110414. * @param buttonIdx Which button index changed
  110415. * @param state New state of the button
  110416. * @param changes Which properties on the state changed since last frame
  110417. */
  110418. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110419. }
  110420. }
  110421. declare module BABYLON {
  110422. /**
  110423. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  110424. */
  110425. export class WebXRControllerModelLoader {
  110426. /**
  110427. * Creates the WebXRControllerModelLoader
  110428. * @param input xr input that creates the controllers
  110429. */
  110430. constructor(input: WebXRInput);
  110431. }
  110432. }
  110433. declare module BABYLON {
  110434. /**
  110435. * Contains an array of blocks representing the octree
  110436. */
  110437. export interface IOctreeContainer<T> {
  110438. /**
  110439. * Blocks within the octree
  110440. */
  110441. blocks: Array<OctreeBlock<T>>;
  110442. }
  110443. /**
  110444. * Class used to store a cell in an octree
  110445. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110446. */
  110447. export class OctreeBlock<T> {
  110448. /**
  110449. * Gets the content of the current block
  110450. */
  110451. entries: T[];
  110452. /**
  110453. * Gets the list of block children
  110454. */
  110455. blocks: Array<OctreeBlock<T>>;
  110456. private _depth;
  110457. private _maxDepth;
  110458. private _capacity;
  110459. private _minPoint;
  110460. private _maxPoint;
  110461. private _boundingVectors;
  110462. private _creationFunc;
  110463. /**
  110464. * Creates a new block
  110465. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  110466. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  110467. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  110468. * @param depth defines the current depth of this block in the octree
  110469. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  110470. * @param creationFunc defines a callback to call when an element is added to the block
  110471. */
  110472. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  110473. /**
  110474. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  110475. */
  110476. readonly capacity: number;
  110477. /**
  110478. * Gets the minimum vector (in world space) of the block's bounding box
  110479. */
  110480. readonly minPoint: Vector3;
  110481. /**
  110482. * Gets the maximum vector (in world space) of the block's bounding box
  110483. */
  110484. readonly maxPoint: Vector3;
  110485. /**
  110486. * Add a new element to this block
  110487. * @param entry defines the element to add
  110488. */
  110489. addEntry(entry: T): void;
  110490. /**
  110491. * Remove an element from this block
  110492. * @param entry defines the element to remove
  110493. */
  110494. removeEntry(entry: T): void;
  110495. /**
  110496. * Add an array of elements to this block
  110497. * @param entries defines the array of elements to add
  110498. */
  110499. addEntries(entries: T[]): void;
  110500. /**
  110501. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  110502. * @param frustumPlanes defines the frustum planes to test
  110503. * @param selection defines the array to store current content if selection is positive
  110504. * @param allowDuplicate defines if the selection array can contains duplicated entries
  110505. */
  110506. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  110507. /**
  110508. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  110509. * @param sphereCenter defines the bounding sphere center
  110510. * @param sphereRadius defines the bounding sphere radius
  110511. * @param selection defines the array to store current content if selection is positive
  110512. * @param allowDuplicate defines if the selection array can contains duplicated entries
  110513. */
  110514. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  110515. /**
  110516. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  110517. * @param ray defines the ray to test with
  110518. * @param selection defines the array to store current content if selection is positive
  110519. */
  110520. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  110521. /**
  110522. * Subdivide the content into child blocks (this block will then be empty)
  110523. */
  110524. createInnerBlocks(): void;
  110525. /**
  110526. * @hidden
  110527. */
  110528. 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;
  110529. }
  110530. }
  110531. declare module BABYLON {
  110532. /**
  110533. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  110534. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110535. */
  110536. export class Octree<T> {
  110537. /** 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.) */
  110538. maxDepth: number;
  110539. /**
  110540. * Blocks within the octree containing objects
  110541. */
  110542. blocks: Array<OctreeBlock<T>>;
  110543. /**
  110544. * Content stored in the octree
  110545. */
  110546. dynamicContent: T[];
  110547. private _maxBlockCapacity;
  110548. private _selectionContent;
  110549. private _creationFunc;
  110550. /**
  110551. * Creates a octree
  110552. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110553. * @param creationFunc function to be used to instatiate the octree
  110554. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  110555. * @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.)
  110556. */
  110557. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  110558. /** 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.) */
  110559. maxDepth?: number);
  110560. /**
  110561. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  110562. * @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);
  110563. * @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);
  110564. * @param entries meshes to be added to the octree blocks
  110565. */
  110566. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  110567. /**
  110568. * Adds a mesh to the octree
  110569. * @param entry Mesh to add to the octree
  110570. */
  110571. addMesh(entry: T): void;
  110572. /**
  110573. * Remove an element from the octree
  110574. * @param entry defines the element to remove
  110575. */
  110576. removeMesh(entry: T): void;
  110577. /**
  110578. * Selects an array of meshes within the frustum
  110579. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  110580. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  110581. * @returns array of meshes within the frustum
  110582. */
  110583. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  110584. /**
  110585. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  110586. * @param sphereCenter defines the bounding sphere center
  110587. * @param sphereRadius defines the bounding sphere radius
  110588. * @param allowDuplicate defines if the selection array can contains duplicated entries
  110589. * @returns an array of objects that intersect the sphere
  110590. */
  110591. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  110592. /**
  110593. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  110594. * @param ray defines the ray to test with
  110595. * @returns array of intersected objects
  110596. */
  110597. intersectsRay(ray: Ray): SmartArray<T>;
  110598. /**
  110599. * Adds a mesh into the octree block if it intersects the block
  110600. */
  110601. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  110602. /**
  110603. * Adds a submesh into the octree block if it intersects the block
  110604. */
  110605. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  110606. }
  110607. }
  110608. declare module BABYLON {
  110609. interface Scene {
  110610. /**
  110611. * @hidden
  110612. * Backing Filed
  110613. */
  110614. _selectionOctree: Octree<AbstractMesh>;
  110615. /**
  110616. * Gets the octree used to boost mesh selection (picking)
  110617. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110618. */
  110619. selectionOctree: Octree<AbstractMesh>;
  110620. /**
  110621. * Creates or updates the octree used to boost selection (picking)
  110622. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110623. * @param maxCapacity defines the maximum capacity per leaf
  110624. * @param maxDepth defines the maximum depth of the octree
  110625. * @returns an octree of AbstractMesh
  110626. */
  110627. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  110628. }
  110629. interface AbstractMesh {
  110630. /**
  110631. * @hidden
  110632. * Backing Field
  110633. */
  110634. _submeshesOctree: Octree<SubMesh>;
  110635. /**
  110636. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  110637. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  110638. * @param maxCapacity defines the maximum size of each block (64 by default)
  110639. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  110640. * @returns the new octree
  110641. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  110642. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110643. */
  110644. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  110645. }
  110646. /**
  110647. * Defines the octree scene component responsible to manage any octrees
  110648. * in a given scene.
  110649. */
  110650. export class OctreeSceneComponent {
  110651. /**
  110652. * The component name help to identify the component in the list of scene components.
  110653. */
  110654. readonly name: string;
  110655. /**
  110656. * The scene the component belongs to.
  110657. */
  110658. scene: Scene;
  110659. /**
  110660. * Indicates if the meshes have been checked to make sure they are isEnabled()
  110661. */
  110662. readonly checksIsEnabled: boolean;
  110663. /**
  110664. * Creates a new instance of the component for the given scene
  110665. * @param scene Defines the scene to register the component in
  110666. */
  110667. constructor(scene: Scene);
  110668. /**
  110669. * Registers the component in a given scene
  110670. */
  110671. register(): void;
  110672. /**
  110673. * Return the list of active meshes
  110674. * @returns the list of active meshes
  110675. */
  110676. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  110677. /**
  110678. * Return the list of active sub meshes
  110679. * @param mesh The mesh to get the candidates sub meshes from
  110680. * @returns the list of active sub meshes
  110681. */
  110682. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  110683. private _tempRay;
  110684. /**
  110685. * Return the list of sub meshes intersecting with a given local ray
  110686. * @param mesh defines the mesh to find the submesh for
  110687. * @param localRay defines the ray in local space
  110688. * @returns the list of intersecting sub meshes
  110689. */
  110690. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  110691. /**
  110692. * Return the list of sub meshes colliding with a collider
  110693. * @param mesh defines the mesh to find the submesh for
  110694. * @param collider defines the collider to evaluate the collision against
  110695. * @returns the list of colliding sub meshes
  110696. */
  110697. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  110698. /**
  110699. * Rebuilds the elements related to this component in case of
  110700. * context lost for instance.
  110701. */
  110702. rebuild(): void;
  110703. /**
  110704. * Disposes the component and the associated ressources.
  110705. */
  110706. dispose(): void;
  110707. }
  110708. }
  110709. declare module BABYLON {
  110710. /**
  110711. * Renders a layer on top of an existing scene
  110712. */
  110713. export class UtilityLayerRenderer implements IDisposable {
  110714. /** the original scene that will be rendered on top of */
  110715. originalScene: Scene;
  110716. private _pointerCaptures;
  110717. private _lastPointerEvents;
  110718. private static _DefaultUtilityLayer;
  110719. private static _DefaultKeepDepthUtilityLayer;
  110720. private _sharedGizmoLight;
  110721. private _renderCamera;
  110722. /**
  110723. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  110724. * @returns the camera that is used when rendering the utility layer
  110725. */
  110726. getRenderCamera(): Nullable<Camera>;
  110727. /**
  110728. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  110729. * @param cam the camera that should be used when rendering the utility layer
  110730. */
  110731. setRenderCamera(cam: Nullable<Camera>): void;
  110732. /**
  110733. * @hidden
  110734. * Light which used by gizmos to get light shading
  110735. */
  110736. _getSharedGizmoLight(): HemisphericLight;
  110737. /**
  110738. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  110739. */
  110740. pickUtilitySceneFirst: boolean;
  110741. /**
  110742. * 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)
  110743. */
  110744. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  110745. /**
  110746. * 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)
  110747. */
  110748. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  110749. /**
  110750. * The scene that is rendered on top of the original scene
  110751. */
  110752. utilityLayerScene: Scene;
  110753. /**
  110754. * If the utility layer should automatically be rendered on top of existing scene
  110755. */
  110756. shouldRender: boolean;
  110757. /**
  110758. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  110759. */
  110760. onlyCheckPointerDownEvents: boolean;
  110761. /**
  110762. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  110763. */
  110764. processAllEvents: boolean;
  110765. /**
  110766. * Observable raised when the pointer move from the utility layer scene to the main scene
  110767. */
  110768. onPointerOutObservable: Observable<number>;
  110769. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  110770. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  110771. private _afterRenderObserver;
  110772. private _sceneDisposeObserver;
  110773. private _originalPointerObserver;
  110774. /**
  110775. * Instantiates a UtilityLayerRenderer
  110776. * @param originalScene the original scene that will be rendered on top of
  110777. * @param handleEvents boolean indicating if the utility layer should handle events
  110778. */
  110779. constructor(
  110780. /** the original scene that will be rendered on top of */
  110781. originalScene: Scene, handleEvents?: boolean);
  110782. private _notifyObservers;
  110783. /**
  110784. * Renders the utility layers scene on top of the original scene
  110785. */
  110786. render(): void;
  110787. /**
  110788. * Disposes of the renderer
  110789. */
  110790. dispose(): void;
  110791. private _updateCamera;
  110792. }
  110793. }
  110794. declare module BABYLON {
  110795. /**
  110796. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  110797. */
  110798. export class Gizmo implements IDisposable {
  110799. /** The utility layer the gizmo will be added to */
  110800. gizmoLayer: UtilityLayerRenderer;
  110801. /**
  110802. * The root mesh of the gizmo
  110803. */
  110804. _rootMesh: Mesh;
  110805. private _attachedMesh;
  110806. /**
  110807. * Ratio for the scale of the gizmo (Default: 1)
  110808. */
  110809. scaleRatio: number;
  110810. /**
  110811. * If a custom mesh has been set (Default: false)
  110812. */
  110813. protected _customMeshSet: boolean;
  110814. /**
  110815. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  110816. * * When set, interactions will be enabled
  110817. */
  110818. attachedMesh: Nullable<AbstractMesh>;
  110819. /**
  110820. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  110821. * @param mesh The mesh to replace the default mesh of the gizmo
  110822. */
  110823. setCustomMesh(mesh: Mesh): void;
  110824. /**
  110825. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  110826. */
  110827. updateGizmoRotationToMatchAttachedMesh: boolean;
  110828. /**
  110829. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  110830. */
  110831. updateGizmoPositionToMatchAttachedMesh: boolean;
  110832. /**
  110833. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  110834. */
  110835. updateScale: boolean;
  110836. protected _interactionsEnabled: boolean;
  110837. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  110838. private _beforeRenderObserver;
  110839. private _tempVector;
  110840. /**
  110841. * Creates a gizmo
  110842. * @param gizmoLayer The utility layer the gizmo will be added to
  110843. */
  110844. constructor(
  110845. /** The utility layer the gizmo will be added to */
  110846. gizmoLayer?: UtilityLayerRenderer);
  110847. /**
  110848. * Updates the gizmo to match the attached mesh's position/rotation
  110849. */
  110850. protected _update(): void;
  110851. /**
  110852. * Disposes of the gizmo
  110853. */
  110854. dispose(): void;
  110855. }
  110856. }
  110857. declare module BABYLON {
  110858. /**
  110859. * Single plane drag gizmo
  110860. */
  110861. export class PlaneDragGizmo extends Gizmo {
  110862. /**
  110863. * Drag behavior responsible for the gizmos dragging interactions
  110864. */
  110865. dragBehavior: PointerDragBehavior;
  110866. private _pointerObserver;
  110867. /**
  110868. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  110869. */
  110870. snapDistance: number;
  110871. /**
  110872. * Event that fires each time the gizmo snaps to a new location.
  110873. * * snapDistance is the the change in distance
  110874. */
  110875. onSnapObservable: Observable<{
  110876. snapDistance: number;
  110877. }>;
  110878. private _plane;
  110879. private _coloredMaterial;
  110880. private _hoverMaterial;
  110881. private _isEnabled;
  110882. private _parent;
  110883. /** @hidden */
  110884. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  110885. /** @hidden */
  110886. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  110887. /**
  110888. * Creates a PlaneDragGizmo
  110889. * @param gizmoLayer The utility layer the gizmo will be added to
  110890. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  110891. * @param color The color of the gizmo
  110892. */
  110893. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  110894. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  110895. /**
  110896. * If the gizmo is enabled
  110897. */
  110898. isEnabled: boolean;
  110899. /**
  110900. * Disposes of the gizmo
  110901. */
  110902. dispose(): void;
  110903. }
  110904. }
  110905. declare module BABYLON {
  110906. /**
  110907. * Gizmo that enables dragging a mesh along 3 axis
  110908. */
  110909. export class PositionGizmo extends Gizmo {
  110910. /**
  110911. * Internal gizmo used for interactions on the x axis
  110912. */
  110913. xGizmo: AxisDragGizmo;
  110914. /**
  110915. * Internal gizmo used for interactions on the y axis
  110916. */
  110917. yGizmo: AxisDragGizmo;
  110918. /**
  110919. * Internal gizmo used for interactions on the z axis
  110920. */
  110921. zGizmo: AxisDragGizmo;
  110922. /**
  110923. * Internal gizmo used for interactions on the yz plane
  110924. */
  110925. xPlaneGizmo: PlaneDragGizmo;
  110926. /**
  110927. * Internal gizmo used for interactions on the xz plane
  110928. */
  110929. yPlaneGizmo: PlaneDragGizmo;
  110930. /**
  110931. * Internal gizmo used for interactions on the xy plane
  110932. */
  110933. zPlaneGizmo: PlaneDragGizmo;
  110934. /**
  110935. * private variables
  110936. */
  110937. private _meshAttached;
  110938. private _updateGizmoRotationToMatchAttachedMesh;
  110939. private _snapDistance;
  110940. private _scaleRatio;
  110941. /** Fires an event when any of it's sub gizmos are dragged */
  110942. onDragStartObservable: Observable<unknown>;
  110943. /** Fires an event when any of it's sub gizmos are released from dragging */
  110944. onDragEndObservable: Observable<unknown>;
  110945. /**
  110946. * If set to true, planar drag is enabled
  110947. */
  110948. private _planarGizmoEnabled;
  110949. attachedMesh: Nullable<AbstractMesh>;
  110950. /**
  110951. * Creates a PositionGizmo
  110952. * @param gizmoLayer The utility layer the gizmo will be added to
  110953. */
  110954. constructor(gizmoLayer?: UtilityLayerRenderer);
  110955. /**
  110956. * If the planar drag gizmo is enabled
  110957. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  110958. */
  110959. planarGizmoEnabled: boolean;
  110960. updateGizmoRotationToMatchAttachedMesh: boolean;
  110961. /**
  110962. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  110963. */
  110964. snapDistance: number;
  110965. /**
  110966. * Ratio for the scale of the gizmo (Default: 1)
  110967. */
  110968. scaleRatio: number;
  110969. /**
  110970. * Disposes of the gizmo
  110971. */
  110972. dispose(): void;
  110973. /**
  110974. * CustomMeshes are not supported by this gizmo
  110975. * @param mesh The mesh to replace the default mesh of the gizmo
  110976. */
  110977. setCustomMesh(mesh: Mesh): void;
  110978. }
  110979. }
  110980. declare module BABYLON {
  110981. /**
  110982. * Single axis drag gizmo
  110983. */
  110984. export class AxisDragGizmo extends Gizmo {
  110985. /**
  110986. * Drag behavior responsible for the gizmos dragging interactions
  110987. */
  110988. dragBehavior: PointerDragBehavior;
  110989. private _pointerObserver;
  110990. /**
  110991. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  110992. */
  110993. snapDistance: number;
  110994. /**
  110995. * Event that fires each time the gizmo snaps to a new location.
  110996. * * snapDistance is the the change in distance
  110997. */
  110998. onSnapObservable: Observable<{
  110999. snapDistance: number;
  111000. }>;
  111001. private _isEnabled;
  111002. private _parent;
  111003. private _arrow;
  111004. private _coloredMaterial;
  111005. private _hoverMaterial;
  111006. /** @hidden */
  111007. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  111008. /** @hidden */
  111009. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  111010. /**
  111011. * Creates an AxisDragGizmo
  111012. * @param gizmoLayer The utility layer the gizmo will be added to
  111013. * @param dragAxis The axis which the gizmo will be able to drag on
  111014. * @param color The color of the gizmo
  111015. */
  111016. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  111017. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  111018. /**
  111019. * If the gizmo is enabled
  111020. */
  111021. isEnabled: boolean;
  111022. /**
  111023. * Disposes of the gizmo
  111024. */
  111025. dispose(): void;
  111026. }
  111027. }
  111028. declare module BABYLON.Debug {
  111029. /**
  111030. * The Axes viewer will show 3 axes in a specific point in space
  111031. */
  111032. export class AxesViewer {
  111033. private _xAxis;
  111034. private _yAxis;
  111035. private _zAxis;
  111036. private _scaleLinesFactor;
  111037. private _instanced;
  111038. /**
  111039. * Gets the hosting scene
  111040. */
  111041. scene: Scene;
  111042. /**
  111043. * Gets or sets a number used to scale line length
  111044. */
  111045. scaleLines: number;
  111046. /** Gets the node hierarchy used to render x-axis */
  111047. readonly xAxis: TransformNode;
  111048. /** Gets the node hierarchy used to render y-axis */
  111049. readonly yAxis: TransformNode;
  111050. /** Gets the node hierarchy used to render z-axis */
  111051. readonly zAxis: TransformNode;
  111052. /**
  111053. * Creates a new AxesViewer
  111054. * @param scene defines the hosting scene
  111055. * @param scaleLines defines a number used to scale line length (1 by default)
  111056. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  111057. * @param xAxis defines the node hierarchy used to render the x-axis
  111058. * @param yAxis defines the node hierarchy used to render the y-axis
  111059. * @param zAxis defines the node hierarchy used to render the z-axis
  111060. */
  111061. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  111062. /**
  111063. * Force the viewer to update
  111064. * @param position defines the position of the viewer
  111065. * @param xaxis defines the x axis of the viewer
  111066. * @param yaxis defines the y axis of the viewer
  111067. * @param zaxis defines the z axis of the viewer
  111068. */
  111069. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  111070. /**
  111071. * Creates an instance of this axes viewer.
  111072. * @returns a new axes viewer with instanced meshes
  111073. */
  111074. createInstance(): AxesViewer;
  111075. /** Releases resources */
  111076. dispose(): void;
  111077. private static _SetRenderingGroupId;
  111078. }
  111079. }
  111080. declare module BABYLON.Debug {
  111081. /**
  111082. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  111083. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  111084. */
  111085. export class BoneAxesViewer extends AxesViewer {
  111086. /**
  111087. * Gets or sets the target mesh where to display the axes viewer
  111088. */
  111089. mesh: Nullable<Mesh>;
  111090. /**
  111091. * Gets or sets the target bone where to display the axes viewer
  111092. */
  111093. bone: Nullable<Bone>;
  111094. /** Gets current position */
  111095. pos: Vector3;
  111096. /** Gets direction of X axis */
  111097. xaxis: Vector3;
  111098. /** Gets direction of Y axis */
  111099. yaxis: Vector3;
  111100. /** Gets direction of Z axis */
  111101. zaxis: Vector3;
  111102. /**
  111103. * Creates a new BoneAxesViewer
  111104. * @param scene defines the hosting scene
  111105. * @param bone defines the target bone
  111106. * @param mesh defines the target mesh
  111107. * @param scaleLines defines a scaling factor for line length (1 by default)
  111108. */
  111109. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  111110. /**
  111111. * Force the viewer to update
  111112. */
  111113. update(): void;
  111114. /** Releases resources */
  111115. dispose(): void;
  111116. }
  111117. }
  111118. declare module BABYLON {
  111119. /**
  111120. * Interface used to define scene explorer extensibility option
  111121. */
  111122. export interface IExplorerExtensibilityOption {
  111123. /**
  111124. * Define the option label
  111125. */
  111126. label: string;
  111127. /**
  111128. * Defines the action to execute on click
  111129. */
  111130. action: (entity: any) => void;
  111131. }
  111132. /**
  111133. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  111134. */
  111135. export interface IExplorerExtensibilityGroup {
  111136. /**
  111137. * Defines a predicate to test if a given type mut be extended
  111138. */
  111139. predicate: (entity: any) => boolean;
  111140. /**
  111141. * Gets the list of options added to a type
  111142. */
  111143. entries: IExplorerExtensibilityOption[];
  111144. }
  111145. /**
  111146. * Interface used to define the options to use to create the Inspector
  111147. */
  111148. export interface IInspectorOptions {
  111149. /**
  111150. * Display in overlay mode (default: false)
  111151. */
  111152. overlay?: boolean;
  111153. /**
  111154. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  111155. */
  111156. globalRoot?: HTMLElement;
  111157. /**
  111158. * Display the Scene explorer
  111159. */
  111160. showExplorer?: boolean;
  111161. /**
  111162. * Display the property inspector
  111163. */
  111164. showInspector?: boolean;
  111165. /**
  111166. * Display in embed mode (both panes on the right)
  111167. */
  111168. embedMode?: boolean;
  111169. /**
  111170. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  111171. */
  111172. handleResize?: boolean;
  111173. /**
  111174. * Allow the panes to popup (default: true)
  111175. */
  111176. enablePopup?: boolean;
  111177. /**
  111178. * Allow the panes to be closed by users (default: true)
  111179. */
  111180. enableClose?: boolean;
  111181. /**
  111182. * Optional list of extensibility entries
  111183. */
  111184. explorerExtensibility?: IExplorerExtensibilityGroup[];
  111185. /**
  111186. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  111187. */
  111188. inspectorURL?: string;
  111189. }
  111190. interface Scene {
  111191. /**
  111192. * @hidden
  111193. * Backing field
  111194. */
  111195. _debugLayer: DebugLayer;
  111196. /**
  111197. * Gets the debug layer (aka Inspector) associated with the scene
  111198. * @see http://doc.babylonjs.com/features/playground_debuglayer
  111199. */
  111200. debugLayer: DebugLayer;
  111201. }
  111202. /**
  111203. * The debug layer (aka Inspector) is the go to tool in order to better understand
  111204. * what is happening in your scene
  111205. * @see http://doc.babylonjs.com/features/playground_debuglayer
  111206. */
  111207. export class DebugLayer {
  111208. /**
  111209. * Define the url to get the inspector script from.
  111210. * By default it uses the babylonjs CDN.
  111211. * @ignoreNaming
  111212. */
  111213. static InspectorURL: string;
  111214. private _scene;
  111215. private BJSINSPECTOR;
  111216. private _onPropertyChangedObservable?;
  111217. /**
  111218. * Observable triggered when a property is changed through the inspector.
  111219. */
  111220. readonly onPropertyChangedObservable: any;
  111221. /**
  111222. * Instantiates a new debug layer.
  111223. * The debug layer (aka Inspector) is the go to tool in order to better understand
  111224. * what is happening in your scene
  111225. * @see http://doc.babylonjs.com/features/playground_debuglayer
  111226. * @param scene Defines the scene to inspect
  111227. */
  111228. constructor(scene: Scene);
  111229. /** Creates the inspector window. */
  111230. private _createInspector;
  111231. /**
  111232. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  111233. * @param entity defines the entity to select
  111234. * @param lineContainerTitle defines the specific block to highlight
  111235. */
  111236. select(entity: any, lineContainerTitle?: string): void;
  111237. /** Get the inspector from bundle or global */
  111238. private _getGlobalInspector;
  111239. /**
  111240. * Get if the inspector is visible or not.
  111241. * @returns true if visible otherwise, false
  111242. */
  111243. isVisible(): boolean;
  111244. /**
  111245. * Hide the inspector and close its window.
  111246. */
  111247. hide(): void;
  111248. /**
  111249. * Launch the debugLayer.
  111250. * @param config Define the configuration of the inspector
  111251. * @return a promise fulfilled when the debug layer is visible
  111252. */
  111253. show(config?: IInspectorOptions): Promise<DebugLayer>;
  111254. }
  111255. }
  111256. declare module BABYLON {
  111257. /**
  111258. * Class containing static functions to help procedurally build meshes
  111259. */
  111260. export class BoxBuilder {
  111261. /**
  111262. * Creates a box mesh
  111263. * * The parameter `size` sets the size (float) of each box side (default 1)
  111264. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  111265. * * 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)
  111266. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  111267. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  111268. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  111269. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111270. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  111271. * @param name defines the name of the mesh
  111272. * @param options defines the options used to create the mesh
  111273. * @param scene defines the hosting scene
  111274. * @returns the box mesh
  111275. */
  111276. static CreateBox(name: string, options: {
  111277. size?: number;
  111278. width?: number;
  111279. height?: number;
  111280. depth?: number;
  111281. faceUV?: Vector4[];
  111282. faceColors?: Color4[];
  111283. sideOrientation?: number;
  111284. frontUVs?: Vector4;
  111285. backUVs?: Vector4;
  111286. wrap?: boolean;
  111287. topBaseAt?: number;
  111288. bottomBaseAt?: number;
  111289. updatable?: boolean;
  111290. }, scene?: Nullable<Scene>): Mesh;
  111291. }
  111292. }
  111293. declare module BABYLON {
  111294. /**
  111295. * Class containing static functions to help procedurally build meshes
  111296. */
  111297. export class SphereBuilder {
  111298. /**
  111299. * Creates a sphere mesh
  111300. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  111301. * * 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`)
  111302. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  111303. * * 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
  111304. * * 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)
  111305. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  111306. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  111307. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111308. * @param name defines the name of the mesh
  111309. * @param options defines the options used to create the mesh
  111310. * @param scene defines the hosting scene
  111311. * @returns the sphere mesh
  111312. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  111313. */
  111314. static CreateSphere(name: string, options: {
  111315. segments?: number;
  111316. diameter?: number;
  111317. diameterX?: number;
  111318. diameterY?: number;
  111319. diameterZ?: number;
  111320. arc?: number;
  111321. slice?: number;
  111322. sideOrientation?: number;
  111323. frontUVs?: Vector4;
  111324. backUVs?: Vector4;
  111325. updatable?: boolean;
  111326. }, scene?: Nullable<Scene>): Mesh;
  111327. }
  111328. }
  111329. declare module BABYLON.Debug {
  111330. /**
  111331. * Used to show the physics impostor around the specific mesh
  111332. */
  111333. export class PhysicsViewer {
  111334. /** @hidden */
  111335. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  111336. /** @hidden */
  111337. protected _meshes: Array<Nullable<AbstractMesh>>;
  111338. /** @hidden */
  111339. protected _scene: Nullable<Scene>;
  111340. /** @hidden */
  111341. protected _numMeshes: number;
  111342. /** @hidden */
  111343. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  111344. private _renderFunction;
  111345. private _utilityLayer;
  111346. private _debugBoxMesh;
  111347. private _debugSphereMesh;
  111348. private _debugCylinderMesh;
  111349. private _debugMaterial;
  111350. private _debugMeshMeshes;
  111351. /**
  111352. * Creates a new PhysicsViewer
  111353. * @param scene defines the hosting scene
  111354. */
  111355. constructor(scene: Scene);
  111356. /** @hidden */
  111357. protected _updateDebugMeshes(): void;
  111358. /**
  111359. * Renders a specified physic impostor
  111360. * @param impostor defines the impostor to render
  111361. * @param targetMesh defines the mesh represented by the impostor
  111362. * @returns the new debug mesh used to render the impostor
  111363. */
  111364. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  111365. /**
  111366. * Hides a specified physic impostor
  111367. * @param impostor defines the impostor to hide
  111368. */
  111369. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  111370. private _getDebugMaterial;
  111371. private _getDebugBoxMesh;
  111372. private _getDebugSphereMesh;
  111373. private _getDebugCylinderMesh;
  111374. private _getDebugMeshMesh;
  111375. private _getDebugMesh;
  111376. /** Releases all resources */
  111377. dispose(): void;
  111378. }
  111379. }
  111380. declare module BABYLON {
  111381. /**
  111382. * Class containing static functions to help procedurally build meshes
  111383. */
  111384. export class LinesBuilder {
  111385. /**
  111386. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  111387. * * 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
  111388. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  111389. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  111390. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  111391. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  111392. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  111393. * * 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
  111394. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  111395. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111396. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  111397. * @param name defines the name of the new line system
  111398. * @param options defines the options used to create the line system
  111399. * @param scene defines the hosting scene
  111400. * @returns a new line system mesh
  111401. */
  111402. static CreateLineSystem(name: string, options: {
  111403. lines: Vector3[][];
  111404. updatable?: boolean;
  111405. instance?: Nullable<LinesMesh>;
  111406. colors?: Nullable<Color4[][]>;
  111407. useVertexAlpha?: boolean;
  111408. }, scene: Nullable<Scene>): LinesMesh;
  111409. /**
  111410. * Creates a line mesh
  111411. * 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
  111412. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  111413. * * The parameter `points` is an array successive Vector3
  111414. * * 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
  111415. * * The optional parameter `colors` is an array of successive Color4, one per line point
  111416. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  111417. * * When updating an instance, remember that only point positions can change, not the number of points
  111418. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111419. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  111420. * @param name defines the name of the new line system
  111421. * @param options defines the options used to create the line system
  111422. * @param scene defines the hosting scene
  111423. * @returns a new line mesh
  111424. */
  111425. static CreateLines(name: string, options: {
  111426. points: Vector3[];
  111427. updatable?: boolean;
  111428. instance?: Nullable<LinesMesh>;
  111429. colors?: Color4[];
  111430. useVertexAlpha?: boolean;
  111431. }, scene?: Nullable<Scene>): LinesMesh;
  111432. /**
  111433. * Creates a dashed line mesh
  111434. * * 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
  111435. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  111436. * * The parameter `points` is an array successive Vector3
  111437. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  111438. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  111439. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  111440. * * 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
  111441. * * When updating an instance, remember that only point positions can change, not the number of points
  111442. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111443. * @param name defines the name of the mesh
  111444. * @param options defines the options used to create the mesh
  111445. * @param scene defines the hosting scene
  111446. * @returns the dashed line mesh
  111447. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  111448. */
  111449. static CreateDashedLines(name: string, options: {
  111450. points: Vector3[];
  111451. dashSize?: number;
  111452. gapSize?: number;
  111453. dashNb?: number;
  111454. updatable?: boolean;
  111455. instance?: LinesMesh;
  111456. }, scene?: Nullable<Scene>): LinesMesh;
  111457. }
  111458. }
  111459. declare module BABYLON {
  111460. /**
  111461. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  111462. * in order to better appreciate the issue one might have.
  111463. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  111464. */
  111465. export class RayHelper {
  111466. /**
  111467. * Defines the ray we are currently tryin to visualize.
  111468. */
  111469. ray: Nullable<Ray>;
  111470. private _renderPoints;
  111471. private _renderLine;
  111472. private _renderFunction;
  111473. private _scene;
  111474. private _updateToMeshFunction;
  111475. private _attachedToMesh;
  111476. private _meshSpaceDirection;
  111477. private _meshSpaceOrigin;
  111478. /**
  111479. * Helper function to create a colored helper in a scene in one line.
  111480. * @param ray Defines the ray we are currently tryin to visualize
  111481. * @param scene Defines the scene the ray is used in
  111482. * @param color Defines the color we want to see the ray in
  111483. * @returns The newly created ray helper.
  111484. */
  111485. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  111486. /**
  111487. * Instantiate a new ray helper.
  111488. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  111489. * in order to better appreciate the issue one might have.
  111490. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  111491. * @param ray Defines the ray we are currently tryin to visualize
  111492. */
  111493. constructor(ray: Ray);
  111494. /**
  111495. * Shows the ray we are willing to debug.
  111496. * @param scene Defines the scene the ray needs to be rendered in
  111497. * @param color Defines the color the ray needs to be rendered in
  111498. */
  111499. show(scene: Scene, color?: Color3): void;
  111500. /**
  111501. * Hides the ray we are debugging.
  111502. */
  111503. hide(): void;
  111504. private _render;
  111505. /**
  111506. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  111507. * @param mesh Defines the mesh we want the helper attached to
  111508. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  111509. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  111510. * @param length Defines the length of the ray
  111511. */
  111512. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  111513. /**
  111514. * Detach the ray helper from the mesh it has previously been attached to.
  111515. */
  111516. detachFromMesh(): void;
  111517. private _updateToMesh;
  111518. /**
  111519. * Dispose the helper and release its associated resources.
  111520. */
  111521. dispose(): void;
  111522. }
  111523. }
  111524. declare module BABYLON.Debug {
  111525. /**
  111526. * Class used to render a debug view of a given skeleton
  111527. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  111528. */
  111529. export class SkeletonViewer {
  111530. /** defines the skeleton to render */
  111531. skeleton: Skeleton;
  111532. /** defines the mesh attached to the skeleton */
  111533. mesh: AbstractMesh;
  111534. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  111535. autoUpdateBonesMatrices: boolean;
  111536. /** defines the rendering group id to use with the viewer */
  111537. renderingGroupId: number;
  111538. /** Gets or sets the color used to render the skeleton */
  111539. color: Color3;
  111540. private _scene;
  111541. private _debugLines;
  111542. private _debugMesh;
  111543. private _isEnabled;
  111544. private _renderFunction;
  111545. private _utilityLayer;
  111546. /**
  111547. * Returns the mesh used to render the bones
  111548. */
  111549. readonly debugMesh: Nullable<LinesMesh>;
  111550. /**
  111551. * Creates a new SkeletonViewer
  111552. * @param skeleton defines the skeleton to render
  111553. * @param mesh defines the mesh attached to the skeleton
  111554. * @param scene defines the hosting scene
  111555. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  111556. * @param renderingGroupId defines the rendering group id to use with the viewer
  111557. */
  111558. constructor(
  111559. /** defines the skeleton to render */
  111560. skeleton: Skeleton,
  111561. /** defines the mesh attached to the skeleton */
  111562. mesh: AbstractMesh, scene: Scene,
  111563. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  111564. autoUpdateBonesMatrices?: boolean,
  111565. /** defines the rendering group id to use with the viewer */
  111566. renderingGroupId?: number);
  111567. /** Gets or sets a boolean indicating if the viewer is enabled */
  111568. isEnabled: boolean;
  111569. private _getBonePosition;
  111570. private _getLinesForBonesWithLength;
  111571. private _getLinesForBonesNoLength;
  111572. /** Update the viewer to sync with current skeleton state */
  111573. update(): void;
  111574. /** Release associated resources */
  111575. dispose(): void;
  111576. }
  111577. }
  111578. declare module BABYLON {
  111579. /**
  111580. * Options to create the null engine
  111581. */
  111582. export class NullEngineOptions {
  111583. /**
  111584. * Render width (Default: 512)
  111585. */
  111586. renderWidth: number;
  111587. /**
  111588. * Render height (Default: 256)
  111589. */
  111590. renderHeight: number;
  111591. /**
  111592. * Texture size (Default: 512)
  111593. */
  111594. textureSize: number;
  111595. /**
  111596. * If delta time between frames should be constant
  111597. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  111598. */
  111599. deterministicLockstep: boolean;
  111600. /**
  111601. * Maximum about of steps between frames (Default: 4)
  111602. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  111603. */
  111604. lockstepMaxSteps: number;
  111605. }
  111606. /**
  111607. * The null engine class provides support for headless version of babylon.js.
  111608. * This can be used in server side scenario or for testing purposes
  111609. */
  111610. export class NullEngine extends Engine {
  111611. private _options;
  111612. /**
  111613. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  111614. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  111615. * @returns true if engine is in deterministic lock step mode
  111616. */
  111617. isDeterministicLockStep(): boolean;
  111618. /**
  111619. * Gets the max steps when engine is running in deterministic lock step
  111620. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  111621. * @returns the max steps
  111622. */
  111623. getLockstepMaxSteps(): number;
  111624. /**
  111625. * Gets the current hardware scaling level.
  111626. * By default the hardware scaling level is computed from the window device ratio.
  111627. * 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.
  111628. * @returns a number indicating the current hardware scaling level
  111629. */
  111630. getHardwareScalingLevel(): number;
  111631. constructor(options?: NullEngineOptions);
  111632. /**
  111633. * Creates a vertex buffer
  111634. * @param vertices the data for the vertex buffer
  111635. * @returns the new WebGL static buffer
  111636. */
  111637. createVertexBuffer(vertices: FloatArray): DataBuffer;
  111638. /**
  111639. * Creates a new index buffer
  111640. * @param indices defines the content of the index buffer
  111641. * @param updatable defines if the index buffer must be updatable
  111642. * @returns a new webGL buffer
  111643. */
  111644. createIndexBuffer(indices: IndicesArray): DataBuffer;
  111645. /**
  111646. * Clear the current render buffer or the current render target (if any is set up)
  111647. * @param color defines the color to use
  111648. * @param backBuffer defines if the back buffer must be cleared
  111649. * @param depth defines if the depth buffer must be cleared
  111650. * @param stencil defines if the stencil buffer must be cleared
  111651. */
  111652. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  111653. /**
  111654. * Gets the current render width
  111655. * @param useScreen defines if screen size must be used (or the current render target if any)
  111656. * @returns a number defining the current render width
  111657. */
  111658. getRenderWidth(useScreen?: boolean): number;
  111659. /**
  111660. * Gets the current render height
  111661. * @param useScreen defines if screen size must be used (or the current render target if any)
  111662. * @returns a number defining the current render height
  111663. */
  111664. getRenderHeight(useScreen?: boolean): number;
  111665. /**
  111666. * Set the WebGL's viewport
  111667. * @param viewport defines the viewport element to be used
  111668. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  111669. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  111670. */
  111671. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  111672. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  111673. /**
  111674. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  111675. * @param pipelineContext defines the pipeline context to use
  111676. * @param uniformsNames defines the list of uniform names
  111677. * @returns an array of webGL uniform locations
  111678. */
  111679. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  111680. /**
  111681. * Gets the lsit of active attributes for a given webGL program
  111682. * @param pipelineContext defines the pipeline context to use
  111683. * @param attributesNames defines the list of attribute names to get
  111684. * @returns an array of indices indicating the offset of each attribute
  111685. */
  111686. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  111687. /**
  111688. * Binds an effect to the webGL context
  111689. * @param effect defines the effect to bind
  111690. */
  111691. bindSamplers(effect: Effect): void;
  111692. /**
  111693. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  111694. * @param effect defines the effect to activate
  111695. */
  111696. enableEffect(effect: Effect): void;
  111697. /**
  111698. * Set various states to the webGL context
  111699. * @param culling defines backface culling state
  111700. * @param zOffset defines the value to apply to zOffset (0 by default)
  111701. * @param force defines if states must be applied even if cache is up to date
  111702. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  111703. */
  111704. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  111705. /**
  111706. * Set the value of an uniform to an array of int32
  111707. * @param uniform defines the webGL uniform location where to store the value
  111708. * @param array defines the array of int32 to store
  111709. */
  111710. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  111711. /**
  111712. * Set the value of an uniform to an array of int32 (stored as vec2)
  111713. * @param uniform defines the webGL uniform location where to store the value
  111714. * @param array defines the array of int32 to store
  111715. */
  111716. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  111717. /**
  111718. * Set the value of an uniform to an array of int32 (stored as vec3)
  111719. * @param uniform defines the webGL uniform location where to store the value
  111720. * @param array defines the array of int32 to store
  111721. */
  111722. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  111723. /**
  111724. * Set the value of an uniform to an array of int32 (stored as vec4)
  111725. * @param uniform defines the webGL uniform location where to store the value
  111726. * @param array defines the array of int32 to store
  111727. */
  111728. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  111729. /**
  111730. * Set the value of an uniform to an array of float32
  111731. * @param uniform defines the webGL uniform location where to store the value
  111732. * @param array defines the array of float32 to store
  111733. */
  111734. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  111735. /**
  111736. * Set the value of an uniform to an array of float32 (stored as vec2)
  111737. * @param uniform defines the webGL uniform location where to store the value
  111738. * @param array defines the array of float32 to store
  111739. */
  111740. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  111741. /**
  111742. * Set the value of an uniform to an array of float32 (stored as vec3)
  111743. * @param uniform defines the webGL uniform location where to store the value
  111744. * @param array defines the array of float32 to store
  111745. */
  111746. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  111747. /**
  111748. * Set the value of an uniform to an array of float32 (stored as vec4)
  111749. * @param uniform defines the webGL uniform location where to store the value
  111750. * @param array defines the array of float32 to store
  111751. */
  111752. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  111753. /**
  111754. * Set the value of an uniform to an array of number
  111755. * @param uniform defines the webGL uniform location where to store the value
  111756. * @param array defines the array of number to store
  111757. */
  111758. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  111759. /**
  111760. * Set the value of an uniform to an array of number (stored as vec2)
  111761. * @param uniform defines the webGL uniform location where to store the value
  111762. * @param array defines the array of number to store
  111763. */
  111764. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  111765. /**
  111766. * Set the value of an uniform to an array of number (stored as vec3)
  111767. * @param uniform defines the webGL uniform location where to store the value
  111768. * @param array defines the array of number to store
  111769. */
  111770. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  111771. /**
  111772. * Set the value of an uniform to an array of number (stored as vec4)
  111773. * @param uniform defines the webGL uniform location where to store the value
  111774. * @param array defines the array of number to store
  111775. */
  111776. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  111777. /**
  111778. * Set the value of an uniform to an array of float32 (stored as matrices)
  111779. * @param uniform defines the webGL uniform location where to store the value
  111780. * @param matrices defines the array of float32 to store
  111781. */
  111782. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  111783. /**
  111784. * Set the value of an uniform to a matrix (3x3)
  111785. * @param uniform defines the webGL uniform location where to store the value
  111786. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  111787. */
  111788. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  111789. /**
  111790. * Set the value of an uniform to a matrix (2x2)
  111791. * @param uniform defines the webGL uniform location where to store the value
  111792. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  111793. */
  111794. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  111795. /**
  111796. * Set the value of an uniform to a number (float)
  111797. * @param uniform defines the webGL uniform location where to store the value
  111798. * @param value defines the float number to store
  111799. */
  111800. setFloat(uniform: WebGLUniformLocation, value: number): void;
  111801. /**
  111802. * Set the value of an uniform to a vec2
  111803. * @param uniform defines the webGL uniform location where to store the value
  111804. * @param x defines the 1st component of the value
  111805. * @param y defines the 2nd component of the value
  111806. */
  111807. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  111808. /**
  111809. * Set the value of an uniform to a vec3
  111810. * @param uniform defines the webGL uniform location where to store the value
  111811. * @param x defines the 1st component of the value
  111812. * @param y defines the 2nd component of the value
  111813. * @param z defines the 3rd component of the value
  111814. */
  111815. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  111816. /**
  111817. * Set the value of an uniform to a boolean
  111818. * @param uniform defines the webGL uniform location where to store the value
  111819. * @param bool defines the boolean to store
  111820. */
  111821. setBool(uniform: WebGLUniformLocation, bool: number): void;
  111822. /**
  111823. * Set the value of an uniform to a vec4
  111824. * @param uniform defines the webGL uniform location where to store the value
  111825. * @param x defines the 1st component of the value
  111826. * @param y defines the 2nd component of the value
  111827. * @param z defines the 3rd component of the value
  111828. * @param w defines the 4th component of the value
  111829. */
  111830. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  111831. /**
  111832. * Sets the current alpha mode
  111833. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  111834. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  111835. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  111836. */
  111837. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  111838. /**
  111839. * Bind webGl buffers directly to the webGL context
  111840. * @param vertexBuffers defines the vertex buffer to bind
  111841. * @param indexBuffer defines the index buffer to bind
  111842. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  111843. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  111844. * @param effect defines the effect associated with the vertex buffer
  111845. */
  111846. bindBuffers(vertexBuffers: {
  111847. [key: string]: VertexBuffer;
  111848. }, indexBuffer: DataBuffer, effect: Effect): void;
  111849. /**
  111850. * Force the entire cache to be cleared
  111851. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  111852. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  111853. */
  111854. wipeCaches(bruteForce?: boolean): void;
  111855. /**
  111856. * Send a draw order
  111857. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  111858. * @param indexStart defines the starting index
  111859. * @param indexCount defines the number of index to draw
  111860. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  111861. */
  111862. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  111863. /**
  111864. * Draw a list of indexed primitives
  111865. * @param fillMode defines the primitive to use
  111866. * @param indexStart defines the starting index
  111867. * @param indexCount defines the number of index to draw
  111868. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  111869. */
  111870. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  111871. /**
  111872. * Draw a list of unindexed primitives
  111873. * @param fillMode defines the primitive to use
  111874. * @param verticesStart defines the index of first vertex to draw
  111875. * @param verticesCount defines the count of vertices to draw
  111876. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  111877. */
  111878. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  111879. /** @hidden */
  111880. _createTexture(): WebGLTexture;
  111881. /** @hidden */
  111882. _releaseTexture(texture: InternalTexture): void;
  111883. /**
  111884. * Usually called from Texture.ts.
  111885. * Passed information to create a WebGLTexture
  111886. * @param urlArg defines a value which contains one of the following:
  111887. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  111888. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  111889. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  111890. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  111891. * @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)
  111892. * @param scene needed for loading to the correct scene
  111893. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  111894. * @param onLoad optional callback to be called upon successful completion
  111895. * @param onError optional callback to be called upon failure
  111896. * @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
  111897. * @param fallBack an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  111898. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  111899. * @param forcedExtension defines the extension to use to pick the right loader
  111900. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  111901. * @returns a InternalTexture for assignment back into BABYLON.Texture
  111902. */
  111903. createTexture(urlArg: string, noMipmap: boolean, invertY: boolean, scene: Scene, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<ArrayBuffer | HTMLImageElement>, fallBack?: InternalTexture, format?: number): InternalTexture;
  111904. /**
  111905. * Creates a new render target texture
  111906. * @param size defines the size of the texture
  111907. * @param options defines the options used to create the texture
  111908. * @returns a new render target texture stored in an InternalTexture
  111909. */
  111910. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  111911. /**
  111912. * Update the sampling mode of a given texture
  111913. * @param samplingMode defines the required sampling mode
  111914. * @param texture defines the texture to update
  111915. */
  111916. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  111917. /**
  111918. * Binds the frame buffer to the specified texture.
  111919. * @param texture The texture to render to or null for the default canvas
  111920. * @param faceIndex The face of the texture to render to in case of cube texture
  111921. * @param requiredWidth The width of the target to render to
  111922. * @param requiredHeight The height of the target to render to
  111923. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  111924. * @param depthStencilTexture The depth stencil texture to use to render
  111925. * @param lodLevel defines le lod level to bind to the frame buffer
  111926. */
  111927. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  111928. /**
  111929. * Unbind the current render target texture from the webGL context
  111930. * @param texture defines the render target texture to unbind
  111931. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  111932. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  111933. */
  111934. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  111935. /**
  111936. * Creates a dynamic vertex buffer
  111937. * @param vertices the data for the dynamic vertex buffer
  111938. * @returns the new WebGL dynamic buffer
  111939. */
  111940. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  111941. /**
  111942. * Update the content of a dynamic texture
  111943. * @param texture defines the texture to update
  111944. * @param canvas defines the canvas containing the source
  111945. * @param invertY defines if data must be stored with Y axis inverted
  111946. * @param premulAlpha defines if alpha is stored as premultiplied
  111947. * @param format defines the format of the data
  111948. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  111949. */
  111950. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  111951. /**
  111952. * Gets a boolean indicating if all created effects are ready
  111953. * @returns true if all effects are ready
  111954. */
  111955. areAllEffectsReady(): boolean;
  111956. /**
  111957. * @hidden
  111958. * Get the current error code of the webGL context
  111959. * @returns the error code
  111960. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  111961. */
  111962. getError(): number;
  111963. /** @hidden */
  111964. _getUnpackAlignement(): number;
  111965. /** @hidden */
  111966. _unpackFlipY(value: boolean): void;
  111967. /**
  111968. * Update a dynamic index buffer
  111969. * @param indexBuffer defines the target index buffer
  111970. * @param indices defines the data to update
  111971. * @param offset defines the offset in the target index buffer where update should start
  111972. */
  111973. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  111974. /**
  111975. * Updates a dynamic vertex buffer.
  111976. * @param vertexBuffer the vertex buffer to update
  111977. * @param vertices the data used to update the vertex buffer
  111978. * @param byteOffset the byte offset of the data (optional)
  111979. * @param byteLength the byte length of the data (optional)
  111980. */
  111981. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  111982. /** @hidden */
  111983. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  111984. /** @hidden */
  111985. _bindTexture(channel: number, texture: InternalTexture): void;
  111986. protected _deleteBuffer(buffer: WebGLBuffer): void;
  111987. /**
  111988. * 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
  111989. */
  111990. releaseEffects(): void;
  111991. displayLoadingUI(): void;
  111992. hideLoadingUI(): void;
  111993. /** @hidden */
  111994. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  111995. /** @hidden */
  111996. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  111997. /** @hidden */
  111998. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  111999. /** @hidden */
  112000. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  112001. }
  112002. }
  112003. declare module BABYLON {
  112004. /** @hidden */
  112005. export class _OcclusionDataStorage {
  112006. /** @hidden */
  112007. occlusionInternalRetryCounter: number;
  112008. /** @hidden */
  112009. isOcclusionQueryInProgress: boolean;
  112010. /** @hidden */
  112011. isOccluded: boolean;
  112012. /** @hidden */
  112013. occlusionRetryCount: number;
  112014. /** @hidden */
  112015. occlusionType: number;
  112016. /** @hidden */
  112017. occlusionQueryAlgorithmType: number;
  112018. }
  112019. interface Engine {
  112020. /**
  112021. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  112022. * @return the new query
  112023. */
  112024. createQuery(): WebGLQuery;
  112025. /**
  112026. * Delete and release a webGL query
  112027. * @param query defines the query to delete
  112028. * @return the current engine
  112029. */
  112030. deleteQuery(query: WebGLQuery): Engine;
  112031. /**
  112032. * Check if a given query has resolved and got its value
  112033. * @param query defines the query to check
  112034. * @returns true if the query got its value
  112035. */
  112036. isQueryResultAvailable(query: WebGLQuery): boolean;
  112037. /**
  112038. * Gets the value of a given query
  112039. * @param query defines the query to check
  112040. * @returns the value of the query
  112041. */
  112042. getQueryResult(query: WebGLQuery): number;
  112043. /**
  112044. * Initiates an occlusion query
  112045. * @param algorithmType defines the algorithm to use
  112046. * @param query defines the query to use
  112047. * @returns the current engine
  112048. * @see http://doc.babylonjs.com/features/occlusionquery
  112049. */
  112050. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  112051. /**
  112052. * Ends an occlusion query
  112053. * @see http://doc.babylonjs.com/features/occlusionquery
  112054. * @param algorithmType defines the algorithm to use
  112055. * @returns the current engine
  112056. */
  112057. endOcclusionQuery(algorithmType: number): Engine;
  112058. /**
  112059. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  112060. * Please note that only one query can be issued at a time
  112061. * @returns a time token used to track the time span
  112062. */
  112063. startTimeQuery(): Nullable<_TimeToken>;
  112064. /**
  112065. * Ends a time query
  112066. * @param token defines the token used to measure the time span
  112067. * @returns the time spent (in ns)
  112068. */
  112069. endTimeQuery(token: _TimeToken): int;
  112070. /** @hidden */
  112071. _currentNonTimestampToken: Nullable<_TimeToken>;
  112072. /** @hidden */
  112073. _createTimeQuery(): WebGLQuery;
  112074. /** @hidden */
  112075. _deleteTimeQuery(query: WebGLQuery): void;
  112076. /** @hidden */
  112077. _getGlAlgorithmType(algorithmType: number): number;
  112078. /** @hidden */
  112079. _getTimeQueryResult(query: WebGLQuery): any;
  112080. /** @hidden */
  112081. _getTimeQueryAvailability(query: WebGLQuery): any;
  112082. }
  112083. interface AbstractMesh {
  112084. /**
  112085. * Backing filed
  112086. * @hidden
  112087. */
  112088. __occlusionDataStorage: _OcclusionDataStorage;
  112089. /**
  112090. * Access property
  112091. * @hidden
  112092. */
  112093. _occlusionDataStorage: _OcclusionDataStorage;
  112094. /**
  112095. * 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.
  112096. * The default value is -1 which means don't break the query and wait till the result
  112097. * @see http://doc.babylonjs.com/features/occlusionquery
  112098. */
  112099. occlusionRetryCount: number;
  112100. /**
  112101. * 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:
  112102. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  112103. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  112104. * * 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.
  112105. * @see http://doc.babylonjs.com/features/occlusionquery
  112106. */
  112107. occlusionType: number;
  112108. /**
  112109. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  112110. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  112111. * * 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.
  112112. * @see http://doc.babylonjs.com/features/occlusionquery
  112113. */
  112114. occlusionQueryAlgorithmType: number;
  112115. /**
  112116. * 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
  112117. * @see http://doc.babylonjs.com/features/occlusionquery
  112118. */
  112119. isOccluded: boolean;
  112120. /**
  112121. * Flag to check the progress status of the query
  112122. * @see http://doc.babylonjs.com/features/occlusionquery
  112123. */
  112124. isOcclusionQueryInProgress: boolean;
  112125. }
  112126. }
  112127. declare module BABYLON {
  112128. /** @hidden */
  112129. export var _forceTransformFeedbackToBundle: boolean;
  112130. interface Engine {
  112131. /**
  112132. * Creates a webGL transform feedback object
  112133. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  112134. * @returns the webGL transform feedback object
  112135. */
  112136. createTransformFeedback(): WebGLTransformFeedback;
  112137. /**
  112138. * Delete a webGL transform feedback object
  112139. * @param value defines the webGL transform feedback object to delete
  112140. */
  112141. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  112142. /**
  112143. * Bind a webGL transform feedback object to the webgl context
  112144. * @param value defines the webGL transform feedback object to bind
  112145. */
  112146. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  112147. /**
  112148. * Begins a transform feedback operation
  112149. * @param usePoints defines if points or triangles must be used
  112150. */
  112151. beginTransformFeedback(usePoints: boolean): void;
  112152. /**
  112153. * Ends a transform feedback operation
  112154. */
  112155. endTransformFeedback(): void;
  112156. /**
  112157. * Specify the varyings to use with transform feedback
  112158. * @param program defines the associated webGL program
  112159. * @param value defines the list of strings representing the varying names
  112160. */
  112161. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  112162. /**
  112163. * Bind a webGL buffer for a transform feedback operation
  112164. * @param value defines the webGL buffer to bind
  112165. */
  112166. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  112167. }
  112168. }
  112169. declare module BABYLON {
  112170. /**
  112171. * Creation options of the multi render target texture.
  112172. */
  112173. export interface IMultiRenderTargetOptions {
  112174. /**
  112175. * Define if the texture needs to create mip maps after render.
  112176. */
  112177. generateMipMaps?: boolean;
  112178. /**
  112179. * Define the types of all the draw buffers we want to create
  112180. */
  112181. types?: number[];
  112182. /**
  112183. * Define the sampling modes of all the draw buffers we want to create
  112184. */
  112185. samplingModes?: number[];
  112186. /**
  112187. * Define if a depth buffer is required
  112188. */
  112189. generateDepthBuffer?: boolean;
  112190. /**
  112191. * Define if a stencil buffer is required
  112192. */
  112193. generateStencilBuffer?: boolean;
  112194. /**
  112195. * Define if a depth texture is required instead of a depth buffer
  112196. */
  112197. generateDepthTexture?: boolean;
  112198. /**
  112199. * Define the number of desired draw buffers
  112200. */
  112201. textureCount?: number;
  112202. /**
  112203. * Define if aspect ratio should be adapted to the texture or stay the scene one
  112204. */
  112205. doNotChangeAspectRatio?: boolean;
  112206. /**
  112207. * Define the default type of the buffers we are creating
  112208. */
  112209. defaultType?: number;
  112210. }
  112211. /**
  112212. * A multi render target, like a render target provides the ability to render to a texture.
  112213. * Unlike the render target, it can render to several draw buffers in one draw.
  112214. * This is specially interesting in deferred rendering or for any effects requiring more than
  112215. * just one color from a single pass.
  112216. */
  112217. export class MultiRenderTarget extends RenderTargetTexture {
  112218. private _internalTextures;
  112219. private _textures;
  112220. private _multiRenderTargetOptions;
  112221. /**
  112222. * Get if draw buffers are currently supported by the used hardware and browser.
  112223. */
  112224. readonly isSupported: boolean;
  112225. /**
  112226. * Get the list of textures generated by the multi render target.
  112227. */
  112228. readonly textures: Texture[];
  112229. /**
  112230. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  112231. */
  112232. readonly depthTexture: Texture;
  112233. /**
  112234. * Set the wrapping mode on U of all the textures we are rendering to.
  112235. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  112236. */
  112237. wrapU: number;
  112238. /**
  112239. * Set the wrapping mode on V of all the textures we are rendering to.
  112240. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  112241. */
  112242. wrapV: number;
  112243. /**
  112244. * Instantiate a new multi render target texture.
  112245. * A multi render target, like a render target provides the ability to render to a texture.
  112246. * Unlike the render target, it can render to several draw buffers in one draw.
  112247. * This is specially interesting in deferred rendering or for any effects requiring more than
  112248. * just one color from a single pass.
  112249. * @param name Define the name of the texture
  112250. * @param size Define the size of the buffers to render to
  112251. * @param count Define the number of target we are rendering into
  112252. * @param scene Define the scene the texture belongs to
  112253. * @param options Define the options used to create the multi render target
  112254. */
  112255. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  112256. /** @hidden */
  112257. _rebuild(): void;
  112258. private _createInternalTextures;
  112259. private _createTextures;
  112260. /**
  112261. * Define the number of samples used if MSAA is enabled.
  112262. */
  112263. samples: number;
  112264. /**
  112265. * Resize all the textures in the multi render target.
  112266. * Be carrefull as it will recreate all the data in the new texture.
  112267. * @param size Define the new size
  112268. */
  112269. resize(size: any): void;
  112270. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  112271. /**
  112272. * Dispose the render targets and their associated resources
  112273. */
  112274. dispose(): void;
  112275. /**
  112276. * Release all the underlying texture used as draw buffers.
  112277. */
  112278. releaseInternalTextures(): void;
  112279. }
  112280. }
  112281. declare module BABYLON {
  112282. interface ThinEngine {
  112283. /**
  112284. * Unbind a list of render target textures from the webGL context
  112285. * This is used only when drawBuffer extension or webGL2 are active
  112286. * @param textures defines the render target textures to unbind
  112287. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  112288. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  112289. */
  112290. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  112291. /**
  112292. * Create a multi render target texture
  112293. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  112294. * @param size defines the size of the texture
  112295. * @param options defines the creation options
  112296. * @returns the cube texture as an InternalTexture
  112297. */
  112298. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  112299. /**
  112300. * Update the sample count for a given multiple render target texture
  112301. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  112302. * @param textures defines the textures to update
  112303. * @param samples defines the sample count to set
  112304. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  112305. */
  112306. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  112307. }
  112308. }
  112309. declare module BABYLON {
  112310. interface Engine {
  112311. /** Gets or sets the list of views */
  112312. views: {
  112313. target: HTMLCanvasElement;
  112314. camera: Camera;
  112315. }[];
  112316. /**
  112317. * Register a new child canvas
  112318. * @param canvas defines the canvas to register
  112319. * @param camera defines the camera to use with this canvas (it will overwrite the scene.camera for this view)
  112320. * @returns the current engine
  112321. */
  112322. registerView(canvas: HTMLCanvasElement, camera: Camera): Engine;
  112323. /**
  112324. * Remove a registered child canvas
  112325. * @param canvas defines the canvas to remove
  112326. * @returns the current engine
  112327. */
  112328. unRegisterView(canvas: HTMLCanvasElement): Engine;
  112329. }
  112330. }
  112331. declare module BABYLON {
  112332. /**
  112333. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  112334. */
  112335. export interface CubeMapInfo {
  112336. /**
  112337. * The pixel array for the front face.
  112338. * This is stored in format, left to right, up to down format.
  112339. */
  112340. front: Nullable<ArrayBufferView>;
  112341. /**
  112342. * The pixel array for the back face.
  112343. * This is stored in format, left to right, up to down format.
  112344. */
  112345. back: Nullable<ArrayBufferView>;
  112346. /**
  112347. * The pixel array for the left face.
  112348. * This is stored in format, left to right, up to down format.
  112349. */
  112350. left: Nullable<ArrayBufferView>;
  112351. /**
  112352. * The pixel array for the right face.
  112353. * This is stored in format, left to right, up to down format.
  112354. */
  112355. right: Nullable<ArrayBufferView>;
  112356. /**
  112357. * The pixel array for the up face.
  112358. * This is stored in format, left to right, up to down format.
  112359. */
  112360. up: Nullable<ArrayBufferView>;
  112361. /**
  112362. * The pixel array for the down face.
  112363. * This is stored in format, left to right, up to down format.
  112364. */
  112365. down: Nullable<ArrayBufferView>;
  112366. /**
  112367. * The size of the cubemap stored.
  112368. *
  112369. * Each faces will be size * size pixels.
  112370. */
  112371. size: number;
  112372. /**
  112373. * The format of the texture.
  112374. *
  112375. * RGBA, RGB.
  112376. */
  112377. format: number;
  112378. /**
  112379. * The type of the texture data.
  112380. *
  112381. * UNSIGNED_INT, FLOAT.
  112382. */
  112383. type: number;
  112384. /**
  112385. * Specifies whether the texture is in gamma space.
  112386. */
  112387. gammaSpace: boolean;
  112388. }
  112389. /**
  112390. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  112391. */
  112392. export class PanoramaToCubeMapTools {
  112393. private static FACE_FRONT;
  112394. private static FACE_BACK;
  112395. private static FACE_RIGHT;
  112396. private static FACE_LEFT;
  112397. private static FACE_DOWN;
  112398. private static FACE_UP;
  112399. /**
  112400. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  112401. *
  112402. * @param float32Array The source data.
  112403. * @param inputWidth The width of the input panorama.
  112404. * @param inputHeight The height of the input panorama.
  112405. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  112406. * @return The cubemap data
  112407. */
  112408. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  112409. private static CreateCubemapTexture;
  112410. private static CalcProjectionSpherical;
  112411. }
  112412. }
  112413. declare module BABYLON {
  112414. /**
  112415. * Helper class dealing with the extraction of spherical polynomial dataArray
  112416. * from a cube map.
  112417. */
  112418. export class CubeMapToSphericalPolynomialTools {
  112419. private static FileFaces;
  112420. /**
  112421. * Converts a texture to the according Spherical Polynomial data.
  112422. * This extracts the first 3 orders only as they are the only one used in the lighting.
  112423. *
  112424. * @param texture The texture to extract the information from.
  112425. * @return The Spherical Polynomial data.
  112426. */
  112427. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  112428. /**
  112429. * Converts a cubemap to the according Spherical Polynomial data.
  112430. * This extracts the first 3 orders only as they are the only one used in the lighting.
  112431. *
  112432. * @param cubeInfo The Cube map to extract the information from.
  112433. * @return The Spherical Polynomial data.
  112434. */
  112435. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  112436. }
  112437. }
  112438. declare module BABYLON {
  112439. interface BaseTexture {
  112440. /**
  112441. * Get the polynomial representation of the texture data.
  112442. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  112443. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  112444. */
  112445. sphericalPolynomial: Nullable<SphericalPolynomial>;
  112446. }
  112447. }
  112448. declare module BABYLON {
  112449. /** @hidden */
  112450. export var rgbdEncodePixelShader: {
  112451. name: string;
  112452. shader: string;
  112453. };
  112454. }
  112455. declare module BABYLON {
  112456. /** @hidden */
  112457. export var rgbdDecodePixelShader: {
  112458. name: string;
  112459. shader: string;
  112460. };
  112461. }
  112462. declare module BABYLON {
  112463. /**
  112464. * Raw texture data and descriptor sufficient for WebGL texture upload
  112465. */
  112466. export interface EnvironmentTextureInfo {
  112467. /**
  112468. * Version of the environment map
  112469. */
  112470. version: number;
  112471. /**
  112472. * Width of image
  112473. */
  112474. width: number;
  112475. /**
  112476. * Irradiance information stored in the file.
  112477. */
  112478. irradiance: any;
  112479. /**
  112480. * Specular information stored in the file.
  112481. */
  112482. specular: any;
  112483. }
  112484. /**
  112485. * Defines One Image in the file. It requires only the position in the file
  112486. * as well as the length.
  112487. */
  112488. interface BufferImageData {
  112489. /**
  112490. * Length of the image data.
  112491. */
  112492. length: number;
  112493. /**
  112494. * Position of the data from the null terminator delimiting the end of the JSON.
  112495. */
  112496. position: number;
  112497. }
  112498. /**
  112499. * Defines the specular data enclosed in the file.
  112500. * This corresponds to the version 1 of the data.
  112501. */
  112502. export interface EnvironmentTextureSpecularInfoV1 {
  112503. /**
  112504. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  112505. */
  112506. specularDataPosition?: number;
  112507. /**
  112508. * This contains all the images data needed to reconstruct the cubemap.
  112509. */
  112510. mipmaps: Array<BufferImageData>;
  112511. /**
  112512. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  112513. */
  112514. lodGenerationScale: number;
  112515. }
  112516. /**
  112517. * Sets of helpers addressing the serialization and deserialization of environment texture
  112518. * stored in a BabylonJS env file.
  112519. * Those files are usually stored as .env files.
  112520. */
  112521. export class EnvironmentTextureTools {
  112522. /**
  112523. * Magic number identifying the env file.
  112524. */
  112525. private static _MagicBytes;
  112526. /**
  112527. * Gets the environment info from an env file.
  112528. * @param data The array buffer containing the .env bytes.
  112529. * @returns the environment file info (the json header) if successfully parsed.
  112530. */
  112531. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  112532. /**
  112533. * Creates an environment texture from a loaded cube texture.
  112534. * @param texture defines the cube texture to convert in env file
  112535. * @return a promise containing the environment data if succesfull.
  112536. */
  112537. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  112538. /**
  112539. * Creates a JSON representation of the spherical data.
  112540. * @param texture defines the texture containing the polynomials
  112541. * @return the JSON representation of the spherical info
  112542. */
  112543. private static _CreateEnvTextureIrradiance;
  112544. /**
  112545. * Creates the ArrayBufferViews used for initializing environment texture image data.
  112546. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  112547. * @param info parameters that determine what views will be created for accessing the underlying buffer
  112548. * @return the views described by info providing access to the underlying buffer
  112549. */
  112550. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  112551. /**
  112552. * Uploads the texture info contained in the env file to the GPU.
  112553. * @param texture defines the internal texture to upload to
  112554. * @param arrayBuffer defines the buffer cotaining the data to load
  112555. * @param info defines the texture info retrieved through the GetEnvInfo method
  112556. * @returns a promise
  112557. */
  112558. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  112559. private static _OnImageReadyAsync;
  112560. /**
  112561. * Uploads the levels of image data to the GPU.
  112562. * @param texture defines the internal texture to upload to
  112563. * @param imageData defines the array buffer views of image data [mipmap][face]
  112564. * @returns a promise
  112565. */
  112566. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  112567. /**
  112568. * Uploads spherical polynomials information to the texture.
  112569. * @param texture defines the texture we are trying to upload the information to
  112570. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  112571. */
  112572. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  112573. /** @hidden */
  112574. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  112575. }
  112576. }
  112577. declare module BABYLON {
  112578. /**
  112579. * Contains position and normal vectors for a vertex
  112580. */
  112581. export class PositionNormalVertex {
  112582. /** the position of the vertex (defaut: 0,0,0) */
  112583. position: Vector3;
  112584. /** the normal of the vertex (defaut: 0,1,0) */
  112585. normal: Vector3;
  112586. /**
  112587. * Creates a PositionNormalVertex
  112588. * @param position the position of the vertex (defaut: 0,0,0)
  112589. * @param normal the normal of the vertex (defaut: 0,1,0)
  112590. */
  112591. constructor(
  112592. /** the position of the vertex (defaut: 0,0,0) */
  112593. position?: Vector3,
  112594. /** the normal of the vertex (defaut: 0,1,0) */
  112595. normal?: Vector3);
  112596. /**
  112597. * Clones the PositionNormalVertex
  112598. * @returns the cloned PositionNormalVertex
  112599. */
  112600. clone(): PositionNormalVertex;
  112601. }
  112602. /**
  112603. * Contains position, normal and uv vectors for a vertex
  112604. */
  112605. export class PositionNormalTextureVertex {
  112606. /** the position of the vertex (defaut: 0,0,0) */
  112607. position: Vector3;
  112608. /** the normal of the vertex (defaut: 0,1,0) */
  112609. normal: Vector3;
  112610. /** the uv of the vertex (default: 0,0) */
  112611. uv: Vector2;
  112612. /**
  112613. * Creates a PositionNormalTextureVertex
  112614. * @param position the position of the vertex (defaut: 0,0,0)
  112615. * @param normal the normal of the vertex (defaut: 0,1,0)
  112616. * @param uv the uv of the vertex (default: 0,0)
  112617. */
  112618. constructor(
  112619. /** the position of the vertex (defaut: 0,0,0) */
  112620. position?: Vector3,
  112621. /** the normal of the vertex (defaut: 0,1,0) */
  112622. normal?: Vector3,
  112623. /** the uv of the vertex (default: 0,0) */
  112624. uv?: Vector2);
  112625. /**
  112626. * Clones the PositionNormalTextureVertex
  112627. * @returns the cloned PositionNormalTextureVertex
  112628. */
  112629. clone(): PositionNormalTextureVertex;
  112630. }
  112631. }
  112632. declare module BABYLON {
  112633. /** @hidden */
  112634. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  112635. private _genericAttributeLocation;
  112636. private _varyingLocationCount;
  112637. private _varyingLocationMap;
  112638. private _replacements;
  112639. private _textureCount;
  112640. private _uniforms;
  112641. lineProcessor(line: string): string;
  112642. attributeProcessor(attribute: string): string;
  112643. varyingProcessor(varying: string, isFragment: boolean): string;
  112644. uniformProcessor(uniform: string): string;
  112645. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  112646. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  112647. }
  112648. }
  112649. declare module BABYLON {
  112650. /**
  112651. * Container for accessors for natively-stored mesh data buffers.
  112652. */
  112653. class NativeDataBuffer extends DataBuffer {
  112654. /**
  112655. * Accessor value used to identify/retrieve a natively-stored index buffer.
  112656. */
  112657. nativeIndexBuffer?: any;
  112658. /**
  112659. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  112660. */
  112661. nativeVertexBuffer?: any;
  112662. }
  112663. /** @hidden */
  112664. class NativeTexture extends InternalTexture {
  112665. getInternalTexture(): InternalTexture;
  112666. getViewCount(): number;
  112667. }
  112668. /** @hidden */
  112669. export class NativeEngine extends Engine {
  112670. private readonly _native;
  112671. getHardwareScalingLevel(): number;
  112672. constructor();
  112673. /**
  112674. * Can be used to override the current requestAnimationFrame requester.
  112675. * @hidden
  112676. */
  112677. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  112678. /**
  112679. * Override default engine behavior.
  112680. * @param color
  112681. * @param backBuffer
  112682. * @param depth
  112683. * @param stencil
  112684. */
  112685. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  112686. clear(color: Color4, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  112687. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  112688. createVertexBuffer(data: DataArray): NativeDataBuffer;
  112689. recordVertexArrayObject(vertexBuffers: {
  112690. [key: string]: VertexBuffer;
  112691. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  112692. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  112693. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  112694. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  112695. /**
  112696. * Draw a list of indexed primitives
  112697. * @param fillMode defines the primitive to use
  112698. * @param indexStart defines the starting index
  112699. * @param indexCount defines the number of index to draw
  112700. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112701. */
  112702. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  112703. /**
  112704. * Draw a list of unindexed primitives
  112705. * @param fillMode defines the primitive to use
  112706. * @param verticesStart defines the index of first vertex to draw
  112707. * @param verticesCount defines the count of vertices to draw
  112708. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112709. */
  112710. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  112711. createPipelineContext(): IPipelineContext;
  112712. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  112713. /** @hidden */
  112714. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  112715. /** @hidden */
  112716. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  112717. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  112718. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  112719. protected _setProgram(program: WebGLProgram): void;
  112720. _releaseEffect(effect: Effect): void;
  112721. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  112722. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  112723. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  112724. bindSamplers(effect: Effect): void;
  112725. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  112726. getRenderWidth(useScreen?: boolean): number;
  112727. getRenderHeight(useScreen?: boolean): number;
  112728. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  112729. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  112730. /**
  112731. * Set the z offset to apply to current rendering
  112732. * @param value defines the offset to apply
  112733. */
  112734. setZOffset(value: number): void;
  112735. /**
  112736. * Gets the current value of the zOffset
  112737. * @returns the current zOffset state
  112738. */
  112739. getZOffset(): number;
  112740. /**
  112741. * Enable or disable depth buffering
  112742. * @param enable defines the state to set
  112743. */
  112744. setDepthBuffer(enable: boolean): void;
  112745. /**
  112746. * Gets a boolean indicating if depth writing is enabled
  112747. * @returns the current depth writing state
  112748. */
  112749. getDepthWrite(): boolean;
  112750. /**
  112751. * Enable or disable depth writing
  112752. * @param enable defines the state to set
  112753. */
  112754. setDepthWrite(enable: boolean): void;
  112755. /**
  112756. * Enable or disable color writing
  112757. * @param enable defines the state to set
  112758. */
  112759. setColorWrite(enable: boolean): void;
  112760. /**
  112761. * Gets a boolean indicating if color writing is enabled
  112762. * @returns the current color writing state
  112763. */
  112764. getColorWrite(): boolean;
  112765. /**
  112766. * Sets alpha constants used by some alpha blending modes
  112767. * @param r defines the red component
  112768. * @param g defines the green component
  112769. * @param b defines the blue component
  112770. * @param a defines the alpha component
  112771. */
  112772. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  112773. /**
  112774. * Sets the current alpha mode
  112775. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  112776. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  112777. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  112778. */
  112779. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  112780. /**
  112781. * Gets the current alpha mode
  112782. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  112783. * @returns the current alpha mode
  112784. */
  112785. getAlphaMode(): number;
  112786. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  112787. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  112788. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  112789. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  112790. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  112791. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  112792. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  112793. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  112794. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  112795. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  112796. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  112797. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  112798. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  112799. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  112800. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  112801. setFloat(uniform: WebGLUniformLocation, value: number): void;
  112802. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  112803. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  112804. setBool(uniform: WebGLUniformLocation, bool: number): void;
  112805. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  112806. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  112807. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  112808. wipeCaches(bruteForce?: boolean): void;
  112809. _createTexture(): WebGLTexture;
  112810. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  112811. /**
  112812. * Usually called from BABYLON.Texture.ts.
  112813. * Passed information to create a WebGLTexture
  112814. * @param urlArg defines a value which contains one of the following:
  112815. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  112816. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  112817. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  112818. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  112819. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  112820. * @param scene needed for loading to the correct scene
  112821. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  112822. * @param onLoad optional callback to be called upon successful completion
  112823. * @param onError optional callback to be called upon failure
  112824. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  112825. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  112826. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  112827. * @param forcedExtension defines the extension to use to pick the right loader
  112828. * @returns a InternalTexture for assignment back into BABYLON.Texture
  112829. */
  112830. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<Scene>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>): InternalTexture;
  112831. /**
  112832. * Creates a cube texture
  112833. * @param rootUrl defines the url where the files to load is located
  112834. * @param scene defines the current scene
  112835. * @param files defines the list of files to load (1 per face)
  112836. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  112837. * @param onLoad defines an optional callback raised when the texture is loaded
  112838. * @param onError defines an optional callback raised if there is an issue to load the texture
  112839. * @param format defines the format of the data
  112840. * @param forcedExtension defines the extension to use to pick the right loader
  112841. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  112842. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  112843. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  112844. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  112845. * @returns the cube texture as an InternalTexture
  112846. */
  112847. 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;
  112848. private _getSamplingFilter;
  112849. private static _GetNativeTextureFormat;
  112850. createRenderTargetTexture(size: number | {
  112851. width: number;
  112852. height: number;
  112853. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  112854. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  112855. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  112856. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  112857. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  112858. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  112859. /**
  112860. * Updates a dynamic vertex buffer.
  112861. * @param vertexBuffer the vertex buffer to update
  112862. * @param data the data used to update the vertex buffer
  112863. * @param byteOffset the byte offset of the data (optional)
  112864. * @param byteLength the byte length of the data (optional)
  112865. */
  112866. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  112867. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  112868. private _updateAnisotropicLevel;
  112869. private _getAddressMode;
  112870. /** @hidden */
  112871. _bindTexture(channel: number, texture: InternalTexture): void;
  112872. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  112873. releaseEffects(): void;
  112874. /** @hidden */
  112875. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112876. /** @hidden */
  112877. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112878. /** @hidden */
  112879. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112880. /** @hidden */
  112881. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  112882. }
  112883. }
  112884. declare module BABYLON {
  112885. /**
  112886. * Gather the list of clipboard event types as constants.
  112887. */
  112888. export class ClipboardEventTypes {
  112889. /**
  112890. * The clipboard event is fired when a copy command is active (pressed).
  112891. */
  112892. static readonly COPY: number;
  112893. /**
  112894. * The clipboard event is fired when a cut command is active (pressed).
  112895. */
  112896. static readonly CUT: number;
  112897. /**
  112898. * The clipboard event is fired when a paste command is active (pressed).
  112899. */
  112900. static readonly PASTE: number;
  112901. }
  112902. /**
  112903. * This class is used to store clipboard related info for the onClipboardObservable event.
  112904. */
  112905. export class ClipboardInfo {
  112906. /**
  112907. * Defines the type of event (BABYLON.ClipboardEventTypes)
  112908. */
  112909. type: number;
  112910. /**
  112911. * Defines the related dom event
  112912. */
  112913. event: ClipboardEvent;
  112914. /**
  112915. *Creates an instance of ClipboardInfo.
  112916. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  112917. * @param event Defines the related dom event
  112918. */
  112919. constructor(
  112920. /**
  112921. * Defines the type of event (BABYLON.ClipboardEventTypes)
  112922. */
  112923. type: number,
  112924. /**
  112925. * Defines the related dom event
  112926. */
  112927. event: ClipboardEvent);
  112928. /**
  112929. * Get the clipboard event's type from the keycode.
  112930. * @param keyCode Defines the keyCode for the current keyboard event.
  112931. * @return {number}
  112932. */
  112933. static GetTypeFromCharacter(keyCode: number): number;
  112934. }
  112935. }
  112936. declare module BABYLON {
  112937. /**
  112938. * Google Daydream controller
  112939. */
  112940. export class DaydreamController extends WebVRController {
  112941. /**
  112942. * Base Url for the controller model.
  112943. */
  112944. static MODEL_BASE_URL: string;
  112945. /**
  112946. * File name for the controller model.
  112947. */
  112948. static MODEL_FILENAME: string;
  112949. /**
  112950. * Gamepad Id prefix used to identify Daydream Controller.
  112951. */
  112952. static readonly GAMEPAD_ID_PREFIX: string;
  112953. /**
  112954. * Creates a new DaydreamController from a gamepad
  112955. * @param vrGamepad the gamepad that the controller should be created from
  112956. */
  112957. constructor(vrGamepad: any);
  112958. /**
  112959. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  112960. * @param scene scene in which to add meshes
  112961. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  112962. */
  112963. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  112964. /**
  112965. * Called once for each button that changed state since the last frame
  112966. * @param buttonIdx Which button index changed
  112967. * @param state New state of the button
  112968. * @param changes Which properties on the state changed since last frame
  112969. */
  112970. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  112971. }
  112972. }
  112973. declare module BABYLON {
  112974. /**
  112975. * Gear VR Controller
  112976. */
  112977. export class GearVRController extends WebVRController {
  112978. /**
  112979. * Base Url for the controller model.
  112980. */
  112981. static MODEL_BASE_URL: string;
  112982. /**
  112983. * File name for the controller model.
  112984. */
  112985. static MODEL_FILENAME: string;
  112986. /**
  112987. * Gamepad Id prefix used to identify this controller.
  112988. */
  112989. static readonly GAMEPAD_ID_PREFIX: string;
  112990. private readonly _buttonIndexToObservableNameMap;
  112991. /**
  112992. * Creates a new GearVRController from a gamepad
  112993. * @param vrGamepad the gamepad that the controller should be created from
  112994. */
  112995. constructor(vrGamepad: any);
  112996. /**
  112997. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  112998. * @param scene scene in which to add meshes
  112999. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  113000. */
  113001. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  113002. /**
  113003. * Called once for each button that changed state since the last frame
  113004. * @param buttonIdx Which button index changed
  113005. * @param state New state of the button
  113006. * @param changes Which properties on the state changed since last frame
  113007. */
  113008. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  113009. }
  113010. }
  113011. declare module BABYLON {
  113012. /**
  113013. * Class containing static functions to help procedurally build meshes
  113014. */
  113015. export class PolyhedronBuilder {
  113016. /**
  113017. * Creates a polyhedron mesh
  113018. * * 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
  113019. * * The parameter `size` (positive float, default 1) sets the polygon size
  113020. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  113021. * * 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`
  113022. * * 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
  113023. * * 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)`)
  113024. * * 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
  113025. * * 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
  113026. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  113027. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  113028. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  113029. * @param name defines the name of the mesh
  113030. * @param options defines the options used to create the mesh
  113031. * @param scene defines the hosting scene
  113032. * @returns the polyhedron mesh
  113033. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  113034. */
  113035. static CreatePolyhedron(name: string, options: {
  113036. type?: number;
  113037. size?: number;
  113038. sizeX?: number;
  113039. sizeY?: number;
  113040. sizeZ?: number;
  113041. custom?: any;
  113042. faceUV?: Vector4[];
  113043. faceColors?: Color4[];
  113044. flat?: boolean;
  113045. updatable?: boolean;
  113046. sideOrientation?: number;
  113047. frontUVs?: Vector4;
  113048. backUVs?: Vector4;
  113049. }, scene?: Nullable<Scene>): Mesh;
  113050. }
  113051. }
  113052. declare module BABYLON {
  113053. /**
  113054. * Gizmo that enables scaling a mesh along 3 axis
  113055. */
  113056. export class ScaleGizmo extends Gizmo {
  113057. /**
  113058. * Internal gizmo used for interactions on the x axis
  113059. */
  113060. xGizmo: AxisScaleGizmo;
  113061. /**
  113062. * Internal gizmo used for interactions on the y axis
  113063. */
  113064. yGizmo: AxisScaleGizmo;
  113065. /**
  113066. * Internal gizmo used for interactions on the z axis
  113067. */
  113068. zGizmo: AxisScaleGizmo;
  113069. /**
  113070. * Internal gizmo used to scale all axis equally
  113071. */
  113072. uniformScaleGizmo: AxisScaleGizmo;
  113073. private _meshAttached;
  113074. private _updateGizmoRotationToMatchAttachedMesh;
  113075. private _snapDistance;
  113076. private _scaleRatio;
  113077. private _uniformScalingMesh;
  113078. private _octahedron;
  113079. /** Fires an event when any of it's sub gizmos are dragged */
  113080. onDragStartObservable: Observable<unknown>;
  113081. /** Fires an event when any of it's sub gizmos are released from dragging */
  113082. onDragEndObservable: Observable<unknown>;
  113083. attachedMesh: Nullable<AbstractMesh>;
  113084. /**
  113085. * Creates a ScaleGizmo
  113086. * @param gizmoLayer The utility layer the gizmo will be added to
  113087. */
  113088. constructor(gizmoLayer?: UtilityLayerRenderer);
  113089. updateGizmoRotationToMatchAttachedMesh: boolean;
  113090. /**
  113091. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  113092. */
  113093. snapDistance: number;
  113094. /**
  113095. * Ratio for the scale of the gizmo (Default: 1)
  113096. */
  113097. scaleRatio: number;
  113098. /**
  113099. * Disposes of the gizmo
  113100. */
  113101. dispose(): void;
  113102. }
  113103. }
  113104. declare module BABYLON {
  113105. /**
  113106. * Single axis scale gizmo
  113107. */
  113108. export class AxisScaleGizmo extends Gizmo {
  113109. /**
  113110. * Drag behavior responsible for the gizmos dragging interactions
  113111. */
  113112. dragBehavior: PointerDragBehavior;
  113113. private _pointerObserver;
  113114. /**
  113115. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  113116. */
  113117. snapDistance: number;
  113118. /**
  113119. * Event that fires each time the gizmo snaps to a new location.
  113120. * * snapDistance is the the change in distance
  113121. */
  113122. onSnapObservable: Observable<{
  113123. snapDistance: number;
  113124. }>;
  113125. /**
  113126. * If the scaling operation should be done on all axis (default: false)
  113127. */
  113128. uniformScaling: boolean;
  113129. private _isEnabled;
  113130. private _parent;
  113131. private _arrow;
  113132. private _coloredMaterial;
  113133. private _hoverMaterial;
  113134. /**
  113135. * Creates an AxisScaleGizmo
  113136. * @param gizmoLayer The utility layer the gizmo will be added to
  113137. * @param dragAxis The axis which the gizmo will be able to scale on
  113138. * @param color The color of the gizmo
  113139. */
  113140. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  113141. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  113142. /**
  113143. * If the gizmo is enabled
  113144. */
  113145. isEnabled: boolean;
  113146. /**
  113147. * Disposes of the gizmo
  113148. */
  113149. dispose(): void;
  113150. /**
  113151. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  113152. * @param mesh The mesh to replace the default mesh of the gizmo
  113153. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  113154. */
  113155. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  113156. }
  113157. }
  113158. declare module BABYLON {
  113159. /**
  113160. * Bounding box gizmo
  113161. */
  113162. export class BoundingBoxGizmo extends Gizmo {
  113163. private _lineBoundingBox;
  113164. private _rotateSpheresParent;
  113165. private _scaleBoxesParent;
  113166. private _boundingDimensions;
  113167. private _renderObserver;
  113168. private _pointerObserver;
  113169. private _scaleDragSpeed;
  113170. private _tmpQuaternion;
  113171. private _tmpVector;
  113172. private _tmpRotationMatrix;
  113173. /**
  113174. * 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)
  113175. */
  113176. ignoreChildren: boolean;
  113177. /**
  113178. * 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)
  113179. */
  113180. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  113181. /**
  113182. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  113183. */
  113184. rotationSphereSize: number;
  113185. /**
  113186. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  113187. */
  113188. scaleBoxSize: number;
  113189. /**
  113190. * 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)
  113191. */
  113192. fixedDragMeshScreenSize: boolean;
  113193. /**
  113194. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  113195. */
  113196. fixedDragMeshScreenSizeDistanceFactor: number;
  113197. /**
  113198. * Fired when a rotation sphere or scale box is dragged
  113199. */
  113200. onDragStartObservable: Observable<{}>;
  113201. /**
  113202. * Fired when a scale box is dragged
  113203. */
  113204. onScaleBoxDragObservable: Observable<{}>;
  113205. /**
  113206. * Fired when a scale box drag is ended
  113207. */
  113208. onScaleBoxDragEndObservable: Observable<{}>;
  113209. /**
  113210. * Fired when a rotation sphere is dragged
  113211. */
  113212. onRotationSphereDragObservable: Observable<{}>;
  113213. /**
  113214. * Fired when a rotation sphere drag is ended
  113215. */
  113216. onRotationSphereDragEndObservable: Observable<{}>;
  113217. /**
  113218. * Relative bounding box pivot used when scaling the attached mesh. 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)
  113219. */
  113220. scalePivot: Nullable<Vector3>;
  113221. /**
  113222. * Mesh used as a pivot to rotate the attached mesh
  113223. */
  113224. private _anchorMesh;
  113225. private _existingMeshScale;
  113226. private _dragMesh;
  113227. private pointerDragBehavior;
  113228. private coloredMaterial;
  113229. private hoverColoredMaterial;
  113230. /**
  113231. * Sets the color of the bounding box gizmo
  113232. * @param color the color to set
  113233. */
  113234. setColor(color: Color3): void;
  113235. /**
  113236. * Creates an BoundingBoxGizmo
  113237. * @param gizmoLayer The utility layer the gizmo will be added to
  113238. * @param color The color of the gizmo
  113239. */
  113240. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  113241. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  113242. private _selectNode;
  113243. /**
  113244. * Updates the bounding box information for the Gizmo
  113245. */
  113246. updateBoundingBox(): void;
  113247. private _updateRotationSpheres;
  113248. private _updateScaleBoxes;
  113249. /**
  113250. * Enables rotation on the specified axis and disables rotation on the others
  113251. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  113252. */
  113253. setEnabledRotationAxis(axis: string): void;
  113254. /**
  113255. * Enables/disables scaling
  113256. * @param enable if scaling should be enabled
  113257. */
  113258. setEnabledScaling(enable: boolean): void;
  113259. private _updateDummy;
  113260. /**
  113261. * Enables a pointer drag behavior on the bounding box of the gizmo
  113262. */
  113263. enableDragBehavior(): void;
  113264. /**
  113265. * Disposes of the gizmo
  113266. */
  113267. dispose(): void;
  113268. /**
  113269. * 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)
  113270. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  113271. * @returns the bounding box mesh with the passed in mesh as a child
  113272. */
  113273. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  113274. /**
  113275. * CustomMeshes are not supported by this gizmo
  113276. * @param mesh The mesh to replace the default mesh of the gizmo
  113277. */
  113278. setCustomMesh(mesh: Mesh): void;
  113279. }
  113280. }
  113281. declare module BABYLON {
  113282. /**
  113283. * Single plane rotation gizmo
  113284. */
  113285. export class PlaneRotationGizmo extends Gizmo {
  113286. /**
  113287. * Drag behavior responsible for the gizmos dragging interactions
  113288. */
  113289. dragBehavior: PointerDragBehavior;
  113290. private _pointerObserver;
  113291. /**
  113292. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  113293. */
  113294. snapDistance: number;
  113295. /**
  113296. * Event that fires each time the gizmo snaps to a new location.
  113297. * * snapDistance is the the change in distance
  113298. */
  113299. onSnapObservable: Observable<{
  113300. snapDistance: number;
  113301. }>;
  113302. private _isEnabled;
  113303. private _parent;
  113304. /**
  113305. * Creates a PlaneRotationGizmo
  113306. * @param gizmoLayer The utility layer the gizmo will be added to
  113307. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  113308. * @param color The color of the gizmo
  113309. * @param tessellation Amount of tessellation to be used when creating rotation circles
  113310. * @param useEulerRotation Use and update Euler angle instead of quaternion
  113311. */
  113312. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  113313. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  113314. /**
  113315. * If the gizmo is enabled
  113316. */
  113317. isEnabled: boolean;
  113318. /**
  113319. * Disposes of the gizmo
  113320. */
  113321. dispose(): void;
  113322. }
  113323. }
  113324. declare module BABYLON {
  113325. /**
  113326. * Gizmo that enables rotating a mesh along 3 axis
  113327. */
  113328. export class RotationGizmo extends Gizmo {
  113329. /**
  113330. * Internal gizmo used for interactions on the x axis
  113331. */
  113332. xGizmo: PlaneRotationGizmo;
  113333. /**
  113334. * Internal gizmo used for interactions on the y axis
  113335. */
  113336. yGizmo: PlaneRotationGizmo;
  113337. /**
  113338. * Internal gizmo used for interactions on the z axis
  113339. */
  113340. zGizmo: PlaneRotationGizmo;
  113341. /** Fires an event when any of it's sub gizmos are dragged */
  113342. onDragStartObservable: Observable<unknown>;
  113343. /** Fires an event when any of it's sub gizmos are released from dragging */
  113344. onDragEndObservable: Observable<unknown>;
  113345. private _meshAttached;
  113346. attachedMesh: Nullable<AbstractMesh>;
  113347. /**
  113348. * Creates a RotationGizmo
  113349. * @param gizmoLayer The utility layer the gizmo will be added to
  113350. * @param tessellation Amount of tessellation to be used when creating rotation circles
  113351. * @param useEulerRotation Use and update Euler angle instead of quaternion
  113352. */
  113353. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  113354. updateGizmoRotationToMatchAttachedMesh: boolean;
  113355. /**
  113356. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  113357. */
  113358. snapDistance: number;
  113359. /**
  113360. * Ratio for the scale of the gizmo (Default: 1)
  113361. */
  113362. scaleRatio: number;
  113363. /**
  113364. * Disposes of the gizmo
  113365. */
  113366. dispose(): void;
  113367. /**
  113368. * CustomMeshes are not supported by this gizmo
  113369. * @param mesh The mesh to replace the default mesh of the gizmo
  113370. */
  113371. setCustomMesh(mesh: Mesh): void;
  113372. }
  113373. }
  113374. declare module BABYLON {
  113375. /**
  113376. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  113377. */
  113378. export class GizmoManager implements IDisposable {
  113379. private scene;
  113380. /**
  113381. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  113382. */
  113383. gizmos: {
  113384. positionGizmo: Nullable<PositionGizmo>;
  113385. rotationGizmo: Nullable<RotationGizmo>;
  113386. scaleGizmo: Nullable<ScaleGizmo>;
  113387. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  113388. };
  113389. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  113390. clearGizmoOnEmptyPointerEvent: boolean;
  113391. /** Fires an event when the manager is attached to a mesh */
  113392. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  113393. private _gizmosEnabled;
  113394. private _pointerObserver;
  113395. private _attachedMesh;
  113396. private _boundingBoxColor;
  113397. private _defaultUtilityLayer;
  113398. private _defaultKeepDepthUtilityLayer;
  113399. /**
  113400. * When bounding box gizmo is enabled, this can be used to track drag/end events
  113401. */
  113402. boundingBoxDragBehavior: SixDofDragBehavior;
  113403. /**
  113404. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  113405. */
  113406. attachableMeshes: Nullable<Array<AbstractMesh>>;
  113407. /**
  113408. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  113409. */
  113410. usePointerToAttachGizmos: boolean;
  113411. /**
  113412. * Utility layer that the bounding box gizmo belongs to
  113413. */
  113414. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  113415. /**
  113416. * Utility layer that all gizmos besides bounding box belong to
  113417. */
  113418. readonly utilityLayer: UtilityLayerRenderer;
  113419. /**
  113420. * Instatiates a gizmo manager
  113421. * @param scene the scene to overlay the gizmos on top of
  113422. */
  113423. constructor(scene: Scene);
  113424. /**
  113425. * Attaches a set of gizmos to the specified mesh
  113426. * @param mesh The mesh the gizmo's should be attached to
  113427. */
  113428. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  113429. /**
  113430. * If the position gizmo is enabled
  113431. */
  113432. positionGizmoEnabled: boolean;
  113433. /**
  113434. * If the rotation gizmo is enabled
  113435. */
  113436. rotationGizmoEnabled: boolean;
  113437. /**
  113438. * If the scale gizmo is enabled
  113439. */
  113440. scaleGizmoEnabled: boolean;
  113441. /**
  113442. * If the boundingBox gizmo is enabled
  113443. */
  113444. boundingBoxGizmoEnabled: boolean;
  113445. /**
  113446. * Disposes of the gizmo manager
  113447. */
  113448. dispose(): void;
  113449. }
  113450. }
  113451. declare module BABYLON {
  113452. /**
  113453. * A directional light is defined by a direction (what a surprise!).
  113454. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  113455. * 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.
  113456. * Documentation: https://doc.babylonjs.com/babylon101/lights
  113457. */
  113458. export class DirectionalLight extends ShadowLight {
  113459. private _shadowFrustumSize;
  113460. /**
  113461. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  113462. */
  113463. /**
  113464. * Specifies a fix frustum size for the shadow generation.
  113465. */
  113466. shadowFrustumSize: number;
  113467. private _shadowOrthoScale;
  113468. /**
  113469. * Gets the shadow projection scale against the optimal computed one.
  113470. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  113471. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  113472. */
  113473. /**
  113474. * Sets the shadow projection scale against the optimal computed one.
  113475. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  113476. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  113477. */
  113478. shadowOrthoScale: number;
  113479. /**
  113480. * Automatically compute the projection matrix to best fit (including all the casters)
  113481. * on each frame.
  113482. */
  113483. autoUpdateExtends: boolean;
  113484. private _orthoLeft;
  113485. private _orthoRight;
  113486. private _orthoTop;
  113487. private _orthoBottom;
  113488. /**
  113489. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  113490. * The directional light is emitted from everywhere in the given direction.
  113491. * It can cast shadows.
  113492. * Documentation : https://doc.babylonjs.com/babylon101/lights
  113493. * @param name The friendly name of the light
  113494. * @param direction The direction of the light
  113495. * @param scene The scene the light belongs to
  113496. */
  113497. constructor(name: string, direction: Vector3, scene: Scene);
  113498. /**
  113499. * Returns the string "DirectionalLight".
  113500. * @return The class name
  113501. */
  113502. getClassName(): string;
  113503. /**
  113504. * Returns the integer 1.
  113505. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  113506. */
  113507. getTypeID(): number;
  113508. /**
  113509. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  113510. * Returns the DirectionalLight Shadow projection matrix.
  113511. */
  113512. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  113513. /**
  113514. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  113515. * Returns the DirectionalLight Shadow projection matrix.
  113516. */
  113517. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  113518. /**
  113519. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  113520. * Returns the DirectionalLight Shadow projection matrix.
  113521. */
  113522. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  113523. protected _buildUniformLayout(): void;
  113524. /**
  113525. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  113526. * @param effect The effect to update
  113527. * @param lightIndex The index of the light in the effect to update
  113528. * @returns The directional light
  113529. */
  113530. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  113531. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  113532. /**
  113533. * Gets the minZ used for shadow according to both the scene and the light.
  113534. *
  113535. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  113536. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  113537. * @param activeCamera The camera we are returning the min for
  113538. * @returns the depth min z
  113539. */
  113540. getDepthMinZ(activeCamera: Camera): number;
  113541. /**
  113542. * Gets the maxZ used for shadow according to both the scene and the light.
  113543. *
  113544. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  113545. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  113546. * @param activeCamera The camera we are returning the max for
  113547. * @returns the depth max z
  113548. */
  113549. getDepthMaxZ(activeCamera: Camera): number;
  113550. /**
  113551. * Prepares the list of defines specific to the light type.
  113552. * @param defines the list of defines
  113553. * @param lightIndex defines the index of the light for the effect
  113554. */
  113555. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  113556. }
  113557. }
  113558. declare module BABYLON {
  113559. /**
  113560. * Class containing static functions to help procedurally build meshes
  113561. */
  113562. export class HemisphereBuilder {
  113563. /**
  113564. * Creates a hemisphere mesh
  113565. * @param name defines the name of the mesh
  113566. * @param options defines the options used to create the mesh
  113567. * @param scene defines the hosting scene
  113568. * @returns the hemisphere mesh
  113569. */
  113570. static CreateHemisphere(name: string, options: {
  113571. segments?: number;
  113572. diameter?: number;
  113573. sideOrientation?: number;
  113574. }, scene: any): Mesh;
  113575. }
  113576. }
  113577. declare module BABYLON {
  113578. /**
  113579. * A spot light is defined by a position, a direction, an angle, and an exponent.
  113580. * These values define a cone of light starting from the position, emitting toward the direction.
  113581. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  113582. * and the exponent defines the speed of the decay of the light with distance (reach).
  113583. * Documentation: https://doc.babylonjs.com/babylon101/lights
  113584. */
  113585. export class SpotLight extends ShadowLight {
  113586. private _angle;
  113587. private _innerAngle;
  113588. private _cosHalfAngle;
  113589. private _lightAngleScale;
  113590. private _lightAngleOffset;
  113591. /**
  113592. * Gets the cone angle of the spot light in Radians.
  113593. */
  113594. /**
  113595. * Sets the cone angle of the spot light in Radians.
  113596. */
  113597. angle: number;
  113598. /**
  113599. * Only used in gltf falloff mode, this defines the angle where
  113600. * the directional falloff will start before cutting at angle which could be seen
  113601. * as outer angle.
  113602. */
  113603. /**
  113604. * Only used in gltf falloff mode, this defines the angle where
  113605. * the directional falloff will start before cutting at angle which could be seen
  113606. * as outer angle.
  113607. */
  113608. innerAngle: number;
  113609. private _shadowAngleScale;
  113610. /**
  113611. * Allows scaling the angle of the light for shadow generation only.
  113612. */
  113613. /**
  113614. * Allows scaling the angle of the light for shadow generation only.
  113615. */
  113616. shadowAngleScale: number;
  113617. /**
  113618. * The light decay speed with the distance from the emission spot.
  113619. */
  113620. exponent: number;
  113621. private _projectionTextureMatrix;
  113622. /**
  113623. * Allows reading the projecton texture
  113624. */
  113625. readonly projectionTextureMatrix: Matrix;
  113626. protected _projectionTextureLightNear: number;
  113627. /**
  113628. * Gets the near clip of the Spotlight for texture projection.
  113629. */
  113630. /**
  113631. * Sets the near clip of the Spotlight for texture projection.
  113632. */
  113633. projectionTextureLightNear: number;
  113634. protected _projectionTextureLightFar: number;
  113635. /**
  113636. * Gets the far clip of the Spotlight for texture projection.
  113637. */
  113638. /**
  113639. * Sets the far clip of the Spotlight for texture projection.
  113640. */
  113641. projectionTextureLightFar: number;
  113642. protected _projectionTextureUpDirection: Vector3;
  113643. /**
  113644. * Gets the Up vector of the Spotlight for texture projection.
  113645. */
  113646. /**
  113647. * Sets the Up vector of the Spotlight for texture projection.
  113648. */
  113649. projectionTextureUpDirection: Vector3;
  113650. private _projectionTexture;
  113651. /**
  113652. * Gets the projection texture of the light.
  113653. */
  113654. /**
  113655. * Sets the projection texture of the light.
  113656. */
  113657. projectionTexture: Nullable<BaseTexture>;
  113658. private _projectionTextureViewLightDirty;
  113659. private _projectionTextureProjectionLightDirty;
  113660. private _projectionTextureDirty;
  113661. private _projectionTextureViewTargetVector;
  113662. private _projectionTextureViewLightMatrix;
  113663. private _projectionTextureProjectionLightMatrix;
  113664. private _projectionTextureScalingMatrix;
  113665. /**
  113666. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  113667. * It can cast shadows.
  113668. * Documentation : https://doc.babylonjs.com/babylon101/lights
  113669. * @param name The light friendly name
  113670. * @param position The position of the spot light in the scene
  113671. * @param direction The direction of the light in the scene
  113672. * @param angle The cone angle of the light in Radians
  113673. * @param exponent The light decay speed with the distance from the emission spot
  113674. * @param scene The scene the lights belongs to
  113675. */
  113676. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  113677. /**
  113678. * Returns the string "SpotLight".
  113679. * @returns the class name
  113680. */
  113681. getClassName(): string;
  113682. /**
  113683. * Returns the integer 2.
  113684. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  113685. */
  113686. getTypeID(): number;
  113687. /**
  113688. * Overrides the direction setter to recompute the projection texture view light Matrix.
  113689. */
  113690. protected _setDirection(value: Vector3): void;
  113691. /**
  113692. * Overrides the position setter to recompute the projection texture view light Matrix.
  113693. */
  113694. protected _setPosition(value: Vector3): void;
  113695. /**
  113696. * 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.
  113697. * Returns the SpotLight.
  113698. */
  113699. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  113700. protected _computeProjectionTextureViewLightMatrix(): void;
  113701. protected _computeProjectionTextureProjectionLightMatrix(): void;
  113702. /**
  113703. * Main function for light texture projection matrix computing.
  113704. */
  113705. protected _computeProjectionTextureMatrix(): void;
  113706. protected _buildUniformLayout(): void;
  113707. private _computeAngleValues;
  113708. /**
  113709. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  113710. * @param effect The effect to update
  113711. * @param lightIndex The index of the light in the effect to update
  113712. * @returns The spot light
  113713. */
  113714. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  113715. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  113716. /**
  113717. * Disposes the light and the associated resources.
  113718. */
  113719. dispose(): void;
  113720. /**
  113721. * Prepares the list of defines specific to the light type.
  113722. * @param defines the list of defines
  113723. * @param lightIndex defines the index of the light for the effect
  113724. */
  113725. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  113726. }
  113727. }
  113728. declare module BABYLON {
  113729. /**
  113730. * Gizmo that enables viewing a light
  113731. */
  113732. export class LightGizmo extends Gizmo {
  113733. private _lightMesh;
  113734. private _material;
  113735. private cachedPosition;
  113736. private cachedForward;
  113737. /**
  113738. * Creates a LightGizmo
  113739. * @param gizmoLayer The utility layer the gizmo will be added to
  113740. */
  113741. constructor(gizmoLayer?: UtilityLayerRenderer);
  113742. private _light;
  113743. /**
  113744. * The light that the gizmo is attached to
  113745. */
  113746. light: Nullable<Light>;
  113747. /**
  113748. * Gets the material used to render the light gizmo
  113749. */
  113750. readonly material: StandardMaterial;
  113751. /**
  113752. * @hidden
  113753. * Updates the gizmo to match the attached mesh's position/rotation
  113754. */
  113755. protected _update(): void;
  113756. private static _Scale;
  113757. /**
  113758. * Creates the lines for a light mesh
  113759. */
  113760. private static _createLightLines;
  113761. /**
  113762. * Disposes of the light gizmo
  113763. */
  113764. dispose(): void;
  113765. private static _CreateHemisphericLightMesh;
  113766. private static _CreatePointLightMesh;
  113767. private static _CreateSpotLightMesh;
  113768. private static _CreateDirectionalLightMesh;
  113769. }
  113770. }
  113771. declare module BABYLON {
  113772. /** @hidden */
  113773. export var backgroundFragmentDeclaration: {
  113774. name: string;
  113775. shader: string;
  113776. };
  113777. }
  113778. declare module BABYLON {
  113779. /** @hidden */
  113780. export var backgroundUboDeclaration: {
  113781. name: string;
  113782. shader: string;
  113783. };
  113784. }
  113785. declare module BABYLON {
  113786. /** @hidden */
  113787. export var backgroundPixelShader: {
  113788. name: string;
  113789. shader: string;
  113790. };
  113791. }
  113792. declare module BABYLON {
  113793. /** @hidden */
  113794. export var backgroundVertexDeclaration: {
  113795. name: string;
  113796. shader: string;
  113797. };
  113798. }
  113799. declare module BABYLON {
  113800. /** @hidden */
  113801. export var backgroundVertexShader: {
  113802. name: string;
  113803. shader: string;
  113804. };
  113805. }
  113806. declare module BABYLON {
  113807. /**
  113808. * Background material used to create an efficient environement around your scene.
  113809. */
  113810. export class BackgroundMaterial extends PushMaterial {
  113811. /**
  113812. * Standard reflectance value at parallel view angle.
  113813. */
  113814. static StandardReflectance0: number;
  113815. /**
  113816. * Standard reflectance value at grazing angle.
  113817. */
  113818. static StandardReflectance90: number;
  113819. protected _primaryColor: Color3;
  113820. /**
  113821. * Key light Color (multiply against the environement texture)
  113822. */
  113823. primaryColor: Color3;
  113824. protected __perceptualColor: Nullable<Color3>;
  113825. /**
  113826. * Experimental Internal Use Only.
  113827. *
  113828. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  113829. * This acts as a helper to set the primary color to a more "human friendly" value.
  113830. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  113831. * output color as close as possible from the chosen value.
  113832. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  113833. * part of lighting setup.)
  113834. */
  113835. _perceptualColor: Nullable<Color3>;
  113836. protected _primaryColorShadowLevel: float;
  113837. /**
  113838. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  113839. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  113840. */
  113841. primaryColorShadowLevel: float;
  113842. protected _primaryColorHighlightLevel: float;
  113843. /**
  113844. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  113845. * The primary color is used at the level chosen to define what the white area would look.
  113846. */
  113847. primaryColorHighlightLevel: float;
  113848. protected _reflectionTexture: Nullable<BaseTexture>;
  113849. /**
  113850. * Reflection Texture used in the material.
  113851. * Should be author in a specific way for the best result (refer to the documentation).
  113852. */
  113853. reflectionTexture: Nullable<BaseTexture>;
  113854. protected _reflectionBlur: float;
  113855. /**
  113856. * Reflection Texture level of blur.
  113857. *
  113858. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  113859. * texture twice.
  113860. */
  113861. reflectionBlur: float;
  113862. protected _diffuseTexture: Nullable<BaseTexture>;
  113863. /**
  113864. * Diffuse Texture used in the material.
  113865. * Should be author in a specific way for the best result (refer to the documentation).
  113866. */
  113867. diffuseTexture: Nullable<BaseTexture>;
  113868. protected _shadowLights: Nullable<IShadowLight[]>;
  113869. /**
  113870. * Specify the list of lights casting shadow on the material.
  113871. * All scene shadow lights will be included if null.
  113872. */
  113873. shadowLights: Nullable<IShadowLight[]>;
  113874. protected _shadowLevel: float;
  113875. /**
  113876. * Helps adjusting the shadow to a softer level if required.
  113877. * 0 means black shadows and 1 means no shadows.
  113878. */
  113879. shadowLevel: float;
  113880. protected _sceneCenter: Vector3;
  113881. /**
  113882. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  113883. * It is usually zero but might be interesting to modify according to your setup.
  113884. */
  113885. sceneCenter: Vector3;
  113886. protected _opacityFresnel: boolean;
  113887. /**
  113888. * This helps specifying that the material is falling off to the sky box at grazing angle.
  113889. * This helps ensuring a nice transition when the camera goes under the ground.
  113890. */
  113891. opacityFresnel: boolean;
  113892. protected _reflectionFresnel: boolean;
  113893. /**
  113894. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  113895. * This helps adding a mirror texture on the ground.
  113896. */
  113897. reflectionFresnel: boolean;
  113898. protected _reflectionFalloffDistance: number;
  113899. /**
  113900. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  113901. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  113902. */
  113903. reflectionFalloffDistance: number;
  113904. protected _reflectionAmount: number;
  113905. /**
  113906. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  113907. */
  113908. reflectionAmount: number;
  113909. protected _reflectionReflectance0: number;
  113910. /**
  113911. * This specifies the weight of the reflection at grazing angle.
  113912. */
  113913. reflectionReflectance0: number;
  113914. protected _reflectionReflectance90: number;
  113915. /**
  113916. * This specifies the weight of the reflection at a perpendicular point of view.
  113917. */
  113918. reflectionReflectance90: number;
  113919. /**
  113920. * Sets the reflection reflectance fresnel values according to the default standard
  113921. * empirically know to work well :-)
  113922. */
  113923. reflectionStandardFresnelWeight: number;
  113924. protected _useRGBColor: boolean;
  113925. /**
  113926. * Helps to directly use the maps channels instead of their level.
  113927. */
  113928. useRGBColor: boolean;
  113929. protected _enableNoise: boolean;
  113930. /**
  113931. * This helps reducing the banding effect that could occur on the background.
  113932. */
  113933. enableNoise: boolean;
  113934. /**
  113935. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  113936. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  113937. * Recommended to be keep at 1.0 except for special cases.
  113938. */
  113939. fovMultiplier: number;
  113940. private _fovMultiplier;
  113941. /**
  113942. * Enable the FOV adjustment feature controlled by fovMultiplier.
  113943. */
  113944. useEquirectangularFOV: boolean;
  113945. private _maxSimultaneousLights;
  113946. /**
  113947. * Number of Simultaneous lights allowed on the material.
  113948. */
  113949. maxSimultaneousLights: int;
  113950. /**
  113951. * Default configuration related to image processing available in the Background Material.
  113952. */
  113953. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  113954. /**
  113955. * Keep track of the image processing observer to allow dispose and replace.
  113956. */
  113957. private _imageProcessingObserver;
  113958. /**
  113959. * Attaches a new image processing configuration to the PBR Material.
  113960. * @param configuration (if null the scene configuration will be use)
  113961. */
  113962. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  113963. /**
  113964. * Gets the image processing configuration used either in this material.
  113965. */
  113966. /**
  113967. * Sets the Default image processing configuration used either in the this material.
  113968. *
  113969. * If sets to null, the scene one is in use.
  113970. */
  113971. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  113972. /**
  113973. * Gets wether the color curves effect is enabled.
  113974. */
  113975. /**
  113976. * Sets wether the color curves effect is enabled.
  113977. */
  113978. cameraColorCurvesEnabled: boolean;
  113979. /**
  113980. * Gets wether the color grading effect is enabled.
  113981. */
  113982. /**
  113983. * Gets wether the color grading effect is enabled.
  113984. */
  113985. cameraColorGradingEnabled: boolean;
  113986. /**
  113987. * Gets wether tonemapping is enabled or not.
  113988. */
  113989. /**
  113990. * Sets wether tonemapping is enabled or not
  113991. */
  113992. cameraToneMappingEnabled: boolean;
  113993. /**
  113994. * The camera exposure used on this material.
  113995. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  113996. * This corresponds to a photographic exposure.
  113997. */
  113998. /**
  113999. * The camera exposure used on this material.
  114000. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  114001. * This corresponds to a photographic exposure.
  114002. */
  114003. cameraExposure: float;
  114004. /**
  114005. * Gets The camera contrast used on this material.
  114006. */
  114007. /**
  114008. * Sets The camera contrast used on this material.
  114009. */
  114010. cameraContrast: float;
  114011. /**
  114012. * Gets the Color Grading 2D Lookup Texture.
  114013. */
  114014. /**
  114015. * Sets the Color Grading 2D Lookup Texture.
  114016. */
  114017. cameraColorGradingTexture: Nullable<BaseTexture>;
  114018. /**
  114019. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  114020. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  114021. * 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;
  114022. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  114023. */
  114024. /**
  114025. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  114026. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  114027. * 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;
  114028. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  114029. */
  114030. cameraColorCurves: Nullable<ColorCurves>;
  114031. /**
  114032. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  114033. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  114034. */
  114035. switchToBGR: boolean;
  114036. private _renderTargets;
  114037. private _reflectionControls;
  114038. private _white;
  114039. private _primaryShadowColor;
  114040. private _primaryHighlightColor;
  114041. /**
  114042. * Instantiates a Background Material in the given scene
  114043. * @param name The friendly name of the material
  114044. * @param scene The scene to add the material to
  114045. */
  114046. constructor(name: string, scene: Scene);
  114047. /**
  114048. * Gets a boolean indicating that current material needs to register RTT
  114049. */
  114050. readonly hasRenderTargetTextures: boolean;
  114051. /**
  114052. * The entire material has been created in order to prevent overdraw.
  114053. * @returns false
  114054. */
  114055. needAlphaTesting(): boolean;
  114056. /**
  114057. * The entire material has been created in order to prevent overdraw.
  114058. * @returns true if blending is enable
  114059. */
  114060. needAlphaBlending(): boolean;
  114061. /**
  114062. * Checks wether the material is ready to be rendered for a given mesh.
  114063. * @param mesh The mesh to render
  114064. * @param subMesh The submesh to check against
  114065. * @param useInstances Specify wether or not the material is used with instances
  114066. * @returns true if all the dependencies are ready (Textures, Effects...)
  114067. */
  114068. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  114069. /**
  114070. * Compute the primary color according to the chosen perceptual color.
  114071. */
  114072. private _computePrimaryColorFromPerceptualColor;
  114073. /**
  114074. * Compute the highlights and shadow colors according to their chosen levels.
  114075. */
  114076. private _computePrimaryColors;
  114077. /**
  114078. * Build the uniform buffer used in the material.
  114079. */
  114080. buildUniformLayout(): void;
  114081. /**
  114082. * Unbind the material.
  114083. */
  114084. unbind(): void;
  114085. /**
  114086. * Bind only the world matrix to the material.
  114087. * @param world The world matrix to bind.
  114088. */
  114089. bindOnlyWorldMatrix(world: Matrix): void;
  114090. /**
  114091. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  114092. * @param world The world matrix to bind.
  114093. * @param subMesh The submesh to bind for.
  114094. */
  114095. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  114096. /**
  114097. * Checks to see if a texture is used in the material.
  114098. * @param texture - Base texture to use.
  114099. * @returns - Boolean specifying if a texture is used in the material.
  114100. */
  114101. hasTexture(texture: BaseTexture): boolean;
  114102. /**
  114103. * Dispose the material.
  114104. * @param forceDisposeEffect Force disposal of the associated effect.
  114105. * @param forceDisposeTextures Force disposal of the associated textures.
  114106. */
  114107. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  114108. /**
  114109. * Clones the material.
  114110. * @param name The cloned name.
  114111. * @returns The cloned material.
  114112. */
  114113. clone(name: string): BackgroundMaterial;
  114114. /**
  114115. * Serializes the current material to its JSON representation.
  114116. * @returns The JSON representation.
  114117. */
  114118. serialize(): any;
  114119. /**
  114120. * Gets the class name of the material
  114121. * @returns "BackgroundMaterial"
  114122. */
  114123. getClassName(): string;
  114124. /**
  114125. * Parse a JSON input to create back a background material.
  114126. * @param source The JSON data to parse
  114127. * @param scene The scene to create the parsed material in
  114128. * @param rootUrl The root url of the assets the material depends upon
  114129. * @returns the instantiated BackgroundMaterial.
  114130. */
  114131. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  114132. }
  114133. }
  114134. declare module BABYLON {
  114135. /**
  114136. * Represents the different options available during the creation of
  114137. * a Environment helper.
  114138. *
  114139. * This can control the default ground, skybox and image processing setup of your scene.
  114140. */
  114141. export interface IEnvironmentHelperOptions {
  114142. /**
  114143. * Specifies wether or not to create a ground.
  114144. * True by default.
  114145. */
  114146. createGround: boolean;
  114147. /**
  114148. * Specifies the ground size.
  114149. * 15 by default.
  114150. */
  114151. groundSize: number;
  114152. /**
  114153. * The texture used on the ground for the main color.
  114154. * Comes from the BabylonJS CDN by default.
  114155. *
  114156. * Remarks: Can be either a texture or a url.
  114157. */
  114158. groundTexture: string | BaseTexture;
  114159. /**
  114160. * The color mixed in the ground texture by default.
  114161. * BabylonJS clearColor by default.
  114162. */
  114163. groundColor: Color3;
  114164. /**
  114165. * Specifies the ground opacity.
  114166. * 1 by default.
  114167. */
  114168. groundOpacity: number;
  114169. /**
  114170. * Enables the ground to receive shadows.
  114171. * True by default.
  114172. */
  114173. enableGroundShadow: boolean;
  114174. /**
  114175. * Helps preventing the shadow to be fully black on the ground.
  114176. * 0.5 by default.
  114177. */
  114178. groundShadowLevel: number;
  114179. /**
  114180. * Creates a mirror texture attach to the ground.
  114181. * false by default.
  114182. */
  114183. enableGroundMirror: boolean;
  114184. /**
  114185. * Specifies the ground mirror size ratio.
  114186. * 0.3 by default as the default kernel is 64.
  114187. */
  114188. groundMirrorSizeRatio: number;
  114189. /**
  114190. * Specifies the ground mirror blur kernel size.
  114191. * 64 by default.
  114192. */
  114193. groundMirrorBlurKernel: number;
  114194. /**
  114195. * Specifies the ground mirror visibility amount.
  114196. * 1 by default
  114197. */
  114198. groundMirrorAmount: number;
  114199. /**
  114200. * Specifies the ground mirror reflectance weight.
  114201. * This uses the standard weight of the background material to setup the fresnel effect
  114202. * of the mirror.
  114203. * 1 by default.
  114204. */
  114205. groundMirrorFresnelWeight: number;
  114206. /**
  114207. * Specifies the ground mirror Falloff distance.
  114208. * This can helps reducing the size of the reflection.
  114209. * 0 by Default.
  114210. */
  114211. groundMirrorFallOffDistance: number;
  114212. /**
  114213. * Specifies the ground mirror texture type.
  114214. * Unsigned Int by Default.
  114215. */
  114216. groundMirrorTextureType: number;
  114217. /**
  114218. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  114219. * the shown objects.
  114220. */
  114221. groundYBias: number;
  114222. /**
  114223. * Specifies wether or not to create a skybox.
  114224. * True by default.
  114225. */
  114226. createSkybox: boolean;
  114227. /**
  114228. * Specifies the skybox size.
  114229. * 20 by default.
  114230. */
  114231. skyboxSize: number;
  114232. /**
  114233. * The texture used on the skybox for the main color.
  114234. * Comes from the BabylonJS CDN by default.
  114235. *
  114236. * Remarks: Can be either a texture or a url.
  114237. */
  114238. skyboxTexture: string | BaseTexture;
  114239. /**
  114240. * The color mixed in the skybox texture by default.
  114241. * BabylonJS clearColor by default.
  114242. */
  114243. skyboxColor: Color3;
  114244. /**
  114245. * The background rotation around the Y axis of the scene.
  114246. * This helps aligning the key lights of your scene with the background.
  114247. * 0 by default.
  114248. */
  114249. backgroundYRotation: number;
  114250. /**
  114251. * Compute automatically the size of the elements to best fit with the scene.
  114252. */
  114253. sizeAuto: boolean;
  114254. /**
  114255. * Default position of the rootMesh if autoSize is not true.
  114256. */
  114257. rootPosition: Vector3;
  114258. /**
  114259. * Sets up the image processing in the scene.
  114260. * true by default.
  114261. */
  114262. setupImageProcessing: boolean;
  114263. /**
  114264. * The texture used as your environment texture in the scene.
  114265. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  114266. *
  114267. * Remarks: Can be either a texture or a url.
  114268. */
  114269. environmentTexture: string | BaseTexture;
  114270. /**
  114271. * The value of the exposure to apply to the scene.
  114272. * 0.6 by default if setupImageProcessing is true.
  114273. */
  114274. cameraExposure: number;
  114275. /**
  114276. * The value of the contrast to apply to the scene.
  114277. * 1.6 by default if setupImageProcessing is true.
  114278. */
  114279. cameraContrast: number;
  114280. /**
  114281. * Specifies wether or not tonemapping should be enabled in the scene.
  114282. * true by default if setupImageProcessing is true.
  114283. */
  114284. toneMappingEnabled: boolean;
  114285. }
  114286. /**
  114287. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  114288. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  114289. * It also helps with the default setup of your imageProcessing configuration.
  114290. */
  114291. export class EnvironmentHelper {
  114292. /**
  114293. * Default ground texture URL.
  114294. */
  114295. private static _groundTextureCDNUrl;
  114296. /**
  114297. * Default skybox texture URL.
  114298. */
  114299. private static _skyboxTextureCDNUrl;
  114300. /**
  114301. * Default environment texture URL.
  114302. */
  114303. private static _environmentTextureCDNUrl;
  114304. /**
  114305. * Creates the default options for the helper.
  114306. */
  114307. private static _getDefaultOptions;
  114308. private _rootMesh;
  114309. /**
  114310. * Gets the root mesh created by the helper.
  114311. */
  114312. readonly rootMesh: Mesh;
  114313. private _skybox;
  114314. /**
  114315. * Gets the skybox created by the helper.
  114316. */
  114317. readonly skybox: Nullable<Mesh>;
  114318. private _skyboxTexture;
  114319. /**
  114320. * Gets the skybox texture created by the helper.
  114321. */
  114322. readonly skyboxTexture: Nullable<BaseTexture>;
  114323. private _skyboxMaterial;
  114324. /**
  114325. * Gets the skybox material created by the helper.
  114326. */
  114327. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  114328. private _ground;
  114329. /**
  114330. * Gets the ground mesh created by the helper.
  114331. */
  114332. readonly ground: Nullable<Mesh>;
  114333. private _groundTexture;
  114334. /**
  114335. * Gets the ground texture created by the helper.
  114336. */
  114337. readonly groundTexture: Nullable<BaseTexture>;
  114338. private _groundMirror;
  114339. /**
  114340. * Gets the ground mirror created by the helper.
  114341. */
  114342. readonly groundMirror: Nullable<MirrorTexture>;
  114343. /**
  114344. * Gets the ground mirror render list to helps pushing the meshes
  114345. * you wish in the ground reflection.
  114346. */
  114347. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  114348. private _groundMaterial;
  114349. /**
  114350. * Gets the ground material created by the helper.
  114351. */
  114352. readonly groundMaterial: Nullable<BackgroundMaterial>;
  114353. /**
  114354. * Stores the creation options.
  114355. */
  114356. private readonly _scene;
  114357. private _options;
  114358. /**
  114359. * This observable will be notified with any error during the creation of the environment,
  114360. * mainly texture creation errors.
  114361. */
  114362. onErrorObservable: Observable<{
  114363. message?: string;
  114364. exception?: any;
  114365. }>;
  114366. /**
  114367. * constructor
  114368. * @param options Defines the options we want to customize the helper
  114369. * @param scene The scene to add the material to
  114370. */
  114371. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  114372. /**
  114373. * Updates the background according to the new options
  114374. * @param options
  114375. */
  114376. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  114377. /**
  114378. * Sets the primary color of all the available elements.
  114379. * @param color the main color to affect to the ground and the background
  114380. */
  114381. setMainColor(color: Color3): void;
  114382. /**
  114383. * Setup the image processing according to the specified options.
  114384. */
  114385. private _setupImageProcessing;
  114386. /**
  114387. * Setup the environment texture according to the specified options.
  114388. */
  114389. private _setupEnvironmentTexture;
  114390. /**
  114391. * Setup the background according to the specified options.
  114392. */
  114393. private _setupBackground;
  114394. /**
  114395. * Get the scene sizes according to the setup.
  114396. */
  114397. private _getSceneSize;
  114398. /**
  114399. * Setup the ground according to the specified options.
  114400. */
  114401. private _setupGround;
  114402. /**
  114403. * Setup the ground material according to the specified options.
  114404. */
  114405. private _setupGroundMaterial;
  114406. /**
  114407. * Setup the ground diffuse texture according to the specified options.
  114408. */
  114409. private _setupGroundDiffuseTexture;
  114410. /**
  114411. * Setup the ground mirror texture according to the specified options.
  114412. */
  114413. private _setupGroundMirrorTexture;
  114414. /**
  114415. * Setup the ground to receive the mirror texture.
  114416. */
  114417. private _setupMirrorInGroundMaterial;
  114418. /**
  114419. * Setup the skybox according to the specified options.
  114420. */
  114421. private _setupSkybox;
  114422. /**
  114423. * Setup the skybox material according to the specified options.
  114424. */
  114425. private _setupSkyboxMaterial;
  114426. /**
  114427. * Setup the skybox reflection texture according to the specified options.
  114428. */
  114429. private _setupSkyboxReflectionTexture;
  114430. private _errorHandler;
  114431. /**
  114432. * Dispose all the elements created by the Helper.
  114433. */
  114434. dispose(): void;
  114435. }
  114436. }
  114437. declare module BABYLON {
  114438. /**
  114439. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  114440. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  114441. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  114442. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  114443. */
  114444. export class PhotoDome extends TransformNode {
  114445. /**
  114446. * Define the image as a Monoscopic panoramic 360 image.
  114447. */
  114448. static readonly MODE_MONOSCOPIC: number;
  114449. /**
  114450. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  114451. */
  114452. static readonly MODE_TOPBOTTOM: number;
  114453. /**
  114454. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  114455. */
  114456. static readonly MODE_SIDEBYSIDE: number;
  114457. private _useDirectMapping;
  114458. /**
  114459. * The texture being displayed on the sphere
  114460. */
  114461. protected _photoTexture: Texture;
  114462. /**
  114463. * Gets or sets the texture being displayed on the sphere
  114464. */
  114465. photoTexture: Texture;
  114466. /**
  114467. * Observable raised when an error occured while loading the 360 image
  114468. */
  114469. onLoadErrorObservable: Observable<string>;
  114470. /**
  114471. * The skybox material
  114472. */
  114473. protected _material: BackgroundMaterial;
  114474. /**
  114475. * The surface used for the skybox
  114476. */
  114477. protected _mesh: Mesh;
  114478. /**
  114479. * Gets the mesh used for the skybox.
  114480. */
  114481. readonly mesh: Mesh;
  114482. /**
  114483. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  114484. * Also see the options.resolution property.
  114485. */
  114486. fovMultiplier: number;
  114487. private _imageMode;
  114488. /**
  114489. * Gets or set the current video mode for the video. It can be:
  114490. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  114491. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  114492. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  114493. */
  114494. imageMode: number;
  114495. /**
  114496. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  114497. * @param name Element's name, child elements will append suffixes for their own names.
  114498. * @param urlsOfPhoto defines the url of the photo to display
  114499. * @param options defines an object containing optional or exposed sub element properties
  114500. * @param onError defines a callback called when an error occured while loading the texture
  114501. */
  114502. constructor(name: string, urlOfPhoto: string, options: {
  114503. resolution?: number;
  114504. size?: number;
  114505. useDirectMapping?: boolean;
  114506. faceForward?: boolean;
  114507. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  114508. private _onBeforeCameraRenderObserver;
  114509. private _changeImageMode;
  114510. /**
  114511. * Releases resources associated with this node.
  114512. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  114513. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  114514. */
  114515. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  114516. }
  114517. }
  114518. declare module BABYLON {
  114519. /**
  114520. * Class used to host RGBD texture specific utilities
  114521. */
  114522. export class RGBDTextureTools {
  114523. /**
  114524. * Expand the RGBD Texture from RGBD to Half Float if possible.
  114525. * @param texture the texture to expand.
  114526. */
  114527. static ExpandRGBDTexture(texture: Texture): void;
  114528. }
  114529. }
  114530. declare module BABYLON {
  114531. /**
  114532. * Class used to host texture specific utilities
  114533. */
  114534. export class BRDFTextureTools {
  114535. /**
  114536. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  114537. * @param scene defines the hosting scene
  114538. * @returns the environment BRDF texture
  114539. */
  114540. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  114541. private static _environmentBRDFBase64Texture;
  114542. }
  114543. }
  114544. declare module BABYLON {
  114545. /**
  114546. * @hidden
  114547. */
  114548. export interface IMaterialClearCoatDefines {
  114549. CLEARCOAT: boolean;
  114550. CLEARCOAT_DEFAULTIOR: boolean;
  114551. CLEARCOAT_TEXTURE: boolean;
  114552. CLEARCOAT_TEXTUREDIRECTUV: number;
  114553. CLEARCOAT_BUMP: boolean;
  114554. CLEARCOAT_BUMPDIRECTUV: number;
  114555. CLEARCOAT_TINT: boolean;
  114556. CLEARCOAT_TINT_TEXTURE: boolean;
  114557. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  114558. /** @hidden */
  114559. _areTexturesDirty: boolean;
  114560. }
  114561. /**
  114562. * Define the code related to the clear coat parameters of the pbr material.
  114563. */
  114564. export class PBRClearCoatConfiguration {
  114565. /**
  114566. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  114567. * The default fits with a polyurethane material.
  114568. */
  114569. private static readonly _DefaultIndexOfRefraction;
  114570. private _isEnabled;
  114571. /**
  114572. * Defines if the clear coat is enabled in the material.
  114573. */
  114574. isEnabled: boolean;
  114575. /**
  114576. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  114577. */
  114578. intensity: number;
  114579. /**
  114580. * Defines the clear coat layer roughness.
  114581. */
  114582. roughness: number;
  114583. private _indexOfRefraction;
  114584. /**
  114585. * Defines the index of refraction of the clear coat.
  114586. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  114587. * The default fits with a polyurethane material.
  114588. * Changing the default value is more performance intensive.
  114589. */
  114590. indexOfRefraction: number;
  114591. private _texture;
  114592. /**
  114593. * Stores the clear coat values in a texture.
  114594. */
  114595. texture: Nullable<BaseTexture>;
  114596. private _bumpTexture;
  114597. /**
  114598. * Define the clear coat specific bump texture.
  114599. */
  114600. bumpTexture: Nullable<BaseTexture>;
  114601. private _isTintEnabled;
  114602. /**
  114603. * Defines if the clear coat tint is enabled in the material.
  114604. */
  114605. isTintEnabled: boolean;
  114606. /**
  114607. * Defines the clear coat tint of the material.
  114608. * This is only use if tint is enabled
  114609. */
  114610. tintColor: Color3;
  114611. /**
  114612. * Defines the distance at which the tint color should be found in the
  114613. * clear coat media.
  114614. * This is only use if tint is enabled
  114615. */
  114616. tintColorAtDistance: number;
  114617. /**
  114618. * Defines the clear coat layer thickness.
  114619. * This is only use if tint is enabled
  114620. */
  114621. tintThickness: number;
  114622. private _tintTexture;
  114623. /**
  114624. * Stores the clear tint values in a texture.
  114625. * rgb is tint
  114626. * a is a thickness factor
  114627. */
  114628. tintTexture: Nullable<BaseTexture>;
  114629. /** @hidden */
  114630. private _internalMarkAllSubMeshesAsTexturesDirty;
  114631. /** @hidden */
  114632. _markAllSubMeshesAsTexturesDirty(): void;
  114633. /**
  114634. * Instantiate a new istance of clear coat configuration.
  114635. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  114636. */
  114637. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  114638. /**
  114639. * Gets wehter the submesh is ready to be used or not.
  114640. * @param defines the list of "defines" to update.
  114641. * @param scene defines the scene the material belongs to.
  114642. * @param engine defines the engine the material belongs to.
  114643. * @param disableBumpMap defines wether the material disables bump or not.
  114644. * @returns - boolean indicating that the submesh is ready or not.
  114645. */
  114646. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  114647. /**
  114648. * Checks to see if a texture is used in the material.
  114649. * @param defines the list of "defines" to update.
  114650. * @param scene defines the scene to the material belongs to.
  114651. */
  114652. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  114653. /**
  114654. * Binds the material data.
  114655. * @param uniformBuffer defines the Uniform buffer to fill in.
  114656. * @param scene defines the scene the material belongs to.
  114657. * @param engine defines the engine the material belongs to.
  114658. * @param disableBumpMap defines wether the material disables bump or not.
  114659. * @param isFrozen defines wether the material is frozen or not.
  114660. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  114661. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  114662. */
  114663. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  114664. /**
  114665. * Checks to see if a texture is used in the material.
  114666. * @param texture - Base texture to use.
  114667. * @returns - Boolean specifying if a texture is used in the material.
  114668. */
  114669. hasTexture(texture: BaseTexture): boolean;
  114670. /**
  114671. * Returns an array of the actively used textures.
  114672. * @param activeTextures Array of BaseTextures
  114673. */
  114674. getActiveTextures(activeTextures: BaseTexture[]): void;
  114675. /**
  114676. * Returns the animatable textures.
  114677. * @param animatables Array of animatable textures.
  114678. */
  114679. getAnimatables(animatables: IAnimatable[]): void;
  114680. /**
  114681. * Disposes the resources of the material.
  114682. * @param forceDisposeTextures - Forces the disposal of all textures.
  114683. */
  114684. dispose(forceDisposeTextures?: boolean): void;
  114685. /**
  114686. * Get the current class name of the texture useful for serialization or dynamic coding.
  114687. * @returns "PBRClearCoatConfiguration"
  114688. */
  114689. getClassName(): string;
  114690. /**
  114691. * Add fallbacks to the effect fallbacks list.
  114692. * @param defines defines the Base texture to use.
  114693. * @param fallbacks defines the current fallback list.
  114694. * @param currentRank defines the current fallback rank.
  114695. * @returns the new fallback rank.
  114696. */
  114697. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  114698. /**
  114699. * Add the required uniforms to the current list.
  114700. * @param uniforms defines the current uniform list.
  114701. */
  114702. static AddUniforms(uniforms: string[]): void;
  114703. /**
  114704. * Add the required samplers to the current list.
  114705. * @param samplers defines the current sampler list.
  114706. */
  114707. static AddSamplers(samplers: string[]): void;
  114708. /**
  114709. * Add the required uniforms to the current buffer.
  114710. * @param uniformBuffer defines the current uniform buffer.
  114711. */
  114712. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  114713. /**
  114714. * Makes a duplicate of the current configuration into another one.
  114715. * @param clearCoatConfiguration define the config where to copy the info
  114716. */
  114717. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  114718. /**
  114719. * Serializes this clear coat configuration.
  114720. * @returns - An object with the serialized config.
  114721. */
  114722. serialize(): any;
  114723. /**
  114724. * Parses a anisotropy Configuration from a serialized object.
  114725. * @param source - Serialized object.
  114726. * @param scene Defines the scene we are parsing for
  114727. * @param rootUrl Defines the rootUrl to load from
  114728. */
  114729. parse(source: any, scene: Scene, rootUrl: string): void;
  114730. }
  114731. }
  114732. declare module BABYLON {
  114733. /**
  114734. * @hidden
  114735. */
  114736. export interface IMaterialAnisotropicDefines {
  114737. ANISOTROPIC: boolean;
  114738. ANISOTROPIC_TEXTURE: boolean;
  114739. ANISOTROPIC_TEXTUREDIRECTUV: number;
  114740. MAINUV1: boolean;
  114741. _areTexturesDirty: boolean;
  114742. _needUVs: boolean;
  114743. }
  114744. /**
  114745. * Define the code related to the anisotropic parameters of the pbr material.
  114746. */
  114747. export class PBRAnisotropicConfiguration {
  114748. private _isEnabled;
  114749. /**
  114750. * Defines if the anisotropy is enabled in the material.
  114751. */
  114752. isEnabled: boolean;
  114753. /**
  114754. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  114755. */
  114756. intensity: number;
  114757. /**
  114758. * Defines if the effect is along the tangents, bitangents or in between.
  114759. * By default, the effect is "strectching" the highlights along the tangents.
  114760. */
  114761. direction: Vector2;
  114762. private _texture;
  114763. /**
  114764. * Stores the anisotropy values in a texture.
  114765. * rg is direction (like normal from -1 to 1)
  114766. * b is a intensity
  114767. */
  114768. texture: Nullable<BaseTexture>;
  114769. /** @hidden */
  114770. private _internalMarkAllSubMeshesAsTexturesDirty;
  114771. /** @hidden */
  114772. _markAllSubMeshesAsTexturesDirty(): void;
  114773. /**
  114774. * Instantiate a new istance of anisotropy configuration.
  114775. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  114776. */
  114777. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  114778. /**
  114779. * Specifies that the submesh is ready to be used.
  114780. * @param defines the list of "defines" to update.
  114781. * @param scene defines the scene the material belongs to.
  114782. * @returns - boolean indicating that the submesh is ready or not.
  114783. */
  114784. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  114785. /**
  114786. * Checks to see if a texture is used in the material.
  114787. * @param defines the list of "defines" to update.
  114788. * @param mesh the mesh we are preparing the defines for.
  114789. * @param scene defines the scene the material belongs to.
  114790. */
  114791. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  114792. /**
  114793. * Binds the material data.
  114794. * @param uniformBuffer defines the Uniform buffer to fill in.
  114795. * @param scene defines the scene the material belongs to.
  114796. * @param isFrozen defines wether the material is frozen or not.
  114797. */
  114798. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  114799. /**
  114800. * Checks to see if a texture is used in the material.
  114801. * @param texture - Base texture to use.
  114802. * @returns - Boolean specifying if a texture is used in the material.
  114803. */
  114804. hasTexture(texture: BaseTexture): boolean;
  114805. /**
  114806. * Returns an array of the actively used textures.
  114807. * @param activeTextures Array of BaseTextures
  114808. */
  114809. getActiveTextures(activeTextures: BaseTexture[]): void;
  114810. /**
  114811. * Returns the animatable textures.
  114812. * @param animatables Array of animatable textures.
  114813. */
  114814. getAnimatables(animatables: IAnimatable[]): void;
  114815. /**
  114816. * Disposes the resources of the material.
  114817. * @param forceDisposeTextures - Forces the disposal of all textures.
  114818. */
  114819. dispose(forceDisposeTextures?: boolean): void;
  114820. /**
  114821. * Get the current class name of the texture useful for serialization or dynamic coding.
  114822. * @returns "PBRAnisotropicConfiguration"
  114823. */
  114824. getClassName(): string;
  114825. /**
  114826. * Add fallbacks to the effect fallbacks list.
  114827. * @param defines defines the Base texture to use.
  114828. * @param fallbacks defines the current fallback list.
  114829. * @param currentRank defines the current fallback rank.
  114830. * @returns the new fallback rank.
  114831. */
  114832. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  114833. /**
  114834. * Add the required uniforms to the current list.
  114835. * @param uniforms defines the current uniform list.
  114836. */
  114837. static AddUniforms(uniforms: string[]): void;
  114838. /**
  114839. * Add the required uniforms to the current buffer.
  114840. * @param uniformBuffer defines the current uniform buffer.
  114841. */
  114842. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  114843. /**
  114844. * Add the required samplers to the current list.
  114845. * @param samplers defines the current sampler list.
  114846. */
  114847. static AddSamplers(samplers: string[]): void;
  114848. /**
  114849. * Makes a duplicate of the current configuration into another one.
  114850. * @param anisotropicConfiguration define the config where to copy the info
  114851. */
  114852. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  114853. /**
  114854. * Serializes this anisotropy configuration.
  114855. * @returns - An object with the serialized config.
  114856. */
  114857. serialize(): any;
  114858. /**
  114859. * Parses a anisotropy Configuration from a serialized object.
  114860. * @param source - Serialized object.
  114861. * @param scene Defines the scene we are parsing for
  114862. * @param rootUrl Defines the rootUrl to load from
  114863. */
  114864. parse(source: any, scene: Scene, rootUrl: string): void;
  114865. }
  114866. }
  114867. declare module BABYLON {
  114868. /**
  114869. * @hidden
  114870. */
  114871. export interface IMaterialBRDFDefines {
  114872. BRDF_V_HEIGHT_CORRELATED: boolean;
  114873. MS_BRDF_ENERGY_CONSERVATION: boolean;
  114874. SPHERICAL_HARMONICS: boolean;
  114875. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  114876. /** @hidden */
  114877. _areMiscDirty: boolean;
  114878. }
  114879. /**
  114880. * Define the code related to the BRDF parameters of the pbr material.
  114881. */
  114882. export class PBRBRDFConfiguration {
  114883. /**
  114884. * Default value used for the energy conservation.
  114885. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  114886. */
  114887. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  114888. /**
  114889. * Default value used for the Smith Visibility Height Correlated mode.
  114890. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  114891. */
  114892. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  114893. /**
  114894. * Default value used for the IBL diffuse part.
  114895. * This can help switching back to the polynomials mode globally which is a tiny bit
  114896. * less GPU intensive at the drawback of a lower quality.
  114897. */
  114898. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  114899. /**
  114900. * Default value used for activating energy conservation for the specular workflow.
  114901. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  114902. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  114903. */
  114904. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  114905. private _useEnergyConservation;
  114906. /**
  114907. * Defines if the material uses energy conservation.
  114908. */
  114909. useEnergyConservation: boolean;
  114910. private _useSmithVisibilityHeightCorrelated;
  114911. /**
  114912. * LEGACY Mode set to false
  114913. * Defines if the material uses height smith correlated visibility term.
  114914. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  114915. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  114916. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  114917. * Not relying on height correlated will also disable energy conservation.
  114918. */
  114919. useSmithVisibilityHeightCorrelated: boolean;
  114920. private _useSphericalHarmonics;
  114921. /**
  114922. * LEGACY Mode set to false
  114923. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  114924. * diffuse part of the IBL.
  114925. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  114926. * to the ground truth.
  114927. */
  114928. useSphericalHarmonics: boolean;
  114929. private _useSpecularGlossinessInputEnergyConservation;
  114930. /**
  114931. * Defines if the material uses energy conservation, when the specular workflow is active.
  114932. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  114933. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  114934. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  114935. */
  114936. useSpecularGlossinessInputEnergyConservation: boolean;
  114937. /** @hidden */
  114938. private _internalMarkAllSubMeshesAsMiscDirty;
  114939. /** @hidden */
  114940. _markAllSubMeshesAsMiscDirty(): void;
  114941. /**
  114942. * Instantiate a new istance of clear coat configuration.
  114943. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  114944. */
  114945. constructor(markAllSubMeshesAsMiscDirty: () => void);
  114946. /**
  114947. * Checks to see if a texture is used in the material.
  114948. * @param defines the list of "defines" to update.
  114949. */
  114950. prepareDefines(defines: IMaterialBRDFDefines): void;
  114951. /**
  114952. * Get the current class name of the texture useful for serialization or dynamic coding.
  114953. * @returns "PBRClearCoatConfiguration"
  114954. */
  114955. getClassName(): string;
  114956. /**
  114957. * Makes a duplicate of the current configuration into another one.
  114958. * @param brdfConfiguration define the config where to copy the info
  114959. */
  114960. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  114961. /**
  114962. * Serializes this BRDF configuration.
  114963. * @returns - An object with the serialized config.
  114964. */
  114965. serialize(): any;
  114966. /**
  114967. * Parses a anisotropy Configuration from a serialized object.
  114968. * @param source - Serialized object.
  114969. * @param scene Defines the scene we are parsing for
  114970. * @param rootUrl Defines the rootUrl to load from
  114971. */
  114972. parse(source: any, scene: Scene, rootUrl: string): void;
  114973. }
  114974. }
  114975. declare module BABYLON {
  114976. /**
  114977. * @hidden
  114978. */
  114979. export interface IMaterialSheenDefines {
  114980. SHEEN: boolean;
  114981. SHEEN_TEXTURE: boolean;
  114982. SHEEN_TEXTUREDIRECTUV: number;
  114983. SHEEN_LINKWITHALBEDO: boolean;
  114984. /** @hidden */
  114985. _areTexturesDirty: boolean;
  114986. }
  114987. /**
  114988. * Define the code related to the Sheen parameters of the pbr material.
  114989. */
  114990. export class PBRSheenConfiguration {
  114991. private _isEnabled;
  114992. /**
  114993. * Defines if the material uses sheen.
  114994. */
  114995. isEnabled: boolean;
  114996. private _linkSheenWithAlbedo;
  114997. /**
  114998. * Defines if the sheen is linked to the sheen color.
  114999. */
  115000. linkSheenWithAlbedo: boolean;
  115001. /**
  115002. * Defines the sheen intensity.
  115003. */
  115004. intensity: number;
  115005. /**
  115006. * Defines the sheen color.
  115007. */
  115008. color: Color3;
  115009. private _texture;
  115010. /**
  115011. * Stores the sheen tint values in a texture.
  115012. * rgb is tint
  115013. * a is a intensity
  115014. */
  115015. texture: Nullable<BaseTexture>;
  115016. /** @hidden */
  115017. private _internalMarkAllSubMeshesAsTexturesDirty;
  115018. /** @hidden */
  115019. _markAllSubMeshesAsTexturesDirty(): void;
  115020. /**
  115021. * Instantiate a new istance of clear coat configuration.
  115022. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  115023. */
  115024. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  115025. /**
  115026. * Specifies that the submesh is ready to be used.
  115027. * @param defines the list of "defines" to update.
  115028. * @param scene defines the scene the material belongs to.
  115029. * @returns - boolean indicating that the submesh is ready or not.
  115030. */
  115031. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  115032. /**
  115033. * Checks to see if a texture is used in the material.
  115034. * @param defines the list of "defines" to update.
  115035. * @param scene defines the scene the material belongs to.
  115036. */
  115037. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  115038. /**
  115039. * Binds the material data.
  115040. * @param uniformBuffer defines the Uniform buffer to fill in.
  115041. * @param scene defines the scene the material belongs to.
  115042. * @param isFrozen defines wether the material is frozen or not.
  115043. */
  115044. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  115045. /**
  115046. * Checks to see if a texture is used in the material.
  115047. * @param texture - Base texture to use.
  115048. * @returns - Boolean specifying if a texture is used in the material.
  115049. */
  115050. hasTexture(texture: BaseTexture): boolean;
  115051. /**
  115052. * Returns an array of the actively used textures.
  115053. * @param activeTextures Array of BaseTextures
  115054. */
  115055. getActiveTextures(activeTextures: BaseTexture[]): void;
  115056. /**
  115057. * Returns the animatable textures.
  115058. * @param animatables Array of animatable textures.
  115059. */
  115060. getAnimatables(animatables: IAnimatable[]): void;
  115061. /**
  115062. * Disposes the resources of the material.
  115063. * @param forceDisposeTextures - Forces the disposal of all textures.
  115064. */
  115065. dispose(forceDisposeTextures?: boolean): void;
  115066. /**
  115067. * Get the current class name of the texture useful for serialization or dynamic coding.
  115068. * @returns "PBRSheenConfiguration"
  115069. */
  115070. getClassName(): string;
  115071. /**
  115072. * Add fallbacks to the effect fallbacks list.
  115073. * @param defines defines the Base texture to use.
  115074. * @param fallbacks defines the current fallback list.
  115075. * @param currentRank defines the current fallback rank.
  115076. * @returns the new fallback rank.
  115077. */
  115078. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  115079. /**
  115080. * Add the required uniforms to the current list.
  115081. * @param uniforms defines the current uniform list.
  115082. */
  115083. static AddUniforms(uniforms: string[]): void;
  115084. /**
  115085. * Add the required uniforms to the current buffer.
  115086. * @param uniformBuffer defines the current uniform buffer.
  115087. */
  115088. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115089. /**
  115090. * Add the required samplers to the current list.
  115091. * @param samplers defines the current sampler list.
  115092. */
  115093. static AddSamplers(samplers: string[]): void;
  115094. /**
  115095. * Makes a duplicate of the current configuration into another one.
  115096. * @param sheenConfiguration define the config where to copy the info
  115097. */
  115098. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  115099. /**
  115100. * Serializes this BRDF configuration.
  115101. * @returns - An object with the serialized config.
  115102. */
  115103. serialize(): any;
  115104. /**
  115105. * Parses a anisotropy Configuration from a serialized object.
  115106. * @param source - Serialized object.
  115107. * @param scene Defines the scene we are parsing for
  115108. * @param rootUrl Defines the rootUrl to load from
  115109. */
  115110. parse(source: any, scene: Scene, rootUrl: string): void;
  115111. }
  115112. }
  115113. declare module BABYLON {
  115114. /**
  115115. * @hidden
  115116. */
  115117. export interface IMaterialSubSurfaceDefines {
  115118. SUBSURFACE: boolean;
  115119. SS_REFRACTION: boolean;
  115120. SS_TRANSLUCENCY: boolean;
  115121. SS_SCATERRING: boolean;
  115122. SS_THICKNESSANDMASK_TEXTURE: boolean;
  115123. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  115124. SS_REFRACTIONMAP_3D: boolean;
  115125. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  115126. SS_LODINREFRACTIONALPHA: boolean;
  115127. SS_GAMMAREFRACTION: boolean;
  115128. SS_RGBDREFRACTION: boolean;
  115129. SS_LINEARSPECULARREFRACTION: boolean;
  115130. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  115131. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  115132. /** @hidden */
  115133. _areTexturesDirty: boolean;
  115134. }
  115135. /**
  115136. * Define the code related to the sub surface parameters of the pbr material.
  115137. */
  115138. export class PBRSubSurfaceConfiguration {
  115139. private _isRefractionEnabled;
  115140. /**
  115141. * Defines if the refraction is enabled in the material.
  115142. */
  115143. isRefractionEnabled: boolean;
  115144. private _isTranslucencyEnabled;
  115145. /**
  115146. * Defines if the translucency is enabled in the material.
  115147. */
  115148. isTranslucencyEnabled: boolean;
  115149. private _isScatteringEnabled;
  115150. /**
  115151. * Defines the refraction intensity of the material.
  115152. * The refraction when enabled replaces the Diffuse part of the material.
  115153. * The intensity helps transitionning between diffuse and refraction.
  115154. */
  115155. refractionIntensity: number;
  115156. /**
  115157. * Defines the translucency intensity of the material.
  115158. * When translucency has been enabled, this defines how much of the "translucency"
  115159. * is addded to the diffuse part of the material.
  115160. */
  115161. translucencyIntensity: number;
  115162. /**
  115163. * Defines the scattering intensity of the material.
  115164. * When scattering has been enabled, this defines how much of the "scattered light"
  115165. * is addded to the diffuse part of the material.
  115166. */
  115167. scatteringIntensity: number;
  115168. private _thicknessTexture;
  115169. /**
  115170. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  115171. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  115172. * 0 would mean minimumThickness
  115173. * 1 would mean maximumThickness
  115174. * The other channels might be use as a mask to vary the different effects intensity.
  115175. */
  115176. thicknessTexture: Nullable<BaseTexture>;
  115177. private _refractionTexture;
  115178. /**
  115179. * Defines the texture to use for refraction.
  115180. */
  115181. refractionTexture: Nullable<BaseTexture>;
  115182. private _indexOfRefraction;
  115183. /**
  115184. * Defines the index of refraction used in the material.
  115185. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  115186. */
  115187. indexOfRefraction: number;
  115188. private _invertRefractionY;
  115189. /**
  115190. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  115191. */
  115192. invertRefractionY: boolean;
  115193. private _linkRefractionWithTransparency;
  115194. /**
  115195. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  115196. * Materials half opaque for instance using refraction could benefit from this control.
  115197. */
  115198. linkRefractionWithTransparency: boolean;
  115199. /**
  115200. * Defines the minimum thickness stored in the thickness map.
  115201. * If no thickness map is defined, this value will be used to simulate thickness.
  115202. */
  115203. minimumThickness: number;
  115204. /**
  115205. * Defines the maximum thickness stored in the thickness map.
  115206. */
  115207. maximumThickness: number;
  115208. /**
  115209. * Defines the volume tint of the material.
  115210. * This is used for both translucency and scattering.
  115211. */
  115212. tintColor: Color3;
  115213. /**
  115214. * Defines the distance at which the tint color should be found in the media.
  115215. * This is used for refraction only.
  115216. */
  115217. tintColorAtDistance: number;
  115218. /**
  115219. * Defines how far each channel transmit through the media.
  115220. * It is defined as a color to simplify it selection.
  115221. */
  115222. diffusionDistance: Color3;
  115223. private _useMaskFromThicknessTexture;
  115224. /**
  115225. * Stores the intensity of the different subsurface effects in the thickness texture.
  115226. * * the green channel is the translucency intensity.
  115227. * * the blue channel is the scattering intensity.
  115228. * * the alpha channel is the refraction intensity.
  115229. */
  115230. useMaskFromThicknessTexture: boolean;
  115231. /** @hidden */
  115232. private _internalMarkAllSubMeshesAsTexturesDirty;
  115233. /** @hidden */
  115234. _markAllSubMeshesAsTexturesDirty(): void;
  115235. /**
  115236. * Instantiate a new istance of sub surface configuration.
  115237. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  115238. */
  115239. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  115240. /**
  115241. * Gets wehter the submesh is ready to be used or not.
  115242. * @param defines the list of "defines" to update.
  115243. * @param scene defines the scene the material belongs to.
  115244. * @returns - boolean indicating that the submesh is ready or not.
  115245. */
  115246. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  115247. /**
  115248. * Checks to see if a texture is used in the material.
  115249. * @param defines the list of "defines" to update.
  115250. * @param scene defines the scene to the material belongs to.
  115251. */
  115252. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  115253. /**
  115254. * Binds the material data.
  115255. * @param uniformBuffer defines the Uniform buffer to fill in.
  115256. * @param scene defines the scene the material belongs to.
  115257. * @param engine defines the engine the material belongs to.
  115258. * @param isFrozen defines wether the material is frozen or not.
  115259. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  115260. */
  115261. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  115262. /**
  115263. * Unbinds the material from the mesh.
  115264. * @param activeEffect defines the effect that should be unbound from.
  115265. * @returns true if unbound, otherwise false
  115266. */
  115267. unbind(activeEffect: Effect): boolean;
  115268. /**
  115269. * Returns the texture used for refraction or null if none is used.
  115270. * @param scene defines the scene the material belongs to.
  115271. * @returns - Refraction texture if present. If no refraction texture and refraction
  115272. * is linked with transparency, returns environment texture. Otherwise, returns null.
  115273. */
  115274. private _getRefractionTexture;
  115275. /**
  115276. * Returns true if alpha blending should be disabled.
  115277. */
  115278. readonly disableAlphaBlending: boolean;
  115279. /**
  115280. * Fills the list of render target textures.
  115281. * @param renderTargets the list of render targets to update
  115282. */
  115283. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  115284. /**
  115285. * Checks to see if a texture is used in the material.
  115286. * @param texture - Base texture to use.
  115287. * @returns - Boolean specifying if a texture is used in the material.
  115288. */
  115289. hasTexture(texture: BaseTexture): boolean;
  115290. /**
  115291. * Gets a boolean indicating that current material needs to register RTT
  115292. * @returns true if this uses a render target otherwise false.
  115293. */
  115294. hasRenderTargetTextures(): boolean;
  115295. /**
  115296. * Returns an array of the actively used textures.
  115297. * @param activeTextures Array of BaseTextures
  115298. */
  115299. getActiveTextures(activeTextures: BaseTexture[]): void;
  115300. /**
  115301. * Returns the animatable textures.
  115302. * @param animatables Array of animatable textures.
  115303. */
  115304. getAnimatables(animatables: IAnimatable[]): void;
  115305. /**
  115306. * Disposes the resources of the material.
  115307. * @param forceDisposeTextures - Forces the disposal of all textures.
  115308. */
  115309. dispose(forceDisposeTextures?: boolean): void;
  115310. /**
  115311. * Get the current class name of the texture useful for serialization or dynamic coding.
  115312. * @returns "PBRSubSurfaceConfiguration"
  115313. */
  115314. getClassName(): string;
  115315. /**
  115316. * Add fallbacks to the effect fallbacks list.
  115317. * @param defines defines the Base texture to use.
  115318. * @param fallbacks defines the current fallback list.
  115319. * @param currentRank defines the current fallback rank.
  115320. * @returns the new fallback rank.
  115321. */
  115322. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  115323. /**
  115324. * Add the required uniforms to the current list.
  115325. * @param uniforms defines the current uniform list.
  115326. */
  115327. static AddUniforms(uniforms: string[]): void;
  115328. /**
  115329. * Add the required samplers to the current list.
  115330. * @param samplers defines the current sampler list.
  115331. */
  115332. static AddSamplers(samplers: string[]): void;
  115333. /**
  115334. * Add the required uniforms to the current buffer.
  115335. * @param uniformBuffer defines the current uniform buffer.
  115336. */
  115337. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115338. /**
  115339. * Makes a duplicate of the current configuration into another one.
  115340. * @param configuration define the config where to copy the info
  115341. */
  115342. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  115343. /**
  115344. * Serializes this Sub Surface configuration.
  115345. * @returns - An object with the serialized config.
  115346. */
  115347. serialize(): any;
  115348. /**
  115349. * Parses a anisotropy Configuration from a serialized object.
  115350. * @param source - Serialized object.
  115351. * @param scene Defines the scene we are parsing for
  115352. * @param rootUrl Defines the rootUrl to load from
  115353. */
  115354. parse(source: any, scene: Scene, rootUrl: string): void;
  115355. }
  115356. }
  115357. declare module BABYLON {
  115358. /** @hidden */
  115359. export var pbrFragmentDeclaration: {
  115360. name: string;
  115361. shader: string;
  115362. };
  115363. }
  115364. declare module BABYLON {
  115365. /** @hidden */
  115366. export var pbrUboDeclaration: {
  115367. name: string;
  115368. shader: string;
  115369. };
  115370. }
  115371. declare module BABYLON {
  115372. /** @hidden */
  115373. export var pbrFragmentExtraDeclaration: {
  115374. name: string;
  115375. shader: string;
  115376. };
  115377. }
  115378. declare module BABYLON {
  115379. /** @hidden */
  115380. export var pbrFragmentSamplersDeclaration: {
  115381. name: string;
  115382. shader: string;
  115383. };
  115384. }
  115385. declare module BABYLON {
  115386. /** @hidden */
  115387. export var pbrHelperFunctions: {
  115388. name: string;
  115389. shader: string;
  115390. };
  115391. }
  115392. declare module BABYLON {
  115393. /** @hidden */
  115394. export var harmonicsFunctions: {
  115395. name: string;
  115396. shader: string;
  115397. };
  115398. }
  115399. declare module BABYLON {
  115400. /** @hidden */
  115401. export var pbrDirectLightingSetupFunctions: {
  115402. name: string;
  115403. shader: string;
  115404. };
  115405. }
  115406. declare module BABYLON {
  115407. /** @hidden */
  115408. export var pbrDirectLightingFalloffFunctions: {
  115409. name: string;
  115410. shader: string;
  115411. };
  115412. }
  115413. declare module BABYLON {
  115414. /** @hidden */
  115415. export var pbrBRDFFunctions: {
  115416. name: string;
  115417. shader: string;
  115418. };
  115419. }
  115420. declare module BABYLON {
  115421. /** @hidden */
  115422. export var pbrDirectLightingFunctions: {
  115423. name: string;
  115424. shader: string;
  115425. };
  115426. }
  115427. declare module BABYLON {
  115428. /** @hidden */
  115429. export var pbrIBLFunctions: {
  115430. name: string;
  115431. shader: string;
  115432. };
  115433. }
  115434. declare module BABYLON {
  115435. /** @hidden */
  115436. export var pbrDebug: {
  115437. name: string;
  115438. shader: string;
  115439. };
  115440. }
  115441. declare module BABYLON {
  115442. /** @hidden */
  115443. export var pbrPixelShader: {
  115444. name: string;
  115445. shader: string;
  115446. };
  115447. }
  115448. declare module BABYLON {
  115449. /** @hidden */
  115450. export var pbrVertexDeclaration: {
  115451. name: string;
  115452. shader: string;
  115453. };
  115454. }
  115455. declare module BABYLON {
  115456. /** @hidden */
  115457. export var pbrVertexShader: {
  115458. name: string;
  115459. shader: string;
  115460. };
  115461. }
  115462. declare module BABYLON {
  115463. /**
  115464. * Manages the defines for the PBR Material.
  115465. * @hidden
  115466. */
  115467. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  115468. PBR: boolean;
  115469. MAINUV1: boolean;
  115470. MAINUV2: boolean;
  115471. UV1: boolean;
  115472. UV2: boolean;
  115473. ALBEDO: boolean;
  115474. ALBEDODIRECTUV: number;
  115475. VERTEXCOLOR: boolean;
  115476. AMBIENT: boolean;
  115477. AMBIENTDIRECTUV: number;
  115478. AMBIENTINGRAYSCALE: boolean;
  115479. OPACITY: boolean;
  115480. VERTEXALPHA: boolean;
  115481. OPACITYDIRECTUV: number;
  115482. OPACITYRGB: boolean;
  115483. ALPHATEST: boolean;
  115484. DEPTHPREPASS: boolean;
  115485. ALPHABLEND: boolean;
  115486. ALPHAFROMALBEDO: boolean;
  115487. ALPHATESTVALUE: string;
  115488. SPECULAROVERALPHA: boolean;
  115489. RADIANCEOVERALPHA: boolean;
  115490. ALPHAFRESNEL: boolean;
  115491. LINEARALPHAFRESNEL: boolean;
  115492. PREMULTIPLYALPHA: boolean;
  115493. EMISSIVE: boolean;
  115494. EMISSIVEDIRECTUV: number;
  115495. REFLECTIVITY: boolean;
  115496. REFLECTIVITYDIRECTUV: number;
  115497. SPECULARTERM: boolean;
  115498. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  115499. MICROSURFACEAUTOMATIC: boolean;
  115500. LODBASEDMICROSFURACE: boolean;
  115501. MICROSURFACEMAP: boolean;
  115502. MICROSURFACEMAPDIRECTUV: number;
  115503. METALLICWORKFLOW: boolean;
  115504. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  115505. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  115506. METALLNESSSTOREINMETALMAPBLUE: boolean;
  115507. AOSTOREINMETALMAPRED: boolean;
  115508. METALLICF0FACTORFROMMETALLICMAP: boolean;
  115509. ENVIRONMENTBRDF: boolean;
  115510. ENVIRONMENTBRDF_RGBD: boolean;
  115511. NORMAL: boolean;
  115512. TANGENT: boolean;
  115513. BUMP: boolean;
  115514. BUMPDIRECTUV: number;
  115515. OBJECTSPACE_NORMALMAP: boolean;
  115516. PARALLAX: boolean;
  115517. PARALLAXOCCLUSION: boolean;
  115518. NORMALXYSCALE: boolean;
  115519. LIGHTMAP: boolean;
  115520. LIGHTMAPDIRECTUV: number;
  115521. USELIGHTMAPASSHADOWMAP: boolean;
  115522. GAMMALIGHTMAP: boolean;
  115523. RGBDLIGHTMAP: boolean;
  115524. REFLECTION: boolean;
  115525. REFLECTIONMAP_3D: boolean;
  115526. REFLECTIONMAP_SPHERICAL: boolean;
  115527. REFLECTIONMAP_PLANAR: boolean;
  115528. REFLECTIONMAP_CUBIC: boolean;
  115529. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  115530. REFLECTIONMAP_PROJECTION: boolean;
  115531. REFLECTIONMAP_SKYBOX: boolean;
  115532. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  115533. REFLECTIONMAP_EXPLICIT: boolean;
  115534. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  115535. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  115536. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  115537. INVERTCUBICMAP: boolean;
  115538. USESPHERICALFROMREFLECTIONMAP: boolean;
  115539. USEIRRADIANCEMAP: boolean;
  115540. SPHERICAL_HARMONICS: boolean;
  115541. USESPHERICALINVERTEX: boolean;
  115542. REFLECTIONMAP_OPPOSITEZ: boolean;
  115543. LODINREFLECTIONALPHA: boolean;
  115544. GAMMAREFLECTION: boolean;
  115545. RGBDREFLECTION: boolean;
  115546. LINEARSPECULARREFLECTION: boolean;
  115547. RADIANCEOCCLUSION: boolean;
  115548. HORIZONOCCLUSION: boolean;
  115549. INSTANCES: boolean;
  115550. NUM_BONE_INFLUENCERS: number;
  115551. BonesPerMesh: number;
  115552. BONETEXTURE: boolean;
  115553. NONUNIFORMSCALING: boolean;
  115554. MORPHTARGETS: boolean;
  115555. MORPHTARGETS_NORMAL: boolean;
  115556. MORPHTARGETS_TANGENT: boolean;
  115557. MORPHTARGETS_UV: boolean;
  115558. NUM_MORPH_INFLUENCERS: number;
  115559. IMAGEPROCESSING: boolean;
  115560. VIGNETTE: boolean;
  115561. VIGNETTEBLENDMODEMULTIPLY: boolean;
  115562. VIGNETTEBLENDMODEOPAQUE: boolean;
  115563. TONEMAPPING: boolean;
  115564. TONEMAPPING_ACES: boolean;
  115565. CONTRAST: boolean;
  115566. COLORCURVES: boolean;
  115567. COLORGRADING: boolean;
  115568. COLORGRADING3D: boolean;
  115569. SAMPLER3DGREENDEPTH: boolean;
  115570. SAMPLER3DBGRMAP: boolean;
  115571. IMAGEPROCESSINGPOSTPROCESS: boolean;
  115572. EXPOSURE: boolean;
  115573. MULTIVIEW: boolean;
  115574. USEPHYSICALLIGHTFALLOFF: boolean;
  115575. USEGLTFLIGHTFALLOFF: boolean;
  115576. TWOSIDEDLIGHTING: boolean;
  115577. SHADOWFLOAT: boolean;
  115578. CLIPPLANE: boolean;
  115579. CLIPPLANE2: boolean;
  115580. CLIPPLANE3: boolean;
  115581. CLIPPLANE4: boolean;
  115582. POINTSIZE: boolean;
  115583. FOG: boolean;
  115584. LOGARITHMICDEPTH: boolean;
  115585. FORCENORMALFORWARD: boolean;
  115586. SPECULARAA: boolean;
  115587. CLEARCOAT: boolean;
  115588. CLEARCOAT_DEFAULTIOR: boolean;
  115589. CLEARCOAT_TEXTURE: boolean;
  115590. CLEARCOAT_TEXTUREDIRECTUV: number;
  115591. CLEARCOAT_BUMP: boolean;
  115592. CLEARCOAT_BUMPDIRECTUV: number;
  115593. CLEARCOAT_TINT: boolean;
  115594. CLEARCOAT_TINT_TEXTURE: boolean;
  115595. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  115596. ANISOTROPIC: boolean;
  115597. ANISOTROPIC_TEXTURE: boolean;
  115598. ANISOTROPIC_TEXTUREDIRECTUV: number;
  115599. BRDF_V_HEIGHT_CORRELATED: boolean;
  115600. MS_BRDF_ENERGY_CONSERVATION: boolean;
  115601. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  115602. SHEEN: boolean;
  115603. SHEEN_TEXTURE: boolean;
  115604. SHEEN_TEXTUREDIRECTUV: number;
  115605. SHEEN_LINKWITHALBEDO: boolean;
  115606. SUBSURFACE: boolean;
  115607. SS_REFRACTION: boolean;
  115608. SS_TRANSLUCENCY: boolean;
  115609. SS_SCATERRING: boolean;
  115610. SS_THICKNESSANDMASK_TEXTURE: boolean;
  115611. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  115612. SS_REFRACTIONMAP_3D: boolean;
  115613. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  115614. SS_LODINREFRACTIONALPHA: boolean;
  115615. SS_GAMMAREFRACTION: boolean;
  115616. SS_RGBDREFRACTION: boolean;
  115617. SS_LINEARSPECULARREFRACTION: boolean;
  115618. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  115619. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  115620. UNLIT: boolean;
  115621. DEBUGMODE: number;
  115622. /**
  115623. * Initializes the PBR Material defines.
  115624. */
  115625. constructor();
  115626. /**
  115627. * Resets the PBR Material defines.
  115628. */
  115629. reset(): void;
  115630. }
  115631. /**
  115632. * The Physically based material base class of BJS.
  115633. *
  115634. * This offers the main features of a standard PBR material.
  115635. * For more information, please refer to the documentation :
  115636. * https://doc.babylonjs.com/how_to/physically_based_rendering
  115637. */
  115638. export abstract class PBRBaseMaterial extends PushMaterial {
  115639. /**
  115640. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  115641. */
  115642. static readonly PBRMATERIAL_OPAQUE: number;
  115643. /**
  115644. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  115645. */
  115646. static readonly PBRMATERIAL_ALPHATEST: number;
  115647. /**
  115648. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  115649. */
  115650. static readonly PBRMATERIAL_ALPHABLEND: number;
  115651. /**
  115652. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  115653. * They are also discarded below the alpha cutoff threshold to improve performances.
  115654. */
  115655. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  115656. /**
  115657. * Defines the default value of how much AO map is occluding the analytical lights
  115658. * (point spot...).
  115659. */
  115660. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  115661. /**
  115662. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  115663. */
  115664. static readonly LIGHTFALLOFF_PHYSICAL: number;
  115665. /**
  115666. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  115667. * to enhance interoperability with other engines.
  115668. */
  115669. static readonly LIGHTFALLOFF_GLTF: number;
  115670. /**
  115671. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  115672. * to enhance interoperability with other materials.
  115673. */
  115674. static readonly LIGHTFALLOFF_STANDARD: number;
  115675. /**
  115676. * Intensity of the direct lights e.g. the four lights available in your scene.
  115677. * This impacts both the direct diffuse and specular highlights.
  115678. */
  115679. protected _directIntensity: number;
  115680. /**
  115681. * Intensity of the emissive part of the material.
  115682. * This helps controlling the emissive effect without modifying the emissive color.
  115683. */
  115684. protected _emissiveIntensity: number;
  115685. /**
  115686. * Intensity of the environment e.g. how much the environment will light the object
  115687. * either through harmonics for rough material or through the refelction for shiny ones.
  115688. */
  115689. protected _environmentIntensity: number;
  115690. /**
  115691. * This is a special control allowing the reduction of the specular highlights coming from the
  115692. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  115693. */
  115694. protected _specularIntensity: number;
  115695. /**
  115696. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  115697. */
  115698. private _lightingInfos;
  115699. /**
  115700. * Debug Control allowing disabling the bump map on this material.
  115701. */
  115702. protected _disableBumpMap: boolean;
  115703. /**
  115704. * AKA Diffuse Texture in standard nomenclature.
  115705. */
  115706. protected _albedoTexture: Nullable<BaseTexture>;
  115707. /**
  115708. * AKA Occlusion Texture in other nomenclature.
  115709. */
  115710. protected _ambientTexture: Nullable<BaseTexture>;
  115711. /**
  115712. * AKA Occlusion Texture Intensity in other nomenclature.
  115713. */
  115714. protected _ambientTextureStrength: number;
  115715. /**
  115716. * Defines how much the AO map is occluding the analytical lights (point spot...).
  115717. * 1 means it completely occludes it
  115718. * 0 mean it has no impact
  115719. */
  115720. protected _ambientTextureImpactOnAnalyticalLights: number;
  115721. /**
  115722. * Stores the alpha values in a texture.
  115723. */
  115724. protected _opacityTexture: Nullable<BaseTexture>;
  115725. /**
  115726. * Stores the reflection values in a texture.
  115727. */
  115728. protected _reflectionTexture: Nullable<BaseTexture>;
  115729. /**
  115730. * Stores the emissive values in a texture.
  115731. */
  115732. protected _emissiveTexture: Nullable<BaseTexture>;
  115733. /**
  115734. * AKA Specular texture in other nomenclature.
  115735. */
  115736. protected _reflectivityTexture: Nullable<BaseTexture>;
  115737. /**
  115738. * Used to switch from specular/glossiness to metallic/roughness workflow.
  115739. */
  115740. protected _metallicTexture: Nullable<BaseTexture>;
  115741. /**
  115742. * Specifies the metallic scalar of the metallic/roughness workflow.
  115743. * Can also be used to scale the metalness values of the metallic texture.
  115744. */
  115745. protected _metallic: Nullable<number>;
  115746. /**
  115747. * Specifies the roughness scalar of the metallic/roughness workflow.
  115748. * Can also be used to scale the roughness values of the metallic texture.
  115749. */
  115750. protected _roughness: Nullable<number>;
  115751. /**
  115752. * Specifies the an F0 factor to help configuring the material F0.
  115753. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  115754. * to 0.5 the previously hard coded value stays the same.
  115755. * Can also be used to scale the F0 values of the metallic texture.
  115756. */
  115757. protected _metallicF0Factor: number;
  115758. /**
  115759. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  115760. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  115761. * your expectation as it multiplies with the texture data.
  115762. */
  115763. protected _useMetallicF0FactorFromMetallicTexture: boolean;
  115764. /**
  115765. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  115766. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  115767. */
  115768. protected _microSurfaceTexture: Nullable<BaseTexture>;
  115769. /**
  115770. * Stores surface normal data used to displace a mesh in a texture.
  115771. */
  115772. protected _bumpTexture: Nullable<BaseTexture>;
  115773. /**
  115774. * Stores the pre-calculated light information of a mesh in a texture.
  115775. */
  115776. protected _lightmapTexture: Nullable<BaseTexture>;
  115777. /**
  115778. * The color of a material in ambient lighting.
  115779. */
  115780. protected _ambientColor: Color3;
  115781. /**
  115782. * AKA Diffuse Color in other nomenclature.
  115783. */
  115784. protected _albedoColor: Color3;
  115785. /**
  115786. * AKA Specular Color in other nomenclature.
  115787. */
  115788. protected _reflectivityColor: Color3;
  115789. /**
  115790. * The color applied when light is reflected from a material.
  115791. */
  115792. protected _reflectionColor: Color3;
  115793. /**
  115794. * The color applied when light is emitted from a material.
  115795. */
  115796. protected _emissiveColor: Color3;
  115797. /**
  115798. * AKA Glossiness in other nomenclature.
  115799. */
  115800. protected _microSurface: number;
  115801. /**
  115802. * Specifies that the material will use the light map as a show map.
  115803. */
  115804. protected _useLightmapAsShadowmap: boolean;
  115805. /**
  115806. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  115807. * makes the reflect vector face the model (under horizon).
  115808. */
  115809. protected _useHorizonOcclusion: boolean;
  115810. /**
  115811. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  115812. * too much the area relying on ambient texture to define their ambient occlusion.
  115813. */
  115814. protected _useRadianceOcclusion: boolean;
  115815. /**
  115816. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  115817. */
  115818. protected _useAlphaFromAlbedoTexture: boolean;
  115819. /**
  115820. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  115821. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  115822. */
  115823. protected _useSpecularOverAlpha: boolean;
  115824. /**
  115825. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  115826. */
  115827. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  115828. /**
  115829. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  115830. */
  115831. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  115832. /**
  115833. * Specifies if the metallic texture contains the roughness information in its green channel.
  115834. */
  115835. protected _useRoughnessFromMetallicTextureGreen: boolean;
  115836. /**
  115837. * Specifies if the metallic texture contains the metallness information in its blue channel.
  115838. */
  115839. protected _useMetallnessFromMetallicTextureBlue: boolean;
  115840. /**
  115841. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  115842. */
  115843. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  115844. /**
  115845. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  115846. */
  115847. protected _useAmbientInGrayScale: boolean;
  115848. /**
  115849. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  115850. * The material will try to infer what glossiness each pixel should be.
  115851. */
  115852. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  115853. /**
  115854. * Defines the falloff type used in this material.
  115855. * It by default is Physical.
  115856. */
  115857. protected _lightFalloff: number;
  115858. /**
  115859. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  115860. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  115861. */
  115862. protected _useRadianceOverAlpha: boolean;
  115863. /**
  115864. * Allows using an object space normal map (instead of tangent space).
  115865. */
  115866. protected _useObjectSpaceNormalMap: boolean;
  115867. /**
  115868. * Allows using the bump map in parallax mode.
  115869. */
  115870. protected _useParallax: boolean;
  115871. /**
  115872. * Allows using the bump map in parallax occlusion mode.
  115873. */
  115874. protected _useParallaxOcclusion: boolean;
  115875. /**
  115876. * Controls the scale bias of the parallax mode.
  115877. */
  115878. protected _parallaxScaleBias: number;
  115879. /**
  115880. * If sets to true, disables all the lights affecting the material.
  115881. */
  115882. protected _disableLighting: boolean;
  115883. /**
  115884. * Number of Simultaneous lights allowed on the material.
  115885. */
  115886. protected _maxSimultaneousLights: number;
  115887. /**
  115888. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  115889. */
  115890. protected _invertNormalMapX: boolean;
  115891. /**
  115892. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  115893. */
  115894. protected _invertNormalMapY: boolean;
  115895. /**
  115896. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  115897. */
  115898. protected _twoSidedLighting: boolean;
  115899. /**
  115900. * Defines the alpha limits in alpha test mode.
  115901. */
  115902. protected _alphaCutOff: number;
  115903. /**
  115904. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  115905. */
  115906. protected _forceAlphaTest: boolean;
  115907. /**
  115908. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  115909. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  115910. */
  115911. protected _useAlphaFresnel: boolean;
  115912. /**
  115913. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  115914. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  115915. */
  115916. protected _useLinearAlphaFresnel: boolean;
  115917. /**
  115918. * The transparency mode of the material.
  115919. */
  115920. protected _transparencyMode: Nullable<number>;
  115921. /**
  115922. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  115923. * from cos thetav and roughness:
  115924. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  115925. */
  115926. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  115927. /**
  115928. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  115929. */
  115930. protected _forceIrradianceInFragment: boolean;
  115931. /**
  115932. * Force normal to face away from face.
  115933. */
  115934. protected _forceNormalForward: boolean;
  115935. /**
  115936. * Enables specular anti aliasing in the PBR shader.
  115937. * It will both interacts on the Geometry for analytical and IBL lighting.
  115938. * It also prefilter the roughness map based on the bump values.
  115939. */
  115940. protected _enableSpecularAntiAliasing: boolean;
  115941. /**
  115942. * Default configuration related to image processing available in the PBR Material.
  115943. */
  115944. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  115945. /**
  115946. * Keep track of the image processing observer to allow dispose and replace.
  115947. */
  115948. private _imageProcessingObserver;
  115949. /**
  115950. * Attaches a new image processing configuration to the PBR Material.
  115951. * @param configuration
  115952. */
  115953. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  115954. /**
  115955. * Stores the available render targets.
  115956. */
  115957. private _renderTargets;
  115958. /**
  115959. * Sets the global ambient color for the material used in lighting calculations.
  115960. */
  115961. private _globalAmbientColor;
  115962. /**
  115963. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  115964. */
  115965. private _useLogarithmicDepth;
  115966. /**
  115967. * If set to true, no lighting calculations will be applied.
  115968. */
  115969. private _unlit;
  115970. private _debugMode;
  115971. /**
  115972. * @hidden
  115973. * This is reserved for the inspector.
  115974. * Defines the material debug mode.
  115975. * It helps seeing only some components of the material while troubleshooting.
  115976. */
  115977. debugMode: number;
  115978. /**
  115979. * @hidden
  115980. * This is reserved for the inspector.
  115981. * Specify from where on screen the debug mode should start.
  115982. * The value goes from -1 (full screen) to 1 (not visible)
  115983. * It helps with side by side comparison against the final render
  115984. * This defaults to -1
  115985. */
  115986. private debugLimit;
  115987. /**
  115988. * @hidden
  115989. * This is reserved for the inspector.
  115990. * As the default viewing range might not be enough (if the ambient is really small for instance)
  115991. * You can use the factor to better multiply the final value.
  115992. */
  115993. private debugFactor;
  115994. /**
  115995. * Defines the clear coat layer parameters for the material.
  115996. */
  115997. readonly clearCoat: PBRClearCoatConfiguration;
  115998. /**
  115999. * Defines the anisotropic parameters for the material.
  116000. */
  116001. readonly anisotropy: PBRAnisotropicConfiguration;
  116002. /**
  116003. * Defines the BRDF parameters for the material.
  116004. */
  116005. readonly brdf: PBRBRDFConfiguration;
  116006. /**
  116007. * Defines the Sheen parameters for the material.
  116008. */
  116009. readonly sheen: PBRSheenConfiguration;
  116010. /**
  116011. * Defines the SubSurface parameters for the material.
  116012. */
  116013. readonly subSurface: PBRSubSurfaceConfiguration;
  116014. /**
  116015. * Custom callback helping to override the default shader used in the material.
  116016. */
  116017. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  116018. protected _rebuildInParallel: boolean;
  116019. /**
  116020. * Instantiates a new PBRMaterial instance.
  116021. *
  116022. * @param name The material name
  116023. * @param scene The scene the material will be use in.
  116024. */
  116025. constructor(name: string, scene: Scene);
  116026. /**
  116027. * Gets a boolean indicating that current material needs to register RTT
  116028. */
  116029. readonly hasRenderTargetTextures: boolean;
  116030. /**
  116031. * Gets the name of the material class.
  116032. */
  116033. getClassName(): string;
  116034. /**
  116035. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  116036. */
  116037. /**
  116038. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  116039. */
  116040. useLogarithmicDepth: boolean;
  116041. /**
  116042. * Gets the current transparency mode.
  116043. */
  116044. /**
  116045. * Sets the transparency mode of the material.
  116046. *
  116047. * | Value | Type | Description |
  116048. * | ----- | ----------------------------------- | ----------- |
  116049. * | 0 | OPAQUE | |
  116050. * | 1 | ALPHATEST | |
  116051. * | 2 | ALPHABLEND | |
  116052. * | 3 | ALPHATESTANDBLEND | |
  116053. *
  116054. */
  116055. transparencyMode: Nullable<number>;
  116056. /**
  116057. * Returns true if alpha blending should be disabled.
  116058. */
  116059. private readonly _disableAlphaBlending;
  116060. /**
  116061. * Specifies whether or not this material should be rendered in alpha blend mode.
  116062. */
  116063. needAlphaBlending(): boolean;
  116064. /**
  116065. * Specifies if the mesh will require alpha blending.
  116066. * @param mesh - BJS mesh.
  116067. */
  116068. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  116069. /**
  116070. * Specifies whether or not this material should be rendered in alpha test mode.
  116071. */
  116072. needAlphaTesting(): boolean;
  116073. /**
  116074. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  116075. */
  116076. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  116077. /**
  116078. * Gets the texture used for the alpha test.
  116079. */
  116080. getAlphaTestTexture(): Nullable<BaseTexture>;
  116081. /**
  116082. * Specifies that the submesh is ready to be used.
  116083. * @param mesh - BJS mesh.
  116084. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  116085. * @param useInstances - Specifies that instances should be used.
  116086. * @returns - boolean indicating that the submesh is ready or not.
  116087. */
  116088. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  116089. /**
  116090. * Specifies if the material uses metallic roughness workflow.
  116091. * @returns boolean specifiying if the material uses metallic roughness workflow.
  116092. */
  116093. isMetallicWorkflow(): boolean;
  116094. private _prepareEffect;
  116095. private _prepareDefines;
  116096. /**
  116097. * Force shader compilation
  116098. */
  116099. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  116100. /**
  116101. * Initializes the uniform buffer layout for the shader.
  116102. */
  116103. buildUniformLayout(): void;
  116104. /**
  116105. * Unbinds the material from the mesh
  116106. */
  116107. unbind(): void;
  116108. /**
  116109. * Binds the submesh data.
  116110. * @param world - The world matrix.
  116111. * @param mesh - The BJS mesh.
  116112. * @param subMesh - A submesh of the BJS mesh.
  116113. */
  116114. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  116115. /**
  116116. * Returns the animatable textures.
  116117. * @returns - Array of animatable textures.
  116118. */
  116119. getAnimatables(): IAnimatable[];
  116120. /**
  116121. * Returns the texture used for reflections.
  116122. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  116123. */
  116124. private _getReflectionTexture;
  116125. /**
  116126. * Returns an array of the actively used textures.
  116127. * @returns - Array of BaseTextures
  116128. */
  116129. getActiveTextures(): BaseTexture[];
  116130. /**
  116131. * Checks to see if a texture is used in the material.
  116132. * @param texture - Base texture to use.
  116133. * @returns - Boolean specifying if a texture is used in the material.
  116134. */
  116135. hasTexture(texture: BaseTexture): boolean;
  116136. /**
  116137. * Disposes the resources of the material.
  116138. * @param forceDisposeEffect - Forces the disposal of effects.
  116139. * @param forceDisposeTextures - Forces the disposal of all textures.
  116140. */
  116141. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  116142. }
  116143. }
  116144. declare module BABYLON {
  116145. /**
  116146. * The Physically based material of BJS.
  116147. *
  116148. * This offers the main features of a standard PBR material.
  116149. * For more information, please refer to the documentation :
  116150. * https://doc.babylonjs.com/how_to/physically_based_rendering
  116151. */
  116152. export class PBRMaterial extends PBRBaseMaterial {
  116153. /**
  116154. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  116155. */
  116156. static readonly PBRMATERIAL_OPAQUE: number;
  116157. /**
  116158. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  116159. */
  116160. static readonly PBRMATERIAL_ALPHATEST: number;
  116161. /**
  116162. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116163. */
  116164. static readonly PBRMATERIAL_ALPHABLEND: number;
  116165. /**
  116166. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116167. * They are also discarded below the alpha cutoff threshold to improve performances.
  116168. */
  116169. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  116170. /**
  116171. * Defines the default value of how much AO map is occluding the analytical lights
  116172. * (point spot...).
  116173. */
  116174. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  116175. /**
  116176. * Intensity of the direct lights e.g. the four lights available in your scene.
  116177. * This impacts both the direct diffuse and specular highlights.
  116178. */
  116179. directIntensity: number;
  116180. /**
  116181. * Intensity of the emissive part of the material.
  116182. * This helps controlling the emissive effect without modifying the emissive color.
  116183. */
  116184. emissiveIntensity: number;
  116185. /**
  116186. * Intensity of the environment e.g. how much the environment will light the object
  116187. * either through harmonics for rough material or through the refelction for shiny ones.
  116188. */
  116189. environmentIntensity: number;
  116190. /**
  116191. * This is a special control allowing the reduction of the specular highlights coming from the
  116192. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  116193. */
  116194. specularIntensity: number;
  116195. /**
  116196. * Debug Control allowing disabling the bump map on this material.
  116197. */
  116198. disableBumpMap: boolean;
  116199. /**
  116200. * AKA Diffuse Texture in standard nomenclature.
  116201. */
  116202. albedoTexture: BaseTexture;
  116203. /**
  116204. * AKA Occlusion Texture in other nomenclature.
  116205. */
  116206. ambientTexture: BaseTexture;
  116207. /**
  116208. * AKA Occlusion Texture Intensity in other nomenclature.
  116209. */
  116210. ambientTextureStrength: number;
  116211. /**
  116212. * Defines how much the AO map is occluding the analytical lights (point spot...).
  116213. * 1 means it completely occludes it
  116214. * 0 mean it has no impact
  116215. */
  116216. ambientTextureImpactOnAnalyticalLights: number;
  116217. /**
  116218. * Stores the alpha values in a texture.
  116219. */
  116220. opacityTexture: BaseTexture;
  116221. /**
  116222. * Stores the reflection values in a texture.
  116223. */
  116224. reflectionTexture: Nullable<BaseTexture>;
  116225. /**
  116226. * Stores the emissive values in a texture.
  116227. */
  116228. emissiveTexture: BaseTexture;
  116229. /**
  116230. * AKA Specular texture in other nomenclature.
  116231. */
  116232. reflectivityTexture: BaseTexture;
  116233. /**
  116234. * Used to switch from specular/glossiness to metallic/roughness workflow.
  116235. */
  116236. metallicTexture: BaseTexture;
  116237. /**
  116238. * Specifies the metallic scalar of the metallic/roughness workflow.
  116239. * Can also be used to scale the metalness values of the metallic texture.
  116240. */
  116241. metallic: Nullable<number>;
  116242. /**
  116243. * Specifies the roughness scalar of the metallic/roughness workflow.
  116244. * Can also be used to scale the roughness values of the metallic texture.
  116245. */
  116246. roughness: Nullable<number>;
  116247. /**
  116248. * Specifies the an F0 factor to help configuring the material F0.
  116249. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  116250. * to 0.5 the previously hard coded value stays the same.
  116251. * Can also be used to scale the F0 values of the metallic texture.
  116252. */
  116253. metallicF0Factor: number;
  116254. /**
  116255. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  116256. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  116257. * your expectation as it multiplies with the texture data.
  116258. */
  116259. useMetallicF0FactorFromMetallicTexture: boolean;
  116260. /**
  116261. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  116262. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  116263. */
  116264. microSurfaceTexture: BaseTexture;
  116265. /**
  116266. * Stores surface normal data used to displace a mesh in a texture.
  116267. */
  116268. bumpTexture: BaseTexture;
  116269. /**
  116270. * Stores the pre-calculated light information of a mesh in a texture.
  116271. */
  116272. lightmapTexture: BaseTexture;
  116273. /**
  116274. * Stores the refracted light information in a texture.
  116275. */
  116276. refractionTexture: Nullable<BaseTexture>;
  116277. /**
  116278. * The color of a material in ambient lighting.
  116279. */
  116280. ambientColor: Color3;
  116281. /**
  116282. * AKA Diffuse Color in other nomenclature.
  116283. */
  116284. albedoColor: Color3;
  116285. /**
  116286. * AKA Specular Color in other nomenclature.
  116287. */
  116288. reflectivityColor: Color3;
  116289. /**
  116290. * The color reflected from the material.
  116291. */
  116292. reflectionColor: Color3;
  116293. /**
  116294. * The color emitted from the material.
  116295. */
  116296. emissiveColor: Color3;
  116297. /**
  116298. * AKA Glossiness in other nomenclature.
  116299. */
  116300. microSurface: number;
  116301. /**
  116302. * source material index of refraction (IOR)' / 'destination material IOR.
  116303. */
  116304. indexOfRefraction: number;
  116305. /**
  116306. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  116307. */
  116308. invertRefractionY: boolean;
  116309. /**
  116310. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  116311. * Materials half opaque for instance using refraction could benefit from this control.
  116312. */
  116313. linkRefractionWithTransparency: boolean;
  116314. /**
  116315. * If true, the light map contains occlusion information instead of lighting info.
  116316. */
  116317. useLightmapAsShadowmap: boolean;
  116318. /**
  116319. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  116320. */
  116321. useAlphaFromAlbedoTexture: boolean;
  116322. /**
  116323. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  116324. */
  116325. forceAlphaTest: boolean;
  116326. /**
  116327. * Defines the alpha limits in alpha test mode.
  116328. */
  116329. alphaCutOff: number;
  116330. /**
  116331. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  116332. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  116333. */
  116334. useSpecularOverAlpha: boolean;
  116335. /**
  116336. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  116337. */
  116338. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  116339. /**
  116340. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  116341. */
  116342. useRoughnessFromMetallicTextureAlpha: boolean;
  116343. /**
  116344. * Specifies if the metallic texture contains the roughness information in its green channel.
  116345. */
  116346. useRoughnessFromMetallicTextureGreen: boolean;
  116347. /**
  116348. * Specifies if the metallic texture contains the metallness information in its blue channel.
  116349. */
  116350. useMetallnessFromMetallicTextureBlue: boolean;
  116351. /**
  116352. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  116353. */
  116354. useAmbientOcclusionFromMetallicTextureRed: boolean;
  116355. /**
  116356. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  116357. */
  116358. useAmbientInGrayScale: boolean;
  116359. /**
  116360. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  116361. * The material will try to infer what glossiness each pixel should be.
  116362. */
  116363. useAutoMicroSurfaceFromReflectivityMap: boolean;
  116364. /**
  116365. * BJS is using an harcoded light falloff based on a manually sets up range.
  116366. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  116367. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  116368. */
  116369. /**
  116370. * BJS is using an harcoded light falloff based on a manually sets up range.
  116371. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  116372. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  116373. */
  116374. usePhysicalLightFalloff: boolean;
  116375. /**
  116376. * In order to support the falloff compatibility with gltf, a special mode has been added
  116377. * to reproduce the gltf light falloff.
  116378. */
  116379. /**
  116380. * In order to support the falloff compatibility with gltf, a special mode has been added
  116381. * to reproduce the gltf light falloff.
  116382. */
  116383. useGLTFLightFalloff: boolean;
  116384. /**
  116385. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  116386. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  116387. */
  116388. useRadianceOverAlpha: boolean;
  116389. /**
  116390. * Allows using an object space normal map (instead of tangent space).
  116391. */
  116392. useObjectSpaceNormalMap: boolean;
  116393. /**
  116394. * Allows using the bump map in parallax mode.
  116395. */
  116396. useParallax: boolean;
  116397. /**
  116398. * Allows using the bump map in parallax occlusion mode.
  116399. */
  116400. useParallaxOcclusion: boolean;
  116401. /**
  116402. * Controls the scale bias of the parallax mode.
  116403. */
  116404. parallaxScaleBias: number;
  116405. /**
  116406. * If sets to true, disables all the lights affecting the material.
  116407. */
  116408. disableLighting: boolean;
  116409. /**
  116410. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  116411. */
  116412. forceIrradianceInFragment: boolean;
  116413. /**
  116414. * Number of Simultaneous lights allowed on the material.
  116415. */
  116416. maxSimultaneousLights: number;
  116417. /**
  116418. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  116419. */
  116420. invertNormalMapX: boolean;
  116421. /**
  116422. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  116423. */
  116424. invertNormalMapY: boolean;
  116425. /**
  116426. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  116427. */
  116428. twoSidedLighting: boolean;
  116429. /**
  116430. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  116431. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  116432. */
  116433. useAlphaFresnel: boolean;
  116434. /**
  116435. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  116436. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  116437. */
  116438. useLinearAlphaFresnel: boolean;
  116439. /**
  116440. * Let user defines the brdf lookup texture used for IBL.
  116441. * A default 8bit version is embedded but you could point at :
  116442. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  116443. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  116444. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  116445. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  116446. */
  116447. environmentBRDFTexture: Nullable<BaseTexture>;
  116448. /**
  116449. * Force normal to face away from face.
  116450. */
  116451. forceNormalForward: boolean;
  116452. /**
  116453. * Enables specular anti aliasing in the PBR shader.
  116454. * It will both interacts on the Geometry for analytical and IBL lighting.
  116455. * It also prefilter the roughness map based on the bump values.
  116456. */
  116457. enableSpecularAntiAliasing: boolean;
  116458. /**
  116459. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  116460. * makes the reflect vector face the model (under horizon).
  116461. */
  116462. useHorizonOcclusion: boolean;
  116463. /**
  116464. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  116465. * too much the area relying on ambient texture to define their ambient occlusion.
  116466. */
  116467. useRadianceOcclusion: boolean;
  116468. /**
  116469. * If set to true, no lighting calculations will be applied.
  116470. */
  116471. unlit: boolean;
  116472. /**
  116473. * Gets the image processing configuration used either in this material.
  116474. */
  116475. /**
  116476. * Sets the Default image processing configuration used either in the this material.
  116477. *
  116478. * If sets to null, the scene one is in use.
  116479. */
  116480. imageProcessingConfiguration: ImageProcessingConfiguration;
  116481. /**
  116482. * Gets wether the color curves effect is enabled.
  116483. */
  116484. /**
  116485. * Sets wether the color curves effect is enabled.
  116486. */
  116487. cameraColorCurvesEnabled: boolean;
  116488. /**
  116489. * Gets wether the color grading effect is enabled.
  116490. */
  116491. /**
  116492. * Gets wether the color grading effect is enabled.
  116493. */
  116494. cameraColorGradingEnabled: boolean;
  116495. /**
  116496. * Gets wether tonemapping is enabled or not.
  116497. */
  116498. /**
  116499. * Sets wether tonemapping is enabled or not
  116500. */
  116501. cameraToneMappingEnabled: boolean;
  116502. /**
  116503. * The camera exposure used on this material.
  116504. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  116505. * This corresponds to a photographic exposure.
  116506. */
  116507. /**
  116508. * The camera exposure used on this material.
  116509. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  116510. * This corresponds to a photographic exposure.
  116511. */
  116512. cameraExposure: number;
  116513. /**
  116514. * Gets The camera contrast used on this material.
  116515. */
  116516. /**
  116517. * Sets The camera contrast used on this material.
  116518. */
  116519. cameraContrast: number;
  116520. /**
  116521. * Gets the Color Grading 2D Lookup Texture.
  116522. */
  116523. /**
  116524. * Sets the Color Grading 2D Lookup Texture.
  116525. */
  116526. cameraColorGradingTexture: Nullable<BaseTexture>;
  116527. /**
  116528. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  116529. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  116530. * 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;
  116531. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  116532. */
  116533. /**
  116534. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  116535. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  116536. * 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;
  116537. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  116538. */
  116539. cameraColorCurves: Nullable<ColorCurves>;
  116540. /**
  116541. * Instantiates a new PBRMaterial instance.
  116542. *
  116543. * @param name The material name
  116544. * @param scene The scene the material will be use in.
  116545. */
  116546. constructor(name: string, scene: Scene);
  116547. /**
  116548. * Returns the name of this material class.
  116549. */
  116550. getClassName(): string;
  116551. /**
  116552. * Makes a duplicate of the current material.
  116553. * @param name - name to use for the new material.
  116554. */
  116555. clone(name: string): PBRMaterial;
  116556. /**
  116557. * Serializes this PBR Material.
  116558. * @returns - An object with the serialized material.
  116559. */
  116560. serialize(): any;
  116561. /**
  116562. * Parses a PBR Material from a serialized object.
  116563. * @param source - Serialized object.
  116564. * @param scene - BJS scene instance.
  116565. * @param rootUrl - url for the scene object
  116566. * @returns - PBRMaterial
  116567. */
  116568. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  116569. }
  116570. }
  116571. declare module BABYLON {
  116572. /**
  116573. * Direct draw surface info
  116574. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  116575. */
  116576. export interface DDSInfo {
  116577. /**
  116578. * Width of the texture
  116579. */
  116580. width: number;
  116581. /**
  116582. * Width of the texture
  116583. */
  116584. height: number;
  116585. /**
  116586. * Number of Mipmaps for the texture
  116587. * @see https://en.wikipedia.org/wiki/Mipmap
  116588. */
  116589. mipmapCount: number;
  116590. /**
  116591. * If the textures format is a known fourCC format
  116592. * @see https://www.fourcc.org/
  116593. */
  116594. isFourCC: boolean;
  116595. /**
  116596. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  116597. */
  116598. isRGB: boolean;
  116599. /**
  116600. * If the texture is a lumincance format
  116601. */
  116602. isLuminance: boolean;
  116603. /**
  116604. * If this is a cube texture
  116605. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  116606. */
  116607. isCube: boolean;
  116608. /**
  116609. * If the texture is a compressed format eg. FOURCC_DXT1
  116610. */
  116611. isCompressed: boolean;
  116612. /**
  116613. * The dxgiFormat of the texture
  116614. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  116615. */
  116616. dxgiFormat: number;
  116617. /**
  116618. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  116619. */
  116620. textureType: number;
  116621. /**
  116622. * Sphericle polynomial created for the dds texture
  116623. */
  116624. sphericalPolynomial?: SphericalPolynomial;
  116625. }
  116626. /**
  116627. * Class used to provide DDS decompression tools
  116628. */
  116629. export class DDSTools {
  116630. /**
  116631. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  116632. */
  116633. static StoreLODInAlphaChannel: boolean;
  116634. /**
  116635. * Gets DDS information from an array buffer
  116636. * @param arrayBuffer defines the array buffer to read data from
  116637. * @returns the DDS information
  116638. */
  116639. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  116640. private static _FloatView;
  116641. private static _Int32View;
  116642. private static _ToHalfFloat;
  116643. private static _FromHalfFloat;
  116644. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  116645. private static _GetHalfFloatRGBAArrayBuffer;
  116646. private static _GetFloatRGBAArrayBuffer;
  116647. private static _GetFloatAsUIntRGBAArrayBuffer;
  116648. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  116649. private static _GetRGBAArrayBuffer;
  116650. private static _ExtractLongWordOrder;
  116651. private static _GetRGBArrayBuffer;
  116652. private static _GetLuminanceArrayBuffer;
  116653. /**
  116654. * Uploads DDS Levels to a Babylon Texture
  116655. * @hidden
  116656. */
  116657. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  116658. }
  116659. interface ThinEngine {
  116660. /**
  116661. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  116662. * @param rootUrl defines the url where the file to load is located
  116663. * @param scene defines the current scene
  116664. * @param lodScale defines scale to apply to the mip map selection
  116665. * @param lodOffset defines offset to apply to the mip map selection
  116666. * @param onLoad defines an optional callback raised when the texture is loaded
  116667. * @param onError defines an optional callback raised if there is an issue to load the texture
  116668. * @param format defines the format of the data
  116669. * @param forcedExtension defines the extension to use to pick the right loader
  116670. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  116671. * @returns the cube texture as an InternalTexture
  116672. */
  116673. 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;
  116674. }
  116675. }
  116676. declare module BABYLON {
  116677. /**
  116678. * Implementation of the DDS Texture Loader.
  116679. * @hidden
  116680. */
  116681. export class _DDSTextureLoader implements IInternalTextureLoader {
  116682. /**
  116683. * Defines wether the loader supports cascade loading the different faces.
  116684. */
  116685. readonly supportCascades: boolean;
  116686. /**
  116687. * This returns if the loader support the current file information.
  116688. * @param extension defines the file extension of the file being loaded
  116689. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116690. * @param fallback defines the fallback internal texture if any
  116691. * @param isBase64 defines whether the texture is encoded as a base64
  116692. * @param isBuffer defines whether the texture data are stored as a buffer
  116693. * @returns true if the loader can load the specified file
  116694. */
  116695. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  116696. /**
  116697. * Transform the url before loading if required.
  116698. * @param rootUrl the url of the texture
  116699. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116700. * @returns the transformed texture
  116701. */
  116702. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  116703. /**
  116704. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  116705. * @param rootUrl the url of the texture
  116706. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116707. * @returns the fallback texture
  116708. */
  116709. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  116710. /**
  116711. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  116712. * @param data contains the texture data
  116713. * @param texture defines the BabylonJS internal texture
  116714. * @param createPolynomials will be true if polynomials have been requested
  116715. * @param onLoad defines the callback to trigger once the texture is ready
  116716. * @param onError defines the callback to trigger in case of error
  116717. */
  116718. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  116719. /**
  116720. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  116721. * @param data contains the texture data
  116722. * @param texture defines the BabylonJS internal texture
  116723. * @param callback defines the method to call once ready to upload
  116724. */
  116725. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  116726. }
  116727. }
  116728. declare module BABYLON {
  116729. /**
  116730. * Implementation of the ENV Texture Loader.
  116731. * @hidden
  116732. */
  116733. export class _ENVTextureLoader implements IInternalTextureLoader {
  116734. /**
  116735. * Defines wether the loader supports cascade loading the different faces.
  116736. */
  116737. readonly supportCascades: boolean;
  116738. /**
  116739. * This returns if the loader support the current file information.
  116740. * @param extension defines the file extension of the file being loaded
  116741. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116742. * @param fallback defines the fallback internal texture if any
  116743. * @param isBase64 defines whether the texture is encoded as a base64
  116744. * @param isBuffer defines whether the texture data are stored as a buffer
  116745. * @returns true if the loader can load the specified file
  116746. */
  116747. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  116748. /**
  116749. * Transform the url before loading if required.
  116750. * @param rootUrl the url of the texture
  116751. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116752. * @returns the transformed texture
  116753. */
  116754. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  116755. /**
  116756. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  116757. * @param rootUrl the url of the texture
  116758. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116759. * @returns the fallback texture
  116760. */
  116761. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  116762. /**
  116763. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  116764. * @param data contains the texture data
  116765. * @param texture defines the BabylonJS internal texture
  116766. * @param createPolynomials will be true if polynomials have been requested
  116767. * @param onLoad defines the callback to trigger once the texture is ready
  116768. * @param onError defines the callback to trigger in case of error
  116769. */
  116770. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  116771. /**
  116772. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  116773. * @param data contains the texture data
  116774. * @param texture defines the BabylonJS internal texture
  116775. * @param callback defines the method to call once ready to upload
  116776. */
  116777. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  116778. }
  116779. }
  116780. declare module BABYLON {
  116781. /**
  116782. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  116783. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  116784. */
  116785. export class KhronosTextureContainer {
  116786. /** contents of the KTX container file */
  116787. arrayBuffer: any;
  116788. private static HEADER_LEN;
  116789. private static COMPRESSED_2D;
  116790. private static COMPRESSED_3D;
  116791. private static TEX_2D;
  116792. private static TEX_3D;
  116793. /**
  116794. * Gets the openGL type
  116795. */
  116796. glType: number;
  116797. /**
  116798. * Gets the openGL type size
  116799. */
  116800. glTypeSize: number;
  116801. /**
  116802. * Gets the openGL format
  116803. */
  116804. glFormat: number;
  116805. /**
  116806. * Gets the openGL internal format
  116807. */
  116808. glInternalFormat: number;
  116809. /**
  116810. * Gets the base internal format
  116811. */
  116812. glBaseInternalFormat: number;
  116813. /**
  116814. * Gets image width in pixel
  116815. */
  116816. pixelWidth: number;
  116817. /**
  116818. * Gets image height in pixel
  116819. */
  116820. pixelHeight: number;
  116821. /**
  116822. * Gets image depth in pixels
  116823. */
  116824. pixelDepth: number;
  116825. /**
  116826. * Gets the number of array elements
  116827. */
  116828. numberOfArrayElements: number;
  116829. /**
  116830. * Gets the number of faces
  116831. */
  116832. numberOfFaces: number;
  116833. /**
  116834. * Gets the number of mipmap levels
  116835. */
  116836. numberOfMipmapLevels: number;
  116837. /**
  116838. * Gets the bytes of key value data
  116839. */
  116840. bytesOfKeyValueData: number;
  116841. /**
  116842. * Gets the load type
  116843. */
  116844. loadType: number;
  116845. /**
  116846. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  116847. */
  116848. isInvalid: boolean;
  116849. /**
  116850. * Creates a new KhronosTextureContainer
  116851. * @param arrayBuffer contents of the KTX container file
  116852. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  116853. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  116854. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  116855. */
  116856. constructor(
  116857. /** contents of the KTX container file */
  116858. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  116859. /**
  116860. * Uploads KTX content to a Babylon Texture.
  116861. * It is assumed that the texture has already been created & is currently bound
  116862. * @hidden
  116863. */
  116864. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  116865. private _upload2DCompressedLevels;
  116866. }
  116867. }
  116868. declare module BABYLON {
  116869. /**
  116870. * Implementation of the KTX Texture Loader.
  116871. * @hidden
  116872. */
  116873. export class _KTXTextureLoader implements IInternalTextureLoader {
  116874. /**
  116875. * Defines wether the loader supports cascade loading the different faces.
  116876. */
  116877. readonly supportCascades: boolean;
  116878. /**
  116879. * This returns if the loader support the current file information.
  116880. * @param extension defines the file extension of the file being loaded
  116881. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116882. * @param fallback defines the fallback internal texture if any
  116883. * @param isBase64 defines whether the texture is encoded as a base64
  116884. * @param isBuffer defines whether the texture data are stored as a buffer
  116885. * @returns true if the loader can load the specified file
  116886. */
  116887. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  116888. /**
  116889. * Transform the url before loading if required.
  116890. * @param rootUrl the url of the texture
  116891. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116892. * @returns the transformed texture
  116893. */
  116894. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  116895. /**
  116896. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  116897. * @param rootUrl the url of the texture
  116898. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116899. * @returns the fallback texture
  116900. */
  116901. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  116902. /**
  116903. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  116904. * @param data contains the texture data
  116905. * @param texture defines the BabylonJS internal texture
  116906. * @param createPolynomials will be true if polynomials have been requested
  116907. * @param onLoad defines the callback to trigger once the texture is ready
  116908. * @param onError defines the callback to trigger in case of error
  116909. */
  116910. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  116911. /**
  116912. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  116913. * @param data contains the texture data
  116914. * @param texture defines the BabylonJS internal texture
  116915. * @param callback defines the method to call once ready to upload
  116916. */
  116917. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  116918. }
  116919. }
  116920. declare module BABYLON {
  116921. /**
  116922. * Options for the default xr helper
  116923. */
  116924. export class WebXRDefaultExperienceOptions {
  116925. /**
  116926. * Floor meshes that should be used for teleporting
  116927. */
  116928. floorMeshes: Array<AbstractMesh>;
  116929. /**
  116930. * Enable or disable default UI to enter XR
  116931. */
  116932. disableDefaultUI: boolean;
  116933. }
  116934. /**
  116935. * Default experience which provides a similar setup to the previous webVRExperience
  116936. */
  116937. export class WebXRDefaultExperience {
  116938. /**
  116939. * Base experience
  116940. */
  116941. baseExperience: WebXRExperienceHelper;
  116942. /**
  116943. * Input experience extension
  116944. */
  116945. input: WebXRInput;
  116946. /**
  116947. * Loads the controller models
  116948. */
  116949. controllerModelLoader: WebXRControllerModelLoader;
  116950. /**
  116951. * Enables laser pointer and selection
  116952. */
  116953. pointerSelection: WebXRControllerPointerSelection;
  116954. /**
  116955. * Enables teleportation
  116956. */
  116957. teleportation: WebXRControllerTeleportation;
  116958. /**
  116959. * Enables ui for enetering/exiting xr
  116960. */
  116961. enterExitUI: WebXREnterExitUI;
  116962. /**
  116963. * Default target xr should render to
  116964. */
  116965. renderTarget: WebXRRenderTarget;
  116966. /**
  116967. * Creates the default xr experience
  116968. * @param scene scene
  116969. * @param options options for basic configuration
  116970. * @returns resulting WebXRDefaultExperience
  116971. */
  116972. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  116973. private constructor();
  116974. /**
  116975. * DIsposes of the experience helper
  116976. */
  116977. dispose(): void;
  116978. }
  116979. }
  116980. declare module BABYLON {
  116981. /** @hidden */
  116982. export var _forceSceneHelpersToBundle: boolean;
  116983. interface Scene {
  116984. /**
  116985. * Creates a default light for the scene.
  116986. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  116987. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  116988. */
  116989. createDefaultLight(replace?: boolean): void;
  116990. /**
  116991. * Creates a default camera for the scene.
  116992. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  116993. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  116994. * @param replace has default false, when true replaces the active camera in the scene
  116995. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  116996. */
  116997. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  116998. /**
  116999. * Creates a default camera and a default light.
  117000. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  117001. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  117002. * @param replace has the default false, when true replaces the active camera/light in the scene
  117003. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  117004. */
  117005. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  117006. /**
  117007. * Creates a new sky box
  117008. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  117009. * @param environmentTexture defines the texture to use as environment texture
  117010. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  117011. * @param scale defines the overall scale of the skybox
  117012. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  117013. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  117014. * @returns a new mesh holding the sky box
  117015. */
  117016. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  117017. /**
  117018. * Creates a new environment
  117019. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  117020. * @param options defines the options you can use to configure the environment
  117021. * @returns the new EnvironmentHelper
  117022. */
  117023. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  117024. /**
  117025. * Creates a new VREXperienceHelper
  117026. * @see http://doc.babylonjs.com/how_to/webvr_helper
  117027. * @param webVROptions defines the options used to create the new VREXperienceHelper
  117028. * @returns a new VREXperienceHelper
  117029. */
  117030. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  117031. /**
  117032. * Creates a new WebXRDefaultExperience
  117033. * @see http://doc.babylonjs.com/how_to/webxr
  117034. * @param options experience options
  117035. * @returns a promise for a new WebXRDefaultExperience
  117036. */
  117037. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  117038. }
  117039. }
  117040. declare module BABYLON {
  117041. /**
  117042. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  117043. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  117044. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  117045. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  117046. */
  117047. export class VideoDome extends TransformNode {
  117048. /**
  117049. * Define the video source as a Monoscopic panoramic 360 video.
  117050. */
  117051. static readonly MODE_MONOSCOPIC: number;
  117052. /**
  117053. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  117054. */
  117055. static readonly MODE_TOPBOTTOM: number;
  117056. /**
  117057. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  117058. */
  117059. static readonly MODE_SIDEBYSIDE: number;
  117060. private _halfDome;
  117061. private _useDirectMapping;
  117062. /**
  117063. * The video texture being displayed on the sphere
  117064. */
  117065. protected _videoTexture: VideoTexture;
  117066. /**
  117067. * Gets the video texture being displayed on the sphere
  117068. */
  117069. readonly videoTexture: VideoTexture;
  117070. /**
  117071. * The skybox material
  117072. */
  117073. protected _material: BackgroundMaterial;
  117074. /**
  117075. * The surface used for the skybox
  117076. */
  117077. protected _mesh: Mesh;
  117078. /**
  117079. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  117080. */
  117081. private _halfDomeMask;
  117082. /**
  117083. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  117084. * Also see the options.resolution property.
  117085. */
  117086. fovMultiplier: number;
  117087. private _videoMode;
  117088. /**
  117089. * Gets or set the current video mode for the video. It can be:
  117090. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  117091. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  117092. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  117093. */
  117094. videoMode: number;
  117095. /**
  117096. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  117097. *
  117098. */
  117099. /**
  117100. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  117101. */
  117102. halfDome: boolean;
  117103. /**
  117104. * Oberserver used in Stereoscopic VR Mode.
  117105. */
  117106. private _onBeforeCameraRenderObserver;
  117107. /**
  117108. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  117109. * @param name Element's name, child elements will append suffixes for their own names.
  117110. * @param urlsOrVideo defines the url(s) or the video element to use
  117111. * @param options An object containing optional or exposed sub element properties
  117112. */
  117113. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  117114. resolution?: number;
  117115. clickToPlay?: boolean;
  117116. autoPlay?: boolean;
  117117. loop?: boolean;
  117118. size?: number;
  117119. poster?: string;
  117120. faceForward?: boolean;
  117121. useDirectMapping?: boolean;
  117122. halfDomeMode?: boolean;
  117123. }, scene: Scene);
  117124. private _changeVideoMode;
  117125. /**
  117126. * Releases resources associated with this node.
  117127. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  117128. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  117129. */
  117130. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  117131. }
  117132. }
  117133. declare module BABYLON {
  117134. /**
  117135. * This class can be used to get instrumentation data from a Babylon engine
  117136. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117137. */
  117138. export class EngineInstrumentation implements IDisposable {
  117139. /**
  117140. * Define the instrumented engine.
  117141. */
  117142. engine: Engine;
  117143. private _captureGPUFrameTime;
  117144. private _gpuFrameTimeToken;
  117145. private _gpuFrameTime;
  117146. private _captureShaderCompilationTime;
  117147. private _shaderCompilationTime;
  117148. private _onBeginFrameObserver;
  117149. private _onEndFrameObserver;
  117150. private _onBeforeShaderCompilationObserver;
  117151. private _onAfterShaderCompilationObserver;
  117152. /**
  117153. * Gets the perf counter used for GPU frame time
  117154. */
  117155. readonly gpuFrameTimeCounter: PerfCounter;
  117156. /**
  117157. * Gets the GPU frame time capture status
  117158. */
  117159. /**
  117160. * Enable or disable the GPU frame time capture
  117161. */
  117162. captureGPUFrameTime: boolean;
  117163. /**
  117164. * Gets the perf counter used for shader compilation time
  117165. */
  117166. readonly shaderCompilationTimeCounter: PerfCounter;
  117167. /**
  117168. * Gets the shader compilation time capture status
  117169. */
  117170. /**
  117171. * Enable or disable the shader compilation time capture
  117172. */
  117173. captureShaderCompilationTime: boolean;
  117174. /**
  117175. * Instantiates a new engine instrumentation.
  117176. * This class can be used to get instrumentation data from a Babylon engine
  117177. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117178. * @param engine Defines the engine to instrument
  117179. */
  117180. constructor(
  117181. /**
  117182. * Define the instrumented engine.
  117183. */
  117184. engine: Engine);
  117185. /**
  117186. * Dispose and release associated resources.
  117187. */
  117188. dispose(): void;
  117189. }
  117190. }
  117191. declare module BABYLON {
  117192. /**
  117193. * This class can be used to get instrumentation data from a Babylon engine
  117194. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  117195. */
  117196. export class SceneInstrumentation implements IDisposable {
  117197. /**
  117198. * Defines the scene to instrument
  117199. */
  117200. scene: Scene;
  117201. private _captureActiveMeshesEvaluationTime;
  117202. private _activeMeshesEvaluationTime;
  117203. private _captureRenderTargetsRenderTime;
  117204. private _renderTargetsRenderTime;
  117205. private _captureFrameTime;
  117206. private _frameTime;
  117207. private _captureRenderTime;
  117208. private _renderTime;
  117209. private _captureInterFrameTime;
  117210. private _interFrameTime;
  117211. private _captureParticlesRenderTime;
  117212. private _particlesRenderTime;
  117213. private _captureSpritesRenderTime;
  117214. private _spritesRenderTime;
  117215. private _capturePhysicsTime;
  117216. private _physicsTime;
  117217. private _captureAnimationsTime;
  117218. private _animationsTime;
  117219. private _captureCameraRenderTime;
  117220. private _cameraRenderTime;
  117221. private _onBeforeActiveMeshesEvaluationObserver;
  117222. private _onAfterActiveMeshesEvaluationObserver;
  117223. private _onBeforeRenderTargetsRenderObserver;
  117224. private _onAfterRenderTargetsRenderObserver;
  117225. private _onAfterRenderObserver;
  117226. private _onBeforeDrawPhaseObserver;
  117227. private _onAfterDrawPhaseObserver;
  117228. private _onBeforeAnimationsObserver;
  117229. private _onBeforeParticlesRenderingObserver;
  117230. private _onAfterParticlesRenderingObserver;
  117231. private _onBeforeSpritesRenderingObserver;
  117232. private _onAfterSpritesRenderingObserver;
  117233. private _onBeforePhysicsObserver;
  117234. private _onAfterPhysicsObserver;
  117235. private _onAfterAnimationsObserver;
  117236. private _onBeforeCameraRenderObserver;
  117237. private _onAfterCameraRenderObserver;
  117238. /**
  117239. * Gets the perf counter used for active meshes evaluation time
  117240. */
  117241. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  117242. /**
  117243. * Gets the active meshes evaluation time capture status
  117244. */
  117245. /**
  117246. * Enable or disable the active meshes evaluation time capture
  117247. */
  117248. captureActiveMeshesEvaluationTime: boolean;
  117249. /**
  117250. * Gets the perf counter used for render targets render time
  117251. */
  117252. readonly renderTargetsRenderTimeCounter: PerfCounter;
  117253. /**
  117254. * Gets the render targets render time capture status
  117255. */
  117256. /**
  117257. * Enable or disable the render targets render time capture
  117258. */
  117259. captureRenderTargetsRenderTime: boolean;
  117260. /**
  117261. * Gets the perf counter used for particles render time
  117262. */
  117263. readonly particlesRenderTimeCounter: PerfCounter;
  117264. /**
  117265. * Gets the particles render time capture status
  117266. */
  117267. /**
  117268. * Enable or disable the particles render time capture
  117269. */
  117270. captureParticlesRenderTime: boolean;
  117271. /**
  117272. * Gets the perf counter used for sprites render time
  117273. */
  117274. readonly spritesRenderTimeCounter: PerfCounter;
  117275. /**
  117276. * Gets the sprites render time capture status
  117277. */
  117278. /**
  117279. * Enable or disable the sprites render time capture
  117280. */
  117281. captureSpritesRenderTime: boolean;
  117282. /**
  117283. * Gets the perf counter used for physics time
  117284. */
  117285. readonly physicsTimeCounter: PerfCounter;
  117286. /**
  117287. * Gets the physics time capture status
  117288. */
  117289. /**
  117290. * Enable or disable the physics time capture
  117291. */
  117292. capturePhysicsTime: boolean;
  117293. /**
  117294. * Gets the perf counter used for animations time
  117295. */
  117296. readonly animationsTimeCounter: PerfCounter;
  117297. /**
  117298. * Gets the animations time capture status
  117299. */
  117300. /**
  117301. * Enable or disable the animations time capture
  117302. */
  117303. captureAnimationsTime: boolean;
  117304. /**
  117305. * Gets the perf counter used for frame time capture
  117306. */
  117307. readonly frameTimeCounter: PerfCounter;
  117308. /**
  117309. * Gets the frame time capture status
  117310. */
  117311. /**
  117312. * Enable or disable the frame time capture
  117313. */
  117314. captureFrameTime: boolean;
  117315. /**
  117316. * Gets the perf counter used for inter-frames time capture
  117317. */
  117318. readonly interFrameTimeCounter: PerfCounter;
  117319. /**
  117320. * Gets the inter-frames time capture status
  117321. */
  117322. /**
  117323. * Enable or disable the inter-frames time capture
  117324. */
  117325. captureInterFrameTime: boolean;
  117326. /**
  117327. * Gets the perf counter used for render time capture
  117328. */
  117329. readonly renderTimeCounter: PerfCounter;
  117330. /**
  117331. * Gets the render time capture status
  117332. */
  117333. /**
  117334. * Enable or disable the render time capture
  117335. */
  117336. captureRenderTime: boolean;
  117337. /**
  117338. * Gets the perf counter used for camera render time capture
  117339. */
  117340. readonly cameraRenderTimeCounter: PerfCounter;
  117341. /**
  117342. * Gets the camera render time capture status
  117343. */
  117344. /**
  117345. * Enable or disable the camera render time capture
  117346. */
  117347. captureCameraRenderTime: boolean;
  117348. /**
  117349. * Gets the perf counter used for draw calls
  117350. */
  117351. readonly drawCallsCounter: PerfCounter;
  117352. /**
  117353. * Instantiates a new scene instrumentation.
  117354. * This class can be used to get instrumentation data from a Babylon engine
  117355. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  117356. * @param scene Defines the scene to instrument
  117357. */
  117358. constructor(
  117359. /**
  117360. * Defines the scene to instrument
  117361. */
  117362. scene: Scene);
  117363. /**
  117364. * Dispose and release associated resources.
  117365. */
  117366. dispose(): void;
  117367. }
  117368. }
  117369. declare module BABYLON {
  117370. /** @hidden */
  117371. export var glowMapGenerationPixelShader: {
  117372. name: string;
  117373. shader: string;
  117374. };
  117375. }
  117376. declare module BABYLON {
  117377. /** @hidden */
  117378. export var glowMapGenerationVertexShader: {
  117379. name: string;
  117380. shader: string;
  117381. };
  117382. }
  117383. declare module BABYLON {
  117384. /**
  117385. * Effect layer options. This helps customizing the behaviour
  117386. * of the effect layer.
  117387. */
  117388. export interface IEffectLayerOptions {
  117389. /**
  117390. * Multiplication factor apply to the canvas size to compute the render target size
  117391. * used to generated the objects (the smaller the faster).
  117392. */
  117393. mainTextureRatio: number;
  117394. /**
  117395. * Enforces a fixed size texture to ensure effect stability across devices.
  117396. */
  117397. mainTextureFixedSize?: number;
  117398. /**
  117399. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  117400. */
  117401. alphaBlendingMode: number;
  117402. /**
  117403. * The camera attached to the layer.
  117404. */
  117405. camera: Nullable<Camera>;
  117406. /**
  117407. * The rendering group to draw the layer in.
  117408. */
  117409. renderingGroupId: number;
  117410. }
  117411. /**
  117412. * The effect layer Helps adding post process effect blended with the main pass.
  117413. *
  117414. * This can be for instance use to generate glow or higlight effects on the scene.
  117415. *
  117416. * The effect layer class can not be used directly and is intented to inherited from to be
  117417. * customized per effects.
  117418. */
  117419. export abstract class EffectLayer {
  117420. private _vertexBuffers;
  117421. private _indexBuffer;
  117422. private _cachedDefines;
  117423. private _effectLayerMapGenerationEffect;
  117424. private _effectLayerOptions;
  117425. private _mergeEffect;
  117426. protected _scene: Scene;
  117427. protected _engine: Engine;
  117428. protected _maxSize: number;
  117429. protected _mainTextureDesiredSize: ISize;
  117430. protected _mainTexture: RenderTargetTexture;
  117431. protected _shouldRender: boolean;
  117432. protected _postProcesses: PostProcess[];
  117433. protected _textures: BaseTexture[];
  117434. protected _emissiveTextureAndColor: {
  117435. texture: Nullable<BaseTexture>;
  117436. color: Color4;
  117437. };
  117438. /**
  117439. * The name of the layer
  117440. */
  117441. name: string;
  117442. /**
  117443. * The clear color of the texture used to generate the glow map.
  117444. */
  117445. neutralColor: Color4;
  117446. /**
  117447. * Specifies wether the highlight layer is enabled or not.
  117448. */
  117449. isEnabled: boolean;
  117450. /**
  117451. * Gets the camera attached to the layer.
  117452. */
  117453. readonly camera: Nullable<Camera>;
  117454. /**
  117455. * Gets the rendering group id the layer should render in.
  117456. */
  117457. renderingGroupId: number;
  117458. /**
  117459. * An event triggered when the effect layer has been disposed.
  117460. */
  117461. onDisposeObservable: Observable<EffectLayer>;
  117462. /**
  117463. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  117464. */
  117465. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  117466. /**
  117467. * An event triggered when the generated texture is being merged in the scene.
  117468. */
  117469. onBeforeComposeObservable: Observable<EffectLayer>;
  117470. /**
  117471. * An event triggered when the mesh is rendered into the effect render target.
  117472. */
  117473. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  117474. /**
  117475. * An event triggered after the mesh has been rendered into the effect render target.
  117476. */
  117477. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  117478. /**
  117479. * An event triggered when the generated texture has been merged in the scene.
  117480. */
  117481. onAfterComposeObservable: Observable<EffectLayer>;
  117482. /**
  117483. * An event triggered when the efffect layer changes its size.
  117484. */
  117485. onSizeChangedObservable: Observable<EffectLayer>;
  117486. /** @hidden */
  117487. static _SceneComponentInitialization: (scene: Scene) => void;
  117488. /**
  117489. * Instantiates a new effect Layer and references it in the scene.
  117490. * @param name The name of the layer
  117491. * @param scene The scene to use the layer in
  117492. */
  117493. constructor(
  117494. /** The Friendly of the effect in the scene */
  117495. name: string, scene: Scene);
  117496. /**
  117497. * Get the effect name of the layer.
  117498. * @return The effect name
  117499. */
  117500. abstract getEffectName(): string;
  117501. /**
  117502. * Checks for the readiness of the element composing the layer.
  117503. * @param subMesh the mesh to check for
  117504. * @param useInstances specify wether or not to use instances to render the mesh
  117505. * @return true if ready otherwise, false
  117506. */
  117507. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  117508. /**
  117509. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  117510. * @returns true if the effect requires stencil during the main canvas render pass.
  117511. */
  117512. abstract needStencil(): boolean;
  117513. /**
  117514. * Create the merge effect. This is the shader use to blit the information back
  117515. * to the main canvas at the end of the scene rendering.
  117516. * @returns The effect containing the shader used to merge the effect on the main canvas
  117517. */
  117518. protected abstract _createMergeEffect(): Effect;
  117519. /**
  117520. * Creates the render target textures and post processes used in the effect layer.
  117521. */
  117522. protected abstract _createTextureAndPostProcesses(): void;
  117523. /**
  117524. * Implementation specific of rendering the generating effect on the main canvas.
  117525. * @param effect The effect used to render through
  117526. */
  117527. protected abstract _internalRender(effect: Effect): void;
  117528. /**
  117529. * Sets the required values for both the emissive texture and and the main color.
  117530. */
  117531. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  117532. /**
  117533. * Free any resources and references associated to a mesh.
  117534. * Internal use
  117535. * @param mesh The mesh to free.
  117536. */
  117537. abstract _disposeMesh(mesh: Mesh): void;
  117538. /**
  117539. * Serializes this layer (Glow or Highlight for example)
  117540. * @returns a serialized layer object
  117541. */
  117542. abstract serialize?(): any;
  117543. /**
  117544. * Initializes the effect layer with the required options.
  117545. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  117546. */
  117547. protected _init(options: Partial<IEffectLayerOptions>): void;
  117548. /**
  117549. * Generates the index buffer of the full screen quad blending to the main canvas.
  117550. */
  117551. private _generateIndexBuffer;
  117552. /**
  117553. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  117554. */
  117555. private _generateVertexBuffer;
  117556. /**
  117557. * Sets the main texture desired size which is the closest power of two
  117558. * of the engine canvas size.
  117559. */
  117560. private _setMainTextureSize;
  117561. /**
  117562. * Creates the main texture for the effect layer.
  117563. */
  117564. protected _createMainTexture(): void;
  117565. /**
  117566. * Adds specific effects defines.
  117567. * @param defines The defines to add specifics to.
  117568. */
  117569. protected _addCustomEffectDefines(defines: string[]): void;
  117570. /**
  117571. * Checks for the readiness of the element composing the layer.
  117572. * @param subMesh the mesh to check for
  117573. * @param useInstances specify wether or not to use instances to render the mesh
  117574. * @param emissiveTexture the associated emissive texture used to generate the glow
  117575. * @return true if ready otherwise, false
  117576. */
  117577. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  117578. /**
  117579. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  117580. */
  117581. render(): void;
  117582. /**
  117583. * Determine if a given mesh will be used in the current effect.
  117584. * @param mesh mesh to test
  117585. * @returns true if the mesh will be used
  117586. */
  117587. hasMesh(mesh: AbstractMesh): boolean;
  117588. /**
  117589. * Returns true if the layer contains information to display, otherwise false.
  117590. * @returns true if the glow layer should be rendered
  117591. */
  117592. shouldRender(): boolean;
  117593. /**
  117594. * Returns true if the mesh should render, otherwise false.
  117595. * @param mesh The mesh to render
  117596. * @returns true if it should render otherwise false
  117597. */
  117598. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  117599. /**
  117600. * Returns true if the mesh can be rendered, otherwise false.
  117601. * @param mesh The mesh to render
  117602. * @param material The material used on the mesh
  117603. * @returns true if it can be rendered otherwise false
  117604. */
  117605. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  117606. /**
  117607. * Returns true if the mesh should render, otherwise false.
  117608. * @param mesh The mesh to render
  117609. * @returns true if it should render otherwise false
  117610. */
  117611. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  117612. /**
  117613. * Renders the submesh passed in parameter to the generation map.
  117614. */
  117615. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  117616. /**
  117617. * Defines wether the current material of the mesh should be use to render the effect.
  117618. * @param mesh defines the current mesh to render
  117619. */
  117620. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  117621. /**
  117622. * Rebuild the required buffers.
  117623. * @hidden Internal use only.
  117624. */
  117625. _rebuild(): void;
  117626. /**
  117627. * Dispose only the render target textures and post process.
  117628. */
  117629. private _disposeTextureAndPostProcesses;
  117630. /**
  117631. * Dispose the highlight layer and free resources.
  117632. */
  117633. dispose(): void;
  117634. /**
  117635. * Gets the class name of the effect layer
  117636. * @returns the string with the class name of the effect layer
  117637. */
  117638. getClassName(): string;
  117639. /**
  117640. * Creates an effect layer from parsed effect layer data
  117641. * @param parsedEffectLayer defines effect layer data
  117642. * @param scene defines the current scene
  117643. * @param rootUrl defines the root URL containing the effect layer information
  117644. * @returns a parsed effect Layer
  117645. */
  117646. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  117647. }
  117648. }
  117649. declare module BABYLON {
  117650. interface AbstractScene {
  117651. /**
  117652. * The list of effect layers (highlights/glow) added to the scene
  117653. * @see http://doc.babylonjs.com/how_to/highlight_layer
  117654. * @see http://doc.babylonjs.com/how_to/glow_layer
  117655. */
  117656. effectLayers: Array<EffectLayer>;
  117657. /**
  117658. * Removes the given effect layer from this scene.
  117659. * @param toRemove defines the effect layer to remove
  117660. * @returns the index of the removed effect layer
  117661. */
  117662. removeEffectLayer(toRemove: EffectLayer): number;
  117663. /**
  117664. * Adds the given effect layer to this scene
  117665. * @param newEffectLayer defines the effect layer to add
  117666. */
  117667. addEffectLayer(newEffectLayer: EffectLayer): void;
  117668. }
  117669. /**
  117670. * Defines the layer scene component responsible to manage any effect layers
  117671. * in a given scene.
  117672. */
  117673. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  117674. /**
  117675. * The component name helpfull to identify the component in the list of scene components.
  117676. */
  117677. readonly name: string;
  117678. /**
  117679. * The scene the component belongs to.
  117680. */
  117681. scene: Scene;
  117682. private _engine;
  117683. private _renderEffects;
  117684. private _needStencil;
  117685. private _previousStencilState;
  117686. /**
  117687. * Creates a new instance of the component for the given scene
  117688. * @param scene Defines the scene to register the component in
  117689. */
  117690. constructor(scene: Scene);
  117691. /**
  117692. * Registers the component in a given scene
  117693. */
  117694. register(): void;
  117695. /**
  117696. * Rebuilds the elements related to this component in case of
  117697. * context lost for instance.
  117698. */
  117699. rebuild(): void;
  117700. /**
  117701. * Serializes the component data to the specified json object
  117702. * @param serializationObject The object to serialize to
  117703. */
  117704. serialize(serializationObject: any): void;
  117705. /**
  117706. * Adds all the elements from the container to the scene
  117707. * @param container the container holding the elements
  117708. */
  117709. addFromContainer(container: AbstractScene): void;
  117710. /**
  117711. * Removes all the elements in the container from the scene
  117712. * @param container contains the elements to remove
  117713. * @param dispose if the removed element should be disposed (default: false)
  117714. */
  117715. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  117716. /**
  117717. * Disposes the component and the associated ressources.
  117718. */
  117719. dispose(): void;
  117720. private _isReadyForMesh;
  117721. private _renderMainTexture;
  117722. private _setStencil;
  117723. private _setStencilBack;
  117724. private _draw;
  117725. private _drawCamera;
  117726. private _drawRenderingGroup;
  117727. }
  117728. }
  117729. declare module BABYLON {
  117730. /** @hidden */
  117731. export var glowMapMergePixelShader: {
  117732. name: string;
  117733. shader: string;
  117734. };
  117735. }
  117736. declare module BABYLON {
  117737. /** @hidden */
  117738. export var glowMapMergeVertexShader: {
  117739. name: string;
  117740. shader: string;
  117741. };
  117742. }
  117743. declare module BABYLON {
  117744. interface AbstractScene {
  117745. /**
  117746. * Return a the first highlight layer of the scene with a given name.
  117747. * @param name The name of the highlight layer to look for.
  117748. * @return The highlight layer if found otherwise null.
  117749. */
  117750. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  117751. }
  117752. /**
  117753. * Glow layer options. This helps customizing the behaviour
  117754. * of the glow layer.
  117755. */
  117756. export interface IGlowLayerOptions {
  117757. /**
  117758. * Multiplication factor apply to the canvas size to compute the render target size
  117759. * used to generated the glowing objects (the smaller the faster).
  117760. */
  117761. mainTextureRatio: number;
  117762. /**
  117763. * Enforces a fixed size texture to ensure resize independant blur.
  117764. */
  117765. mainTextureFixedSize?: number;
  117766. /**
  117767. * How big is the kernel of the blur texture.
  117768. */
  117769. blurKernelSize: number;
  117770. /**
  117771. * The camera attached to the layer.
  117772. */
  117773. camera: Nullable<Camera>;
  117774. /**
  117775. * Enable MSAA by chosing the number of samples.
  117776. */
  117777. mainTextureSamples?: number;
  117778. /**
  117779. * The rendering group to draw the layer in.
  117780. */
  117781. renderingGroupId: number;
  117782. }
  117783. /**
  117784. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  117785. *
  117786. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  117787. *
  117788. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  117789. */
  117790. export class GlowLayer extends EffectLayer {
  117791. /**
  117792. * Effect Name of the layer.
  117793. */
  117794. static readonly EffectName: string;
  117795. /**
  117796. * The default blur kernel size used for the glow.
  117797. */
  117798. static DefaultBlurKernelSize: number;
  117799. /**
  117800. * The default texture size ratio used for the glow.
  117801. */
  117802. static DefaultTextureRatio: number;
  117803. /**
  117804. * Sets the kernel size of the blur.
  117805. */
  117806. /**
  117807. * Gets the kernel size of the blur.
  117808. */
  117809. blurKernelSize: number;
  117810. /**
  117811. * Sets the glow intensity.
  117812. */
  117813. /**
  117814. * Gets the glow intensity.
  117815. */
  117816. intensity: number;
  117817. private _options;
  117818. private _intensity;
  117819. private _horizontalBlurPostprocess1;
  117820. private _verticalBlurPostprocess1;
  117821. private _horizontalBlurPostprocess2;
  117822. private _verticalBlurPostprocess2;
  117823. private _blurTexture1;
  117824. private _blurTexture2;
  117825. private _postProcesses1;
  117826. private _postProcesses2;
  117827. private _includedOnlyMeshes;
  117828. private _excludedMeshes;
  117829. private _meshesUsingTheirOwnMaterials;
  117830. /**
  117831. * Callback used to let the user override the color selection on a per mesh basis
  117832. */
  117833. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  117834. /**
  117835. * Callback used to let the user override the texture selection on a per mesh basis
  117836. */
  117837. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  117838. /**
  117839. * Instantiates a new glow Layer and references it to the scene.
  117840. * @param name The name of the layer
  117841. * @param scene The scene to use the layer in
  117842. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  117843. */
  117844. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  117845. /**
  117846. * Get the effect name of the layer.
  117847. * @return The effect name
  117848. */
  117849. getEffectName(): string;
  117850. /**
  117851. * Create the merge effect. This is the shader use to blit the information back
  117852. * to the main canvas at the end of the scene rendering.
  117853. */
  117854. protected _createMergeEffect(): Effect;
  117855. /**
  117856. * Creates the render target textures and post processes used in the glow layer.
  117857. */
  117858. protected _createTextureAndPostProcesses(): void;
  117859. /**
  117860. * Checks for the readiness of the element composing the layer.
  117861. * @param subMesh the mesh to check for
  117862. * @param useInstances specify wether or not to use instances to render the mesh
  117863. * @param emissiveTexture the associated emissive texture used to generate the glow
  117864. * @return true if ready otherwise, false
  117865. */
  117866. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  117867. /**
  117868. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  117869. */
  117870. needStencil(): boolean;
  117871. /**
  117872. * Returns true if the mesh can be rendered, otherwise false.
  117873. * @param mesh The mesh to render
  117874. * @param material The material used on the mesh
  117875. * @returns true if it can be rendered otherwise false
  117876. */
  117877. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  117878. /**
  117879. * Implementation specific of rendering the generating effect on the main canvas.
  117880. * @param effect The effect used to render through
  117881. */
  117882. protected _internalRender(effect: Effect): void;
  117883. /**
  117884. * Sets the required values for both the emissive texture and and the main color.
  117885. */
  117886. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  117887. /**
  117888. * Returns true if the mesh should render, otherwise false.
  117889. * @param mesh The mesh to render
  117890. * @returns true if it should render otherwise false
  117891. */
  117892. protected _shouldRenderMesh(mesh: Mesh): boolean;
  117893. /**
  117894. * Adds specific effects defines.
  117895. * @param defines The defines to add specifics to.
  117896. */
  117897. protected _addCustomEffectDefines(defines: string[]): void;
  117898. /**
  117899. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  117900. * @param mesh The mesh to exclude from the glow layer
  117901. */
  117902. addExcludedMesh(mesh: Mesh): void;
  117903. /**
  117904. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  117905. * @param mesh The mesh to remove
  117906. */
  117907. removeExcludedMesh(mesh: Mesh): void;
  117908. /**
  117909. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  117910. * @param mesh The mesh to include in the glow layer
  117911. */
  117912. addIncludedOnlyMesh(mesh: Mesh): void;
  117913. /**
  117914. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  117915. * @param mesh The mesh to remove
  117916. */
  117917. removeIncludedOnlyMesh(mesh: Mesh): void;
  117918. /**
  117919. * Determine if a given mesh will be used in the glow layer
  117920. * @param mesh The mesh to test
  117921. * @returns true if the mesh will be highlighted by the current glow layer
  117922. */
  117923. hasMesh(mesh: AbstractMesh): boolean;
  117924. /**
  117925. * Defines wether the current material of the mesh should be use to render the effect.
  117926. * @param mesh defines the current mesh to render
  117927. */
  117928. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  117929. /**
  117930. * Add a mesh to be rendered through its own material and not with emissive only.
  117931. * @param mesh The mesh for which we need to use its material
  117932. */
  117933. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  117934. /**
  117935. * Remove a mesh from being rendered through its own material and not with emissive only.
  117936. * @param mesh The mesh for which we need to not use its material
  117937. */
  117938. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  117939. /**
  117940. * Free any resources and references associated to a mesh.
  117941. * Internal use
  117942. * @param mesh The mesh to free.
  117943. * @hidden
  117944. */
  117945. _disposeMesh(mesh: Mesh): void;
  117946. /**
  117947. * Gets the class name of the effect layer
  117948. * @returns the string with the class name of the effect layer
  117949. */
  117950. getClassName(): string;
  117951. /**
  117952. * Serializes this glow layer
  117953. * @returns a serialized glow layer object
  117954. */
  117955. serialize(): any;
  117956. /**
  117957. * Creates a Glow Layer from parsed glow layer data
  117958. * @param parsedGlowLayer defines glow layer data
  117959. * @param scene defines the current scene
  117960. * @param rootUrl defines the root URL containing the glow layer information
  117961. * @returns a parsed Glow Layer
  117962. */
  117963. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  117964. }
  117965. }
  117966. declare module BABYLON {
  117967. /** @hidden */
  117968. export var glowBlurPostProcessPixelShader: {
  117969. name: string;
  117970. shader: string;
  117971. };
  117972. }
  117973. declare module BABYLON {
  117974. interface AbstractScene {
  117975. /**
  117976. * Return a the first highlight layer of the scene with a given name.
  117977. * @param name The name of the highlight layer to look for.
  117978. * @return The highlight layer if found otherwise null.
  117979. */
  117980. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  117981. }
  117982. /**
  117983. * Highlight layer options. This helps customizing the behaviour
  117984. * of the highlight layer.
  117985. */
  117986. export interface IHighlightLayerOptions {
  117987. /**
  117988. * Multiplication factor apply to the canvas size to compute the render target size
  117989. * used to generated the glowing objects (the smaller the faster).
  117990. */
  117991. mainTextureRatio: number;
  117992. /**
  117993. * Enforces a fixed size texture to ensure resize independant blur.
  117994. */
  117995. mainTextureFixedSize?: number;
  117996. /**
  117997. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  117998. * of the picture to blur (the smaller the faster).
  117999. */
  118000. blurTextureSizeRatio: number;
  118001. /**
  118002. * How big in texel of the blur texture is the vertical blur.
  118003. */
  118004. blurVerticalSize: number;
  118005. /**
  118006. * How big in texel of the blur texture is the horizontal blur.
  118007. */
  118008. blurHorizontalSize: number;
  118009. /**
  118010. * Alpha blending mode used to apply the blur. Default is combine.
  118011. */
  118012. alphaBlendingMode: number;
  118013. /**
  118014. * The camera attached to the layer.
  118015. */
  118016. camera: Nullable<Camera>;
  118017. /**
  118018. * Should we display highlight as a solid stroke?
  118019. */
  118020. isStroke?: boolean;
  118021. /**
  118022. * The rendering group to draw the layer in.
  118023. */
  118024. renderingGroupId: number;
  118025. }
  118026. /**
  118027. * The highlight layer Helps adding a glow effect around a mesh.
  118028. *
  118029. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  118030. * glowy meshes to your scene.
  118031. *
  118032. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  118033. */
  118034. export class HighlightLayer extends EffectLayer {
  118035. name: string;
  118036. /**
  118037. * Effect Name of the highlight layer.
  118038. */
  118039. static readonly EffectName: string;
  118040. /**
  118041. * The neutral color used during the preparation of the glow effect.
  118042. * This is black by default as the blend operation is a blend operation.
  118043. */
  118044. static NeutralColor: Color4;
  118045. /**
  118046. * Stencil value used for glowing meshes.
  118047. */
  118048. static GlowingMeshStencilReference: number;
  118049. /**
  118050. * Stencil value used for the other meshes in the scene.
  118051. */
  118052. static NormalMeshStencilReference: number;
  118053. /**
  118054. * Specifies whether or not the inner glow is ACTIVE in the layer.
  118055. */
  118056. innerGlow: boolean;
  118057. /**
  118058. * Specifies whether or not the outer glow is ACTIVE in the layer.
  118059. */
  118060. outerGlow: boolean;
  118061. /**
  118062. * Specifies the horizontal size of the blur.
  118063. */
  118064. /**
  118065. * Gets the horizontal size of the blur.
  118066. */
  118067. blurHorizontalSize: number;
  118068. /**
  118069. * Specifies the vertical size of the blur.
  118070. */
  118071. /**
  118072. * Gets the vertical size of the blur.
  118073. */
  118074. blurVerticalSize: number;
  118075. /**
  118076. * An event triggered when the highlight layer is being blurred.
  118077. */
  118078. onBeforeBlurObservable: Observable<HighlightLayer>;
  118079. /**
  118080. * An event triggered when the highlight layer has been blurred.
  118081. */
  118082. onAfterBlurObservable: Observable<HighlightLayer>;
  118083. private _instanceGlowingMeshStencilReference;
  118084. private _options;
  118085. private _downSamplePostprocess;
  118086. private _horizontalBlurPostprocess;
  118087. private _verticalBlurPostprocess;
  118088. private _blurTexture;
  118089. private _meshes;
  118090. private _excludedMeshes;
  118091. /**
  118092. * Instantiates a new highlight Layer and references it to the scene..
  118093. * @param name The name of the layer
  118094. * @param scene The scene to use the layer in
  118095. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  118096. */
  118097. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  118098. /**
  118099. * Get the effect name of the layer.
  118100. * @return The effect name
  118101. */
  118102. getEffectName(): string;
  118103. /**
  118104. * Create the merge effect. This is the shader use to blit the information back
  118105. * to the main canvas at the end of the scene rendering.
  118106. */
  118107. protected _createMergeEffect(): Effect;
  118108. /**
  118109. * Creates the render target textures and post processes used in the highlight layer.
  118110. */
  118111. protected _createTextureAndPostProcesses(): void;
  118112. /**
  118113. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  118114. */
  118115. needStencil(): boolean;
  118116. /**
  118117. * Checks for the readiness of the element composing the layer.
  118118. * @param subMesh the mesh to check for
  118119. * @param useInstances specify wether or not to use instances to render the mesh
  118120. * @param emissiveTexture the associated emissive texture used to generate the glow
  118121. * @return true if ready otherwise, false
  118122. */
  118123. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  118124. /**
  118125. * Implementation specific of rendering the generating effect on the main canvas.
  118126. * @param effect The effect used to render through
  118127. */
  118128. protected _internalRender(effect: Effect): void;
  118129. /**
  118130. * Returns true if the layer contains information to display, otherwise false.
  118131. */
  118132. shouldRender(): boolean;
  118133. /**
  118134. * Returns true if the mesh should render, otherwise false.
  118135. * @param mesh The mesh to render
  118136. * @returns true if it should render otherwise false
  118137. */
  118138. protected _shouldRenderMesh(mesh: Mesh): boolean;
  118139. /**
  118140. * Sets the required values for both the emissive texture and and the main color.
  118141. */
  118142. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  118143. /**
  118144. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  118145. * @param mesh The mesh to exclude from the highlight layer
  118146. */
  118147. addExcludedMesh(mesh: Mesh): void;
  118148. /**
  118149. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  118150. * @param mesh The mesh to highlight
  118151. */
  118152. removeExcludedMesh(mesh: Mesh): void;
  118153. /**
  118154. * Determine if a given mesh will be highlighted by the current HighlightLayer
  118155. * @param mesh mesh to test
  118156. * @returns true if the mesh will be highlighted by the current HighlightLayer
  118157. */
  118158. hasMesh(mesh: AbstractMesh): boolean;
  118159. /**
  118160. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  118161. * @param mesh The mesh to highlight
  118162. * @param color The color of the highlight
  118163. * @param glowEmissiveOnly Extract the glow from the emissive texture
  118164. */
  118165. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  118166. /**
  118167. * Remove a mesh from the highlight layer in order to make it stop glowing.
  118168. * @param mesh The mesh to highlight
  118169. */
  118170. removeMesh(mesh: Mesh): void;
  118171. /**
  118172. * Force the stencil to the normal expected value for none glowing parts
  118173. */
  118174. private _defaultStencilReference;
  118175. /**
  118176. * Free any resources and references associated to a mesh.
  118177. * Internal use
  118178. * @param mesh The mesh to free.
  118179. * @hidden
  118180. */
  118181. _disposeMesh(mesh: Mesh): void;
  118182. /**
  118183. * Dispose the highlight layer and free resources.
  118184. */
  118185. dispose(): void;
  118186. /**
  118187. * Gets the class name of the effect layer
  118188. * @returns the string with the class name of the effect layer
  118189. */
  118190. getClassName(): string;
  118191. /**
  118192. * Serializes this Highlight layer
  118193. * @returns a serialized Highlight layer object
  118194. */
  118195. serialize(): any;
  118196. /**
  118197. * Creates a Highlight layer from parsed Highlight layer data
  118198. * @param parsedHightlightLayer defines the Highlight layer data
  118199. * @param scene defines the current scene
  118200. * @param rootUrl defines the root URL containing the Highlight layer information
  118201. * @returns a parsed Highlight layer
  118202. */
  118203. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  118204. }
  118205. }
  118206. declare module BABYLON {
  118207. interface AbstractScene {
  118208. /**
  118209. * The list of layers (background and foreground) of the scene
  118210. */
  118211. layers: Array<Layer>;
  118212. }
  118213. /**
  118214. * Defines the layer scene component responsible to manage any layers
  118215. * in a given scene.
  118216. */
  118217. export class LayerSceneComponent implements ISceneComponent {
  118218. /**
  118219. * The component name helpfull to identify the component in the list of scene components.
  118220. */
  118221. readonly name: string;
  118222. /**
  118223. * The scene the component belongs to.
  118224. */
  118225. scene: Scene;
  118226. private _engine;
  118227. /**
  118228. * Creates a new instance of the component for the given scene
  118229. * @param scene Defines the scene to register the component in
  118230. */
  118231. constructor(scene: Scene);
  118232. /**
  118233. * Registers the component in a given scene
  118234. */
  118235. register(): void;
  118236. /**
  118237. * Rebuilds the elements related to this component in case of
  118238. * context lost for instance.
  118239. */
  118240. rebuild(): void;
  118241. /**
  118242. * Disposes the component and the associated ressources.
  118243. */
  118244. dispose(): void;
  118245. private _draw;
  118246. private _drawCameraPredicate;
  118247. private _drawCameraBackground;
  118248. private _drawCameraForeground;
  118249. private _drawRenderTargetPredicate;
  118250. private _drawRenderTargetBackground;
  118251. private _drawRenderTargetForeground;
  118252. /**
  118253. * Adds all the elements from the container to the scene
  118254. * @param container the container holding the elements
  118255. */
  118256. addFromContainer(container: AbstractScene): void;
  118257. /**
  118258. * Removes all the elements in the container from the scene
  118259. * @param container contains the elements to remove
  118260. * @param dispose if the removed element should be disposed (default: false)
  118261. */
  118262. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  118263. }
  118264. }
  118265. declare module BABYLON {
  118266. /** @hidden */
  118267. export var layerPixelShader: {
  118268. name: string;
  118269. shader: string;
  118270. };
  118271. }
  118272. declare module BABYLON {
  118273. /** @hidden */
  118274. export var layerVertexShader: {
  118275. name: string;
  118276. shader: string;
  118277. };
  118278. }
  118279. declare module BABYLON {
  118280. /**
  118281. * This represents a full screen 2d layer.
  118282. * This can be useful to display a picture in the background of your scene for instance.
  118283. * @see https://www.babylonjs-playground.com/#08A2BS#1
  118284. */
  118285. export class Layer {
  118286. /**
  118287. * Define the name of the layer.
  118288. */
  118289. name: string;
  118290. /**
  118291. * Define the texture the layer should display.
  118292. */
  118293. texture: Nullable<Texture>;
  118294. /**
  118295. * Is the layer in background or foreground.
  118296. */
  118297. isBackground: boolean;
  118298. /**
  118299. * Define the color of the layer (instead of texture).
  118300. */
  118301. color: Color4;
  118302. /**
  118303. * Define the scale of the layer in order to zoom in out of the texture.
  118304. */
  118305. scale: Vector2;
  118306. /**
  118307. * Define an offset for the layer in order to shift the texture.
  118308. */
  118309. offset: Vector2;
  118310. /**
  118311. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  118312. */
  118313. alphaBlendingMode: number;
  118314. /**
  118315. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  118316. * Alpha test will not mix with the background color in case of transparency.
  118317. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  118318. */
  118319. alphaTest: boolean;
  118320. /**
  118321. * Define a mask to restrict the layer to only some of the scene cameras.
  118322. */
  118323. layerMask: number;
  118324. /**
  118325. * Define the list of render target the layer is visible into.
  118326. */
  118327. renderTargetTextures: RenderTargetTexture[];
  118328. /**
  118329. * Define if the layer is only used in renderTarget or if it also
  118330. * renders in the main frame buffer of the canvas.
  118331. */
  118332. renderOnlyInRenderTargetTextures: boolean;
  118333. private _scene;
  118334. private _vertexBuffers;
  118335. private _indexBuffer;
  118336. private _effect;
  118337. private _alphaTestEffect;
  118338. /**
  118339. * An event triggered when the layer is disposed.
  118340. */
  118341. onDisposeObservable: Observable<Layer>;
  118342. private _onDisposeObserver;
  118343. /**
  118344. * Back compatibility with callback before the onDisposeObservable existed.
  118345. * The set callback will be triggered when the layer has been disposed.
  118346. */
  118347. onDispose: () => void;
  118348. /**
  118349. * An event triggered before rendering the scene
  118350. */
  118351. onBeforeRenderObservable: Observable<Layer>;
  118352. private _onBeforeRenderObserver;
  118353. /**
  118354. * Back compatibility with callback before the onBeforeRenderObservable existed.
  118355. * The set callback will be triggered just before rendering the layer.
  118356. */
  118357. onBeforeRender: () => void;
  118358. /**
  118359. * An event triggered after rendering the scene
  118360. */
  118361. onAfterRenderObservable: Observable<Layer>;
  118362. private _onAfterRenderObserver;
  118363. /**
  118364. * Back compatibility with callback before the onAfterRenderObservable existed.
  118365. * The set callback will be triggered just after rendering the layer.
  118366. */
  118367. onAfterRender: () => void;
  118368. /**
  118369. * Instantiates a new layer.
  118370. * This represents a full screen 2d layer.
  118371. * This can be useful to display a picture in the background of your scene for instance.
  118372. * @see https://www.babylonjs-playground.com/#08A2BS#1
  118373. * @param name Define the name of the layer in the scene
  118374. * @param imgUrl Define the url of the texture to display in the layer
  118375. * @param scene Define the scene the layer belongs to
  118376. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  118377. * @param color Defines a color for the layer
  118378. */
  118379. constructor(
  118380. /**
  118381. * Define the name of the layer.
  118382. */
  118383. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  118384. private _createIndexBuffer;
  118385. /** @hidden */
  118386. _rebuild(): void;
  118387. /**
  118388. * Renders the layer in the scene.
  118389. */
  118390. render(): void;
  118391. /**
  118392. * Disposes and releases the associated ressources.
  118393. */
  118394. dispose(): void;
  118395. }
  118396. }
  118397. declare module BABYLON {
  118398. /** @hidden */
  118399. export var lensFlarePixelShader: {
  118400. name: string;
  118401. shader: string;
  118402. };
  118403. }
  118404. declare module BABYLON {
  118405. /** @hidden */
  118406. export var lensFlareVertexShader: {
  118407. name: string;
  118408. shader: string;
  118409. };
  118410. }
  118411. declare module BABYLON {
  118412. /**
  118413. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  118414. * It is usually composed of several `lensFlare`.
  118415. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118416. */
  118417. export class LensFlareSystem {
  118418. /**
  118419. * Define the name of the lens flare system
  118420. */
  118421. name: string;
  118422. /**
  118423. * List of lens flares used in this system.
  118424. */
  118425. lensFlares: LensFlare[];
  118426. /**
  118427. * Define a limit from the border the lens flare can be visible.
  118428. */
  118429. borderLimit: number;
  118430. /**
  118431. * Define a viewport border we do not want to see the lens flare in.
  118432. */
  118433. viewportBorder: number;
  118434. /**
  118435. * Define a predicate which could limit the list of meshes able to occlude the effect.
  118436. */
  118437. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  118438. /**
  118439. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  118440. */
  118441. layerMask: number;
  118442. /**
  118443. * Define the id of the lens flare system in the scene.
  118444. * (equal to name by default)
  118445. */
  118446. id: string;
  118447. private _scene;
  118448. private _emitter;
  118449. private _vertexBuffers;
  118450. private _indexBuffer;
  118451. private _effect;
  118452. private _positionX;
  118453. private _positionY;
  118454. private _isEnabled;
  118455. /** @hidden */
  118456. static _SceneComponentInitialization: (scene: Scene) => void;
  118457. /**
  118458. * Instantiates a lens flare system.
  118459. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  118460. * It is usually composed of several `lensFlare`.
  118461. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118462. * @param name Define the name of the lens flare system in the scene
  118463. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  118464. * @param scene Define the scene the lens flare system belongs to
  118465. */
  118466. constructor(
  118467. /**
  118468. * Define the name of the lens flare system
  118469. */
  118470. name: string, emitter: any, scene: Scene);
  118471. /**
  118472. * Define if the lens flare system is enabled.
  118473. */
  118474. isEnabled: boolean;
  118475. /**
  118476. * Get the scene the effects belongs to.
  118477. * @returns the scene holding the lens flare system
  118478. */
  118479. getScene(): Scene;
  118480. /**
  118481. * Get the emitter of the lens flare system.
  118482. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  118483. * @returns the emitter of the lens flare system
  118484. */
  118485. getEmitter(): any;
  118486. /**
  118487. * Set the emitter of the lens flare system.
  118488. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  118489. * @param newEmitter Define the new emitter of the system
  118490. */
  118491. setEmitter(newEmitter: any): void;
  118492. /**
  118493. * Get the lens flare system emitter position.
  118494. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  118495. * @returns the position
  118496. */
  118497. getEmitterPosition(): Vector3;
  118498. /**
  118499. * @hidden
  118500. */
  118501. computeEffectivePosition(globalViewport: Viewport): boolean;
  118502. /** @hidden */
  118503. _isVisible(): boolean;
  118504. /**
  118505. * @hidden
  118506. */
  118507. render(): boolean;
  118508. /**
  118509. * Dispose and release the lens flare with its associated resources.
  118510. */
  118511. dispose(): void;
  118512. /**
  118513. * Parse a lens flare system from a JSON repressentation
  118514. * @param parsedLensFlareSystem Define the JSON to parse
  118515. * @param scene Define the scene the parsed system should be instantiated in
  118516. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  118517. * @returns the parsed system
  118518. */
  118519. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  118520. /**
  118521. * Serialize the current Lens Flare System into a JSON representation.
  118522. * @returns the serialized JSON
  118523. */
  118524. serialize(): any;
  118525. }
  118526. }
  118527. declare module BABYLON {
  118528. /**
  118529. * This represents one of the lens effect in a `lensFlareSystem`.
  118530. * It controls one of the indiviual texture used in the effect.
  118531. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118532. */
  118533. export class LensFlare {
  118534. /**
  118535. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  118536. */
  118537. size: number;
  118538. /**
  118539. * 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.
  118540. */
  118541. position: number;
  118542. /**
  118543. * Define the lens color.
  118544. */
  118545. color: Color3;
  118546. /**
  118547. * Define the lens texture.
  118548. */
  118549. texture: Nullable<Texture>;
  118550. /**
  118551. * Define the alpha mode to render this particular lens.
  118552. */
  118553. alphaMode: number;
  118554. private _system;
  118555. /**
  118556. * Creates a new Lens Flare.
  118557. * This represents one of the lens effect in a `lensFlareSystem`.
  118558. * It controls one of the indiviual texture used in the effect.
  118559. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118560. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  118561. * @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.
  118562. * @param color Define the lens color
  118563. * @param imgUrl Define the lens texture url
  118564. * @param system Define the `lensFlareSystem` this flare is part of
  118565. * @returns The newly created Lens Flare
  118566. */
  118567. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  118568. /**
  118569. * Instantiates a new Lens Flare.
  118570. * This represents one of the lens effect in a `lensFlareSystem`.
  118571. * It controls one of the indiviual texture used in the effect.
  118572. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118573. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  118574. * @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.
  118575. * @param color Define the lens color
  118576. * @param imgUrl Define the lens texture url
  118577. * @param system Define the `lensFlareSystem` this flare is part of
  118578. */
  118579. constructor(
  118580. /**
  118581. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  118582. */
  118583. size: number,
  118584. /**
  118585. * 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.
  118586. */
  118587. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  118588. /**
  118589. * Dispose and release the lens flare with its associated resources.
  118590. */
  118591. dispose(): void;
  118592. }
  118593. }
  118594. declare module BABYLON {
  118595. interface AbstractScene {
  118596. /**
  118597. * The list of lens flare system added to the scene
  118598. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118599. */
  118600. lensFlareSystems: Array<LensFlareSystem>;
  118601. /**
  118602. * Removes the given lens flare system from this scene.
  118603. * @param toRemove The lens flare system to remove
  118604. * @returns The index of the removed lens flare system
  118605. */
  118606. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  118607. /**
  118608. * Adds the given lens flare system to this scene
  118609. * @param newLensFlareSystem The lens flare system to add
  118610. */
  118611. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  118612. /**
  118613. * Gets a lens flare system using its name
  118614. * @param name defines the name to look for
  118615. * @returns the lens flare system or null if not found
  118616. */
  118617. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  118618. /**
  118619. * Gets a lens flare system using its id
  118620. * @param id defines the id to look for
  118621. * @returns the lens flare system or null if not found
  118622. */
  118623. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  118624. }
  118625. /**
  118626. * Defines the lens flare scene component responsible to manage any lens flares
  118627. * in a given scene.
  118628. */
  118629. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  118630. /**
  118631. * The component name helpfull to identify the component in the list of scene components.
  118632. */
  118633. readonly name: string;
  118634. /**
  118635. * The scene the component belongs to.
  118636. */
  118637. scene: Scene;
  118638. /**
  118639. * Creates a new instance of the component for the given scene
  118640. * @param scene Defines the scene to register the component in
  118641. */
  118642. constructor(scene: Scene);
  118643. /**
  118644. * Registers the component in a given scene
  118645. */
  118646. register(): void;
  118647. /**
  118648. * Rebuilds the elements related to this component in case of
  118649. * context lost for instance.
  118650. */
  118651. rebuild(): void;
  118652. /**
  118653. * Adds all the elements from the container to the scene
  118654. * @param container the container holding the elements
  118655. */
  118656. addFromContainer(container: AbstractScene): void;
  118657. /**
  118658. * Removes all the elements in the container from the scene
  118659. * @param container contains the elements to remove
  118660. * @param dispose if the removed element should be disposed (default: false)
  118661. */
  118662. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  118663. /**
  118664. * Serializes the component data to the specified json object
  118665. * @param serializationObject The object to serialize to
  118666. */
  118667. serialize(serializationObject: any): void;
  118668. /**
  118669. * Disposes the component and the associated ressources.
  118670. */
  118671. dispose(): void;
  118672. private _draw;
  118673. }
  118674. }
  118675. declare module BABYLON {
  118676. /**
  118677. * Defines the shadow generator component responsible to manage any shadow generators
  118678. * in a given scene.
  118679. */
  118680. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  118681. /**
  118682. * The component name helpfull to identify the component in the list of scene components.
  118683. */
  118684. readonly name: string;
  118685. /**
  118686. * The scene the component belongs to.
  118687. */
  118688. scene: Scene;
  118689. /**
  118690. * Creates a new instance of the component for the given scene
  118691. * @param scene Defines the scene to register the component in
  118692. */
  118693. constructor(scene: Scene);
  118694. /**
  118695. * Registers the component in a given scene
  118696. */
  118697. register(): void;
  118698. /**
  118699. * Rebuilds the elements related to this component in case of
  118700. * context lost for instance.
  118701. */
  118702. rebuild(): void;
  118703. /**
  118704. * Serializes the component data to the specified json object
  118705. * @param serializationObject The object to serialize to
  118706. */
  118707. serialize(serializationObject: any): void;
  118708. /**
  118709. * Adds all the elements from the container to the scene
  118710. * @param container the container holding the elements
  118711. */
  118712. addFromContainer(container: AbstractScene): void;
  118713. /**
  118714. * Removes all the elements in the container from the scene
  118715. * @param container contains the elements to remove
  118716. * @param dispose if the removed element should be disposed (default: false)
  118717. */
  118718. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  118719. /**
  118720. * Rebuilds the elements related to this component in case of
  118721. * context lost for instance.
  118722. */
  118723. dispose(): void;
  118724. private _gatherRenderTargets;
  118725. }
  118726. }
  118727. declare module BABYLON {
  118728. /**
  118729. * A point light is a light defined by an unique point in world space.
  118730. * The light is emitted in every direction from this point.
  118731. * A good example of a point light is a standard light bulb.
  118732. * Documentation: https://doc.babylonjs.com/babylon101/lights
  118733. */
  118734. export class PointLight extends ShadowLight {
  118735. private _shadowAngle;
  118736. /**
  118737. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  118738. * This specifies what angle the shadow will use to be created.
  118739. *
  118740. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  118741. */
  118742. /**
  118743. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  118744. * This specifies what angle the shadow will use to be created.
  118745. *
  118746. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  118747. */
  118748. shadowAngle: number;
  118749. /**
  118750. * Gets the direction if it has been set.
  118751. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  118752. */
  118753. /**
  118754. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  118755. */
  118756. direction: Vector3;
  118757. /**
  118758. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  118759. * A PointLight emits the light in every direction.
  118760. * It can cast shadows.
  118761. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  118762. * ```javascript
  118763. * var pointLight = new PointLight("pl", camera.position, scene);
  118764. * ```
  118765. * Documentation : https://doc.babylonjs.com/babylon101/lights
  118766. * @param name The light friendly name
  118767. * @param position The position of the point light in the scene
  118768. * @param scene The scene the lights belongs to
  118769. */
  118770. constructor(name: string, position: Vector3, scene: Scene);
  118771. /**
  118772. * Returns the string "PointLight"
  118773. * @returns the class name
  118774. */
  118775. getClassName(): string;
  118776. /**
  118777. * Returns the integer 0.
  118778. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  118779. */
  118780. getTypeID(): number;
  118781. /**
  118782. * Specifies wether or not the shadowmap should be a cube texture.
  118783. * @returns true if the shadowmap needs to be a cube texture.
  118784. */
  118785. needCube(): boolean;
  118786. /**
  118787. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  118788. * @param faceIndex The index of the face we are computed the direction to generate shadow
  118789. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  118790. */
  118791. getShadowDirection(faceIndex?: number): Vector3;
  118792. /**
  118793. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  118794. * - fov = PI / 2
  118795. * - aspect ratio : 1.0
  118796. * - z-near and far equal to the active camera minZ and maxZ.
  118797. * Returns the PointLight.
  118798. */
  118799. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  118800. protected _buildUniformLayout(): void;
  118801. /**
  118802. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  118803. * @param effect The effect to update
  118804. * @param lightIndex The index of the light in the effect to update
  118805. * @returns The point light
  118806. */
  118807. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  118808. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  118809. /**
  118810. * Prepares the list of defines specific to the light type.
  118811. * @param defines the list of defines
  118812. * @param lightIndex defines the index of the light for the effect
  118813. */
  118814. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  118815. }
  118816. }
  118817. declare module BABYLON {
  118818. /**
  118819. * Header information of HDR texture files.
  118820. */
  118821. export interface HDRInfo {
  118822. /**
  118823. * The height of the texture in pixels.
  118824. */
  118825. height: number;
  118826. /**
  118827. * The width of the texture in pixels.
  118828. */
  118829. width: number;
  118830. /**
  118831. * The index of the beginning of the data in the binary file.
  118832. */
  118833. dataPosition: number;
  118834. }
  118835. /**
  118836. * This groups tools to convert HDR texture to native colors array.
  118837. */
  118838. export class HDRTools {
  118839. private static Ldexp;
  118840. private static Rgbe2float;
  118841. private static readStringLine;
  118842. /**
  118843. * Reads header information from an RGBE texture stored in a native array.
  118844. * More information on this format are available here:
  118845. * https://en.wikipedia.org/wiki/RGBE_image_format
  118846. *
  118847. * @param uint8array The binary file stored in native array.
  118848. * @return The header information.
  118849. */
  118850. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  118851. /**
  118852. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  118853. * This RGBE texture needs to store the information as a panorama.
  118854. *
  118855. * More information on this format are available here:
  118856. * https://en.wikipedia.org/wiki/RGBE_image_format
  118857. *
  118858. * @param buffer The binary file stored in an array buffer.
  118859. * @param size The expected size of the extracted cubemap.
  118860. * @return The Cube Map information.
  118861. */
  118862. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  118863. /**
  118864. * Returns the pixels data extracted from an RGBE texture.
  118865. * This pixels will be stored left to right up to down in the R G B order in one array.
  118866. *
  118867. * More information on this format are available here:
  118868. * https://en.wikipedia.org/wiki/RGBE_image_format
  118869. *
  118870. * @param uint8array The binary file stored in an array buffer.
  118871. * @param hdrInfo The header information of the file.
  118872. * @return The pixels data in RGB right to left up to down order.
  118873. */
  118874. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  118875. private static RGBE_ReadPixels_RLE;
  118876. }
  118877. }
  118878. declare module BABYLON {
  118879. /**
  118880. * This represents a texture coming from an HDR input.
  118881. *
  118882. * The only supported format is currently panorama picture stored in RGBE format.
  118883. * Example of such files can be found on HDRLib: http://hdrlib.com/
  118884. */
  118885. export class HDRCubeTexture extends BaseTexture {
  118886. private static _facesMapping;
  118887. private _generateHarmonics;
  118888. private _noMipmap;
  118889. private _textureMatrix;
  118890. private _size;
  118891. private _onLoad;
  118892. private _onError;
  118893. /**
  118894. * The texture URL.
  118895. */
  118896. url: string;
  118897. /**
  118898. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  118899. */
  118900. coordinatesMode: number;
  118901. protected _isBlocking: boolean;
  118902. /**
  118903. * Sets wether or not the texture is blocking during loading.
  118904. */
  118905. /**
  118906. * Gets wether or not the texture is blocking during loading.
  118907. */
  118908. isBlocking: boolean;
  118909. protected _rotationY: number;
  118910. /**
  118911. * Sets texture matrix rotation angle around Y axis in radians.
  118912. */
  118913. /**
  118914. * Gets texture matrix rotation angle around Y axis radians.
  118915. */
  118916. rotationY: number;
  118917. /**
  118918. * Gets or sets the center of the bounding box associated with the cube texture
  118919. * It must define where the camera used to render the texture was set
  118920. */
  118921. boundingBoxPosition: Vector3;
  118922. private _boundingBoxSize;
  118923. /**
  118924. * Gets or sets the size of the bounding box associated with the cube texture
  118925. * When defined, the cubemap will switch to local mode
  118926. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  118927. * @example https://www.babylonjs-playground.com/#RNASML
  118928. */
  118929. boundingBoxSize: Vector3;
  118930. /**
  118931. * Instantiates an HDRTexture from the following parameters.
  118932. *
  118933. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  118934. * @param scene The scene the texture will be used in
  118935. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  118936. * @param noMipmap Forces to not generate the mipmap if true
  118937. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  118938. * @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)
  118939. * @param reserved Reserved flag for internal use.
  118940. */
  118941. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  118942. /**
  118943. * Get the current class name of the texture useful for serialization or dynamic coding.
  118944. * @returns "HDRCubeTexture"
  118945. */
  118946. getClassName(): string;
  118947. /**
  118948. * Occurs when the file is raw .hdr file.
  118949. */
  118950. private loadTexture;
  118951. clone(): HDRCubeTexture;
  118952. delayLoad(): void;
  118953. /**
  118954. * Get the texture reflection matrix used to rotate/transform the reflection.
  118955. * @returns the reflection matrix
  118956. */
  118957. getReflectionTextureMatrix(): Matrix;
  118958. /**
  118959. * Set the texture reflection matrix used to rotate/transform the reflection.
  118960. * @param value Define the reflection matrix to set
  118961. */
  118962. setReflectionTextureMatrix(value: Matrix): void;
  118963. /**
  118964. * Parses a JSON representation of an HDR Texture in order to create the texture
  118965. * @param parsedTexture Define the JSON representation
  118966. * @param scene Define the scene the texture should be created in
  118967. * @param rootUrl Define the root url in case we need to load relative dependencies
  118968. * @returns the newly created texture after parsing
  118969. */
  118970. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  118971. serialize(): any;
  118972. }
  118973. }
  118974. declare module BABYLON {
  118975. /**
  118976. * Class used to control physics engine
  118977. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  118978. */
  118979. export class PhysicsEngine implements IPhysicsEngine {
  118980. private _physicsPlugin;
  118981. /**
  118982. * Global value used to control the smallest number supported by the simulation
  118983. */
  118984. static Epsilon: number;
  118985. private _impostors;
  118986. private _joints;
  118987. /**
  118988. * Gets the gravity vector used by the simulation
  118989. */
  118990. gravity: Vector3;
  118991. /**
  118992. * Factory used to create the default physics plugin.
  118993. * @returns The default physics plugin
  118994. */
  118995. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  118996. /**
  118997. * Creates a new Physics Engine
  118998. * @param gravity defines the gravity vector used by the simulation
  118999. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  119000. */
  119001. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  119002. /**
  119003. * Sets the gravity vector used by the simulation
  119004. * @param gravity defines the gravity vector to use
  119005. */
  119006. setGravity(gravity: Vector3): void;
  119007. /**
  119008. * Set the time step of the physics engine.
  119009. * Default is 1/60.
  119010. * To slow it down, enter 1/600 for example.
  119011. * To speed it up, 1/30
  119012. * @param newTimeStep defines the new timestep to apply to this world.
  119013. */
  119014. setTimeStep(newTimeStep?: number): void;
  119015. /**
  119016. * Get the time step of the physics engine.
  119017. * @returns the current time step
  119018. */
  119019. getTimeStep(): number;
  119020. /**
  119021. * Release all resources
  119022. */
  119023. dispose(): void;
  119024. /**
  119025. * Gets the name of the current physics plugin
  119026. * @returns the name of the plugin
  119027. */
  119028. getPhysicsPluginName(): string;
  119029. /**
  119030. * Adding a new impostor for the impostor tracking.
  119031. * This will be done by the impostor itself.
  119032. * @param impostor the impostor to add
  119033. */
  119034. addImpostor(impostor: PhysicsImpostor): void;
  119035. /**
  119036. * Remove an impostor from the engine.
  119037. * This impostor and its mesh will not longer be updated by the physics engine.
  119038. * @param impostor the impostor to remove
  119039. */
  119040. removeImpostor(impostor: PhysicsImpostor): void;
  119041. /**
  119042. * Add a joint to the physics engine
  119043. * @param mainImpostor defines the main impostor to which the joint is added.
  119044. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  119045. * @param joint defines the joint that will connect both impostors.
  119046. */
  119047. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  119048. /**
  119049. * Removes a joint from the simulation
  119050. * @param mainImpostor defines the impostor used with the joint
  119051. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  119052. * @param joint defines the joint to remove
  119053. */
  119054. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  119055. /**
  119056. * Called by the scene. No need to call it.
  119057. * @param delta defines the timespam between frames
  119058. */
  119059. _step(delta: number): void;
  119060. /**
  119061. * Gets the current plugin used to run the simulation
  119062. * @returns current plugin
  119063. */
  119064. getPhysicsPlugin(): IPhysicsEnginePlugin;
  119065. /**
  119066. * Gets the list of physic impostors
  119067. * @returns an array of PhysicsImpostor
  119068. */
  119069. getImpostors(): Array<PhysicsImpostor>;
  119070. /**
  119071. * Gets the impostor for a physics enabled object
  119072. * @param object defines the object impersonated by the impostor
  119073. * @returns the PhysicsImpostor or null if not found
  119074. */
  119075. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  119076. /**
  119077. * Gets the impostor for a physics body object
  119078. * @param body defines physics body used by the impostor
  119079. * @returns the PhysicsImpostor or null if not found
  119080. */
  119081. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  119082. /**
  119083. * Does a raycast in the physics world
  119084. * @param from when should the ray start?
  119085. * @param to when should the ray end?
  119086. * @returns PhysicsRaycastResult
  119087. */
  119088. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  119089. }
  119090. }
  119091. declare module BABYLON {
  119092. /** @hidden */
  119093. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  119094. private _useDeltaForWorldStep;
  119095. world: any;
  119096. name: string;
  119097. private _physicsMaterials;
  119098. private _fixedTimeStep;
  119099. private _cannonRaycastResult;
  119100. private _raycastResult;
  119101. private _physicsBodysToRemoveAfterStep;
  119102. BJSCANNON: any;
  119103. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  119104. setGravity(gravity: Vector3): void;
  119105. setTimeStep(timeStep: number): void;
  119106. getTimeStep(): number;
  119107. executeStep(delta: number): void;
  119108. private _removeMarkedPhysicsBodiesFromWorld;
  119109. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119110. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119111. generatePhysicsBody(impostor: PhysicsImpostor): void;
  119112. private _processChildMeshes;
  119113. removePhysicsBody(impostor: PhysicsImpostor): void;
  119114. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  119115. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  119116. private _addMaterial;
  119117. private _checkWithEpsilon;
  119118. private _createShape;
  119119. private _createHeightmap;
  119120. private _minus90X;
  119121. private _plus90X;
  119122. private _tmpPosition;
  119123. private _tmpDeltaPosition;
  119124. private _tmpUnityRotation;
  119125. private _updatePhysicsBodyTransformation;
  119126. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  119127. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  119128. isSupported(): boolean;
  119129. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119130. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119131. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119132. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119133. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  119134. getBodyMass(impostor: PhysicsImpostor): number;
  119135. getBodyFriction(impostor: PhysicsImpostor): number;
  119136. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  119137. getBodyRestitution(impostor: PhysicsImpostor): number;
  119138. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  119139. sleepBody(impostor: PhysicsImpostor): void;
  119140. wakeUpBody(impostor: PhysicsImpostor): void;
  119141. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  119142. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  119143. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  119144. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  119145. getRadius(impostor: PhysicsImpostor): number;
  119146. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  119147. dispose(): void;
  119148. private _extendNamespace;
  119149. /**
  119150. * Does a raycast in the physics world
  119151. * @param from when should the ray start?
  119152. * @param to when should the ray end?
  119153. * @returns PhysicsRaycastResult
  119154. */
  119155. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  119156. }
  119157. }
  119158. declare module BABYLON {
  119159. /** @hidden */
  119160. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  119161. world: any;
  119162. name: string;
  119163. BJSOIMO: any;
  119164. private _raycastResult;
  119165. constructor(iterations?: number, oimoInjection?: any);
  119166. setGravity(gravity: Vector3): void;
  119167. setTimeStep(timeStep: number): void;
  119168. getTimeStep(): number;
  119169. private _tmpImpostorsArray;
  119170. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  119171. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119172. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119173. generatePhysicsBody(impostor: PhysicsImpostor): void;
  119174. private _tmpPositionVector;
  119175. removePhysicsBody(impostor: PhysicsImpostor): void;
  119176. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  119177. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  119178. isSupported(): boolean;
  119179. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  119180. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  119181. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119182. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119183. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119184. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119185. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  119186. getBodyMass(impostor: PhysicsImpostor): number;
  119187. getBodyFriction(impostor: PhysicsImpostor): number;
  119188. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  119189. getBodyRestitution(impostor: PhysicsImpostor): number;
  119190. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  119191. sleepBody(impostor: PhysicsImpostor): void;
  119192. wakeUpBody(impostor: PhysicsImpostor): void;
  119193. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  119194. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  119195. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  119196. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  119197. getRadius(impostor: PhysicsImpostor): number;
  119198. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  119199. dispose(): void;
  119200. /**
  119201. * Does a raycast in the physics world
  119202. * @param from when should the ray start?
  119203. * @param to when should the ray end?
  119204. * @returns PhysicsRaycastResult
  119205. */
  119206. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  119207. }
  119208. }
  119209. declare module BABYLON {
  119210. /**
  119211. * Class containing static functions to help procedurally build meshes
  119212. */
  119213. export class RibbonBuilder {
  119214. /**
  119215. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  119216. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  119217. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  119218. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  119219. * * 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
  119220. * * 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
  119221. * * 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
  119222. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  119223. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  119224. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  119225. * * 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
  119226. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  119227. * * 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
  119228. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  119229. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  119230. * @param name defines the name of the mesh
  119231. * @param options defines the options used to create the mesh
  119232. * @param scene defines the hosting scene
  119233. * @returns the ribbon mesh
  119234. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  119235. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  119236. */
  119237. static CreateRibbon(name: string, options: {
  119238. pathArray: Vector3[][];
  119239. closeArray?: boolean;
  119240. closePath?: boolean;
  119241. offset?: number;
  119242. updatable?: boolean;
  119243. sideOrientation?: number;
  119244. frontUVs?: Vector4;
  119245. backUVs?: Vector4;
  119246. instance?: Mesh;
  119247. invertUV?: boolean;
  119248. uvs?: Vector2[];
  119249. colors?: Color4[];
  119250. }, scene?: Nullable<Scene>): Mesh;
  119251. }
  119252. }
  119253. declare module BABYLON {
  119254. /**
  119255. * Class containing static functions to help procedurally build meshes
  119256. */
  119257. export class ShapeBuilder {
  119258. /**
  119259. * 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.
  119260. * * 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.
  119261. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  119262. * * 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.
  119263. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  119264. * * 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
  119265. * * 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
  119266. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  119267. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  119268. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  119269. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  119270. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  119271. * @param name defines the name of the mesh
  119272. * @param options defines the options used to create the mesh
  119273. * @param scene defines the hosting scene
  119274. * @returns the extruded shape mesh
  119275. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  119276. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  119277. */
  119278. static ExtrudeShape(name: string, options: {
  119279. shape: Vector3[];
  119280. path: Vector3[];
  119281. scale?: number;
  119282. rotation?: number;
  119283. cap?: number;
  119284. updatable?: boolean;
  119285. sideOrientation?: number;
  119286. frontUVs?: Vector4;
  119287. backUVs?: Vector4;
  119288. instance?: Mesh;
  119289. invertUV?: boolean;
  119290. }, scene?: Nullable<Scene>): Mesh;
  119291. /**
  119292. * Creates an custom extruded shape mesh.
  119293. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  119294. * * 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.
  119295. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  119296. * * 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
  119297. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  119298. * * 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
  119299. * * It must returns a float value that will be the scale value applied to the shape on each path point
  119300. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  119301. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  119302. * * 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
  119303. * * 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
  119304. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  119305. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  119306. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  119307. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  119308. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  119309. * @param name defines the name of the mesh
  119310. * @param options defines the options used to create the mesh
  119311. * @param scene defines the hosting scene
  119312. * @returns the custom extruded shape mesh
  119313. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  119314. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  119315. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  119316. */
  119317. static ExtrudeShapeCustom(name: string, options: {
  119318. shape: Vector3[];
  119319. path: Vector3[];
  119320. scaleFunction?: any;
  119321. rotationFunction?: any;
  119322. ribbonCloseArray?: boolean;
  119323. ribbonClosePath?: boolean;
  119324. cap?: number;
  119325. updatable?: boolean;
  119326. sideOrientation?: number;
  119327. frontUVs?: Vector4;
  119328. backUVs?: Vector4;
  119329. instance?: Mesh;
  119330. invertUV?: boolean;
  119331. }, scene?: Nullable<Scene>): Mesh;
  119332. private static _ExtrudeShapeGeneric;
  119333. }
  119334. }
  119335. declare module BABYLON {
  119336. /**
  119337. * AmmoJS Physics plugin
  119338. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  119339. * @see https://github.com/kripken/ammo.js/
  119340. */
  119341. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  119342. private _useDeltaForWorldStep;
  119343. /**
  119344. * Reference to the Ammo library
  119345. */
  119346. bjsAMMO: any;
  119347. /**
  119348. * Created ammoJS world which physics bodies are added to
  119349. */
  119350. world: any;
  119351. /**
  119352. * Name of the plugin
  119353. */
  119354. name: string;
  119355. private _timeStep;
  119356. private _fixedTimeStep;
  119357. private _maxSteps;
  119358. private _tmpQuaternion;
  119359. private _tmpAmmoTransform;
  119360. private _tmpAmmoQuaternion;
  119361. private _tmpAmmoConcreteContactResultCallback;
  119362. private _collisionConfiguration;
  119363. private _dispatcher;
  119364. private _overlappingPairCache;
  119365. private _solver;
  119366. private _softBodySolver;
  119367. private _tmpAmmoVectorA;
  119368. private _tmpAmmoVectorB;
  119369. private _tmpAmmoVectorC;
  119370. private _tmpAmmoVectorD;
  119371. private _tmpContactCallbackResult;
  119372. private _tmpAmmoVectorRCA;
  119373. private _tmpAmmoVectorRCB;
  119374. private _raycastResult;
  119375. private static readonly DISABLE_COLLISION_FLAG;
  119376. private static readonly KINEMATIC_FLAG;
  119377. private static readonly DISABLE_DEACTIVATION_FLAG;
  119378. /**
  119379. * Initializes the ammoJS plugin
  119380. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  119381. * @param ammoInjection can be used to inject your own ammo reference
  119382. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  119383. */
  119384. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  119385. /**
  119386. * Sets the gravity of the physics world (m/(s^2))
  119387. * @param gravity Gravity to set
  119388. */
  119389. setGravity(gravity: Vector3): void;
  119390. /**
  119391. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  119392. * @param timeStep timestep to use in seconds
  119393. */
  119394. setTimeStep(timeStep: number): void;
  119395. /**
  119396. * 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)
  119397. * @param fixedTimeStep fixedTimeStep to use in seconds
  119398. */
  119399. setFixedTimeStep(fixedTimeStep: number): void;
  119400. /**
  119401. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  119402. * @param maxSteps the maximum number of steps by the physics engine per frame
  119403. */
  119404. setMaxSteps(maxSteps: number): void;
  119405. /**
  119406. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  119407. * @returns the current timestep in seconds
  119408. */
  119409. getTimeStep(): number;
  119410. private _isImpostorInContact;
  119411. private _isImpostorPairInContact;
  119412. private _stepSimulation;
  119413. /**
  119414. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  119415. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  119416. * After the step the babylon meshes are set to the position of the physics imposters
  119417. * @param delta amount of time to step forward
  119418. * @param impostors array of imposters to update before/after the step
  119419. */
  119420. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  119421. /**
  119422. * Update babylon mesh to match physics world object
  119423. * @param impostor imposter to match
  119424. */
  119425. private _afterSoftStep;
  119426. /**
  119427. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  119428. * @param impostor imposter to match
  119429. */
  119430. private _ropeStep;
  119431. /**
  119432. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  119433. * @param impostor imposter to match
  119434. */
  119435. private _softbodyOrClothStep;
  119436. private _tmpVector;
  119437. private _tmpMatrix;
  119438. /**
  119439. * Applies an impulse on the imposter
  119440. * @param impostor imposter to apply impulse to
  119441. * @param force amount of force to be applied to the imposter
  119442. * @param contactPoint the location to apply the impulse on the imposter
  119443. */
  119444. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119445. /**
  119446. * Applies a force on the imposter
  119447. * @param impostor imposter to apply force
  119448. * @param force amount of force to be applied to the imposter
  119449. * @param contactPoint the location to apply the force on the imposter
  119450. */
  119451. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119452. /**
  119453. * Creates a physics body using the plugin
  119454. * @param impostor the imposter to create the physics body on
  119455. */
  119456. generatePhysicsBody(impostor: PhysicsImpostor): void;
  119457. /**
  119458. * Removes the physics body from the imposter and disposes of the body's memory
  119459. * @param impostor imposter to remove the physics body from
  119460. */
  119461. removePhysicsBody(impostor: PhysicsImpostor): void;
  119462. /**
  119463. * Generates a joint
  119464. * @param impostorJoint the imposter joint to create the joint with
  119465. */
  119466. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  119467. /**
  119468. * Removes a joint
  119469. * @param impostorJoint the imposter joint to remove the joint from
  119470. */
  119471. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  119472. private _addMeshVerts;
  119473. /**
  119474. * Initialise the soft body vertices to match its object's (mesh) vertices
  119475. * Softbody vertices (nodes) are in world space and to match this
  119476. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  119477. * @param impostor to create the softbody for
  119478. */
  119479. private _softVertexData;
  119480. /**
  119481. * Create an impostor's soft body
  119482. * @param impostor to create the softbody for
  119483. */
  119484. private _createSoftbody;
  119485. /**
  119486. * Create cloth for an impostor
  119487. * @param impostor to create the softbody for
  119488. */
  119489. private _createCloth;
  119490. /**
  119491. * Create rope for an impostor
  119492. * @param impostor to create the softbody for
  119493. */
  119494. private _createRope;
  119495. private _addHullVerts;
  119496. private _createShape;
  119497. /**
  119498. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  119499. * @param impostor imposter containing the physics body and babylon object
  119500. */
  119501. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  119502. /**
  119503. * Sets the babylon object's position/rotation from the physics body's position/rotation
  119504. * @param impostor imposter containing the physics body and babylon object
  119505. * @param newPosition new position
  119506. * @param newRotation new rotation
  119507. */
  119508. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  119509. /**
  119510. * If this plugin is supported
  119511. * @returns true if its supported
  119512. */
  119513. isSupported(): boolean;
  119514. /**
  119515. * Sets the linear velocity of the physics body
  119516. * @param impostor imposter to set the velocity on
  119517. * @param velocity velocity to set
  119518. */
  119519. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119520. /**
  119521. * Sets the angular velocity of the physics body
  119522. * @param impostor imposter to set the velocity on
  119523. * @param velocity velocity to set
  119524. */
  119525. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119526. /**
  119527. * gets the linear velocity
  119528. * @param impostor imposter to get linear velocity from
  119529. * @returns linear velocity
  119530. */
  119531. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119532. /**
  119533. * gets the angular velocity
  119534. * @param impostor imposter to get angular velocity from
  119535. * @returns angular velocity
  119536. */
  119537. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119538. /**
  119539. * Sets the mass of physics body
  119540. * @param impostor imposter to set the mass on
  119541. * @param mass mass to set
  119542. */
  119543. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  119544. /**
  119545. * Gets the mass of the physics body
  119546. * @param impostor imposter to get the mass from
  119547. * @returns mass
  119548. */
  119549. getBodyMass(impostor: PhysicsImpostor): number;
  119550. /**
  119551. * Gets friction of the impostor
  119552. * @param impostor impostor to get friction from
  119553. * @returns friction value
  119554. */
  119555. getBodyFriction(impostor: PhysicsImpostor): number;
  119556. /**
  119557. * Sets friction of the impostor
  119558. * @param impostor impostor to set friction on
  119559. * @param friction friction value
  119560. */
  119561. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  119562. /**
  119563. * Gets restitution of the impostor
  119564. * @param impostor impostor to get restitution from
  119565. * @returns restitution value
  119566. */
  119567. getBodyRestitution(impostor: PhysicsImpostor): number;
  119568. /**
  119569. * Sets resitution of the impostor
  119570. * @param impostor impostor to set resitution on
  119571. * @param restitution resitution value
  119572. */
  119573. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  119574. /**
  119575. * Gets pressure inside the impostor
  119576. * @param impostor impostor to get pressure from
  119577. * @returns pressure value
  119578. */
  119579. getBodyPressure(impostor: PhysicsImpostor): number;
  119580. /**
  119581. * Sets pressure inside a soft body impostor
  119582. * Cloth and rope must remain 0 pressure
  119583. * @param impostor impostor to set pressure on
  119584. * @param pressure pressure value
  119585. */
  119586. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  119587. /**
  119588. * Gets stiffness of the impostor
  119589. * @param impostor impostor to get stiffness from
  119590. * @returns pressure value
  119591. */
  119592. getBodyStiffness(impostor: PhysicsImpostor): number;
  119593. /**
  119594. * Sets stiffness of the impostor
  119595. * @param impostor impostor to set stiffness on
  119596. * @param stiffness stiffness value from 0 to 1
  119597. */
  119598. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  119599. /**
  119600. * Gets velocityIterations of the impostor
  119601. * @param impostor impostor to get velocity iterations from
  119602. * @returns velocityIterations value
  119603. */
  119604. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  119605. /**
  119606. * Sets velocityIterations of the impostor
  119607. * @param impostor impostor to set velocity iterations on
  119608. * @param velocityIterations velocityIterations value
  119609. */
  119610. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  119611. /**
  119612. * Gets positionIterations of the impostor
  119613. * @param impostor impostor to get position iterations from
  119614. * @returns positionIterations value
  119615. */
  119616. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  119617. /**
  119618. * Sets positionIterations of the impostor
  119619. * @param impostor impostor to set position on
  119620. * @param positionIterations positionIterations value
  119621. */
  119622. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  119623. /**
  119624. * Append an anchor to a cloth object
  119625. * @param impostor is the cloth impostor to add anchor to
  119626. * @param otherImpostor is the rigid impostor to anchor to
  119627. * @param width ratio across width from 0 to 1
  119628. * @param height ratio up height from 0 to 1
  119629. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  119630. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  119631. */
  119632. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  119633. /**
  119634. * Append an hook to a rope object
  119635. * @param impostor is the rope impostor to add hook to
  119636. * @param otherImpostor is the rigid impostor to hook to
  119637. * @param length ratio along the rope from 0 to 1
  119638. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  119639. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  119640. */
  119641. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  119642. /**
  119643. * Sleeps the physics body and stops it from being active
  119644. * @param impostor impostor to sleep
  119645. */
  119646. sleepBody(impostor: PhysicsImpostor): void;
  119647. /**
  119648. * Activates the physics body
  119649. * @param impostor impostor to activate
  119650. */
  119651. wakeUpBody(impostor: PhysicsImpostor): void;
  119652. /**
  119653. * Updates the distance parameters of the joint
  119654. * @param joint joint to update
  119655. * @param maxDistance maximum distance of the joint
  119656. * @param minDistance minimum distance of the joint
  119657. */
  119658. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  119659. /**
  119660. * Sets a motor on the joint
  119661. * @param joint joint to set motor on
  119662. * @param speed speed of the motor
  119663. * @param maxForce maximum force of the motor
  119664. * @param motorIndex index of the motor
  119665. */
  119666. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  119667. /**
  119668. * Sets the motors limit
  119669. * @param joint joint to set limit on
  119670. * @param upperLimit upper limit
  119671. * @param lowerLimit lower limit
  119672. */
  119673. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  119674. /**
  119675. * Syncs the position and rotation of a mesh with the impostor
  119676. * @param mesh mesh to sync
  119677. * @param impostor impostor to update the mesh with
  119678. */
  119679. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  119680. /**
  119681. * Gets the radius of the impostor
  119682. * @param impostor impostor to get radius from
  119683. * @returns the radius
  119684. */
  119685. getRadius(impostor: PhysicsImpostor): number;
  119686. /**
  119687. * Gets the box size of the impostor
  119688. * @param impostor impostor to get box size from
  119689. * @param result the resulting box size
  119690. */
  119691. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  119692. /**
  119693. * Disposes of the impostor
  119694. */
  119695. dispose(): void;
  119696. /**
  119697. * Does a raycast in the physics world
  119698. * @param from when should the ray start?
  119699. * @param to when should the ray end?
  119700. * @returns PhysicsRaycastResult
  119701. */
  119702. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  119703. }
  119704. }
  119705. declare module BABYLON {
  119706. interface AbstractScene {
  119707. /**
  119708. * The list of reflection probes added to the scene
  119709. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  119710. */
  119711. reflectionProbes: Array<ReflectionProbe>;
  119712. /**
  119713. * Removes the given reflection probe from this scene.
  119714. * @param toRemove The reflection probe to remove
  119715. * @returns The index of the removed reflection probe
  119716. */
  119717. removeReflectionProbe(toRemove: ReflectionProbe): number;
  119718. /**
  119719. * Adds the given reflection probe to this scene.
  119720. * @param newReflectionProbe The reflection probe to add
  119721. */
  119722. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  119723. }
  119724. /**
  119725. * Class used to generate realtime reflection / refraction cube textures
  119726. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  119727. */
  119728. export class ReflectionProbe {
  119729. /** defines the name of the probe */
  119730. name: string;
  119731. private _scene;
  119732. private _renderTargetTexture;
  119733. private _projectionMatrix;
  119734. private _viewMatrix;
  119735. private _target;
  119736. private _add;
  119737. private _attachedMesh;
  119738. private _invertYAxis;
  119739. /** Gets or sets probe position (center of the cube map) */
  119740. position: Vector3;
  119741. /**
  119742. * Creates a new reflection probe
  119743. * @param name defines the name of the probe
  119744. * @param size defines the texture resolution (for each face)
  119745. * @param scene defines the hosting scene
  119746. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  119747. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  119748. */
  119749. constructor(
  119750. /** defines the name of the probe */
  119751. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  119752. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  119753. samples: number;
  119754. /** Gets or sets the refresh rate to use (on every frame by default) */
  119755. refreshRate: number;
  119756. /**
  119757. * Gets the hosting scene
  119758. * @returns a Scene
  119759. */
  119760. getScene(): Scene;
  119761. /** Gets the internal CubeTexture used to render to */
  119762. readonly cubeTexture: RenderTargetTexture;
  119763. /** Gets the list of meshes to render */
  119764. readonly renderList: Nullable<AbstractMesh[]>;
  119765. /**
  119766. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  119767. * @param mesh defines the mesh to attach to
  119768. */
  119769. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  119770. /**
  119771. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  119772. * @param renderingGroupId The rendering group id corresponding to its index
  119773. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  119774. */
  119775. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  119776. /**
  119777. * Clean all associated resources
  119778. */
  119779. dispose(): void;
  119780. /**
  119781. * Converts the reflection probe information to a readable string for debug purpose.
  119782. * @param fullDetails Supports for multiple levels of logging within scene loading
  119783. * @returns the human readable reflection probe info
  119784. */
  119785. toString(fullDetails?: boolean): string;
  119786. /**
  119787. * Get the class name of the relfection probe.
  119788. * @returns "ReflectionProbe"
  119789. */
  119790. getClassName(): string;
  119791. /**
  119792. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  119793. * @returns The JSON representation of the texture
  119794. */
  119795. serialize(): any;
  119796. /**
  119797. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  119798. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  119799. * @param scene Define the scene the parsed reflection probe should be instantiated in
  119800. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  119801. * @returns The parsed reflection probe if successful
  119802. */
  119803. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  119804. }
  119805. }
  119806. declare module BABYLON {
  119807. /** @hidden */
  119808. export var _BabylonLoaderRegistered: boolean;
  119809. /**
  119810. * Helps setting up some configuration for the babylon file loader.
  119811. */
  119812. export class BabylonFileLoaderConfiguration {
  119813. /**
  119814. * The loader does not allow injecting custom physix engine into the plugins.
  119815. * Unfortunately in ES6, we need to manually inject them into the plugin.
  119816. * So you could set this variable to your engine import to make it work.
  119817. */
  119818. static LoaderInjectedPhysicsEngine: any;
  119819. }
  119820. }
  119821. declare module BABYLON {
  119822. /**
  119823. * The Physically based simple base material of BJS.
  119824. *
  119825. * This enables better naming and convention enforcements on top of the pbrMaterial.
  119826. * It is used as the base class for both the specGloss and metalRough conventions.
  119827. */
  119828. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  119829. /**
  119830. * Number of Simultaneous lights allowed on the material.
  119831. */
  119832. maxSimultaneousLights: number;
  119833. /**
  119834. * If sets to true, disables all the lights affecting the material.
  119835. */
  119836. disableLighting: boolean;
  119837. /**
  119838. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  119839. */
  119840. environmentTexture: BaseTexture;
  119841. /**
  119842. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  119843. */
  119844. invertNormalMapX: boolean;
  119845. /**
  119846. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  119847. */
  119848. invertNormalMapY: boolean;
  119849. /**
  119850. * Normal map used in the model.
  119851. */
  119852. normalTexture: BaseTexture;
  119853. /**
  119854. * Emissivie color used to self-illuminate the model.
  119855. */
  119856. emissiveColor: Color3;
  119857. /**
  119858. * Emissivie texture used to self-illuminate the model.
  119859. */
  119860. emissiveTexture: BaseTexture;
  119861. /**
  119862. * Occlusion Channel Strenght.
  119863. */
  119864. occlusionStrength: number;
  119865. /**
  119866. * Occlusion Texture of the material (adding extra occlusion effects).
  119867. */
  119868. occlusionTexture: BaseTexture;
  119869. /**
  119870. * Defines the alpha limits in alpha test mode.
  119871. */
  119872. alphaCutOff: number;
  119873. /**
  119874. * Gets the current double sided mode.
  119875. */
  119876. /**
  119877. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  119878. */
  119879. doubleSided: boolean;
  119880. /**
  119881. * Stores the pre-calculated light information of a mesh in a texture.
  119882. */
  119883. lightmapTexture: BaseTexture;
  119884. /**
  119885. * If true, the light map contains occlusion information instead of lighting info.
  119886. */
  119887. useLightmapAsShadowmap: boolean;
  119888. /**
  119889. * Instantiates a new PBRMaterial instance.
  119890. *
  119891. * @param name The material name
  119892. * @param scene The scene the material will be use in.
  119893. */
  119894. constructor(name: string, scene: Scene);
  119895. getClassName(): string;
  119896. }
  119897. }
  119898. declare module BABYLON {
  119899. /**
  119900. * The PBR material of BJS following the metal roughness convention.
  119901. *
  119902. * This fits to the PBR convention in the GLTF definition:
  119903. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  119904. */
  119905. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  119906. /**
  119907. * The base color has two different interpretations depending on the value of metalness.
  119908. * When the material is a metal, the base color is the specific measured reflectance value
  119909. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  119910. * of the material.
  119911. */
  119912. baseColor: Color3;
  119913. /**
  119914. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  119915. * well as opacity information in the alpha channel.
  119916. */
  119917. baseTexture: BaseTexture;
  119918. /**
  119919. * Specifies the metallic scalar value of the material.
  119920. * Can also be used to scale the metalness values of the metallic texture.
  119921. */
  119922. metallic: number;
  119923. /**
  119924. * Specifies the roughness scalar value of the material.
  119925. * Can also be used to scale the roughness values of the metallic texture.
  119926. */
  119927. roughness: number;
  119928. /**
  119929. * Texture containing both the metallic value in the B channel and the
  119930. * roughness value in the G channel to keep better precision.
  119931. */
  119932. metallicRoughnessTexture: BaseTexture;
  119933. /**
  119934. * Instantiates a new PBRMetalRoughnessMaterial instance.
  119935. *
  119936. * @param name The material name
  119937. * @param scene The scene the material will be use in.
  119938. */
  119939. constructor(name: string, scene: Scene);
  119940. /**
  119941. * Return the currrent class name of the material.
  119942. */
  119943. getClassName(): string;
  119944. /**
  119945. * Makes a duplicate of the current material.
  119946. * @param name - name to use for the new material.
  119947. */
  119948. clone(name: string): PBRMetallicRoughnessMaterial;
  119949. /**
  119950. * Serialize the material to a parsable JSON object.
  119951. */
  119952. serialize(): any;
  119953. /**
  119954. * Parses a JSON object correponding to the serialize function.
  119955. */
  119956. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  119957. }
  119958. }
  119959. declare module BABYLON {
  119960. /**
  119961. * The PBR material of BJS following the specular glossiness convention.
  119962. *
  119963. * This fits to the PBR convention in the GLTF definition:
  119964. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  119965. */
  119966. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  119967. /**
  119968. * Specifies the diffuse color of the material.
  119969. */
  119970. diffuseColor: Color3;
  119971. /**
  119972. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  119973. * channel.
  119974. */
  119975. diffuseTexture: BaseTexture;
  119976. /**
  119977. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  119978. */
  119979. specularColor: Color3;
  119980. /**
  119981. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  119982. */
  119983. glossiness: number;
  119984. /**
  119985. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  119986. */
  119987. specularGlossinessTexture: BaseTexture;
  119988. /**
  119989. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  119990. *
  119991. * @param name The material name
  119992. * @param scene The scene the material will be use in.
  119993. */
  119994. constructor(name: string, scene: Scene);
  119995. /**
  119996. * Return the currrent class name of the material.
  119997. */
  119998. getClassName(): string;
  119999. /**
  120000. * Makes a duplicate of the current material.
  120001. * @param name - name to use for the new material.
  120002. */
  120003. clone(name: string): PBRSpecularGlossinessMaterial;
  120004. /**
  120005. * Serialize the material to a parsable JSON object.
  120006. */
  120007. serialize(): any;
  120008. /**
  120009. * Parses a JSON object correponding to the serialize function.
  120010. */
  120011. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  120012. }
  120013. }
  120014. declare module BABYLON {
  120015. /**
  120016. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  120017. * It can help converting any input color in a desired output one. This can then be used to create effects
  120018. * from sepia, black and white to sixties or futuristic rendering...
  120019. *
  120020. * The only supported format is currently 3dl.
  120021. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  120022. */
  120023. export class ColorGradingTexture extends BaseTexture {
  120024. /**
  120025. * The current texture matrix. (will always be identity in color grading texture)
  120026. */
  120027. private _textureMatrix;
  120028. /**
  120029. * The texture URL.
  120030. */
  120031. url: string;
  120032. /**
  120033. * Empty line regex stored for GC.
  120034. */
  120035. private static _noneEmptyLineRegex;
  120036. private _engine;
  120037. /**
  120038. * Instantiates a ColorGradingTexture from the following parameters.
  120039. *
  120040. * @param url The location of the color gradind data (currently only supporting 3dl)
  120041. * @param scene The scene the texture will be used in
  120042. */
  120043. constructor(url: string, scene: Scene);
  120044. /**
  120045. * Returns the texture matrix used in most of the material.
  120046. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  120047. */
  120048. getTextureMatrix(): Matrix;
  120049. /**
  120050. * Occurs when the file being loaded is a .3dl LUT file.
  120051. */
  120052. private load3dlTexture;
  120053. /**
  120054. * Starts the loading process of the texture.
  120055. */
  120056. private loadTexture;
  120057. /**
  120058. * Clones the color gradind texture.
  120059. */
  120060. clone(): ColorGradingTexture;
  120061. /**
  120062. * Called during delayed load for textures.
  120063. */
  120064. delayLoad(): void;
  120065. /**
  120066. * Parses a color grading texture serialized by Babylon.
  120067. * @param parsedTexture The texture information being parsedTexture
  120068. * @param scene The scene to load the texture in
  120069. * @param rootUrl The root url of the data assets to load
  120070. * @return A color gradind texture
  120071. */
  120072. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  120073. /**
  120074. * Serializes the LUT texture to json format.
  120075. */
  120076. serialize(): any;
  120077. }
  120078. }
  120079. declare module BABYLON {
  120080. /**
  120081. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  120082. */
  120083. export class EquiRectangularCubeTexture extends BaseTexture {
  120084. /** The six faces of the cube. */
  120085. private static _FacesMapping;
  120086. private _noMipmap;
  120087. private _onLoad;
  120088. private _onError;
  120089. /** The size of the cubemap. */
  120090. private _size;
  120091. /** The buffer of the image. */
  120092. private _buffer;
  120093. /** The width of the input image. */
  120094. private _width;
  120095. /** The height of the input image. */
  120096. private _height;
  120097. /** The URL to the image. */
  120098. url: string;
  120099. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  120100. coordinatesMode: number;
  120101. /**
  120102. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  120103. * @param url The location of the image
  120104. * @param scene The scene the texture will be used in
  120105. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  120106. * @param noMipmap Forces to not generate the mipmap if true
  120107. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  120108. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  120109. * @param onLoad — defines a callback called when texture is loaded
  120110. * @param onError — defines a callback called if there is an error
  120111. */
  120112. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  120113. /**
  120114. * Load the image data, by putting the image on a canvas and extracting its buffer.
  120115. */
  120116. private loadImage;
  120117. /**
  120118. * Convert the image buffer into a cubemap and create a CubeTexture.
  120119. */
  120120. private loadTexture;
  120121. /**
  120122. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  120123. * @param buffer The ArrayBuffer that should be converted.
  120124. * @returns The buffer as Float32Array.
  120125. */
  120126. private getFloat32ArrayFromArrayBuffer;
  120127. /**
  120128. * Get the current class name of the texture useful for serialization or dynamic coding.
  120129. * @returns "EquiRectangularCubeTexture"
  120130. */
  120131. getClassName(): string;
  120132. /**
  120133. * Create a clone of the current EquiRectangularCubeTexture and return it.
  120134. * @returns A clone of the current EquiRectangularCubeTexture.
  120135. */
  120136. clone(): EquiRectangularCubeTexture;
  120137. }
  120138. }
  120139. declare module BABYLON {
  120140. /**
  120141. * Based on jsTGALoader - Javascript loader for TGA file
  120142. * By Vincent Thibault
  120143. * @see http://blog.robrowser.com/javascript-tga-loader.html
  120144. */
  120145. export class TGATools {
  120146. private static _TYPE_INDEXED;
  120147. private static _TYPE_RGB;
  120148. private static _TYPE_GREY;
  120149. private static _TYPE_RLE_INDEXED;
  120150. private static _TYPE_RLE_RGB;
  120151. private static _TYPE_RLE_GREY;
  120152. private static _ORIGIN_MASK;
  120153. private static _ORIGIN_SHIFT;
  120154. private static _ORIGIN_BL;
  120155. private static _ORIGIN_BR;
  120156. private static _ORIGIN_UL;
  120157. private static _ORIGIN_UR;
  120158. /**
  120159. * Gets the header of a TGA file
  120160. * @param data defines the TGA data
  120161. * @returns the header
  120162. */
  120163. static GetTGAHeader(data: Uint8Array): any;
  120164. /**
  120165. * Uploads TGA content to a Babylon Texture
  120166. * @hidden
  120167. */
  120168. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  120169. /** @hidden */
  120170. 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;
  120171. /** @hidden */
  120172. 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;
  120173. /** @hidden */
  120174. 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;
  120175. /** @hidden */
  120176. 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;
  120177. /** @hidden */
  120178. 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;
  120179. /** @hidden */
  120180. 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;
  120181. }
  120182. }
  120183. declare module BABYLON {
  120184. /**
  120185. * Implementation of the TGA Texture Loader.
  120186. * @hidden
  120187. */
  120188. export class _TGATextureLoader implements IInternalTextureLoader {
  120189. /**
  120190. * Defines wether the loader supports cascade loading the different faces.
  120191. */
  120192. readonly supportCascades: boolean;
  120193. /**
  120194. * This returns if the loader support the current file information.
  120195. * @param extension defines the file extension of the file being loaded
  120196. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120197. * @param fallback defines the fallback internal texture if any
  120198. * @param isBase64 defines whether the texture is encoded as a base64
  120199. * @param isBuffer defines whether the texture data are stored as a buffer
  120200. * @returns true if the loader can load the specified file
  120201. */
  120202. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  120203. /**
  120204. * Transform the url before loading if required.
  120205. * @param rootUrl the url of the texture
  120206. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120207. * @returns the transformed texture
  120208. */
  120209. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  120210. /**
  120211. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  120212. * @param rootUrl the url of the texture
  120213. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120214. * @returns the fallback texture
  120215. */
  120216. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  120217. /**
  120218. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  120219. * @param data contains the texture data
  120220. * @param texture defines the BabylonJS internal texture
  120221. * @param createPolynomials will be true if polynomials have been requested
  120222. * @param onLoad defines the callback to trigger once the texture is ready
  120223. * @param onError defines the callback to trigger in case of error
  120224. */
  120225. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  120226. /**
  120227. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  120228. * @param data contains the texture data
  120229. * @param texture defines the BabylonJS internal texture
  120230. * @param callback defines the method to call once ready to upload
  120231. */
  120232. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  120233. }
  120234. }
  120235. declare module BABYLON {
  120236. /**
  120237. * Info about the .basis files
  120238. */
  120239. class BasisFileInfo {
  120240. /**
  120241. * If the file has alpha
  120242. */
  120243. hasAlpha: boolean;
  120244. /**
  120245. * Info about each image of the basis file
  120246. */
  120247. images: Array<{
  120248. levels: Array<{
  120249. width: number;
  120250. height: number;
  120251. transcodedPixels: ArrayBufferView;
  120252. }>;
  120253. }>;
  120254. }
  120255. /**
  120256. * Result of transcoding a basis file
  120257. */
  120258. class TranscodeResult {
  120259. /**
  120260. * Info about the .basis file
  120261. */
  120262. fileInfo: BasisFileInfo;
  120263. /**
  120264. * Format to use when loading the file
  120265. */
  120266. format: number;
  120267. }
  120268. /**
  120269. * Configuration options for the Basis transcoder
  120270. */
  120271. export class BasisTranscodeConfiguration {
  120272. /**
  120273. * Supported compression formats used to determine the supported output format of the transcoder
  120274. */
  120275. supportedCompressionFormats?: {
  120276. /**
  120277. * etc1 compression format
  120278. */
  120279. etc1?: boolean;
  120280. /**
  120281. * s3tc compression format
  120282. */
  120283. s3tc?: boolean;
  120284. /**
  120285. * pvrtc compression format
  120286. */
  120287. pvrtc?: boolean;
  120288. /**
  120289. * etc2 compression format
  120290. */
  120291. etc2?: boolean;
  120292. };
  120293. /**
  120294. * If mipmap levels should be loaded for transcoded images (Default: true)
  120295. */
  120296. loadMipmapLevels?: boolean;
  120297. /**
  120298. * Index of a single image to load (Default: all images)
  120299. */
  120300. loadSingleImage?: number;
  120301. }
  120302. /**
  120303. * Used to load .Basis files
  120304. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  120305. */
  120306. export class BasisTools {
  120307. private static _IgnoreSupportedFormats;
  120308. /**
  120309. * URL to use when loading the basis transcoder
  120310. */
  120311. static JSModuleURL: string;
  120312. /**
  120313. * URL to use when loading the wasm module for the transcoder
  120314. */
  120315. static WasmModuleURL: string;
  120316. /**
  120317. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  120318. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  120319. * @returns internal format corresponding to the Basis format
  120320. */
  120321. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  120322. private static _WorkerPromise;
  120323. private static _Worker;
  120324. private static _actionId;
  120325. private static _CreateWorkerAsync;
  120326. /**
  120327. * Transcodes a loaded image file to compressed pixel data
  120328. * @param imageData image data to transcode
  120329. * @param config configuration options for the transcoding
  120330. * @returns a promise resulting in the transcoded image
  120331. */
  120332. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  120333. /**
  120334. * Loads a texture from the transcode result
  120335. * @param texture texture load to
  120336. * @param transcodeResult the result of transcoding the basis file to load from
  120337. */
  120338. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  120339. }
  120340. }
  120341. declare module BABYLON {
  120342. /**
  120343. * Loader for .basis file format
  120344. */
  120345. export class _BasisTextureLoader implements IInternalTextureLoader {
  120346. /**
  120347. * Defines whether the loader supports cascade loading the different faces.
  120348. */
  120349. readonly supportCascades: boolean;
  120350. /**
  120351. * This returns if the loader support the current file information.
  120352. * @param extension defines the file extension of the file being loaded
  120353. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120354. * @param fallback defines the fallback internal texture if any
  120355. * @param isBase64 defines whether the texture is encoded as a base64
  120356. * @param isBuffer defines whether the texture data are stored as a buffer
  120357. * @returns true if the loader can load the specified file
  120358. */
  120359. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  120360. /**
  120361. * Transform the url before loading if required.
  120362. * @param rootUrl the url of the texture
  120363. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120364. * @returns the transformed texture
  120365. */
  120366. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  120367. /**
  120368. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  120369. * @param rootUrl the url of the texture
  120370. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120371. * @returns the fallback texture
  120372. */
  120373. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  120374. /**
  120375. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  120376. * @param data contains the texture data
  120377. * @param texture defines the BabylonJS internal texture
  120378. * @param createPolynomials will be true if polynomials have been requested
  120379. * @param onLoad defines the callback to trigger once the texture is ready
  120380. * @param onError defines the callback to trigger in case of error
  120381. */
  120382. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  120383. /**
  120384. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  120385. * @param data contains the texture data
  120386. * @param texture defines the BabylonJS internal texture
  120387. * @param callback defines the method to call once ready to upload
  120388. */
  120389. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  120390. }
  120391. }
  120392. declare module BABYLON {
  120393. /**
  120394. * 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.
  120395. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  120396. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  120397. */
  120398. export class CustomProceduralTexture extends ProceduralTexture {
  120399. private _animate;
  120400. private _time;
  120401. private _config;
  120402. private _texturePath;
  120403. /**
  120404. * Instantiates a new Custom Procedural Texture.
  120405. * 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.
  120406. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  120407. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  120408. * @param name Define the name of the texture
  120409. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  120410. * @param size Define the size of the texture to create
  120411. * @param scene Define the scene the texture belongs to
  120412. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  120413. * @param generateMipMaps Define if the texture should creates mip maps or not
  120414. */
  120415. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  120416. private _loadJson;
  120417. /**
  120418. * Is the texture ready to be used ? (rendered at least once)
  120419. * @returns true if ready, otherwise, false.
  120420. */
  120421. isReady(): boolean;
  120422. /**
  120423. * Render the texture to its associated render target.
  120424. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  120425. */
  120426. render(useCameraPostProcess?: boolean): void;
  120427. /**
  120428. * Update the list of dependant textures samplers in the shader.
  120429. */
  120430. updateTextures(): void;
  120431. /**
  120432. * Update the uniform values of the procedural texture in the shader.
  120433. */
  120434. updateShaderUniforms(): void;
  120435. /**
  120436. * Define if the texture animates or not.
  120437. */
  120438. animate: boolean;
  120439. }
  120440. }
  120441. declare module BABYLON {
  120442. /** @hidden */
  120443. export var noisePixelShader: {
  120444. name: string;
  120445. shader: string;
  120446. };
  120447. }
  120448. declare module BABYLON {
  120449. /**
  120450. * Class used to generate noise procedural textures
  120451. */
  120452. export class NoiseProceduralTexture extends ProceduralTexture {
  120453. private _time;
  120454. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  120455. brightness: number;
  120456. /** Defines the number of octaves to process */
  120457. octaves: number;
  120458. /** Defines the level of persistence (0.8 by default) */
  120459. persistence: number;
  120460. /** Gets or sets animation speed factor (default is 1) */
  120461. animationSpeedFactor: number;
  120462. /**
  120463. * Creates a new NoiseProceduralTexture
  120464. * @param name defines the name fo the texture
  120465. * @param size defines the size of the texture (default is 256)
  120466. * @param scene defines the hosting scene
  120467. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  120468. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  120469. */
  120470. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  120471. private _updateShaderUniforms;
  120472. protected _getDefines(): string;
  120473. /** Generate the current state of the procedural texture */
  120474. render(useCameraPostProcess?: boolean): void;
  120475. /**
  120476. * Serializes this noise procedural texture
  120477. * @returns a serialized noise procedural texture object
  120478. */
  120479. serialize(): any;
  120480. /**
  120481. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  120482. * @param parsedTexture defines parsed texture data
  120483. * @param scene defines the current scene
  120484. * @param rootUrl defines the root URL containing noise procedural texture information
  120485. * @returns a parsed NoiseProceduralTexture
  120486. */
  120487. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  120488. }
  120489. }
  120490. declare module BABYLON {
  120491. /**
  120492. * Raw cube texture where the raw buffers are passed in
  120493. */
  120494. export class RawCubeTexture extends CubeTexture {
  120495. /**
  120496. * Creates a cube texture where the raw buffers are passed in.
  120497. * @param scene defines the scene the texture is attached to
  120498. * @param data defines the array of data to use to create each face
  120499. * @param size defines the size of the textures
  120500. * @param format defines the format of the data
  120501. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  120502. * @param generateMipMaps defines if the engine should generate the mip levels
  120503. * @param invertY defines if data must be stored with Y axis inverted
  120504. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  120505. * @param compression defines the compression used (null by default)
  120506. */
  120507. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  120508. /**
  120509. * Updates the raw cube texture.
  120510. * @param data defines the data to store
  120511. * @param format defines the data format
  120512. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  120513. * @param invertY defines if data must be stored with Y axis inverted
  120514. * @param compression defines the compression used (null by default)
  120515. * @param level defines which level of the texture to update
  120516. */
  120517. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  120518. /**
  120519. * Updates a raw cube texture with RGBD encoded data.
  120520. * @param data defines the array of data [mipmap][face] to use to create each face
  120521. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  120522. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  120523. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  120524. * @returns a promsie that resolves when the operation is complete
  120525. */
  120526. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  120527. /**
  120528. * Clones the raw cube texture.
  120529. * @return a new cube texture
  120530. */
  120531. clone(): CubeTexture;
  120532. /** @hidden */
  120533. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  120534. }
  120535. }
  120536. declare module BABYLON {
  120537. /**
  120538. * Class used to store 3D textures containing user data
  120539. */
  120540. export class RawTexture3D extends Texture {
  120541. /** Gets or sets the texture format to use */
  120542. format: number;
  120543. private _engine;
  120544. /**
  120545. * Create a new RawTexture3D
  120546. * @param data defines the data of the texture
  120547. * @param width defines the width of the texture
  120548. * @param height defines the height of the texture
  120549. * @param depth defines the depth of the texture
  120550. * @param format defines the texture format to use
  120551. * @param scene defines the hosting scene
  120552. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  120553. * @param invertY defines if texture must be stored with Y axis inverted
  120554. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  120555. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  120556. */
  120557. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  120558. /** Gets or sets the texture format to use */
  120559. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  120560. /**
  120561. * Update the texture with new data
  120562. * @param data defines the data to store in the texture
  120563. */
  120564. update(data: ArrayBufferView): void;
  120565. }
  120566. }
  120567. declare module BABYLON {
  120568. /**
  120569. * Creates a refraction texture used by refraction channel of the standard material.
  120570. * It is like a mirror but to see through a material.
  120571. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  120572. */
  120573. export class RefractionTexture extends RenderTargetTexture {
  120574. /**
  120575. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  120576. * 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.
  120577. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  120578. */
  120579. refractionPlane: Plane;
  120580. /**
  120581. * Define how deep under the surface we should see.
  120582. */
  120583. depth: number;
  120584. /**
  120585. * Creates a refraction texture used by refraction channel of the standard material.
  120586. * It is like a mirror but to see through a material.
  120587. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  120588. * @param name Define the texture name
  120589. * @param size Define the size of the underlying texture
  120590. * @param scene Define the scene the refraction belongs to
  120591. * @param generateMipMaps Define if we need to generate mips level for the refraction
  120592. */
  120593. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  120594. /**
  120595. * Clone the refraction texture.
  120596. * @returns the cloned texture
  120597. */
  120598. clone(): RefractionTexture;
  120599. /**
  120600. * Serialize the texture to a JSON representation you could use in Parse later on
  120601. * @returns the serialized JSON representation
  120602. */
  120603. serialize(): any;
  120604. }
  120605. }
  120606. declare module BABYLON {
  120607. /**
  120608. * Defines the options related to the creation of an HtmlElementTexture
  120609. */
  120610. export interface IHtmlElementTextureOptions {
  120611. /**
  120612. * Defines wether mip maps should be created or not.
  120613. */
  120614. generateMipMaps?: boolean;
  120615. /**
  120616. * Defines the sampling mode of the texture.
  120617. */
  120618. samplingMode?: number;
  120619. /**
  120620. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  120621. */
  120622. engine: Nullable<ThinEngine>;
  120623. /**
  120624. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  120625. */
  120626. scene: Nullable<Scene>;
  120627. }
  120628. /**
  120629. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  120630. * To be as efficient as possible depending on your constraints nothing aside the first upload
  120631. * is automatically managed.
  120632. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  120633. * in your application.
  120634. *
  120635. * As the update is not automatic, you need to call them manually.
  120636. */
  120637. export class HtmlElementTexture extends BaseTexture {
  120638. /**
  120639. * The texture URL.
  120640. */
  120641. element: HTMLVideoElement | HTMLCanvasElement;
  120642. private static readonly DefaultOptions;
  120643. private _textureMatrix;
  120644. private _engine;
  120645. private _isVideo;
  120646. private _generateMipMaps;
  120647. private _samplingMode;
  120648. /**
  120649. * Instantiates a HtmlElementTexture from the following parameters.
  120650. *
  120651. * @param name Defines the name of the texture
  120652. * @param element Defines the video or canvas the texture is filled with
  120653. * @param options Defines the other none mandatory texture creation options
  120654. */
  120655. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  120656. private _createInternalTexture;
  120657. /**
  120658. * Returns the texture matrix used in most of the material.
  120659. */
  120660. getTextureMatrix(): Matrix;
  120661. /**
  120662. * Updates the content of the texture.
  120663. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  120664. */
  120665. update(invertY?: Nullable<boolean>): void;
  120666. }
  120667. }
  120668. declare module BABYLON {
  120669. /**
  120670. * Enum used to define the target of a block
  120671. */
  120672. export enum NodeMaterialBlockTargets {
  120673. /** Vertex shader */
  120674. Vertex = 1,
  120675. /** Fragment shader */
  120676. Fragment = 2,
  120677. /** Neutral */
  120678. Neutral = 4,
  120679. /** Vertex and Fragment */
  120680. VertexAndFragment = 3
  120681. }
  120682. }
  120683. declare module BABYLON {
  120684. /**
  120685. * Defines the kind of connection point for node based material
  120686. */
  120687. export enum NodeMaterialBlockConnectionPointTypes {
  120688. /** Float */
  120689. Float = 1,
  120690. /** Int */
  120691. Int = 2,
  120692. /** Vector2 */
  120693. Vector2 = 4,
  120694. /** Vector3 */
  120695. Vector3 = 8,
  120696. /** Vector4 */
  120697. Vector4 = 16,
  120698. /** Color3 */
  120699. Color3 = 32,
  120700. /** Color4 */
  120701. Color4 = 64,
  120702. /** Matrix */
  120703. Matrix = 128,
  120704. /** Detect type based on connection */
  120705. AutoDetect = 1024,
  120706. /** Output type that will be defined by input type */
  120707. BasedOnInput = 2048
  120708. }
  120709. }
  120710. declare module BABYLON {
  120711. /**
  120712. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  120713. */
  120714. export enum NodeMaterialBlockConnectionPointMode {
  120715. /** Value is an uniform */
  120716. Uniform = 0,
  120717. /** Value is a mesh attribute */
  120718. Attribute = 1,
  120719. /** Value is a varying between vertex and fragment shaders */
  120720. Varying = 2,
  120721. /** Mode is undefined */
  120722. Undefined = 3
  120723. }
  120724. }
  120725. declare module BABYLON {
  120726. /**
  120727. * Enum used to define system values e.g. values automatically provided by the system
  120728. */
  120729. export enum NodeMaterialSystemValues {
  120730. /** World */
  120731. World = 1,
  120732. /** View */
  120733. View = 2,
  120734. /** Projection */
  120735. Projection = 3,
  120736. /** ViewProjection */
  120737. ViewProjection = 4,
  120738. /** WorldView */
  120739. WorldView = 5,
  120740. /** WorldViewProjection */
  120741. WorldViewProjection = 6,
  120742. /** CameraPosition */
  120743. CameraPosition = 7,
  120744. /** Fog Color */
  120745. FogColor = 8,
  120746. /** Delta time */
  120747. DeltaTime = 9
  120748. }
  120749. }
  120750. declare module BABYLON {
  120751. /**
  120752. * Root class for all node material optimizers
  120753. */
  120754. export class NodeMaterialOptimizer {
  120755. /**
  120756. * Function used to optimize a NodeMaterial graph
  120757. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  120758. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  120759. */
  120760. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  120761. }
  120762. }
  120763. declare module BABYLON {
  120764. /**
  120765. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  120766. */
  120767. export class TransformBlock extends NodeMaterialBlock {
  120768. /**
  120769. * Defines the value to use to complement W value to transform it to a Vector4
  120770. */
  120771. complementW: number;
  120772. /**
  120773. * Defines the value to use to complement z value to transform it to a Vector4
  120774. */
  120775. complementZ: number;
  120776. /**
  120777. * Creates a new TransformBlock
  120778. * @param name defines the block name
  120779. */
  120780. constructor(name: string);
  120781. /**
  120782. * Gets the current class name
  120783. * @returns the class name
  120784. */
  120785. getClassName(): string;
  120786. /**
  120787. * Gets the vector input
  120788. */
  120789. readonly vector: NodeMaterialConnectionPoint;
  120790. /**
  120791. * Gets the output component
  120792. */
  120793. readonly output: NodeMaterialConnectionPoint;
  120794. /**
  120795. * Gets the matrix transform input
  120796. */
  120797. readonly transform: NodeMaterialConnectionPoint;
  120798. protected _buildBlock(state: NodeMaterialBuildState): this;
  120799. serialize(): any;
  120800. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  120801. protected _dumpPropertiesCode(): string;
  120802. }
  120803. }
  120804. declare module BABYLON {
  120805. /**
  120806. * Block used to output the vertex position
  120807. */
  120808. export class VertexOutputBlock extends NodeMaterialBlock {
  120809. /**
  120810. * Creates a new VertexOutputBlock
  120811. * @param name defines the block name
  120812. */
  120813. constructor(name: string);
  120814. /**
  120815. * Gets the current class name
  120816. * @returns the class name
  120817. */
  120818. getClassName(): string;
  120819. /**
  120820. * Gets the vector input component
  120821. */
  120822. readonly vector: NodeMaterialConnectionPoint;
  120823. protected _buildBlock(state: NodeMaterialBuildState): this;
  120824. }
  120825. }
  120826. declare module BABYLON {
  120827. /**
  120828. * Block used to output the final color
  120829. */
  120830. export class FragmentOutputBlock extends NodeMaterialBlock {
  120831. /**
  120832. * Create a new FragmentOutputBlock
  120833. * @param name defines the block name
  120834. */
  120835. constructor(name: string);
  120836. /**
  120837. * Gets the current class name
  120838. * @returns the class name
  120839. */
  120840. getClassName(): string;
  120841. /**
  120842. * Gets the rgba input component
  120843. */
  120844. readonly rgba: NodeMaterialConnectionPoint;
  120845. /**
  120846. * Gets the rgb input component
  120847. */
  120848. readonly rgb: NodeMaterialConnectionPoint;
  120849. /**
  120850. * Gets the a input component
  120851. */
  120852. readonly a: NodeMaterialConnectionPoint;
  120853. protected _buildBlock(state: NodeMaterialBuildState): this;
  120854. }
  120855. }
  120856. declare module BABYLON {
  120857. /**
  120858. * Block used to read a reflection texture from a sampler
  120859. */
  120860. export class ReflectionTextureBlock extends NodeMaterialBlock {
  120861. private _define3DName;
  120862. private _defineCubicName;
  120863. private _defineExplicitName;
  120864. private _defineProjectionName;
  120865. private _defineLocalCubicName;
  120866. private _defineSphericalName;
  120867. private _definePlanarName;
  120868. private _defineEquirectangularName;
  120869. private _defineMirroredEquirectangularFixedName;
  120870. private _defineEquirectangularFixedName;
  120871. private _defineSkyboxName;
  120872. private _cubeSamplerName;
  120873. private _2DSamplerName;
  120874. private _positionUVWName;
  120875. private _directionWName;
  120876. private _reflectionCoordsName;
  120877. private _reflection2DCoordsName;
  120878. private _reflectionColorName;
  120879. private _reflectionMatrixName;
  120880. /**
  120881. * Gets or sets the texture associated with the node
  120882. */
  120883. texture: Nullable<BaseTexture>;
  120884. /**
  120885. * Create a new TextureBlock
  120886. * @param name defines the block name
  120887. */
  120888. constructor(name: string);
  120889. /**
  120890. * Gets the current class name
  120891. * @returns the class name
  120892. */
  120893. getClassName(): string;
  120894. /**
  120895. * Gets the world position input component
  120896. */
  120897. readonly position: NodeMaterialConnectionPoint;
  120898. /**
  120899. * Gets the world position input component
  120900. */
  120901. readonly worldPosition: NodeMaterialConnectionPoint;
  120902. /**
  120903. * Gets the world normal input component
  120904. */
  120905. readonly worldNormal: NodeMaterialConnectionPoint;
  120906. /**
  120907. * Gets the world input component
  120908. */
  120909. readonly world: NodeMaterialConnectionPoint;
  120910. /**
  120911. * Gets the camera (or eye) position component
  120912. */
  120913. readonly cameraPosition: NodeMaterialConnectionPoint;
  120914. /**
  120915. * Gets the view input component
  120916. */
  120917. readonly view: NodeMaterialConnectionPoint;
  120918. /**
  120919. * Gets the rgb output component
  120920. */
  120921. readonly rgb: NodeMaterialConnectionPoint;
  120922. /**
  120923. * Gets the r output component
  120924. */
  120925. readonly r: NodeMaterialConnectionPoint;
  120926. /**
  120927. * Gets the g output component
  120928. */
  120929. readonly g: NodeMaterialConnectionPoint;
  120930. /**
  120931. * Gets the b output component
  120932. */
  120933. readonly b: NodeMaterialConnectionPoint;
  120934. autoConfigure(material: NodeMaterial): void;
  120935. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  120936. isReady(): boolean;
  120937. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  120938. private _injectVertexCode;
  120939. private _writeOutput;
  120940. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  120941. protected _dumpPropertiesCode(): string;
  120942. serialize(): any;
  120943. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  120944. }
  120945. }
  120946. declare module BABYLON {
  120947. /**
  120948. * Interface used to configure the node material editor
  120949. */
  120950. export interface INodeMaterialEditorOptions {
  120951. /** Define the URl to load node editor script */
  120952. editorURL?: string;
  120953. }
  120954. /** @hidden */
  120955. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  120956. /** BONES */
  120957. NUM_BONE_INFLUENCERS: number;
  120958. BonesPerMesh: number;
  120959. BONETEXTURE: boolean;
  120960. /** MORPH TARGETS */
  120961. MORPHTARGETS: boolean;
  120962. MORPHTARGETS_NORMAL: boolean;
  120963. MORPHTARGETS_TANGENT: boolean;
  120964. MORPHTARGETS_UV: boolean;
  120965. NUM_MORPH_INFLUENCERS: number;
  120966. /** IMAGE PROCESSING */
  120967. IMAGEPROCESSING: boolean;
  120968. VIGNETTE: boolean;
  120969. VIGNETTEBLENDMODEMULTIPLY: boolean;
  120970. VIGNETTEBLENDMODEOPAQUE: boolean;
  120971. TONEMAPPING: boolean;
  120972. TONEMAPPING_ACES: boolean;
  120973. CONTRAST: boolean;
  120974. EXPOSURE: boolean;
  120975. COLORCURVES: boolean;
  120976. COLORGRADING: boolean;
  120977. COLORGRADING3D: boolean;
  120978. SAMPLER3DGREENDEPTH: boolean;
  120979. SAMPLER3DBGRMAP: boolean;
  120980. IMAGEPROCESSINGPOSTPROCESS: boolean;
  120981. /** MISC. */
  120982. BUMPDIRECTUV: number;
  120983. constructor();
  120984. setValue(name: string, value: boolean): void;
  120985. }
  120986. /**
  120987. * Class used to configure NodeMaterial
  120988. */
  120989. export interface INodeMaterialOptions {
  120990. /**
  120991. * Defines if blocks should emit comments
  120992. */
  120993. emitComments: boolean;
  120994. }
  120995. /**
  120996. * Class used to create a node based material built by assembling shader blocks
  120997. */
  120998. export class NodeMaterial extends PushMaterial {
  120999. private static _BuildIdGenerator;
  121000. private _options;
  121001. private _vertexCompilationState;
  121002. private _fragmentCompilationState;
  121003. private _sharedData;
  121004. private _buildId;
  121005. private _buildWasSuccessful;
  121006. private _cachedWorldViewMatrix;
  121007. private _cachedWorldViewProjectionMatrix;
  121008. private _optimizers;
  121009. private _animationFrame;
  121010. /** Define the URl to load node editor script */
  121011. static EditorURL: string;
  121012. private BJSNODEMATERIALEDITOR;
  121013. /** Get the inspector from bundle or global */
  121014. private _getGlobalNodeMaterialEditor;
  121015. /**
  121016. * 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)
  121017. */
  121018. ignoreAlpha: boolean;
  121019. /**
  121020. * Defines the maximum number of lights that can be used in the material
  121021. */
  121022. maxSimultaneousLights: number;
  121023. /**
  121024. * Observable raised when the material is built
  121025. */
  121026. onBuildObservable: Observable<NodeMaterial>;
  121027. /**
  121028. * Gets or sets the root nodes of the material vertex shader
  121029. */
  121030. _vertexOutputNodes: NodeMaterialBlock[];
  121031. /**
  121032. * Gets or sets the root nodes of the material fragment (pixel) shader
  121033. */
  121034. _fragmentOutputNodes: NodeMaterialBlock[];
  121035. /** Gets or sets options to control the node material overall behavior */
  121036. options: INodeMaterialOptions;
  121037. /**
  121038. * Default configuration related to image processing available in the standard Material.
  121039. */
  121040. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  121041. /**
  121042. * Gets the image processing configuration used either in this material.
  121043. */
  121044. /**
  121045. * Sets the Default image processing configuration used either in the this material.
  121046. *
  121047. * If sets to null, the scene one is in use.
  121048. */
  121049. imageProcessingConfiguration: ImageProcessingConfiguration;
  121050. /**
  121051. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  121052. */
  121053. attachedBlocks: NodeMaterialBlock[];
  121054. /**
  121055. * Create a new node based material
  121056. * @param name defines the material name
  121057. * @param scene defines the hosting scene
  121058. * @param options defines creation option
  121059. */
  121060. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  121061. /**
  121062. * Gets the current class name of the material e.g. "NodeMaterial"
  121063. * @returns the class name
  121064. */
  121065. getClassName(): string;
  121066. /**
  121067. * Keep track of the image processing observer to allow dispose and replace.
  121068. */
  121069. private _imageProcessingObserver;
  121070. /**
  121071. * Attaches a new image processing configuration to the Standard Material.
  121072. * @param configuration
  121073. */
  121074. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  121075. /**
  121076. * Get a block by its name
  121077. * @param name defines the name of the block to retrieve
  121078. * @returns the required block or null if not found
  121079. */
  121080. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  121081. /**
  121082. * Get a block by its name
  121083. * @param predicate defines the predicate used to find the good candidate
  121084. * @returns the required block or null if not found
  121085. */
  121086. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  121087. /**
  121088. * Get an input block by its name
  121089. * @param predicate defines the predicate used to find the good candidate
  121090. * @returns the required input block or null if not found
  121091. */
  121092. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  121093. /**
  121094. * Gets the list of input blocks attached to this material
  121095. * @returns an array of InputBlocks
  121096. */
  121097. getInputBlocks(): InputBlock[];
  121098. /**
  121099. * Adds a new optimizer to the list of optimizers
  121100. * @param optimizer defines the optimizers to add
  121101. * @returns the current material
  121102. */
  121103. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  121104. /**
  121105. * Remove an optimizer from the list of optimizers
  121106. * @param optimizer defines the optimizers to remove
  121107. * @returns the current material
  121108. */
  121109. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  121110. /**
  121111. * Add a new block to the list of output nodes
  121112. * @param node defines the node to add
  121113. * @returns the current material
  121114. */
  121115. addOutputNode(node: NodeMaterialBlock): this;
  121116. /**
  121117. * Remove a block from the list of root nodes
  121118. * @param node defines the node to remove
  121119. * @returns the current material
  121120. */
  121121. removeOutputNode(node: NodeMaterialBlock): this;
  121122. private _addVertexOutputNode;
  121123. private _removeVertexOutputNode;
  121124. private _addFragmentOutputNode;
  121125. private _removeFragmentOutputNode;
  121126. /**
  121127. * Specifies if the material will require alpha blending
  121128. * @returns a boolean specifying if alpha blending is needed
  121129. */
  121130. needAlphaBlending(): boolean;
  121131. /**
  121132. * Specifies if this material should be rendered in alpha test mode
  121133. * @returns a boolean specifying if an alpha test is needed.
  121134. */
  121135. needAlphaTesting(): boolean;
  121136. private _initializeBlock;
  121137. private _resetDualBlocks;
  121138. /**
  121139. * Build the material and generates the inner effect
  121140. * @param verbose defines if the build should log activity
  121141. */
  121142. build(verbose?: boolean): void;
  121143. /**
  121144. * Runs an otpimization phase to try to improve the shader code
  121145. */
  121146. optimize(): void;
  121147. private _prepareDefinesForAttributes;
  121148. /**
  121149. * Get if the submesh is ready to be used and all its information available.
  121150. * Child classes can use it to update shaders
  121151. * @param mesh defines the mesh to check
  121152. * @param subMesh defines which submesh to check
  121153. * @param useInstances specifies that instances should be used
  121154. * @returns a boolean indicating that the submesh is ready or not
  121155. */
  121156. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  121157. /**
  121158. * Get a string representing the shaders built by the current node graph
  121159. */
  121160. readonly compiledShaders: string;
  121161. /**
  121162. * Binds the world matrix to the material
  121163. * @param world defines the world transformation matrix
  121164. */
  121165. bindOnlyWorldMatrix(world: Matrix): void;
  121166. /**
  121167. * Binds the submesh to this material by preparing the effect and shader to draw
  121168. * @param world defines the world transformation matrix
  121169. * @param mesh defines the mesh containing the submesh
  121170. * @param subMesh defines the submesh to bind the material to
  121171. */
  121172. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  121173. /**
  121174. * Gets the active textures from the material
  121175. * @returns an array of textures
  121176. */
  121177. getActiveTextures(): BaseTexture[];
  121178. /**
  121179. * Gets the list of texture blocks
  121180. * @returns an array of texture blocks
  121181. */
  121182. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  121183. /**
  121184. * Specifies if the material uses a texture
  121185. * @param texture defines the texture to check against the material
  121186. * @returns a boolean specifying if the material uses the texture
  121187. */
  121188. hasTexture(texture: BaseTexture): boolean;
  121189. /**
  121190. * Disposes the material
  121191. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  121192. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  121193. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  121194. */
  121195. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  121196. /** Creates the node editor window. */
  121197. private _createNodeEditor;
  121198. /**
  121199. * Launch the node material editor
  121200. * @param config Define the configuration of the editor
  121201. * @return a promise fulfilled when the node editor is visible
  121202. */
  121203. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  121204. /**
  121205. * Clear the current material
  121206. */
  121207. clear(): void;
  121208. /**
  121209. * Clear the current material and set it to a default state
  121210. */
  121211. setToDefault(): void;
  121212. /**
  121213. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  121214. * @param url defines the url to load from
  121215. * @returns a promise that will fullfil when the material is fully loaded
  121216. */
  121217. loadAsync(url: string): Promise<void>;
  121218. private _gatherBlocks;
  121219. /**
  121220. * Generate a string containing the code declaration required to create an equivalent of this material
  121221. * @returns a string
  121222. */
  121223. generateCode(): string;
  121224. /**
  121225. * Serializes this material in a JSON representation
  121226. * @returns the serialized material object
  121227. */
  121228. serialize(): any;
  121229. private _restoreConnections;
  121230. /**
  121231. * Clear the current graph and load a new one from a serialization object
  121232. * @param source defines the JSON representation of the material
  121233. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  121234. */
  121235. loadFromSerialization(source: any, rootUrl?: string): void;
  121236. /**
  121237. * Creates a node material from parsed material data
  121238. * @param source defines the JSON representation of the material
  121239. * @param scene defines the hosting scene
  121240. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  121241. * @returns a new node material
  121242. */
  121243. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  121244. /**
  121245. * Creates a new node material set to default basic configuration
  121246. * @param name defines the name of the material
  121247. * @param scene defines the hosting scene
  121248. * @returns a new NodeMaterial
  121249. */
  121250. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  121251. }
  121252. }
  121253. declare module BABYLON {
  121254. /**
  121255. * Block used to read a texture from a sampler
  121256. */
  121257. export class TextureBlock extends NodeMaterialBlock {
  121258. private _defineName;
  121259. private _linearDefineName;
  121260. private _samplerName;
  121261. private _transformedUVName;
  121262. private _textureTransformName;
  121263. private _textureInfoName;
  121264. private _mainUVName;
  121265. private _mainUVDefineName;
  121266. /**
  121267. * Gets or sets the texture associated with the node
  121268. */
  121269. texture: Nullable<Texture>;
  121270. /**
  121271. * Create a new TextureBlock
  121272. * @param name defines the block name
  121273. */
  121274. constructor(name: string);
  121275. /**
  121276. * Gets the current class name
  121277. * @returns the class name
  121278. */
  121279. getClassName(): string;
  121280. /**
  121281. * Gets the uv input component
  121282. */
  121283. readonly uv: NodeMaterialConnectionPoint;
  121284. /**
  121285. * Gets the rgba output component
  121286. */
  121287. readonly rgba: NodeMaterialConnectionPoint;
  121288. /**
  121289. * Gets the rgb output component
  121290. */
  121291. readonly rgb: NodeMaterialConnectionPoint;
  121292. /**
  121293. * Gets the r output component
  121294. */
  121295. readonly r: NodeMaterialConnectionPoint;
  121296. /**
  121297. * Gets the g output component
  121298. */
  121299. readonly g: NodeMaterialConnectionPoint;
  121300. /**
  121301. * Gets the b output component
  121302. */
  121303. readonly b: NodeMaterialConnectionPoint;
  121304. /**
  121305. * Gets the a output component
  121306. */
  121307. readonly a: NodeMaterialConnectionPoint;
  121308. readonly target: NodeMaterialBlockTargets;
  121309. autoConfigure(material: NodeMaterial): void;
  121310. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  121311. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  121312. isReady(): boolean;
  121313. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  121314. private readonly _isMixed;
  121315. private _injectVertexCode;
  121316. private _writeOutput;
  121317. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  121318. protected _dumpPropertiesCode(): string;
  121319. serialize(): any;
  121320. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121321. }
  121322. }
  121323. declare module BABYLON {
  121324. /**
  121325. * Class used to store shared data between 2 NodeMaterialBuildState
  121326. */
  121327. export class NodeMaterialBuildStateSharedData {
  121328. /**
  121329. * Gets the list of emitted varyings
  121330. */
  121331. temps: string[];
  121332. /**
  121333. * Gets the list of emitted varyings
  121334. */
  121335. varyings: string[];
  121336. /**
  121337. * Gets the varying declaration string
  121338. */
  121339. varyingDeclaration: string;
  121340. /**
  121341. * Input blocks
  121342. */
  121343. inputBlocks: InputBlock[];
  121344. /**
  121345. * Input blocks
  121346. */
  121347. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  121348. /**
  121349. * Bindable blocks (Blocks that need to set data to the effect)
  121350. */
  121351. bindableBlocks: NodeMaterialBlock[];
  121352. /**
  121353. * List of blocks that can provide a compilation fallback
  121354. */
  121355. blocksWithFallbacks: NodeMaterialBlock[];
  121356. /**
  121357. * List of blocks that can provide a define update
  121358. */
  121359. blocksWithDefines: NodeMaterialBlock[];
  121360. /**
  121361. * List of blocks that can provide a repeatable content
  121362. */
  121363. repeatableContentBlocks: NodeMaterialBlock[];
  121364. /**
  121365. * List of blocks that can provide a dynamic list of uniforms
  121366. */
  121367. dynamicUniformBlocks: NodeMaterialBlock[];
  121368. /**
  121369. * List of blocks that can block the isReady function for the material
  121370. */
  121371. blockingBlocks: NodeMaterialBlock[];
  121372. /**
  121373. * Gets the list of animated inputs
  121374. */
  121375. animatedInputs: InputBlock[];
  121376. /**
  121377. * Build Id used to avoid multiple recompilations
  121378. */
  121379. buildId: number;
  121380. /** List of emitted variables */
  121381. variableNames: {
  121382. [key: string]: number;
  121383. };
  121384. /** List of emitted defines */
  121385. defineNames: {
  121386. [key: string]: number;
  121387. };
  121388. /** Should emit comments? */
  121389. emitComments: boolean;
  121390. /** Emit build activity */
  121391. verbose: boolean;
  121392. /** Gets or sets the hosting scene */
  121393. scene: Scene;
  121394. /**
  121395. * Gets the compilation hints emitted at compilation time
  121396. */
  121397. hints: {
  121398. needWorldViewMatrix: boolean;
  121399. needWorldViewProjectionMatrix: boolean;
  121400. needAlphaBlending: boolean;
  121401. needAlphaTesting: boolean;
  121402. };
  121403. /**
  121404. * List of compilation checks
  121405. */
  121406. checks: {
  121407. emitVertex: boolean;
  121408. emitFragment: boolean;
  121409. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  121410. };
  121411. /** Creates a new shared data */
  121412. constructor();
  121413. /**
  121414. * Emits console errors and exceptions if there is a failing check
  121415. */
  121416. emitErrors(): void;
  121417. }
  121418. }
  121419. declare module BABYLON {
  121420. /**
  121421. * Class used to store node based material build state
  121422. */
  121423. export class NodeMaterialBuildState {
  121424. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  121425. supportUniformBuffers: boolean;
  121426. /**
  121427. * Gets the list of emitted attributes
  121428. */
  121429. attributes: string[];
  121430. /**
  121431. * Gets the list of emitted uniforms
  121432. */
  121433. uniforms: string[];
  121434. /**
  121435. * Gets the list of emitted constants
  121436. */
  121437. constants: string[];
  121438. /**
  121439. * Gets the list of emitted samplers
  121440. */
  121441. samplers: string[];
  121442. /**
  121443. * Gets the list of emitted functions
  121444. */
  121445. functions: {
  121446. [key: string]: string;
  121447. };
  121448. /**
  121449. * Gets the list of emitted extensions
  121450. */
  121451. extensions: {
  121452. [key: string]: string;
  121453. };
  121454. /**
  121455. * Gets the target of the compilation state
  121456. */
  121457. target: NodeMaterialBlockTargets;
  121458. /**
  121459. * Gets the list of emitted counters
  121460. */
  121461. counters: {
  121462. [key: string]: number;
  121463. };
  121464. /**
  121465. * Shared data between multiple NodeMaterialBuildState instances
  121466. */
  121467. sharedData: NodeMaterialBuildStateSharedData;
  121468. /** @hidden */
  121469. _vertexState: NodeMaterialBuildState;
  121470. /** @hidden */
  121471. _attributeDeclaration: string;
  121472. /** @hidden */
  121473. _uniformDeclaration: string;
  121474. /** @hidden */
  121475. _constantDeclaration: string;
  121476. /** @hidden */
  121477. _samplerDeclaration: string;
  121478. /** @hidden */
  121479. _varyingTransfer: string;
  121480. private _repeatableContentAnchorIndex;
  121481. /** @hidden */
  121482. _builtCompilationString: string;
  121483. /**
  121484. * Gets the emitted compilation strings
  121485. */
  121486. compilationString: string;
  121487. /**
  121488. * Finalize the compilation strings
  121489. * @param state defines the current compilation state
  121490. */
  121491. finalize(state: NodeMaterialBuildState): void;
  121492. /** @hidden */
  121493. readonly _repeatableContentAnchor: string;
  121494. /** @hidden */
  121495. _getFreeVariableName(prefix: string): string;
  121496. /** @hidden */
  121497. _getFreeDefineName(prefix: string): string;
  121498. /** @hidden */
  121499. _excludeVariableName(name: string): void;
  121500. /** @hidden */
  121501. _emit2DSampler(name: string): void;
  121502. /** @hidden */
  121503. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  121504. /** @hidden */
  121505. _emitExtension(name: string, extension: string): void;
  121506. /** @hidden */
  121507. _emitFunction(name: string, code: string, comments: string): void;
  121508. /** @hidden */
  121509. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  121510. replaceStrings?: {
  121511. search: RegExp;
  121512. replace: string;
  121513. }[];
  121514. repeatKey?: string;
  121515. }): string;
  121516. /** @hidden */
  121517. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  121518. repeatKey?: string;
  121519. removeAttributes?: boolean;
  121520. removeUniforms?: boolean;
  121521. removeVaryings?: boolean;
  121522. removeIfDef?: boolean;
  121523. replaceStrings?: {
  121524. search: RegExp;
  121525. replace: string;
  121526. }[];
  121527. }, storeKey?: string): void;
  121528. /** @hidden */
  121529. _registerTempVariable(name: string): boolean;
  121530. /** @hidden */
  121531. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  121532. /** @hidden */
  121533. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  121534. /** @hidden */
  121535. _emitFloat(value: number): string;
  121536. }
  121537. }
  121538. declare module BABYLON {
  121539. /**
  121540. * Defines a block that can be used inside a node based material
  121541. */
  121542. export class NodeMaterialBlock {
  121543. private _buildId;
  121544. private _buildTarget;
  121545. private _target;
  121546. private _isFinalMerger;
  121547. private _isInput;
  121548. /** @hidden */
  121549. _codeVariableName: string;
  121550. /** @hidden */
  121551. _inputs: NodeMaterialConnectionPoint[];
  121552. /** @hidden */
  121553. _outputs: NodeMaterialConnectionPoint[];
  121554. /** @hidden */
  121555. _preparationId: number;
  121556. /**
  121557. * Gets or sets the name of the block
  121558. */
  121559. name: string;
  121560. /**
  121561. * Gets or sets the unique id of the node
  121562. */
  121563. uniqueId: number;
  121564. /**
  121565. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  121566. */
  121567. readonly isFinalMerger: boolean;
  121568. /**
  121569. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  121570. */
  121571. readonly isInput: boolean;
  121572. /**
  121573. * Gets or sets the build Id
  121574. */
  121575. buildId: number;
  121576. /**
  121577. * Gets or sets the target of the block
  121578. */
  121579. target: NodeMaterialBlockTargets;
  121580. /**
  121581. * Gets the list of input points
  121582. */
  121583. readonly inputs: NodeMaterialConnectionPoint[];
  121584. /** Gets the list of output points */
  121585. readonly outputs: NodeMaterialConnectionPoint[];
  121586. /**
  121587. * Find an input by its name
  121588. * @param name defines the name of the input to look for
  121589. * @returns the input or null if not found
  121590. */
  121591. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  121592. /**
  121593. * Find an output by its name
  121594. * @param name defines the name of the outputto look for
  121595. * @returns the output or null if not found
  121596. */
  121597. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  121598. /**
  121599. * Creates a new NodeMaterialBlock
  121600. * @param name defines the block name
  121601. * @param target defines the target of that block (Vertex by default)
  121602. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  121603. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  121604. */
  121605. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  121606. /**
  121607. * Initialize the block and prepare the context for build
  121608. * @param state defines the state that will be used for the build
  121609. */
  121610. initialize(state: NodeMaterialBuildState): void;
  121611. /**
  121612. * Bind data to effect. Will only be called for blocks with isBindable === true
  121613. * @param effect defines the effect to bind data to
  121614. * @param nodeMaterial defines the hosting NodeMaterial
  121615. * @param mesh defines the mesh that will be rendered
  121616. */
  121617. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  121618. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  121619. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  121620. protected _writeFloat(value: number): string;
  121621. /**
  121622. * Gets the current class name e.g. "NodeMaterialBlock"
  121623. * @returns the class name
  121624. */
  121625. getClassName(): string;
  121626. /**
  121627. * Register a new input. Must be called inside a block constructor
  121628. * @param name defines the connection point name
  121629. * @param type defines the connection point type
  121630. * @param isOptional defines a boolean indicating that this input can be omitted
  121631. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  121632. * @returns the current block
  121633. */
  121634. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  121635. /**
  121636. * Register a new output. Must be called inside a block constructor
  121637. * @param name defines the connection point name
  121638. * @param type defines the connection point type
  121639. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  121640. * @returns the current block
  121641. */
  121642. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  121643. /**
  121644. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  121645. * @param forOutput defines an optional connection point to check compatibility with
  121646. * @returns the first available input or null
  121647. */
  121648. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  121649. /**
  121650. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  121651. * @param forBlock defines an optional block to check compatibility with
  121652. * @returns the first available input or null
  121653. */
  121654. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  121655. /**
  121656. * Gets the sibling of the given output
  121657. * @param current defines the current output
  121658. * @returns the next output in the list or null
  121659. */
  121660. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  121661. /**
  121662. * Connect current block with another block
  121663. * @param other defines the block to connect with
  121664. * @param options define the various options to help pick the right connections
  121665. * @returns the current block
  121666. */
  121667. connectTo(other: NodeMaterialBlock, options?: {
  121668. input?: string;
  121669. output?: string;
  121670. outputSwizzle?: string;
  121671. }): this | undefined;
  121672. protected _buildBlock(state: NodeMaterialBuildState): void;
  121673. /**
  121674. * Add uniforms, samplers and uniform buffers at compilation time
  121675. * @param state defines the state to update
  121676. * @param nodeMaterial defines the node material requesting the update
  121677. * @param defines defines the material defines to update
  121678. * @param uniformBuffers defines the list of uniform buffer names
  121679. */
  121680. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  121681. /**
  121682. * Add potential fallbacks if shader compilation fails
  121683. * @param mesh defines the mesh to be rendered
  121684. * @param fallbacks defines the current prioritized list of fallbacks
  121685. */
  121686. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  121687. /**
  121688. * Initialize defines for shader compilation
  121689. * @param mesh defines the mesh to be rendered
  121690. * @param nodeMaterial defines the node material requesting the update
  121691. * @param defines defines the material defines to update
  121692. * @param useInstances specifies that instances should be used
  121693. */
  121694. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  121695. /**
  121696. * Update defines for shader compilation
  121697. * @param mesh defines the mesh to be rendered
  121698. * @param nodeMaterial defines the node material requesting the update
  121699. * @param defines defines the material defines to update
  121700. * @param useInstances specifies that instances should be used
  121701. */
  121702. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  121703. /**
  121704. * Lets the block try to connect some inputs automatically
  121705. * @param material defines the hosting NodeMaterial
  121706. */
  121707. autoConfigure(material: NodeMaterial): void;
  121708. /**
  121709. * Function called when a block is declared as repeatable content generator
  121710. * @param vertexShaderState defines the current compilation state for the vertex shader
  121711. * @param fragmentShaderState defines the current compilation state for the fragment shader
  121712. * @param mesh defines the mesh to be rendered
  121713. * @param defines defines the material defines to update
  121714. */
  121715. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  121716. /**
  121717. * Checks if the block is ready
  121718. * @param mesh defines the mesh to be rendered
  121719. * @param nodeMaterial defines the node material requesting the update
  121720. * @param defines defines the material defines to update
  121721. * @param useInstances specifies that instances should be used
  121722. * @returns true if the block is ready
  121723. */
  121724. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  121725. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  121726. private _processBuild;
  121727. /**
  121728. * Compile the current node and generate the shader code
  121729. * @param state defines the current compilation state (uniforms, samplers, current string)
  121730. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  121731. * @returns true if already built
  121732. */
  121733. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  121734. protected _inputRename(name: string): string;
  121735. protected _outputRename(name: string): string;
  121736. protected _dumpPropertiesCode(): string;
  121737. /** @hidden */
  121738. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  121739. /** @hidden */
  121740. _dumpCodeForOutputConnections(): string;
  121741. /**
  121742. * Clone the current block to a new identical block
  121743. * @param scene defines the hosting scene
  121744. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  121745. * @returns a copy of the current block
  121746. */
  121747. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  121748. /**
  121749. * Serializes this block in a JSON representation
  121750. * @returns the serialized block object
  121751. */
  121752. serialize(): any;
  121753. /** @hidden */
  121754. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121755. /**
  121756. * Release resources
  121757. */
  121758. dispose(): void;
  121759. }
  121760. }
  121761. declare module BABYLON {
  121762. /**
  121763. * Enum defining the type of animations supported by InputBlock
  121764. */
  121765. export enum AnimatedInputBlockTypes {
  121766. /** No animation */
  121767. None = 0,
  121768. /** Time based animation. Will only work for floats */
  121769. Time = 1
  121770. }
  121771. }
  121772. declare module BABYLON {
  121773. /**
  121774. * Block used to expose an input value
  121775. */
  121776. export class InputBlock extends NodeMaterialBlock {
  121777. private _mode;
  121778. private _associatedVariableName;
  121779. private _storedValue;
  121780. private _valueCallback;
  121781. private _type;
  121782. private _animationType;
  121783. /** Gets or set a value used to limit the range of float values */
  121784. min: number;
  121785. /** Gets or set a value used to limit the range of float values */
  121786. max: number;
  121787. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  121788. matrixMode: number;
  121789. /** @hidden */
  121790. _systemValue: Nullable<NodeMaterialSystemValues>;
  121791. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  121792. visibleInInspector: boolean;
  121793. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  121794. isConstant: boolean;
  121795. /**
  121796. * Gets or sets the connection point type (default is float)
  121797. */
  121798. readonly type: NodeMaterialBlockConnectionPointTypes;
  121799. /**
  121800. * Creates a new InputBlock
  121801. * @param name defines the block name
  121802. * @param target defines the target of that block (Vertex by default)
  121803. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  121804. */
  121805. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  121806. /**
  121807. * Gets the output component
  121808. */
  121809. readonly output: NodeMaterialConnectionPoint;
  121810. /**
  121811. * Set the source of this connection point to a vertex attribute
  121812. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  121813. * @returns the current connection point
  121814. */
  121815. setAsAttribute(attributeName?: string): InputBlock;
  121816. /**
  121817. * Set the source of this connection point to a system value
  121818. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  121819. * @returns the current connection point
  121820. */
  121821. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  121822. /**
  121823. * Gets or sets the value of that point.
  121824. * Please note that this value will be ignored if valueCallback is defined
  121825. */
  121826. value: any;
  121827. /**
  121828. * Gets or sets a callback used to get the value of that point.
  121829. * Please note that setting this value will force the connection point to ignore the value property
  121830. */
  121831. valueCallback: () => any;
  121832. /**
  121833. * Gets or sets the associated variable name in the shader
  121834. */
  121835. associatedVariableName: string;
  121836. /** Gets or sets the type of animation applied to the input */
  121837. animationType: AnimatedInputBlockTypes;
  121838. /**
  121839. * Gets a boolean indicating that this connection point not defined yet
  121840. */
  121841. readonly isUndefined: boolean;
  121842. /**
  121843. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  121844. * In this case the connection point name must be the name of the uniform to use.
  121845. * Can only be set on inputs
  121846. */
  121847. isUniform: boolean;
  121848. /**
  121849. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  121850. * In this case the connection point name must be the name of the attribute to use
  121851. * Can only be set on inputs
  121852. */
  121853. isAttribute: boolean;
  121854. /**
  121855. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  121856. * Can only be set on exit points
  121857. */
  121858. isVarying: boolean;
  121859. /**
  121860. * Gets a boolean indicating that the current connection point is a system value
  121861. */
  121862. readonly isSystemValue: boolean;
  121863. /**
  121864. * Gets or sets the current well known value or null if not defined as a system value
  121865. */
  121866. systemValue: Nullable<NodeMaterialSystemValues>;
  121867. /**
  121868. * Gets the current class name
  121869. * @returns the class name
  121870. */
  121871. getClassName(): string;
  121872. /**
  121873. * Animate the input if animationType !== None
  121874. * @param scene defines the rendering scene
  121875. */
  121876. animate(scene: Scene): void;
  121877. private _emitDefine;
  121878. initialize(state: NodeMaterialBuildState): void;
  121879. /**
  121880. * Set the input block to its default value (based on its type)
  121881. */
  121882. setDefaultValue(): void;
  121883. private _emitConstant;
  121884. private _emit;
  121885. /** @hidden */
  121886. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  121887. /** @hidden */
  121888. _transmit(effect: Effect, scene: Scene): void;
  121889. protected _buildBlock(state: NodeMaterialBuildState): void;
  121890. protected _dumpPropertiesCode(): string;
  121891. serialize(): any;
  121892. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121893. }
  121894. }
  121895. declare module BABYLON {
  121896. /**
  121897. * Defines a connection point for a block
  121898. */
  121899. export class NodeMaterialConnectionPoint {
  121900. /** @hidden */
  121901. _ownerBlock: NodeMaterialBlock;
  121902. /** @hidden */
  121903. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  121904. private _endpoints;
  121905. private _associatedVariableName;
  121906. /** @hidden */
  121907. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  121908. /** @hidden */
  121909. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  121910. private _type;
  121911. /** @hidden */
  121912. _enforceAssociatedVariableName: boolean;
  121913. /**
  121914. * Gets or sets the additional types supported by this connection point
  121915. */
  121916. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  121917. /**
  121918. * Gets or sets the additional types excluded by this connection point
  121919. */
  121920. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  121921. /**
  121922. * Observable triggered when this point is connected
  121923. */
  121924. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  121925. /**
  121926. * Gets or sets the associated variable name in the shader
  121927. */
  121928. associatedVariableName: string;
  121929. /**
  121930. * Gets or sets the connection point type (default is float)
  121931. */
  121932. type: NodeMaterialBlockConnectionPointTypes;
  121933. /**
  121934. * Gets or sets the connection point name
  121935. */
  121936. name: string;
  121937. /**
  121938. * Gets or sets a boolean indicating that this connection point can be omitted
  121939. */
  121940. isOptional: boolean;
  121941. /**
  121942. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  121943. */
  121944. define: string;
  121945. /** @hidden */
  121946. _prioritizeVertex: boolean;
  121947. private _target;
  121948. /** Gets or sets the target of that connection point */
  121949. target: NodeMaterialBlockTargets;
  121950. /**
  121951. * Gets a boolean indicating that the current point is connected
  121952. */
  121953. readonly isConnected: boolean;
  121954. /**
  121955. * Gets a boolean indicating that the current point is connected to an input block
  121956. */
  121957. readonly isConnectedToInputBlock: boolean;
  121958. /**
  121959. * Gets a the connected input block (if any)
  121960. */
  121961. readonly connectInputBlock: Nullable<InputBlock>;
  121962. /** Get the other side of the connection (if any) */
  121963. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  121964. /** Get the block that owns this connection point */
  121965. readonly ownerBlock: NodeMaterialBlock;
  121966. /** Get the block connected on the other side of this connection (if any) */
  121967. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  121968. /** Get the block connected on the endpoints of this connection (if any) */
  121969. readonly connectedBlocks: Array<NodeMaterialBlock>;
  121970. /** Gets the list of connected endpoints */
  121971. readonly endpoints: NodeMaterialConnectionPoint[];
  121972. /** Gets a boolean indicating if that output point is connected to at least one input */
  121973. readonly hasEndpoints: boolean;
  121974. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  121975. readonly isConnectedInVertexShader: boolean;
  121976. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  121977. readonly isConnectedInFragmentShader: boolean;
  121978. /**
  121979. * Creates a new connection point
  121980. * @param name defines the connection point name
  121981. * @param ownerBlock defines the block hosting this connection point
  121982. */
  121983. constructor(name: string, ownerBlock: NodeMaterialBlock);
  121984. /**
  121985. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  121986. * @returns the class name
  121987. */
  121988. getClassName(): string;
  121989. /**
  121990. * Gets an boolean indicating if the current point can be connected to another point
  121991. * @param connectionPoint defines the other connection point
  121992. * @returns true if the connection is possible
  121993. */
  121994. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  121995. /**
  121996. * Connect this point to another connection point
  121997. * @param connectionPoint defines the other connection point
  121998. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  121999. * @returns the current connection point
  122000. */
  122001. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  122002. /**
  122003. * Disconnect this point from one of his endpoint
  122004. * @param endpoint defines the other connection point
  122005. * @returns the current connection point
  122006. */
  122007. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  122008. /**
  122009. * Serializes this point in a JSON representation
  122010. * @returns the serialized point object
  122011. */
  122012. serialize(): any;
  122013. /**
  122014. * Release resources
  122015. */
  122016. dispose(): void;
  122017. }
  122018. }
  122019. declare module BABYLON {
  122020. /**
  122021. * Block used to add support for vertex skinning (bones)
  122022. */
  122023. export class BonesBlock extends NodeMaterialBlock {
  122024. /**
  122025. * Creates a new BonesBlock
  122026. * @param name defines the block name
  122027. */
  122028. constructor(name: string);
  122029. /**
  122030. * Initialize the block and prepare the context for build
  122031. * @param state defines the state that will be used for the build
  122032. */
  122033. initialize(state: NodeMaterialBuildState): void;
  122034. /**
  122035. * Gets the current class name
  122036. * @returns the class name
  122037. */
  122038. getClassName(): string;
  122039. /**
  122040. * Gets the matrix indices input component
  122041. */
  122042. readonly matricesIndices: NodeMaterialConnectionPoint;
  122043. /**
  122044. * Gets the matrix weights input component
  122045. */
  122046. readonly matricesWeights: NodeMaterialConnectionPoint;
  122047. /**
  122048. * Gets the extra matrix indices input component
  122049. */
  122050. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  122051. /**
  122052. * Gets the extra matrix weights input component
  122053. */
  122054. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  122055. /**
  122056. * Gets the world input component
  122057. */
  122058. readonly world: NodeMaterialConnectionPoint;
  122059. /**
  122060. * Gets the output component
  122061. */
  122062. readonly output: NodeMaterialConnectionPoint;
  122063. autoConfigure(material: NodeMaterial): void;
  122064. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  122065. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122066. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122067. protected _buildBlock(state: NodeMaterialBuildState): this;
  122068. }
  122069. }
  122070. declare module BABYLON {
  122071. /**
  122072. * Block used to add support for instances
  122073. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  122074. */
  122075. export class InstancesBlock extends NodeMaterialBlock {
  122076. /**
  122077. * Creates a new InstancesBlock
  122078. * @param name defines the block name
  122079. */
  122080. constructor(name: string);
  122081. /**
  122082. * Gets the current class name
  122083. * @returns the class name
  122084. */
  122085. getClassName(): string;
  122086. /**
  122087. * Gets the first world row input component
  122088. */
  122089. readonly world0: NodeMaterialConnectionPoint;
  122090. /**
  122091. * Gets the second world row input component
  122092. */
  122093. readonly world1: NodeMaterialConnectionPoint;
  122094. /**
  122095. * Gets the third world row input component
  122096. */
  122097. readonly world2: NodeMaterialConnectionPoint;
  122098. /**
  122099. * Gets the forth world row input component
  122100. */
  122101. readonly world3: NodeMaterialConnectionPoint;
  122102. /**
  122103. * Gets the world input component
  122104. */
  122105. readonly world: NodeMaterialConnectionPoint;
  122106. /**
  122107. * Gets the output component
  122108. */
  122109. readonly output: NodeMaterialConnectionPoint;
  122110. autoConfigure(material: NodeMaterial): void;
  122111. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  122112. protected _buildBlock(state: NodeMaterialBuildState): this;
  122113. }
  122114. }
  122115. declare module BABYLON {
  122116. /**
  122117. * Block used to add morph targets support to vertex shader
  122118. */
  122119. export class MorphTargetsBlock extends NodeMaterialBlock {
  122120. private _repeatableContentAnchor;
  122121. private _repeatebleContentGenerated;
  122122. /**
  122123. * Create a new MorphTargetsBlock
  122124. * @param name defines the block name
  122125. */
  122126. constructor(name: string);
  122127. /**
  122128. * Gets the current class name
  122129. * @returns the class name
  122130. */
  122131. getClassName(): string;
  122132. /**
  122133. * Gets the position input component
  122134. */
  122135. readonly position: NodeMaterialConnectionPoint;
  122136. /**
  122137. * Gets the normal input component
  122138. */
  122139. readonly normal: NodeMaterialConnectionPoint;
  122140. /**
  122141. * Gets the tangent input component
  122142. */
  122143. readonly tangent: NodeMaterialConnectionPoint;
  122144. /**
  122145. * Gets the tangent input component
  122146. */
  122147. readonly uv: NodeMaterialConnectionPoint;
  122148. /**
  122149. * Gets the position output component
  122150. */
  122151. readonly positionOutput: NodeMaterialConnectionPoint;
  122152. /**
  122153. * Gets the normal output component
  122154. */
  122155. readonly normalOutput: NodeMaterialConnectionPoint;
  122156. /**
  122157. * Gets the tangent output component
  122158. */
  122159. readonly tangentOutput: NodeMaterialConnectionPoint;
  122160. /**
  122161. * Gets the tangent output component
  122162. */
  122163. readonly uvOutput: NodeMaterialConnectionPoint;
  122164. initialize(state: NodeMaterialBuildState): void;
  122165. autoConfigure(material: NodeMaterial): void;
  122166. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122167. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122168. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  122169. protected _buildBlock(state: NodeMaterialBuildState): this;
  122170. }
  122171. }
  122172. declare module BABYLON {
  122173. /**
  122174. * Block used to get data information from a light
  122175. */
  122176. export class LightInformationBlock extends NodeMaterialBlock {
  122177. private _lightDataUniformName;
  122178. private _lightColorUniformName;
  122179. private _lightTypeDefineName;
  122180. /**
  122181. * Gets or sets the light associated with this block
  122182. */
  122183. light: Nullable<Light>;
  122184. /**
  122185. * Creates a new LightInformationBlock
  122186. * @param name defines the block name
  122187. */
  122188. constructor(name: string);
  122189. /**
  122190. * Gets the current class name
  122191. * @returns the class name
  122192. */
  122193. getClassName(): string;
  122194. /**
  122195. * Gets the world position input component
  122196. */
  122197. readonly worldPosition: NodeMaterialConnectionPoint;
  122198. /**
  122199. * Gets the direction output component
  122200. */
  122201. readonly direction: NodeMaterialConnectionPoint;
  122202. /**
  122203. * Gets the direction output component
  122204. */
  122205. readonly color: NodeMaterialConnectionPoint;
  122206. /**
  122207. * Gets the direction output component
  122208. */
  122209. readonly intensity: NodeMaterialConnectionPoint;
  122210. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122211. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122212. protected _buildBlock(state: NodeMaterialBuildState): this;
  122213. serialize(): any;
  122214. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122215. }
  122216. }
  122217. declare module BABYLON {
  122218. /**
  122219. * Block used to add image processing support to fragment shader
  122220. */
  122221. export class ImageProcessingBlock extends NodeMaterialBlock {
  122222. /**
  122223. * Create a new ImageProcessingBlock
  122224. * @param name defines the block name
  122225. */
  122226. constructor(name: string);
  122227. /**
  122228. * Gets the current class name
  122229. * @returns the class name
  122230. */
  122231. getClassName(): string;
  122232. /**
  122233. * Gets the color input component
  122234. */
  122235. readonly color: NodeMaterialConnectionPoint;
  122236. /**
  122237. * Gets the output component
  122238. */
  122239. readonly output: NodeMaterialConnectionPoint;
  122240. /**
  122241. * Initialize the block and prepare the context for build
  122242. * @param state defines the state that will be used for the build
  122243. */
  122244. initialize(state: NodeMaterialBuildState): void;
  122245. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  122246. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122247. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122248. protected _buildBlock(state: NodeMaterialBuildState): this;
  122249. }
  122250. }
  122251. declare module BABYLON {
  122252. /**
  122253. * Block used to pertub normals based on a normal map
  122254. */
  122255. export class PerturbNormalBlock extends NodeMaterialBlock {
  122256. private _tangentSpaceParameterName;
  122257. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  122258. invertX: boolean;
  122259. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  122260. invertY: boolean;
  122261. /**
  122262. * Create a new PerturbNormalBlock
  122263. * @param name defines the block name
  122264. */
  122265. constructor(name: string);
  122266. /**
  122267. * Gets the current class name
  122268. * @returns the class name
  122269. */
  122270. getClassName(): string;
  122271. /**
  122272. * Gets the world position input component
  122273. */
  122274. readonly worldPosition: NodeMaterialConnectionPoint;
  122275. /**
  122276. * Gets the world normal input component
  122277. */
  122278. readonly worldNormal: NodeMaterialConnectionPoint;
  122279. /**
  122280. * Gets the uv input component
  122281. */
  122282. readonly uv: NodeMaterialConnectionPoint;
  122283. /**
  122284. * Gets the normal map color input component
  122285. */
  122286. readonly normalMapColor: NodeMaterialConnectionPoint;
  122287. /**
  122288. * Gets the strength input component
  122289. */
  122290. readonly strength: NodeMaterialConnectionPoint;
  122291. /**
  122292. * Gets the output component
  122293. */
  122294. readonly output: NodeMaterialConnectionPoint;
  122295. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122296. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122297. autoConfigure(material: NodeMaterial): void;
  122298. protected _buildBlock(state: NodeMaterialBuildState): this;
  122299. protected _dumpPropertiesCode(): string;
  122300. serialize(): any;
  122301. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122302. }
  122303. }
  122304. declare module BABYLON {
  122305. /**
  122306. * Block used to discard a pixel if a value is smaller than a cutoff
  122307. */
  122308. export class DiscardBlock extends NodeMaterialBlock {
  122309. /**
  122310. * Create a new DiscardBlock
  122311. * @param name defines the block name
  122312. */
  122313. constructor(name: string);
  122314. /**
  122315. * Gets the current class name
  122316. * @returns the class name
  122317. */
  122318. getClassName(): string;
  122319. /**
  122320. * Gets the color input component
  122321. */
  122322. readonly value: NodeMaterialConnectionPoint;
  122323. /**
  122324. * Gets the cutoff input component
  122325. */
  122326. readonly cutoff: NodeMaterialConnectionPoint;
  122327. protected _buildBlock(state: NodeMaterialBuildState): this;
  122328. }
  122329. }
  122330. declare module BABYLON {
  122331. /**
  122332. * Block used to add support for scene fog
  122333. */
  122334. export class FogBlock extends NodeMaterialBlock {
  122335. private _fogDistanceName;
  122336. private _fogParameters;
  122337. /**
  122338. * Create a new FogBlock
  122339. * @param name defines the block name
  122340. */
  122341. constructor(name: string);
  122342. /**
  122343. * Gets the current class name
  122344. * @returns the class name
  122345. */
  122346. getClassName(): string;
  122347. /**
  122348. * Gets the world position input component
  122349. */
  122350. readonly worldPosition: NodeMaterialConnectionPoint;
  122351. /**
  122352. * Gets the view input component
  122353. */
  122354. readonly view: NodeMaterialConnectionPoint;
  122355. /**
  122356. * Gets the color input component
  122357. */
  122358. readonly input: NodeMaterialConnectionPoint;
  122359. /**
  122360. * Gets the fog color input component
  122361. */
  122362. readonly fogColor: NodeMaterialConnectionPoint;
  122363. /**
  122364. * Gets the output component
  122365. */
  122366. readonly output: NodeMaterialConnectionPoint;
  122367. autoConfigure(material: NodeMaterial): void;
  122368. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122369. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122370. protected _buildBlock(state: NodeMaterialBuildState): this;
  122371. }
  122372. }
  122373. declare module BABYLON {
  122374. /**
  122375. * Block used to add light in the fragment shader
  122376. */
  122377. export class LightBlock extends NodeMaterialBlock {
  122378. private _lightId;
  122379. /**
  122380. * Gets or sets the light associated with this block
  122381. */
  122382. light: Nullable<Light>;
  122383. /**
  122384. * Create a new LightBlock
  122385. * @param name defines the block name
  122386. */
  122387. constructor(name: string);
  122388. /**
  122389. * Gets the current class name
  122390. * @returns the class name
  122391. */
  122392. getClassName(): string;
  122393. /**
  122394. * Gets the world position input component
  122395. */
  122396. readonly worldPosition: NodeMaterialConnectionPoint;
  122397. /**
  122398. * Gets the world normal input component
  122399. */
  122400. readonly worldNormal: NodeMaterialConnectionPoint;
  122401. /**
  122402. * Gets the camera (or eye) position component
  122403. */
  122404. readonly cameraPosition: NodeMaterialConnectionPoint;
  122405. /**
  122406. * Gets the glossiness component
  122407. */
  122408. readonly glossiness: NodeMaterialConnectionPoint;
  122409. /**
  122410. * Gets the glossinness power component
  122411. */
  122412. readonly glossPower: NodeMaterialConnectionPoint;
  122413. /**
  122414. * Gets the diffuse color component
  122415. */
  122416. readonly diffuseColor: NodeMaterialConnectionPoint;
  122417. /**
  122418. * Gets the specular color component
  122419. */
  122420. readonly specularColor: NodeMaterialConnectionPoint;
  122421. /**
  122422. * Gets the diffuse output component
  122423. */
  122424. readonly diffuseOutput: NodeMaterialConnectionPoint;
  122425. /**
  122426. * Gets the specular output component
  122427. */
  122428. readonly specularOutput: NodeMaterialConnectionPoint;
  122429. autoConfigure(material: NodeMaterial): void;
  122430. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122431. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  122432. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122433. private _injectVertexCode;
  122434. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  122435. serialize(): any;
  122436. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122437. }
  122438. }
  122439. declare module BABYLON {
  122440. /**
  122441. * Block used to multiply 2 values
  122442. */
  122443. export class MultiplyBlock extends NodeMaterialBlock {
  122444. /**
  122445. * Creates a new MultiplyBlock
  122446. * @param name defines the block name
  122447. */
  122448. constructor(name: string);
  122449. /**
  122450. * Gets the current class name
  122451. * @returns the class name
  122452. */
  122453. getClassName(): string;
  122454. /**
  122455. * Gets the left operand input component
  122456. */
  122457. readonly left: NodeMaterialConnectionPoint;
  122458. /**
  122459. * Gets the right operand input component
  122460. */
  122461. readonly right: NodeMaterialConnectionPoint;
  122462. /**
  122463. * Gets the output component
  122464. */
  122465. readonly output: NodeMaterialConnectionPoint;
  122466. protected _buildBlock(state: NodeMaterialBuildState): this;
  122467. }
  122468. }
  122469. declare module BABYLON {
  122470. /**
  122471. * Block used to add 2 vectors
  122472. */
  122473. export class AddBlock extends NodeMaterialBlock {
  122474. /**
  122475. * Creates a new AddBlock
  122476. * @param name defines the block name
  122477. */
  122478. constructor(name: string);
  122479. /**
  122480. * Gets the current class name
  122481. * @returns the class name
  122482. */
  122483. getClassName(): string;
  122484. /**
  122485. * Gets the left operand input component
  122486. */
  122487. readonly left: NodeMaterialConnectionPoint;
  122488. /**
  122489. * Gets the right operand input component
  122490. */
  122491. readonly right: NodeMaterialConnectionPoint;
  122492. /**
  122493. * Gets the output component
  122494. */
  122495. readonly output: NodeMaterialConnectionPoint;
  122496. protected _buildBlock(state: NodeMaterialBuildState): this;
  122497. }
  122498. }
  122499. declare module BABYLON {
  122500. /**
  122501. * Block used to scale a vector by a float
  122502. */
  122503. export class ScaleBlock extends NodeMaterialBlock {
  122504. /**
  122505. * Creates a new ScaleBlock
  122506. * @param name defines the block name
  122507. */
  122508. constructor(name: string);
  122509. /**
  122510. * Gets the current class name
  122511. * @returns the class name
  122512. */
  122513. getClassName(): string;
  122514. /**
  122515. * Gets the input component
  122516. */
  122517. readonly input: NodeMaterialConnectionPoint;
  122518. /**
  122519. * Gets the factor input component
  122520. */
  122521. readonly factor: NodeMaterialConnectionPoint;
  122522. /**
  122523. * Gets the output component
  122524. */
  122525. readonly output: NodeMaterialConnectionPoint;
  122526. protected _buildBlock(state: NodeMaterialBuildState): this;
  122527. }
  122528. }
  122529. declare module BABYLON {
  122530. /**
  122531. * Block used to clamp a float
  122532. */
  122533. export class ClampBlock extends NodeMaterialBlock {
  122534. /** Gets or sets the minimum range */
  122535. minimum: number;
  122536. /** Gets or sets the maximum range */
  122537. maximum: number;
  122538. /**
  122539. * Creates a new ClampBlock
  122540. * @param name defines the block name
  122541. */
  122542. constructor(name: string);
  122543. /**
  122544. * Gets the current class name
  122545. * @returns the class name
  122546. */
  122547. getClassName(): string;
  122548. /**
  122549. * Gets the value input component
  122550. */
  122551. readonly value: NodeMaterialConnectionPoint;
  122552. /**
  122553. * Gets the output component
  122554. */
  122555. readonly output: NodeMaterialConnectionPoint;
  122556. protected _buildBlock(state: NodeMaterialBuildState): this;
  122557. protected _dumpPropertiesCode(): string;
  122558. serialize(): any;
  122559. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122560. }
  122561. }
  122562. declare module BABYLON {
  122563. /**
  122564. * Block used to apply a cross product between 2 vectors
  122565. */
  122566. export class CrossBlock extends NodeMaterialBlock {
  122567. /**
  122568. * Creates a new CrossBlock
  122569. * @param name defines the block name
  122570. */
  122571. constructor(name: string);
  122572. /**
  122573. * Gets the current class name
  122574. * @returns the class name
  122575. */
  122576. getClassName(): string;
  122577. /**
  122578. * Gets the left operand input component
  122579. */
  122580. readonly left: NodeMaterialConnectionPoint;
  122581. /**
  122582. * Gets the right operand input component
  122583. */
  122584. readonly right: NodeMaterialConnectionPoint;
  122585. /**
  122586. * Gets the output component
  122587. */
  122588. readonly output: NodeMaterialConnectionPoint;
  122589. protected _buildBlock(state: NodeMaterialBuildState): this;
  122590. }
  122591. }
  122592. declare module BABYLON {
  122593. /**
  122594. * Block used to apply a dot product between 2 vectors
  122595. */
  122596. export class DotBlock extends NodeMaterialBlock {
  122597. /**
  122598. * Creates a new DotBlock
  122599. * @param name defines the block name
  122600. */
  122601. constructor(name: string);
  122602. /**
  122603. * Gets the current class name
  122604. * @returns the class name
  122605. */
  122606. getClassName(): string;
  122607. /**
  122608. * Gets the left operand input component
  122609. */
  122610. readonly left: NodeMaterialConnectionPoint;
  122611. /**
  122612. * Gets the right operand input component
  122613. */
  122614. readonly right: NodeMaterialConnectionPoint;
  122615. /**
  122616. * Gets the output component
  122617. */
  122618. readonly output: NodeMaterialConnectionPoint;
  122619. protected _buildBlock(state: NodeMaterialBuildState): this;
  122620. }
  122621. }
  122622. declare module BABYLON {
  122623. /**
  122624. * Block used to remap a float from a range to a new one
  122625. */
  122626. export class RemapBlock extends NodeMaterialBlock {
  122627. /**
  122628. * Gets or sets the source range
  122629. */
  122630. sourceRange: Vector2;
  122631. /**
  122632. * Gets or sets the target range
  122633. */
  122634. targetRange: Vector2;
  122635. /**
  122636. * Creates a new RemapBlock
  122637. * @param name defines the block name
  122638. */
  122639. constructor(name: string);
  122640. /**
  122641. * Gets the current class name
  122642. * @returns the class name
  122643. */
  122644. getClassName(): string;
  122645. /**
  122646. * Gets the input component
  122647. */
  122648. readonly input: NodeMaterialConnectionPoint;
  122649. /**
  122650. * Gets the source min input component
  122651. */
  122652. readonly sourceMin: NodeMaterialConnectionPoint;
  122653. /**
  122654. * Gets the source max input component
  122655. */
  122656. readonly sourceMax: NodeMaterialConnectionPoint;
  122657. /**
  122658. * Gets the target min input component
  122659. */
  122660. readonly targetMin: NodeMaterialConnectionPoint;
  122661. /**
  122662. * Gets the target max input component
  122663. */
  122664. readonly targetMax: NodeMaterialConnectionPoint;
  122665. /**
  122666. * Gets the output component
  122667. */
  122668. readonly output: NodeMaterialConnectionPoint;
  122669. protected _buildBlock(state: NodeMaterialBuildState): this;
  122670. protected _dumpPropertiesCode(): string;
  122671. serialize(): any;
  122672. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122673. }
  122674. }
  122675. declare module BABYLON {
  122676. /**
  122677. * Block used to normalize a vector
  122678. */
  122679. export class NormalizeBlock extends NodeMaterialBlock {
  122680. /**
  122681. * Creates a new NormalizeBlock
  122682. * @param name defines the block name
  122683. */
  122684. constructor(name: string);
  122685. /**
  122686. * Gets the current class name
  122687. * @returns the class name
  122688. */
  122689. getClassName(): string;
  122690. /**
  122691. * Gets the input component
  122692. */
  122693. readonly input: NodeMaterialConnectionPoint;
  122694. /**
  122695. * Gets the output component
  122696. */
  122697. readonly output: NodeMaterialConnectionPoint;
  122698. protected _buildBlock(state: NodeMaterialBuildState): this;
  122699. }
  122700. }
  122701. declare module BABYLON {
  122702. /**
  122703. * Operations supported by the Trigonometry block
  122704. */
  122705. export enum TrigonometryBlockOperations {
  122706. /** Cos */
  122707. Cos = 0,
  122708. /** Sin */
  122709. Sin = 1,
  122710. /** Abs */
  122711. Abs = 2,
  122712. /** Exp */
  122713. Exp = 3,
  122714. /** Exp2 */
  122715. Exp2 = 4,
  122716. /** Round */
  122717. Round = 5,
  122718. /** Floor */
  122719. Floor = 6,
  122720. /** Ceiling */
  122721. Ceiling = 7,
  122722. /** Square root */
  122723. Sqrt = 8,
  122724. /** Log */
  122725. Log = 9,
  122726. /** Tangent */
  122727. Tan = 10,
  122728. /** Arc tangent */
  122729. ArcTan = 11,
  122730. /** Arc cosinus */
  122731. ArcCos = 12,
  122732. /** Arc sinus */
  122733. ArcSin = 13,
  122734. /** Fraction */
  122735. Fract = 14,
  122736. /** Sign */
  122737. Sign = 15,
  122738. /** To radians (from degrees) */
  122739. Radians = 16,
  122740. /** To degrees (from radians) */
  122741. Degrees = 17
  122742. }
  122743. /**
  122744. * Block used to apply trigonometry operation to floats
  122745. */
  122746. export class TrigonometryBlock extends NodeMaterialBlock {
  122747. /**
  122748. * Gets or sets the operation applied by the block
  122749. */
  122750. operation: TrigonometryBlockOperations;
  122751. /**
  122752. * Creates a new TrigonometryBlock
  122753. * @param name defines the block name
  122754. */
  122755. constructor(name: string);
  122756. /**
  122757. * Gets the current class name
  122758. * @returns the class name
  122759. */
  122760. getClassName(): string;
  122761. /**
  122762. * Gets the input component
  122763. */
  122764. readonly input: NodeMaterialConnectionPoint;
  122765. /**
  122766. * Gets the output component
  122767. */
  122768. readonly output: NodeMaterialConnectionPoint;
  122769. protected _buildBlock(state: NodeMaterialBuildState): this;
  122770. serialize(): any;
  122771. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122772. }
  122773. }
  122774. declare module BABYLON {
  122775. /**
  122776. * Block used to create a Color3/4 out of individual inputs (one for each component)
  122777. */
  122778. export class ColorMergerBlock extends NodeMaterialBlock {
  122779. /**
  122780. * Create a new ColorMergerBlock
  122781. * @param name defines the block name
  122782. */
  122783. constructor(name: string);
  122784. /**
  122785. * Gets the current class name
  122786. * @returns the class name
  122787. */
  122788. getClassName(): string;
  122789. /**
  122790. * Gets the r component (input)
  122791. */
  122792. readonly r: NodeMaterialConnectionPoint;
  122793. /**
  122794. * Gets the g component (input)
  122795. */
  122796. readonly g: NodeMaterialConnectionPoint;
  122797. /**
  122798. * Gets the b component (input)
  122799. */
  122800. readonly b: NodeMaterialConnectionPoint;
  122801. /**
  122802. * Gets the a component (input)
  122803. */
  122804. readonly a: NodeMaterialConnectionPoint;
  122805. /**
  122806. * Gets the rgba component (output)
  122807. */
  122808. readonly rgba: NodeMaterialConnectionPoint;
  122809. /**
  122810. * Gets the rgb component (output)
  122811. */
  122812. readonly rgb: NodeMaterialConnectionPoint;
  122813. protected _buildBlock(state: NodeMaterialBuildState): this;
  122814. }
  122815. }
  122816. declare module BABYLON {
  122817. /**
  122818. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  122819. */
  122820. export class VectorMergerBlock extends NodeMaterialBlock {
  122821. /**
  122822. * Create a new VectorMergerBlock
  122823. * @param name defines the block name
  122824. */
  122825. constructor(name: string);
  122826. /**
  122827. * Gets the current class name
  122828. * @returns the class name
  122829. */
  122830. getClassName(): string;
  122831. /**
  122832. * Gets the x component (input)
  122833. */
  122834. readonly x: NodeMaterialConnectionPoint;
  122835. /**
  122836. * Gets the y component (input)
  122837. */
  122838. readonly y: NodeMaterialConnectionPoint;
  122839. /**
  122840. * Gets the z component (input)
  122841. */
  122842. readonly z: NodeMaterialConnectionPoint;
  122843. /**
  122844. * Gets the w component (input)
  122845. */
  122846. readonly w: NodeMaterialConnectionPoint;
  122847. /**
  122848. * Gets the xyzw component (output)
  122849. */
  122850. readonly xyzw: NodeMaterialConnectionPoint;
  122851. /**
  122852. * Gets the xyz component (output)
  122853. */
  122854. readonly xyz: NodeMaterialConnectionPoint;
  122855. /**
  122856. * Gets the xy component (output)
  122857. */
  122858. readonly xy: NodeMaterialConnectionPoint;
  122859. protected _buildBlock(state: NodeMaterialBuildState): this;
  122860. }
  122861. }
  122862. declare module BABYLON {
  122863. /**
  122864. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  122865. */
  122866. export class ColorSplitterBlock extends NodeMaterialBlock {
  122867. /**
  122868. * Create a new ColorSplitterBlock
  122869. * @param name defines the block name
  122870. */
  122871. constructor(name: string);
  122872. /**
  122873. * Gets the current class name
  122874. * @returns the class name
  122875. */
  122876. getClassName(): string;
  122877. /**
  122878. * Gets the rgba component (input)
  122879. */
  122880. readonly rgba: NodeMaterialConnectionPoint;
  122881. /**
  122882. * Gets the rgb component (input)
  122883. */
  122884. readonly rgbIn: NodeMaterialConnectionPoint;
  122885. /**
  122886. * Gets the rgb component (output)
  122887. */
  122888. readonly rgbOut: NodeMaterialConnectionPoint;
  122889. /**
  122890. * Gets the r component (output)
  122891. */
  122892. readonly r: NodeMaterialConnectionPoint;
  122893. /**
  122894. * Gets the g component (output)
  122895. */
  122896. readonly g: NodeMaterialConnectionPoint;
  122897. /**
  122898. * Gets the b component (output)
  122899. */
  122900. readonly b: NodeMaterialConnectionPoint;
  122901. /**
  122902. * Gets the a component (output)
  122903. */
  122904. readonly a: NodeMaterialConnectionPoint;
  122905. protected _inputRename(name: string): string;
  122906. protected _outputRename(name: string): string;
  122907. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  122908. }
  122909. }
  122910. declare module BABYLON {
  122911. /**
  122912. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  122913. */
  122914. export class VectorSplitterBlock extends NodeMaterialBlock {
  122915. /**
  122916. * Create a new VectorSplitterBlock
  122917. * @param name defines the block name
  122918. */
  122919. constructor(name: string);
  122920. /**
  122921. * Gets the current class name
  122922. * @returns the class name
  122923. */
  122924. getClassName(): string;
  122925. /**
  122926. * Gets the xyzw component (input)
  122927. */
  122928. readonly xyzw: NodeMaterialConnectionPoint;
  122929. /**
  122930. * Gets the xyz component (input)
  122931. */
  122932. readonly xyzIn: NodeMaterialConnectionPoint;
  122933. /**
  122934. * Gets the xy component (input)
  122935. */
  122936. readonly xyIn: NodeMaterialConnectionPoint;
  122937. /**
  122938. * Gets the xyz component (output)
  122939. */
  122940. readonly xyzOut: NodeMaterialConnectionPoint;
  122941. /**
  122942. * Gets the xy component (output)
  122943. */
  122944. readonly xyOut: NodeMaterialConnectionPoint;
  122945. /**
  122946. * Gets the x component (output)
  122947. */
  122948. readonly x: NodeMaterialConnectionPoint;
  122949. /**
  122950. * Gets the y component (output)
  122951. */
  122952. readonly y: NodeMaterialConnectionPoint;
  122953. /**
  122954. * Gets the z component (output)
  122955. */
  122956. readonly z: NodeMaterialConnectionPoint;
  122957. /**
  122958. * Gets the w component (output)
  122959. */
  122960. readonly w: NodeMaterialConnectionPoint;
  122961. protected _inputRename(name: string): string;
  122962. protected _outputRename(name: string): string;
  122963. protected _buildBlock(state: NodeMaterialBuildState): this;
  122964. }
  122965. }
  122966. declare module BABYLON {
  122967. /**
  122968. * Block used to lerp between 2 values
  122969. */
  122970. export class LerpBlock extends NodeMaterialBlock {
  122971. /**
  122972. * Creates a new LerpBlock
  122973. * @param name defines the block name
  122974. */
  122975. constructor(name: string);
  122976. /**
  122977. * Gets the current class name
  122978. * @returns the class name
  122979. */
  122980. getClassName(): string;
  122981. /**
  122982. * Gets the left operand input component
  122983. */
  122984. readonly left: NodeMaterialConnectionPoint;
  122985. /**
  122986. * Gets the right operand input component
  122987. */
  122988. readonly right: NodeMaterialConnectionPoint;
  122989. /**
  122990. * Gets the gradient operand input component
  122991. */
  122992. readonly gradient: NodeMaterialConnectionPoint;
  122993. /**
  122994. * Gets the output component
  122995. */
  122996. readonly output: NodeMaterialConnectionPoint;
  122997. protected _buildBlock(state: NodeMaterialBuildState): this;
  122998. }
  122999. }
  123000. declare module BABYLON {
  123001. /**
  123002. * Block used to divide 2 vectors
  123003. */
  123004. export class DivideBlock extends NodeMaterialBlock {
  123005. /**
  123006. * Creates a new DivideBlock
  123007. * @param name defines the block name
  123008. */
  123009. constructor(name: string);
  123010. /**
  123011. * Gets the current class name
  123012. * @returns the class name
  123013. */
  123014. getClassName(): string;
  123015. /**
  123016. * Gets the left operand input component
  123017. */
  123018. readonly left: NodeMaterialConnectionPoint;
  123019. /**
  123020. * Gets the right operand input component
  123021. */
  123022. readonly right: NodeMaterialConnectionPoint;
  123023. /**
  123024. * Gets the output component
  123025. */
  123026. readonly output: NodeMaterialConnectionPoint;
  123027. protected _buildBlock(state: NodeMaterialBuildState): this;
  123028. }
  123029. }
  123030. declare module BABYLON {
  123031. /**
  123032. * Block used to subtract 2 vectors
  123033. */
  123034. export class SubtractBlock extends NodeMaterialBlock {
  123035. /**
  123036. * Creates a new SubtractBlock
  123037. * @param name defines the block name
  123038. */
  123039. constructor(name: string);
  123040. /**
  123041. * Gets the current class name
  123042. * @returns the class name
  123043. */
  123044. getClassName(): string;
  123045. /**
  123046. * Gets the left operand input component
  123047. */
  123048. readonly left: NodeMaterialConnectionPoint;
  123049. /**
  123050. * Gets the right operand input component
  123051. */
  123052. readonly right: NodeMaterialConnectionPoint;
  123053. /**
  123054. * Gets the output component
  123055. */
  123056. readonly output: NodeMaterialConnectionPoint;
  123057. protected _buildBlock(state: NodeMaterialBuildState): this;
  123058. }
  123059. }
  123060. declare module BABYLON {
  123061. /**
  123062. * Block used to step a value
  123063. */
  123064. export class StepBlock extends NodeMaterialBlock {
  123065. /**
  123066. * Creates a new StepBlock
  123067. * @param name defines the block name
  123068. */
  123069. constructor(name: string);
  123070. /**
  123071. * Gets the current class name
  123072. * @returns the class name
  123073. */
  123074. getClassName(): string;
  123075. /**
  123076. * Gets the value operand input component
  123077. */
  123078. readonly value: NodeMaterialConnectionPoint;
  123079. /**
  123080. * Gets the edge operand input component
  123081. */
  123082. readonly edge: NodeMaterialConnectionPoint;
  123083. /**
  123084. * Gets the output component
  123085. */
  123086. readonly output: NodeMaterialConnectionPoint;
  123087. protected _buildBlock(state: NodeMaterialBuildState): this;
  123088. }
  123089. }
  123090. declare module BABYLON {
  123091. /**
  123092. * Block used to get the opposite (1 - x) of a value
  123093. */
  123094. export class OneMinusBlock extends NodeMaterialBlock {
  123095. /**
  123096. * Creates a new OneMinusBlock
  123097. * @param name defines the block name
  123098. */
  123099. constructor(name: string);
  123100. /**
  123101. * Gets the current class name
  123102. * @returns the class name
  123103. */
  123104. getClassName(): string;
  123105. /**
  123106. * Gets the input component
  123107. */
  123108. readonly input: NodeMaterialConnectionPoint;
  123109. /**
  123110. * Gets the output component
  123111. */
  123112. readonly output: NodeMaterialConnectionPoint;
  123113. protected _buildBlock(state: NodeMaterialBuildState): this;
  123114. }
  123115. }
  123116. declare module BABYLON {
  123117. /**
  123118. * Block used to get the view direction
  123119. */
  123120. export class ViewDirectionBlock extends NodeMaterialBlock {
  123121. /**
  123122. * Creates a new ViewDirectionBlock
  123123. * @param name defines the block name
  123124. */
  123125. constructor(name: string);
  123126. /**
  123127. * Gets the current class name
  123128. * @returns the class name
  123129. */
  123130. getClassName(): string;
  123131. /**
  123132. * Gets the world position component
  123133. */
  123134. readonly worldPosition: NodeMaterialConnectionPoint;
  123135. /**
  123136. * Gets the camera position component
  123137. */
  123138. readonly cameraPosition: NodeMaterialConnectionPoint;
  123139. /**
  123140. * Gets the output component
  123141. */
  123142. readonly output: NodeMaterialConnectionPoint;
  123143. autoConfigure(material: NodeMaterial): void;
  123144. protected _buildBlock(state: NodeMaterialBuildState): this;
  123145. }
  123146. }
  123147. declare module BABYLON {
  123148. /**
  123149. * Block used to compute fresnel value
  123150. */
  123151. export class FresnelBlock extends NodeMaterialBlock {
  123152. /**
  123153. * Create a new FresnelBlock
  123154. * @param name defines the block name
  123155. */
  123156. constructor(name: string);
  123157. /**
  123158. * Gets the current class name
  123159. * @returns the class name
  123160. */
  123161. getClassName(): string;
  123162. /**
  123163. * Gets the world normal input component
  123164. */
  123165. readonly worldNormal: NodeMaterialConnectionPoint;
  123166. /**
  123167. * Gets the view direction input component
  123168. */
  123169. readonly viewDirection: NodeMaterialConnectionPoint;
  123170. /**
  123171. * Gets the bias input component
  123172. */
  123173. readonly bias: NodeMaterialConnectionPoint;
  123174. /**
  123175. * Gets the camera (or eye) position component
  123176. */
  123177. readonly power: NodeMaterialConnectionPoint;
  123178. /**
  123179. * Gets the fresnel output component
  123180. */
  123181. readonly fresnel: NodeMaterialConnectionPoint;
  123182. autoConfigure(material: NodeMaterial): void;
  123183. protected _buildBlock(state: NodeMaterialBuildState): this;
  123184. }
  123185. }
  123186. declare module BABYLON {
  123187. /**
  123188. * Block used to get the max of 2 values
  123189. */
  123190. export class MaxBlock extends NodeMaterialBlock {
  123191. /**
  123192. * Creates a new MaxBlock
  123193. * @param name defines the block name
  123194. */
  123195. constructor(name: string);
  123196. /**
  123197. * Gets the current class name
  123198. * @returns the class name
  123199. */
  123200. getClassName(): string;
  123201. /**
  123202. * Gets the left operand input component
  123203. */
  123204. readonly left: NodeMaterialConnectionPoint;
  123205. /**
  123206. * Gets the right operand input component
  123207. */
  123208. readonly right: NodeMaterialConnectionPoint;
  123209. /**
  123210. * Gets the output component
  123211. */
  123212. readonly output: NodeMaterialConnectionPoint;
  123213. protected _buildBlock(state: NodeMaterialBuildState): this;
  123214. }
  123215. }
  123216. declare module BABYLON {
  123217. /**
  123218. * Block used to get the min of 2 values
  123219. */
  123220. export class MinBlock extends NodeMaterialBlock {
  123221. /**
  123222. * Creates a new MinBlock
  123223. * @param name defines the block name
  123224. */
  123225. constructor(name: string);
  123226. /**
  123227. * Gets the current class name
  123228. * @returns the class name
  123229. */
  123230. getClassName(): string;
  123231. /**
  123232. * Gets the left operand input component
  123233. */
  123234. readonly left: NodeMaterialConnectionPoint;
  123235. /**
  123236. * Gets the right operand input component
  123237. */
  123238. readonly right: NodeMaterialConnectionPoint;
  123239. /**
  123240. * Gets the output component
  123241. */
  123242. readonly output: NodeMaterialConnectionPoint;
  123243. protected _buildBlock(state: NodeMaterialBuildState): this;
  123244. }
  123245. }
  123246. declare module BABYLON {
  123247. /**
  123248. * Block used to get the distance between 2 values
  123249. */
  123250. export class DistanceBlock extends NodeMaterialBlock {
  123251. /**
  123252. * Creates a new DistanceBlock
  123253. * @param name defines the block name
  123254. */
  123255. constructor(name: string);
  123256. /**
  123257. * Gets the current class name
  123258. * @returns the class name
  123259. */
  123260. getClassName(): string;
  123261. /**
  123262. * Gets the left operand input component
  123263. */
  123264. readonly left: NodeMaterialConnectionPoint;
  123265. /**
  123266. * Gets the right operand input component
  123267. */
  123268. readonly right: NodeMaterialConnectionPoint;
  123269. /**
  123270. * Gets the output component
  123271. */
  123272. readonly output: NodeMaterialConnectionPoint;
  123273. protected _buildBlock(state: NodeMaterialBuildState): this;
  123274. }
  123275. }
  123276. declare module BABYLON {
  123277. /**
  123278. * Block used to get the length of a vector
  123279. */
  123280. export class LengthBlock extends NodeMaterialBlock {
  123281. /**
  123282. * Creates a new LengthBlock
  123283. * @param name defines the block name
  123284. */
  123285. constructor(name: string);
  123286. /**
  123287. * Gets the current class name
  123288. * @returns the class name
  123289. */
  123290. getClassName(): string;
  123291. /**
  123292. * Gets the value input component
  123293. */
  123294. readonly value: NodeMaterialConnectionPoint;
  123295. /**
  123296. * Gets the output component
  123297. */
  123298. readonly output: NodeMaterialConnectionPoint;
  123299. protected _buildBlock(state: NodeMaterialBuildState): this;
  123300. }
  123301. }
  123302. declare module BABYLON {
  123303. /**
  123304. * Block used to get negative version of a value (i.e. x * -1)
  123305. */
  123306. export class NegateBlock extends NodeMaterialBlock {
  123307. /**
  123308. * Creates a new NegateBlock
  123309. * @param name defines the block name
  123310. */
  123311. constructor(name: string);
  123312. /**
  123313. * Gets the current class name
  123314. * @returns the class name
  123315. */
  123316. getClassName(): string;
  123317. /**
  123318. * Gets the value input component
  123319. */
  123320. readonly value: NodeMaterialConnectionPoint;
  123321. /**
  123322. * Gets the output component
  123323. */
  123324. readonly output: NodeMaterialConnectionPoint;
  123325. protected _buildBlock(state: NodeMaterialBuildState): this;
  123326. }
  123327. }
  123328. declare module BABYLON {
  123329. /**
  123330. * Block used to get the value of the first parameter raised to the power of the second
  123331. */
  123332. export class PowBlock extends NodeMaterialBlock {
  123333. /**
  123334. * Creates a new PowBlock
  123335. * @param name defines the block name
  123336. */
  123337. constructor(name: string);
  123338. /**
  123339. * Gets the current class name
  123340. * @returns the class name
  123341. */
  123342. getClassName(): string;
  123343. /**
  123344. * Gets the value operand input component
  123345. */
  123346. readonly value: NodeMaterialConnectionPoint;
  123347. /**
  123348. * Gets the power operand input component
  123349. */
  123350. readonly power: NodeMaterialConnectionPoint;
  123351. /**
  123352. * Gets the output component
  123353. */
  123354. readonly output: NodeMaterialConnectionPoint;
  123355. protected _buildBlock(state: NodeMaterialBuildState): this;
  123356. }
  123357. }
  123358. declare module BABYLON {
  123359. /**
  123360. * Block used to get a random number
  123361. */
  123362. export class RandomNumberBlock extends NodeMaterialBlock {
  123363. /**
  123364. * Creates a new RandomNumberBlock
  123365. * @param name defines the block name
  123366. */
  123367. constructor(name: string);
  123368. /**
  123369. * Gets the current class name
  123370. * @returns the class name
  123371. */
  123372. getClassName(): string;
  123373. /**
  123374. * Gets the seed input component
  123375. */
  123376. readonly seed: NodeMaterialConnectionPoint;
  123377. /**
  123378. * Gets the output component
  123379. */
  123380. readonly output: NodeMaterialConnectionPoint;
  123381. protected _buildBlock(state: NodeMaterialBuildState): this;
  123382. }
  123383. }
  123384. declare module BABYLON {
  123385. /**
  123386. * Block used to compute arc tangent of 2 values
  123387. */
  123388. export class ArcTan2Block extends NodeMaterialBlock {
  123389. /**
  123390. * Creates a new ArcTan2Block
  123391. * @param name defines the block name
  123392. */
  123393. constructor(name: string);
  123394. /**
  123395. * Gets the current class name
  123396. * @returns the class name
  123397. */
  123398. getClassName(): string;
  123399. /**
  123400. * Gets the x operand input component
  123401. */
  123402. readonly x: NodeMaterialConnectionPoint;
  123403. /**
  123404. * Gets the y operand input component
  123405. */
  123406. readonly y: NodeMaterialConnectionPoint;
  123407. /**
  123408. * Gets the output component
  123409. */
  123410. readonly output: NodeMaterialConnectionPoint;
  123411. protected _buildBlock(state: NodeMaterialBuildState): this;
  123412. }
  123413. }
  123414. declare module BABYLON {
  123415. /**
  123416. * Block used to smooth step a value
  123417. */
  123418. export class SmoothStepBlock extends NodeMaterialBlock {
  123419. /**
  123420. * Creates a new SmoothStepBlock
  123421. * @param name defines the block name
  123422. */
  123423. constructor(name: string);
  123424. /**
  123425. * Gets the current class name
  123426. * @returns the class name
  123427. */
  123428. getClassName(): string;
  123429. /**
  123430. * Gets the value operand input component
  123431. */
  123432. readonly value: NodeMaterialConnectionPoint;
  123433. /**
  123434. * Gets the first edge operand input component
  123435. */
  123436. readonly edge0: NodeMaterialConnectionPoint;
  123437. /**
  123438. * Gets the second edge operand input component
  123439. */
  123440. readonly edge1: NodeMaterialConnectionPoint;
  123441. /**
  123442. * Gets the output component
  123443. */
  123444. readonly output: NodeMaterialConnectionPoint;
  123445. protected _buildBlock(state: NodeMaterialBuildState): this;
  123446. }
  123447. }
  123448. declare module BABYLON {
  123449. /**
  123450. * Block used to get the reciprocal (1 / x) of a value
  123451. */
  123452. export class ReciprocalBlock extends NodeMaterialBlock {
  123453. /**
  123454. * Creates a new ReciprocalBlock
  123455. * @param name defines the block name
  123456. */
  123457. constructor(name: string);
  123458. /**
  123459. * Gets the current class name
  123460. * @returns the class name
  123461. */
  123462. getClassName(): string;
  123463. /**
  123464. * Gets the input component
  123465. */
  123466. readonly input: NodeMaterialConnectionPoint;
  123467. /**
  123468. * Gets the output component
  123469. */
  123470. readonly output: NodeMaterialConnectionPoint;
  123471. protected _buildBlock(state: NodeMaterialBuildState): this;
  123472. }
  123473. }
  123474. declare module BABYLON {
  123475. /**
  123476. * Block used to replace a color by another one
  123477. */
  123478. export class ReplaceColorBlock extends NodeMaterialBlock {
  123479. /**
  123480. * Creates a new ReplaceColorBlock
  123481. * @param name defines the block name
  123482. */
  123483. constructor(name: string);
  123484. /**
  123485. * Gets the current class name
  123486. * @returns the class name
  123487. */
  123488. getClassName(): string;
  123489. /**
  123490. * Gets the value input component
  123491. */
  123492. readonly value: NodeMaterialConnectionPoint;
  123493. /**
  123494. * Gets the reference input component
  123495. */
  123496. readonly reference: NodeMaterialConnectionPoint;
  123497. /**
  123498. * Gets the distance input component
  123499. */
  123500. readonly distance: NodeMaterialConnectionPoint;
  123501. /**
  123502. * Gets the replacement input component
  123503. */
  123504. readonly replacement: NodeMaterialConnectionPoint;
  123505. /**
  123506. * Gets the output component
  123507. */
  123508. readonly output: NodeMaterialConnectionPoint;
  123509. protected _buildBlock(state: NodeMaterialBuildState): this;
  123510. }
  123511. }
  123512. declare module BABYLON {
  123513. /**
  123514. * Block used to posterize a value
  123515. * @see https://en.wikipedia.org/wiki/Posterization
  123516. */
  123517. export class PosterizeBlock extends NodeMaterialBlock {
  123518. /**
  123519. * Creates a new PosterizeBlock
  123520. * @param name defines the block name
  123521. */
  123522. constructor(name: string);
  123523. /**
  123524. * Gets the current class name
  123525. * @returns the class name
  123526. */
  123527. getClassName(): string;
  123528. /**
  123529. * Gets the value input component
  123530. */
  123531. readonly value: NodeMaterialConnectionPoint;
  123532. /**
  123533. * Gets the steps input component
  123534. */
  123535. readonly steps: NodeMaterialConnectionPoint;
  123536. /**
  123537. * Gets the output component
  123538. */
  123539. readonly output: NodeMaterialConnectionPoint;
  123540. protected _buildBlock(state: NodeMaterialBuildState): this;
  123541. }
  123542. }
  123543. declare module BABYLON {
  123544. /**
  123545. * Operations supported by the Wave block
  123546. */
  123547. export enum WaveBlockKind {
  123548. /** SawTooth */
  123549. SawTooth = 0,
  123550. /** Square */
  123551. Square = 1,
  123552. /** Triangle */
  123553. Triangle = 2
  123554. }
  123555. /**
  123556. * Block used to apply wave operation to floats
  123557. */
  123558. export class WaveBlock extends NodeMaterialBlock {
  123559. /**
  123560. * Gets or sets the kibnd of wave to be applied by the block
  123561. */
  123562. kind: WaveBlockKind;
  123563. /**
  123564. * Creates a new WaveBlock
  123565. * @param name defines the block name
  123566. */
  123567. constructor(name: string);
  123568. /**
  123569. * Gets the current class name
  123570. * @returns the class name
  123571. */
  123572. getClassName(): string;
  123573. /**
  123574. * Gets the input component
  123575. */
  123576. readonly input: NodeMaterialConnectionPoint;
  123577. /**
  123578. * Gets the output component
  123579. */
  123580. readonly output: NodeMaterialConnectionPoint;
  123581. protected _buildBlock(state: NodeMaterialBuildState): this;
  123582. serialize(): any;
  123583. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123584. }
  123585. }
  123586. declare module BABYLON {
  123587. /**
  123588. * Class used to store a color step for the GradientBlock
  123589. */
  123590. export class GradientBlockColorStep {
  123591. /**
  123592. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  123593. */
  123594. step: number;
  123595. /**
  123596. * Gets or sets the color associated with this step
  123597. */
  123598. color: Color3;
  123599. /**
  123600. * Creates a new GradientBlockColorStep
  123601. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  123602. * @param color defines the color associated with this step
  123603. */
  123604. constructor(
  123605. /**
  123606. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  123607. */
  123608. step: number,
  123609. /**
  123610. * Gets or sets the color associated with this step
  123611. */
  123612. color: Color3);
  123613. }
  123614. /**
  123615. * Block used to return a color from a gradient based on an input value between 0 and 1
  123616. */
  123617. export class GradientBlock extends NodeMaterialBlock {
  123618. /**
  123619. * Gets or sets the list of color steps
  123620. */
  123621. colorSteps: GradientBlockColorStep[];
  123622. /**
  123623. * Creates a new GradientBlock
  123624. * @param name defines the block name
  123625. */
  123626. constructor(name: string);
  123627. /**
  123628. * Gets the current class name
  123629. * @returns the class name
  123630. */
  123631. getClassName(): string;
  123632. /**
  123633. * Gets the gradient input component
  123634. */
  123635. readonly gradient: NodeMaterialConnectionPoint;
  123636. /**
  123637. * Gets the output component
  123638. */
  123639. readonly output: NodeMaterialConnectionPoint;
  123640. private _writeColorConstant;
  123641. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  123642. serialize(): any;
  123643. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123644. protected _dumpPropertiesCode(): string;
  123645. }
  123646. }
  123647. declare module BABYLON {
  123648. /**
  123649. * Block used to normalize lerp between 2 values
  123650. */
  123651. export class NLerpBlock extends NodeMaterialBlock {
  123652. /**
  123653. * Creates a new NLerpBlock
  123654. * @param name defines the block name
  123655. */
  123656. constructor(name: string);
  123657. /**
  123658. * Gets the current class name
  123659. * @returns the class name
  123660. */
  123661. getClassName(): string;
  123662. /**
  123663. * Gets the left operand input component
  123664. */
  123665. readonly left: NodeMaterialConnectionPoint;
  123666. /**
  123667. * Gets the right operand input component
  123668. */
  123669. readonly right: NodeMaterialConnectionPoint;
  123670. /**
  123671. * Gets the gradient operand input component
  123672. */
  123673. readonly gradient: NodeMaterialConnectionPoint;
  123674. /**
  123675. * Gets the output component
  123676. */
  123677. readonly output: NodeMaterialConnectionPoint;
  123678. protected _buildBlock(state: NodeMaterialBuildState): this;
  123679. }
  123680. }
  123681. declare module BABYLON {
  123682. /**
  123683. * Block used to test if the fragment shader is front facing
  123684. */
  123685. export class FrontFacingBlock extends NodeMaterialBlock {
  123686. /**
  123687. * Creates a new FrontFacingBlock
  123688. * @param name defines the block name
  123689. */
  123690. constructor(name: string);
  123691. /**
  123692. * Gets the current class name
  123693. * @returns the class name
  123694. */
  123695. getClassName(): string;
  123696. /**
  123697. * Gets the world normal component
  123698. */
  123699. readonly worldNormal: NodeMaterialConnectionPoint;
  123700. /**
  123701. * Gets the view direction input component
  123702. */
  123703. readonly viewDirection: NodeMaterialConnectionPoint;
  123704. /**
  123705. * Gets the output component
  123706. */
  123707. readonly output: NodeMaterialConnectionPoint;
  123708. autoConfigure(material: NodeMaterial): void;
  123709. protected _buildBlock(state: NodeMaterialBuildState): this;
  123710. }
  123711. }
  123712. declare module BABYLON {
  123713. /**
  123714. * Effect Render Options
  123715. */
  123716. export interface IEffectRendererOptions {
  123717. /**
  123718. * Defines the vertices positions.
  123719. */
  123720. positions?: number[];
  123721. /**
  123722. * Defines the indices.
  123723. */
  123724. indices?: number[];
  123725. }
  123726. /**
  123727. * Helper class to render one or more effects
  123728. */
  123729. export class EffectRenderer {
  123730. private engine;
  123731. private static _DefaultOptions;
  123732. private _vertexBuffers;
  123733. private _indexBuffer;
  123734. private _ringBufferIndex;
  123735. private _ringScreenBuffer;
  123736. private _fullscreenViewport;
  123737. private _getNextFrameBuffer;
  123738. /**
  123739. * Creates an effect renderer
  123740. * @param engine the engine to use for rendering
  123741. * @param options defines the options of the effect renderer
  123742. */
  123743. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  123744. /**
  123745. * Sets the current viewport in normalized coordinates 0-1
  123746. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  123747. */
  123748. setViewport(viewport?: Viewport): void;
  123749. /**
  123750. * Binds the embedded attributes buffer to the effect.
  123751. * @param effect Defines the effect to bind the attributes for
  123752. */
  123753. bindBuffers(effect: Effect): void;
  123754. /**
  123755. * Sets the current effect wrapper to use during draw.
  123756. * The effect needs to be ready before calling this api.
  123757. * This also sets the default full screen position attribute.
  123758. * @param effectWrapper Defines the effect to draw with
  123759. */
  123760. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  123761. /**
  123762. * Draws a full screen quad.
  123763. */
  123764. draw(): void;
  123765. /**
  123766. * renders one or more effects to a specified texture
  123767. * @param effectWrappers list of effects to renderer
  123768. * @param outputTexture texture to draw to, if null it will render to the screen
  123769. */
  123770. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  123771. /**
  123772. * Disposes of the effect renderer
  123773. */
  123774. dispose(): void;
  123775. }
  123776. /**
  123777. * Options to create an EffectWrapper
  123778. */
  123779. interface EffectWrapperCreationOptions {
  123780. /**
  123781. * Engine to use to create the effect
  123782. */
  123783. engine: ThinEngine;
  123784. /**
  123785. * Fragment shader for the effect
  123786. */
  123787. fragmentShader: string;
  123788. /**
  123789. * Vertex shader for the effect
  123790. */
  123791. vertexShader?: string;
  123792. /**
  123793. * Attributes to use in the shader
  123794. */
  123795. attributeNames?: Array<string>;
  123796. /**
  123797. * Uniforms to use in the shader
  123798. */
  123799. uniformNames?: Array<string>;
  123800. /**
  123801. * Texture sampler names to use in the shader
  123802. */
  123803. samplerNames?: Array<string>;
  123804. /**
  123805. * The friendly name of the effect displayed in Spector.
  123806. */
  123807. name?: string;
  123808. }
  123809. /**
  123810. * Wraps an effect to be used for rendering
  123811. */
  123812. export class EffectWrapper {
  123813. /**
  123814. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  123815. */
  123816. onApplyObservable: Observable<{}>;
  123817. /**
  123818. * The underlying effect
  123819. */
  123820. effect: Effect;
  123821. /**
  123822. * Creates an effect to be renderer
  123823. * @param creationOptions options to create the effect
  123824. */
  123825. constructor(creationOptions: EffectWrapperCreationOptions);
  123826. /**
  123827. * Disposes of the effect wrapper
  123828. */
  123829. dispose(): void;
  123830. }
  123831. }
  123832. declare module BABYLON {
  123833. /**
  123834. * Helper class to push actions to a pool of workers.
  123835. */
  123836. export class WorkerPool implements IDisposable {
  123837. private _workerInfos;
  123838. private _pendingActions;
  123839. /**
  123840. * Constructor
  123841. * @param workers Array of workers to use for actions
  123842. */
  123843. constructor(workers: Array<Worker>);
  123844. /**
  123845. * Terminates all workers and clears any pending actions.
  123846. */
  123847. dispose(): void;
  123848. /**
  123849. * Pushes an action to the worker pool. If all the workers are active, the action will be
  123850. * pended until a worker has completed its action.
  123851. * @param action The action to perform. Call onComplete when the action is complete.
  123852. */
  123853. push(action: (worker: Worker, onComplete: () => void) => void): void;
  123854. private _execute;
  123855. }
  123856. }
  123857. declare module BABYLON {
  123858. /**
  123859. * Configuration for Draco compression
  123860. */
  123861. export interface IDracoCompressionConfiguration {
  123862. /**
  123863. * Configuration for the decoder.
  123864. */
  123865. decoder: {
  123866. /**
  123867. * The url to the WebAssembly module.
  123868. */
  123869. wasmUrl?: string;
  123870. /**
  123871. * The url to the WebAssembly binary.
  123872. */
  123873. wasmBinaryUrl?: string;
  123874. /**
  123875. * The url to the fallback JavaScript module.
  123876. */
  123877. fallbackUrl?: string;
  123878. };
  123879. }
  123880. /**
  123881. * Draco compression (https://google.github.io/draco/)
  123882. *
  123883. * This class wraps the Draco module.
  123884. *
  123885. * **Encoder**
  123886. *
  123887. * The encoder is not currently implemented.
  123888. *
  123889. * **Decoder**
  123890. *
  123891. * 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.
  123892. *
  123893. * To update the configuration, use the following code:
  123894. * ```javascript
  123895. * DracoCompression.Configuration = {
  123896. * decoder: {
  123897. * wasmUrl: "<url to the WebAssembly library>",
  123898. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  123899. * fallbackUrl: "<url to the fallback JavaScript library>",
  123900. * }
  123901. * };
  123902. * ```
  123903. *
  123904. * 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.
  123905. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  123906. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  123907. *
  123908. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  123909. * ```javascript
  123910. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  123911. * ```
  123912. *
  123913. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  123914. */
  123915. export class DracoCompression implements IDisposable {
  123916. private _workerPoolPromise?;
  123917. private _decoderModulePromise?;
  123918. /**
  123919. * The configuration. Defaults to the following urls:
  123920. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  123921. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  123922. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  123923. */
  123924. static Configuration: IDracoCompressionConfiguration;
  123925. /**
  123926. * Returns true if the decoder configuration is available.
  123927. */
  123928. static readonly DecoderAvailable: boolean;
  123929. /**
  123930. * Default number of workers to create when creating the draco compression object.
  123931. */
  123932. static DefaultNumWorkers: number;
  123933. private static GetDefaultNumWorkers;
  123934. private static _Default;
  123935. /**
  123936. * Default instance for the draco compression object.
  123937. */
  123938. static readonly Default: DracoCompression;
  123939. /**
  123940. * Constructor
  123941. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  123942. */
  123943. constructor(numWorkers?: number);
  123944. /**
  123945. * Stop all async operations and release resources.
  123946. */
  123947. dispose(): void;
  123948. /**
  123949. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  123950. * @returns a promise that resolves when ready
  123951. */
  123952. whenReadyAsync(): Promise<void>;
  123953. /**
  123954. * Decode Draco compressed mesh data to vertex data.
  123955. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  123956. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  123957. * @returns A promise that resolves with the decoded vertex data
  123958. */
  123959. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  123960. [kind: string]: number;
  123961. }): Promise<VertexData>;
  123962. }
  123963. }
  123964. declare module BABYLON {
  123965. /**
  123966. * Class for building Constructive Solid Geometry
  123967. */
  123968. export class CSG {
  123969. private polygons;
  123970. /**
  123971. * The world matrix
  123972. */
  123973. matrix: Matrix;
  123974. /**
  123975. * Stores the position
  123976. */
  123977. position: Vector3;
  123978. /**
  123979. * Stores the rotation
  123980. */
  123981. rotation: Vector3;
  123982. /**
  123983. * Stores the rotation quaternion
  123984. */
  123985. rotationQuaternion: Nullable<Quaternion>;
  123986. /**
  123987. * Stores the scaling vector
  123988. */
  123989. scaling: Vector3;
  123990. /**
  123991. * Convert the Mesh to CSG
  123992. * @param mesh The Mesh to convert to CSG
  123993. * @returns A new CSG from the Mesh
  123994. */
  123995. static FromMesh(mesh: Mesh): CSG;
  123996. /**
  123997. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  123998. * @param polygons Polygons used to construct a CSG solid
  123999. */
  124000. private static FromPolygons;
  124001. /**
  124002. * Clones, or makes a deep copy, of the CSG
  124003. * @returns A new CSG
  124004. */
  124005. clone(): CSG;
  124006. /**
  124007. * Unions this CSG with another CSG
  124008. * @param csg The CSG to union against this CSG
  124009. * @returns The unioned CSG
  124010. */
  124011. union(csg: CSG): CSG;
  124012. /**
  124013. * Unions this CSG with another CSG in place
  124014. * @param csg The CSG to union against this CSG
  124015. */
  124016. unionInPlace(csg: CSG): void;
  124017. /**
  124018. * Subtracts this CSG with another CSG
  124019. * @param csg The CSG to subtract against this CSG
  124020. * @returns A new CSG
  124021. */
  124022. subtract(csg: CSG): CSG;
  124023. /**
  124024. * Subtracts this CSG with another CSG in place
  124025. * @param csg The CSG to subtact against this CSG
  124026. */
  124027. subtractInPlace(csg: CSG): void;
  124028. /**
  124029. * Intersect this CSG with another CSG
  124030. * @param csg The CSG to intersect against this CSG
  124031. * @returns A new CSG
  124032. */
  124033. intersect(csg: CSG): CSG;
  124034. /**
  124035. * Intersects this CSG with another CSG in place
  124036. * @param csg The CSG to intersect against this CSG
  124037. */
  124038. intersectInPlace(csg: CSG): void;
  124039. /**
  124040. * Return a new CSG solid with solid and empty space switched. This solid is
  124041. * not modified.
  124042. * @returns A new CSG solid with solid and empty space switched
  124043. */
  124044. inverse(): CSG;
  124045. /**
  124046. * Inverses the CSG in place
  124047. */
  124048. inverseInPlace(): void;
  124049. /**
  124050. * This is used to keep meshes transformations so they can be restored
  124051. * when we build back a Babylon Mesh
  124052. * NB : All CSG operations are performed in world coordinates
  124053. * @param csg The CSG to copy the transform attributes from
  124054. * @returns This CSG
  124055. */
  124056. copyTransformAttributes(csg: CSG): CSG;
  124057. /**
  124058. * Build Raw mesh from CSG
  124059. * Coordinates here are in world space
  124060. * @param name The name of the mesh geometry
  124061. * @param scene The Scene
  124062. * @param keepSubMeshes Specifies if the submeshes should be kept
  124063. * @returns A new Mesh
  124064. */
  124065. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  124066. /**
  124067. * Build Mesh from CSG taking material and transforms into account
  124068. * @param name The name of the Mesh
  124069. * @param material The material of the Mesh
  124070. * @param scene The Scene
  124071. * @param keepSubMeshes Specifies if submeshes should be kept
  124072. * @returns The new Mesh
  124073. */
  124074. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  124075. }
  124076. }
  124077. declare module BABYLON {
  124078. /**
  124079. * Class used to create a trail following a mesh
  124080. */
  124081. export class TrailMesh extends Mesh {
  124082. private _generator;
  124083. private _autoStart;
  124084. private _running;
  124085. private _diameter;
  124086. private _length;
  124087. private _sectionPolygonPointsCount;
  124088. private _sectionVectors;
  124089. private _sectionNormalVectors;
  124090. private _beforeRenderObserver;
  124091. /**
  124092. * @constructor
  124093. * @param name The value used by scene.getMeshByName() to do a lookup.
  124094. * @param generator The mesh to generate a trail.
  124095. * @param scene The scene to add this mesh to.
  124096. * @param diameter Diameter of trailing mesh. Default is 1.
  124097. * @param length Length of trailing mesh. Default is 60.
  124098. * @param autoStart Automatically start trailing mesh. Default true.
  124099. */
  124100. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  124101. /**
  124102. * "TrailMesh"
  124103. * @returns "TrailMesh"
  124104. */
  124105. getClassName(): string;
  124106. private _createMesh;
  124107. /**
  124108. * Start trailing mesh.
  124109. */
  124110. start(): void;
  124111. /**
  124112. * Stop trailing mesh.
  124113. */
  124114. stop(): void;
  124115. /**
  124116. * Update trailing mesh geometry.
  124117. */
  124118. update(): void;
  124119. /**
  124120. * Returns a new TrailMesh object.
  124121. * @param name is a string, the name given to the new mesh
  124122. * @param newGenerator use new generator object for cloned trail mesh
  124123. * @returns a new mesh
  124124. */
  124125. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  124126. /**
  124127. * Serializes this trail mesh
  124128. * @param serializationObject object to write serialization to
  124129. */
  124130. serialize(serializationObject: any): void;
  124131. /**
  124132. * Parses a serialized trail mesh
  124133. * @param parsedMesh the serialized mesh
  124134. * @param scene the scene to create the trail mesh in
  124135. * @returns the created trail mesh
  124136. */
  124137. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  124138. }
  124139. }
  124140. declare module BABYLON {
  124141. /**
  124142. * Class containing static functions to help procedurally build meshes
  124143. */
  124144. export class TiledBoxBuilder {
  124145. /**
  124146. * Creates a box mesh
  124147. * 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)
  124148. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  124149. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124150. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124151. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124152. * @param name defines the name of the mesh
  124153. * @param options defines the options used to create the mesh
  124154. * @param scene defines the hosting scene
  124155. * @returns the box mesh
  124156. */
  124157. static CreateTiledBox(name: string, options: {
  124158. pattern?: number;
  124159. width?: number;
  124160. height?: number;
  124161. depth?: number;
  124162. tileSize?: number;
  124163. tileWidth?: number;
  124164. tileHeight?: number;
  124165. alignHorizontal?: number;
  124166. alignVertical?: number;
  124167. faceUV?: Vector4[];
  124168. faceColors?: Color4[];
  124169. sideOrientation?: number;
  124170. updatable?: boolean;
  124171. }, scene?: Nullable<Scene>): Mesh;
  124172. }
  124173. }
  124174. declare module BABYLON {
  124175. /**
  124176. * Class containing static functions to help procedurally build meshes
  124177. */
  124178. export class TorusKnotBuilder {
  124179. /**
  124180. * Creates a torus knot mesh
  124181. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  124182. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  124183. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  124184. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  124185. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124186. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124187. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124188. * @param name defines the name of the mesh
  124189. * @param options defines the options used to create the mesh
  124190. * @param scene defines the hosting scene
  124191. * @returns the torus knot mesh
  124192. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  124193. */
  124194. static CreateTorusKnot(name: string, options: {
  124195. radius?: number;
  124196. tube?: number;
  124197. radialSegments?: number;
  124198. tubularSegments?: number;
  124199. p?: number;
  124200. q?: number;
  124201. updatable?: boolean;
  124202. sideOrientation?: number;
  124203. frontUVs?: Vector4;
  124204. backUVs?: Vector4;
  124205. }, scene: any): Mesh;
  124206. }
  124207. }
  124208. declare module BABYLON {
  124209. /**
  124210. * Polygon
  124211. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  124212. */
  124213. export class Polygon {
  124214. /**
  124215. * Creates a rectangle
  124216. * @param xmin bottom X coord
  124217. * @param ymin bottom Y coord
  124218. * @param xmax top X coord
  124219. * @param ymax top Y coord
  124220. * @returns points that make the resulting rectation
  124221. */
  124222. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  124223. /**
  124224. * Creates a circle
  124225. * @param radius radius of circle
  124226. * @param cx scale in x
  124227. * @param cy scale in y
  124228. * @param numberOfSides number of sides that make up the circle
  124229. * @returns points that make the resulting circle
  124230. */
  124231. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  124232. /**
  124233. * Creates a polygon from input string
  124234. * @param input Input polygon data
  124235. * @returns the parsed points
  124236. */
  124237. static Parse(input: string): Vector2[];
  124238. /**
  124239. * Starts building a polygon from x and y coordinates
  124240. * @param x x coordinate
  124241. * @param y y coordinate
  124242. * @returns the started path2
  124243. */
  124244. static StartingAt(x: number, y: number): Path2;
  124245. }
  124246. /**
  124247. * Builds a polygon
  124248. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  124249. */
  124250. export class PolygonMeshBuilder {
  124251. private _points;
  124252. private _outlinepoints;
  124253. private _holes;
  124254. private _name;
  124255. private _scene;
  124256. private _epoints;
  124257. private _eholes;
  124258. private _addToepoint;
  124259. /**
  124260. * Babylon reference to the earcut plugin.
  124261. */
  124262. bjsEarcut: any;
  124263. /**
  124264. * Creates a PolygonMeshBuilder
  124265. * @param name name of the builder
  124266. * @param contours Path of the polygon
  124267. * @param scene scene to add to when creating the mesh
  124268. * @param earcutInjection can be used to inject your own earcut reference
  124269. */
  124270. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  124271. /**
  124272. * Adds a whole within the polygon
  124273. * @param hole Array of points defining the hole
  124274. * @returns this
  124275. */
  124276. addHole(hole: Vector2[]): PolygonMeshBuilder;
  124277. /**
  124278. * Creates the polygon
  124279. * @param updatable If the mesh should be updatable
  124280. * @param depth The depth of the mesh created
  124281. * @returns the created mesh
  124282. */
  124283. build(updatable?: boolean, depth?: number): Mesh;
  124284. /**
  124285. * Creates the polygon
  124286. * @param depth The depth of the mesh created
  124287. * @returns the created VertexData
  124288. */
  124289. buildVertexData(depth?: number): VertexData;
  124290. /**
  124291. * Adds a side to the polygon
  124292. * @param positions points that make the polygon
  124293. * @param normals normals of the polygon
  124294. * @param uvs uvs of the polygon
  124295. * @param indices indices of the polygon
  124296. * @param bounds bounds of the polygon
  124297. * @param points points of the polygon
  124298. * @param depth depth of the polygon
  124299. * @param flip flip of the polygon
  124300. */
  124301. private addSide;
  124302. }
  124303. }
  124304. declare module BABYLON {
  124305. /**
  124306. * Class containing static functions to help procedurally build meshes
  124307. */
  124308. export class PolygonBuilder {
  124309. /**
  124310. * Creates a polygon mesh
  124311. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  124312. * * 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
  124313. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  124314. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124315. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  124316. * * Remember you can only change the shape positions, not their number when updating a polygon
  124317. * @param name defines the name of the mesh
  124318. * @param options defines the options used to create the mesh
  124319. * @param scene defines the hosting scene
  124320. * @param earcutInjection can be used to inject your own earcut reference
  124321. * @returns the polygon mesh
  124322. */
  124323. static CreatePolygon(name: string, options: {
  124324. shape: Vector3[];
  124325. holes?: Vector3[][];
  124326. depth?: number;
  124327. faceUV?: Vector4[];
  124328. faceColors?: Color4[];
  124329. updatable?: boolean;
  124330. sideOrientation?: number;
  124331. frontUVs?: Vector4;
  124332. backUVs?: Vector4;
  124333. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  124334. /**
  124335. * Creates an extruded polygon mesh, with depth in the Y direction.
  124336. * * 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)
  124337. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  124338. * @param name defines the name of the mesh
  124339. * @param options defines the options used to create the mesh
  124340. * @param scene defines the hosting scene
  124341. * @param earcutInjection can be used to inject your own earcut reference
  124342. * @returns the polygon mesh
  124343. */
  124344. static ExtrudePolygon(name: string, options: {
  124345. shape: Vector3[];
  124346. holes?: Vector3[][];
  124347. depth?: number;
  124348. faceUV?: Vector4[];
  124349. faceColors?: Color4[];
  124350. updatable?: boolean;
  124351. sideOrientation?: number;
  124352. frontUVs?: Vector4;
  124353. backUVs?: Vector4;
  124354. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  124355. }
  124356. }
  124357. declare module BABYLON {
  124358. /**
  124359. * Class containing static functions to help procedurally build meshes
  124360. */
  124361. export class LatheBuilder {
  124362. /**
  124363. * Creates lathe mesh.
  124364. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  124365. * * 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
  124366. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  124367. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  124368. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  124369. * * 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
  124370. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  124371. * * 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
  124372. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124373. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124374. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  124375. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124376. * @param name defines the name of the mesh
  124377. * @param options defines the options used to create the mesh
  124378. * @param scene defines the hosting scene
  124379. * @returns the lathe mesh
  124380. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  124381. */
  124382. static CreateLathe(name: string, options: {
  124383. shape: Vector3[];
  124384. radius?: number;
  124385. tessellation?: number;
  124386. clip?: number;
  124387. arc?: number;
  124388. closed?: boolean;
  124389. updatable?: boolean;
  124390. sideOrientation?: number;
  124391. frontUVs?: Vector4;
  124392. backUVs?: Vector4;
  124393. cap?: number;
  124394. invertUV?: boolean;
  124395. }, scene?: Nullable<Scene>): Mesh;
  124396. }
  124397. }
  124398. declare module BABYLON {
  124399. /**
  124400. * Class containing static functions to help procedurally build meshes
  124401. */
  124402. export class TiledPlaneBuilder {
  124403. /**
  124404. * Creates a tiled plane mesh
  124405. * * The parameter `pattern` will, depending on value, do nothing or
  124406. * * * flip (reflect about central vertical) alternate tiles across and up
  124407. * * * flip every tile on alternate rows
  124408. * * * rotate (180 degs) alternate tiles across and up
  124409. * * * rotate every tile on alternate rows
  124410. * * * flip and rotate alternate tiles across and up
  124411. * * * flip and rotate every tile on alternate rows
  124412. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  124413. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  124414. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124415. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  124416. * * 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)
  124417. * * 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)
  124418. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  124419. * @param name defines the name of the mesh
  124420. * @param options defines the options used to create the mesh
  124421. * @param scene defines the hosting scene
  124422. * @returns the box mesh
  124423. */
  124424. static CreateTiledPlane(name: string, options: {
  124425. pattern?: number;
  124426. tileSize?: number;
  124427. tileWidth?: number;
  124428. tileHeight?: number;
  124429. size?: number;
  124430. width?: number;
  124431. height?: number;
  124432. alignHorizontal?: number;
  124433. alignVertical?: number;
  124434. sideOrientation?: number;
  124435. frontUVs?: Vector4;
  124436. backUVs?: Vector4;
  124437. updatable?: boolean;
  124438. }, scene?: Nullable<Scene>): Mesh;
  124439. }
  124440. }
  124441. declare module BABYLON {
  124442. /**
  124443. * Class containing static functions to help procedurally build meshes
  124444. */
  124445. export class TubeBuilder {
  124446. /**
  124447. * Creates a tube mesh.
  124448. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  124449. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  124450. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  124451. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  124452. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  124453. * * 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)
  124454. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  124455. * * 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
  124456. * * 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
  124457. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124458. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124459. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  124460. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124461. * @param name defines the name of the mesh
  124462. * @param options defines the options used to create the mesh
  124463. * @param scene defines the hosting scene
  124464. * @returns the tube mesh
  124465. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  124466. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  124467. */
  124468. static CreateTube(name: string, options: {
  124469. path: Vector3[];
  124470. radius?: number;
  124471. tessellation?: number;
  124472. radiusFunction?: {
  124473. (i: number, distance: number): number;
  124474. };
  124475. cap?: number;
  124476. arc?: number;
  124477. updatable?: boolean;
  124478. sideOrientation?: number;
  124479. frontUVs?: Vector4;
  124480. backUVs?: Vector4;
  124481. instance?: Mesh;
  124482. invertUV?: boolean;
  124483. }, scene?: Nullable<Scene>): Mesh;
  124484. }
  124485. }
  124486. declare module BABYLON {
  124487. /**
  124488. * Class containing static functions to help procedurally build meshes
  124489. */
  124490. export class IcoSphereBuilder {
  124491. /**
  124492. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  124493. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  124494. * * 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`)
  124495. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  124496. * * 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
  124497. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124498. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124499. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124500. * @param name defines the name of the mesh
  124501. * @param options defines the options used to create the mesh
  124502. * @param scene defines the hosting scene
  124503. * @returns the icosahedron mesh
  124504. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  124505. */
  124506. static CreateIcoSphere(name: string, options: {
  124507. radius?: number;
  124508. radiusX?: number;
  124509. radiusY?: number;
  124510. radiusZ?: number;
  124511. flat?: boolean;
  124512. subdivisions?: number;
  124513. sideOrientation?: number;
  124514. frontUVs?: Vector4;
  124515. backUVs?: Vector4;
  124516. updatable?: boolean;
  124517. }, scene?: Nullable<Scene>): Mesh;
  124518. }
  124519. }
  124520. declare module BABYLON {
  124521. /**
  124522. * Class containing static functions to help procedurally build meshes
  124523. */
  124524. export class DecalBuilder {
  124525. /**
  124526. * Creates a decal mesh.
  124527. * 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
  124528. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  124529. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  124530. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  124531. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  124532. * @param name defines the name of the mesh
  124533. * @param sourceMesh defines the mesh where the decal must be applied
  124534. * @param options defines the options used to create the mesh
  124535. * @param scene defines the hosting scene
  124536. * @returns the decal mesh
  124537. * @see https://doc.babylonjs.com/how_to/decals
  124538. */
  124539. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  124540. position?: Vector3;
  124541. normal?: Vector3;
  124542. size?: Vector3;
  124543. angle?: number;
  124544. }): Mesh;
  124545. }
  124546. }
  124547. declare module BABYLON {
  124548. /**
  124549. * Class containing static functions to help procedurally build meshes
  124550. */
  124551. export class MeshBuilder {
  124552. /**
  124553. * Creates a box mesh
  124554. * * The parameter `size` sets the size (float) of each box side (default 1)
  124555. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  124556. * * 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)
  124557. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  124558. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124559. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124560. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124561. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  124562. * @param name defines the name of the mesh
  124563. * @param options defines the options used to create the mesh
  124564. * @param scene defines the hosting scene
  124565. * @returns the box mesh
  124566. */
  124567. static CreateBox(name: string, options: {
  124568. size?: number;
  124569. width?: number;
  124570. height?: number;
  124571. depth?: number;
  124572. faceUV?: Vector4[];
  124573. faceColors?: Color4[];
  124574. sideOrientation?: number;
  124575. frontUVs?: Vector4;
  124576. backUVs?: Vector4;
  124577. updatable?: boolean;
  124578. }, scene?: Nullable<Scene>): Mesh;
  124579. /**
  124580. * Creates a tiled box mesh
  124581. * * faceTiles sets the pattern, tile size and number of tiles for a face
  124582. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124583. * @param name defines the name of the mesh
  124584. * @param options defines the options used to create the mesh
  124585. * @param scene defines the hosting scene
  124586. * @returns the tiled box mesh
  124587. */
  124588. static CreateTiledBox(name: string, options: {
  124589. pattern?: number;
  124590. size?: number;
  124591. width?: number;
  124592. height?: number;
  124593. depth: number;
  124594. tileSize?: number;
  124595. tileWidth?: number;
  124596. tileHeight?: number;
  124597. faceUV?: Vector4[];
  124598. faceColors?: Color4[];
  124599. alignHorizontal?: number;
  124600. alignVertical?: number;
  124601. sideOrientation?: number;
  124602. updatable?: boolean;
  124603. }, scene?: Nullable<Scene>): Mesh;
  124604. /**
  124605. * Creates a sphere mesh
  124606. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  124607. * * 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`)
  124608. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  124609. * * 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
  124610. * * 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)
  124611. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124612. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124613. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124614. * @param name defines the name of the mesh
  124615. * @param options defines the options used to create the mesh
  124616. * @param scene defines the hosting scene
  124617. * @returns the sphere mesh
  124618. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  124619. */
  124620. static CreateSphere(name: string, options: {
  124621. segments?: number;
  124622. diameter?: number;
  124623. diameterX?: number;
  124624. diameterY?: number;
  124625. diameterZ?: number;
  124626. arc?: number;
  124627. slice?: number;
  124628. sideOrientation?: number;
  124629. frontUVs?: Vector4;
  124630. backUVs?: Vector4;
  124631. updatable?: boolean;
  124632. }, scene?: Nullable<Scene>): Mesh;
  124633. /**
  124634. * Creates a plane polygonal mesh. By default, this is a disc
  124635. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  124636. * * 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
  124637. * * 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
  124638. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124639. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124640. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124641. * @param name defines the name of the mesh
  124642. * @param options defines the options used to create the mesh
  124643. * @param scene defines the hosting scene
  124644. * @returns the plane polygonal mesh
  124645. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  124646. */
  124647. static CreateDisc(name: string, options: {
  124648. radius?: number;
  124649. tessellation?: number;
  124650. arc?: number;
  124651. updatable?: boolean;
  124652. sideOrientation?: number;
  124653. frontUVs?: Vector4;
  124654. backUVs?: Vector4;
  124655. }, scene?: Nullable<Scene>): Mesh;
  124656. /**
  124657. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  124658. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  124659. * * 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`)
  124660. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  124661. * * 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
  124662. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124663. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124664. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124665. * @param name defines the name of the mesh
  124666. * @param options defines the options used to create the mesh
  124667. * @param scene defines the hosting scene
  124668. * @returns the icosahedron mesh
  124669. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  124670. */
  124671. static CreateIcoSphere(name: string, options: {
  124672. radius?: number;
  124673. radiusX?: number;
  124674. radiusY?: number;
  124675. radiusZ?: number;
  124676. flat?: boolean;
  124677. subdivisions?: number;
  124678. sideOrientation?: number;
  124679. frontUVs?: Vector4;
  124680. backUVs?: Vector4;
  124681. updatable?: boolean;
  124682. }, scene?: Nullable<Scene>): Mesh;
  124683. /**
  124684. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  124685. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  124686. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  124687. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  124688. * * 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
  124689. * * 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
  124690. * * 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
  124691. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124692. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124693. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  124694. * * 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
  124695. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  124696. * * 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
  124697. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  124698. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124699. * @param name defines the name of the mesh
  124700. * @param options defines the options used to create the mesh
  124701. * @param scene defines the hosting scene
  124702. * @returns the ribbon mesh
  124703. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  124704. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  124705. */
  124706. static CreateRibbon(name: string, options: {
  124707. pathArray: Vector3[][];
  124708. closeArray?: boolean;
  124709. closePath?: boolean;
  124710. offset?: number;
  124711. updatable?: boolean;
  124712. sideOrientation?: number;
  124713. frontUVs?: Vector4;
  124714. backUVs?: Vector4;
  124715. instance?: Mesh;
  124716. invertUV?: boolean;
  124717. uvs?: Vector2[];
  124718. colors?: Color4[];
  124719. }, scene?: Nullable<Scene>): Mesh;
  124720. /**
  124721. * Creates a cylinder or a cone mesh
  124722. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  124723. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  124724. * * 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.
  124725. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  124726. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  124727. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  124728. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  124729. * * 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).
  124730. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  124731. * * 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).
  124732. * * 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
  124733. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  124734. * * 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
  124735. * * 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.
  124736. * * If `enclose` is false, a ring surface is one element.
  124737. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  124738. * * 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
  124739. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124740. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124741. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124742. * @param name defines the name of the mesh
  124743. * @param options defines the options used to create the mesh
  124744. * @param scene defines the hosting scene
  124745. * @returns the cylinder mesh
  124746. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  124747. */
  124748. static CreateCylinder(name: string, options: {
  124749. height?: number;
  124750. diameterTop?: number;
  124751. diameterBottom?: number;
  124752. diameter?: number;
  124753. tessellation?: number;
  124754. subdivisions?: number;
  124755. arc?: number;
  124756. faceColors?: Color4[];
  124757. faceUV?: Vector4[];
  124758. updatable?: boolean;
  124759. hasRings?: boolean;
  124760. enclose?: boolean;
  124761. cap?: number;
  124762. sideOrientation?: number;
  124763. frontUVs?: Vector4;
  124764. backUVs?: Vector4;
  124765. }, scene?: Nullable<Scene>): Mesh;
  124766. /**
  124767. * Creates a torus mesh
  124768. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  124769. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  124770. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  124771. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124772. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124773. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124774. * @param name defines the name of the mesh
  124775. * @param options defines the options used to create the mesh
  124776. * @param scene defines the hosting scene
  124777. * @returns the torus mesh
  124778. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  124779. */
  124780. static CreateTorus(name: string, options: {
  124781. diameter?: number;
  124782. thickness?: number;
  124783. tessellation?: number;
  124784. updatable?: boolean;
  124785. sideOrientation?: number;
  124786. frontUVs?: Vector4;
  124787. backUVs?: Vector4;
  124788. }, scene?: Nullable<Scene>): Mesh;
  124789. /**
  124790. * Creates a torus knot mesh
  124791. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  124792. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  124793. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  124794. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  124795. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124796. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124797. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124798. * @param name defines the name of the mesh
  124799. * @param options defines the options used to create the mesh
  124800. * @param scene defines the hosting scene
  124801. * @returns the torus knot mesh
  124802. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  124803. */
  124804. static CreateTorusKnot(name: string, options: {
  124805. radius?: number;
  124806. tube?: number;
  124807. radialSegments?: number;
  124808. tubularSegments?: number;
  124809. p?: number;
  124810. q?: number;
  124811. updatable?: boolean;
  124812. sideOrientation?: number;
  124813. frontUVs?: Vector4;
  124814. backUVs?: Vector4;
  124815. }, scene?: Nullable<Scene>): Mesh;
  124816. /**
  124817. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  124818. * * 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
  124819. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  124820. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  124821. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  124822. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  124823. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  124824. * * 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
  124825. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  124826. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124827. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  124828. * @param name defines the name of the new line system
  124829. * @param options defines the options used to create the line system
  124830. * @param scene defines the hosting scene
  124831. * @returns a new line system mesh
  124832. */
  124833. static CreateLineSystem(name: string, options: {
  124834. lines: Vector3[][];
  124835. updatable?: boolean;
  124836. instance?: Nullable<LinesMesh>;
  124837. colors?: Nullable<Color4[][]>;
  124838. useVertexAlpha?: boolean;
  124839. }, scene: Nullable<Scene>): LinesMesh;
  124840. /**
  124841. * Creates a line mesh
  124842. * 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
  124843. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  124844. * * The parameter `points` is an array successive Vector3
  124845. * * 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
  124846. * * The optional parameter `colors` is an array of successive Color4, one per line point
  124847. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  124848. * * When updating an instance, remember that only point positions can change, not the number of points
  124849. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124850. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  124851. * @param name defines the name of the new line system
  124852. * @param options defines the options used to create the line system
  124853. * @param scene defines the hosting scene
  124854. * @returns a new line mesh
  124855. */
  124856. static CreateLines(name: string, options: {
  124857. points: Vector3[];
  124858. updatable?: boolean;
  124859. instance?: Nullable<LinesMesh>;
  124860. colors?: Color4[];
  124861. useVertexAlpha?: boolean;
  124862. }, scene?: Nullable<Scene>): LinesMesh;
  124863. /**
  124864. * Creates a dashed line mesh
  124865. * * 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
  124866. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  124867. * * The parameter `points` is an array successive Vector3
  124868. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  124869. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  124870. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  124871. * * 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
  124872. * * When updating an instance, remember that only point positions can change, not the number of points
  124873. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124874. * @param name defines the name of the mesh
  124875. * @param options defines the options used to create the mesh
  124876. * @param scene defines the hosting scene
  124877. * @returns the dashed line mesh
  124878. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  124879. */
  124880. static CreateDashedLines(name: string, options: {
  124881. points: Vector3[];
  124882. dashSize?: number;
  124883. gapSize?: number;
  124884. dashNb?: number;
  124885. updatable?: boolean;
  124886. instance?: LinesMesh;
  124887. }, scene?: Nullable<Scene>): LinesMesh;
  124888. /**
  124889. * 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.
  124890. * * 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.
  124891. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  124892. * * 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.
  124893. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  124894. * * 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
  124895. * * 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
  124896. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  124897. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124898. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124899. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  124900. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124901. * @param name defines the name of the mesh
  124902. * @param options defines the options used to create the mesh
  124903. * @param scene defines the hosting scene
  124904. * @returns the extruded shape mesh
  124905. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  124906. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  124907. */
  124908. static ExtrudeShape(name: string, options: {
  124909. shape: Vector3[];
  124910. path: Vector3[];
  124911. scale?: number;
  124912. rotation?: number;
  124913. cap?: number;
  124914. updatable?: boolean;
  124915. sideOrientation?: number;
  124916. frontUVs?: Vector4;
  124917. backUVs?: Vector4;
  124918. instance?: Mesh;
  124919. invertUV?: boolean;
  124920. }, scene?: Nullable<Scene>): Mesh;
  124921. /**
  124922. * Creates an custom extruded shape mesh.
  124923. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  124924. * * 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.
  124925. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  124926. * * 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
  124927. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  124928. * * 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
  124929. * * It must returns a float value that will be the scale value applied to the shape on each path point
  124930. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  124931. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  124932. * * 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
  124933. * * 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
  124934. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  124935. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124936. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124937. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  124938. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124939. * @param name defines the name of the mesh
  124940. * @param options defines the options used to create the mesh
  124941. * @param scene defines the hosting scene
  124942. * @returns the custom extruded shape mesh
  124943. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  124944. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  124945. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  124946. */
  124947. static ExtrudeShapeCustom(name: string, options: {
  124948. shape: Vector3[];
  124949. path: Vector3[];
  124950. scaleFunction?: any;
  124951. rotationFunction?: any;
  124952. ribbonCloseArray?: boolean;
  124953. ribbonClosePath?: boolean;
  124954. cap?: number;
  124955. updatable?: boolean;
  124956. sideOrientation?: number;
  124957. frontUVs?: Vector4;
  124958. backUVs?: Vector4;
  124959. instance?: Mesh;
  124960. invertUV?: boolean;
  124961. }, scene?: Nullable<Scene>): Mesh;
  124962. /**
  124963. * Creates lathe mesh.
  124964. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  124965. * * 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
  124966. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  124967. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  124968. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  124969. * * 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
  124970. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  124971. * * 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
  124972. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124973. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124974. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  124975. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124976. * @param name defines the name of the mesh
  124977. * @param options defines the options used to create the mesh
  124978. * @param scene defines the hosting scene
  124979. * @returns the lathe mesh
  124980. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  124981. */
  124982. static CreateLathe(name: string, options: {
  124983. shape: Vector3[];
  124984. radius?: number;
  124985. tessellation?: number;
  124986. clip?: number;
  124987. arc?: number;
  124988. closed?: boolean;
  124989. updatable?: boolean;
  124990. sideOrientation?: number;
  124991. frontUVs?: Vector4;
  124992. backUVs?: Vector4;
  124993. cap?: number;
  124994. invertUV?: boolean;
  124995. }, scene?: Nullable<Scene>): Mesh;
  124996. /**
  124997. * Creates a tiled plane mesh
  124998. * * You can set a limited pattern arrangement with the tiles
  124999. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125000. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125001. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125002. * @param name defines the name of the mesh
  125003. * @param options defines the options used to create the mesh
  125004. * @param scene defines the hosting scene
  125005. * @returns the plane mesh
  125006. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  125007. */
  125008. static CreateTiledPlane(name: string, options: {
  125009. pattern?: number;
  125010. tileSize?: number;
  125011. tileWidth?: number;
  125012. tileHeight?: number;
  125013. size?: number;
  125014. width?: number;
  125015. height?: number;
  125016. alignHorizontal?: number;
  125017. alignVertical?: number;
  125018. sideOrientation?: number;
  125019. frontUVs?: Vector4;
  125020. backUVs?: Vector4;
  125021. updatable?: boolean;
  125022. }, scene?: Nullable<Scene>): Mesh;
  125023. /**
  125024. * Creates a plane mesh
  125025. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  125026. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  125027. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  125028. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125029. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125030. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125031. * @param name defines the name of the mesh
  125032. * @param options defines the options used to create the mesh
  125033. * @param scene defines the hosting scene
  125034. * @returns the plane mesh
  125035. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  125036. */
  125037. static CreatePlane(name: string, options: {
  125038. size?: number;
  125039. width?: number;
  125040. height?: number;
  125041. sideOrientation?: number;
  125042. frontUVs?: Vector4;
  125043. backUVs?: Vector4;
  125044. updatable?: boolean;
  125045. sourcePlane?: Plane;
  125046. }, scene?: Nullable<Scene>): Mesh;
  125047. /**
  125048. * Creates a ground mesh
  125049. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  125050. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  125051. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125052. * @param name defines the name of the mesh
  125053. * @param options defines the options used to create the mesh
  125054. * @param scene defines the hosting scene
  125055. * @returns the ground mesh
  125056. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  125057. */
  125058. static CreateGround(name: string, options: {
  125059. width?: number;
  125060. height?: number;
  125061. subdivisions?: number;
  125062. subdivisionsX?: number;
  125063. subdivisionsY?: number;
  125064. updatable?: boolean;
  125065. }, scene?: Nullable<Scene>): Mesh;
  125066. /**
  125067. * Creates a tiled ground mesh
  125068. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  125069. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  125070. * * 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
  125071. * * 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
  125072. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125073. * @param name defines the name of the mesh
  125074. * @param options defines the options used to create the mesh
  125075. * @param scene defines the hosting scene
  125076. * @returns the tiled ground mesh
  125077. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  125078. */
  125079. static CreateTiledGround(name: string, options: {
  125080. xmin: number;
  125081. zmin: number;
  125082. xmax: number;
  125083. zmax: number;
  125084. subdivisions?: {
  125085. w: number;
  125086. h: number;
  125087. };
  125088. precision?: {
  125089. w: number;
  125090. h: number;
  125091. };
  125092. updatable?: boolean;
  125093. }, scene?: Nullable<Scene>): Mesh;
  125094. /**
  125095. * Creates a ground mesh from a height map
  125096. * * The parameter `url` sets the URL of the height map image resource.
  125097. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  125098. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  125099. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  125100. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  125101. * * 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.
  125102. * * 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).
  125103. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  125104. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125105. * @param name defines the name of the mesh
  125106. * @param url defines the url to the height map
  125107. * @param options defines the options used to create the mesh
  125108. * @param scene defines the hosting scene
  125109. * @returns the ground mesh
  125110. * @see https://doc.babylonjs.com/babylon101/height_map
  125111. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  125112. */
  125113. static CreateGroundFromHeightMap(name: string, url: string, options: {
  125114. width?: number;
  125115. height?: number;
  125116. subdivisions?: number;
  125117. minHeight?: number;
  125118. maxHeight?: number;
  125119. colorFilter?: Color3;
  125120. alphaFilter?: number;
  125121. updatable?: boolean;
  125122. onReady?: (mesh: GroundMesh) => void;
  125123. }, scene?: Nullable<Scene>): GroundMesh;
  125124. /**
  125125. * Creates a polygon mesh
  125126. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  125127. * * 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
  125128. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  125129. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125130. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  125131. * * Remember you can only change the shape positions, not their number when updating a polygon
  125132. * @param name defines the name of the mesh
  125133. * @param options defines the options used to create the mesh
  125134. * @param scene defines the hosting scene
  125135. * @param earcutInjection can be used to inject your own earcut reference
  125136. * @returns the polygon mesh
  125137. */
  125138. static CreatePolygon(name: string, options: {
  125139. shape: Vector3[];
  125140. holes?: Vector3[][];
  125141. depth?: number;
  125142. faceUV?: Vector4[];
  125143. faceColors?: Color4[];
  125144. updatable?: boolean;
  125145. sideOrientation?: number;
  125146. frontUVs?: Vector4;
  125147. backUVs?: Vector4;
  125148. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  125149. /**
  125150. * Creates an extruded polygon mesh, with depth in the Y direction.
  125151. * * 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)
  125152. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  125153. * @param name defines the name of the mesh
  125154. * @param options defines the options used to create the mesh
  125155. * @param scene defines the hosting scene
  125156. * @param earcutInjection can be used to inject your own earcut reference
  125157. * @returns the polygon mesh
  125158. */
  125159. static ExtrudePolygon(name: string, options: {
  125160. shape: Vector3[];
  125161. holes?: Vector3[][];
  125162. depth?: number;
  125163. faceUV?: Vector4[];
  125164. faceColors?: Color4[];
  125165. updatable?: boolean;
  125166. sideOrientation?: number;
  125167. frontUVs?: Vector4;
  125168. backUVs?: Vector4;
  125169. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  125170. /**
  125171. * Creates a tube mesh.
  125172. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  125173. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  125174. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  125175. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  125176. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  125177. * * 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)
  125178. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  125179. * * 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
  125180. * * 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
  125181. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125182. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125183. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125184. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125185. * @param name defines the name of the mesh
  125186. * @param options defines the options used to create the mesh
  125187. * @param scene defines the hosting scene
  125188. * @returns the tube mesh
  125189. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125190. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  125191. */
  125192. static CreateTube(name: string, options: {
  125193. path: Vector3[];
  125194. radius?: number;
  125195. tessellation?: number;
  125196. radiusFunction?: {
  125197. (i: number, distance: number): number;
  125198. };
  125199. cap?: number;
  125200. arc?: number;
  125201. updatable?: boolean;
  125202. sideOrientation?: number;
  125203. frontUVs?: Vector4;
  125204. backUVs?: Vector4;
  125205. instance?: Mesh;
  125206. invertUV?: boolean;
  125207. }, scene?: Nullable<Scene>): Mesh;
  125208. /**
  125209. * Creates a polyhedron mesh
  125210. * * 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
  125211. * * The parameter `size` (positive float, default 1) sets the polygon size
  125212. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  125213. * * 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`
  125214. * * 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
  125215. * * 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)`)
  125216. * * 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
  125217. * * 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
  125218. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125219. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125220. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125221. * @param name defines the name of the mesh
  125222. * @param options defines the options used to create the mesh
  125223. * @param scene defines the hosting scene
  125224. * @returns the polyhedron mesh
  125225. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  125226. */
  125227. static CreatePolyhedron(name: string, options: {
  125228. type?: number;
  125229. size?: number;
  125230. sizeX?: number;
  125231. sizeY?: number;
  125232. sizeZ?: number;
  125233. custom?: any;
  125234. faceUV?: Vector4[];
  125235. faceColors?: Color4[];
  125236. flat?: boolean;
  125237. updatable?: boolean;
  125238. sideOrientation?: number;
  125239. frontUVs?: Vector4;
  125240. backUVs?: Vector4;
  125241. }, scene?: Nullable<Scene>): Mesh;
  125242. /**
  125243. * Creates a decal mesh.
  125244. * 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
  125245. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  125246. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  125247. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  125248. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  125249. * @param name defines the name of the mesh
  125250. * @param sourceMesh defines the mesh where the decal must be applied
  125251. * @param options defines the options used to create the mesh
  125252. * @param scene defines the hosting scene
  125253. * @returns the decal mesh
  125254. * @see https://doc.babylonjs.com/how_to/decals
  125255. */
  125256. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  125257. position?: Vector3;
  125258. normal?: Vector3;
  125259. size?: Vector3;
  125260. angle?: number;
  125261. }): Mesh;
  125262. }
  125263. }
  125264. declare module BABYLON {
  125265. /**
  125266. * A simplifier interface for future simplification implementations
  125267. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125268. */
  125269. export interface ISimplifier {
  125270. /**
  125271. * Simplification of a given mesh according to the given settings.
  125272. * Since this requires computation, it is assumed that the function runs async.
  125273. * @param settings The settings of the simplification, including quality and distance
  125274. * @param successCallback A callback that will be called after the mesh was simplified.
  125275. * @param errorCallback in case of an error, this callback will be called. optional.
  125276. */
  125277. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  125278. }
  125279. /**
  125280. * Expected simplification settings.
  125281. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  125282. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125283. */
  125284. export interface ISimplificationSettings {
  125285. /**
  125286. * Gets or sets the expected quality
  125287. */
  125288. quality: number;
  125289. /**
  125290. * Gets or sets the distance when this optimized version should be used
  125291. */
  125292. distance: number;
  125293. /**
  125294. * Gets an already optimized mesh
  125295. */
  125296. optimizeMesh?: boolean;
  125297. }
  125298. /**
  125299. * Class used to specify simplification options
  125300. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125301. */
  125302. export class SimplificationSettings implements ISimplificationSettings {
  125303. /** expected quality */
  125304. quality: number;
  125305. /** distance when this optimized version should be used */
  125306. distance: number;
  125307. /** already optimized mesh */
  125308. optimizeMesh?: boolean | undefined;
  125309. /**
  125310. * Creates a SimplificationSettings
  125311. * @param quality expected quality
  125312. * @param distance distance when this optimized version should be used
  125313. * @param optimizeMesh already optimized mesh
  125314. */
  125315. constructor(
  125316. /** expected quality */
  125317. quality: number,
  125318. /** distance when this optimized version should be used */
  125319. distance: number,
  125320. /** already optimized mesh */
  125321. optimizeMesh?: boolean | undefined);
  125322. }
  125323. /**
  125324. * Interface used to define a simplification task
  125325. */
  125326. export interface ISimplificationTask {
  125327. /**
  125328. * Array of settings
  125329. */
  125330. settings: Array<ISimplificationSettings>;
  125331. /**
  125332. * Simplification type
  125333. */
  125334. simplificationType: SimplificationType;
  125335. /**
  125336. * Mesh to simplify
  125337. */
  125338. mesh: Mesh;
  125339. /**
  125340. * Callback called on success
  125341. */
  125342. successCallback?: () => void;
  125343. /**
  125344. * Defines if parallel processing can be used
  125345. */
  125346. parallelProcessing: boolean;
  125347. }
  125348. /**
  125349. * Queue used to order the simplification tasks
  125350. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125351. */
  125352. export class SimplificationQueue {
  125353. private _simplificationArray;
  125354. /**
  125355. * Gets a boolean indicating that the process is still running
  125356. */
  125357. running: boolean;
  125358. /**
  125359. * Creates a new queue
  125360. */
  125361. constructor();
  125362. /**
  125363. * Adds a new simplification task
  125364. * @param task defines a task to add
  125365. */
  125366. addTask(task: ISimplificationTask): void;
  125367. /**
  125368. * Execute next task
  125369. */
  125370. executeNext(): void;
  125371. /**
  125372. * Execute a simplification task
  125373. * @param task defines the task to run
  125374. */
  125375. runSimplification(task: ISimplificationTask): void;
  125376. private getSimplifier;
  125377. }
  125378. /**
  125379. * The implemented types of simplification
  125380. * At the moment only Quadratic Error Decimation is implemented
  125381. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125382. */
  125383. export enum SimplificationType {
  125384. /** Quadratic error decimation */
  125385. QUADRATIC = 0
  125386. }
  125387. }
  125388. declare module BABYLON {
  125389. interface Scene {
  125390. /** @hidden (Backing field) */
  125391. _simplificationQueue: SimplificationQueue;
  125392. /**
  125393. * Gets or sets the simplification queue attached to the scene
  125394. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125395. */
  125396. simplificationQueue: SimplificationQueue;
  125397. }
  125398. interface Mesh {
  125399. /**
  125400. * Simplify the mesh according to the given array of settings.
  125401. * Function will return immediately and will simplify async
  125402. * @param settings a collection of simplification settings
  125403. * @param parallelProcessing should all levels calculate parallel or one after the other
  125404. * @param simplificationType the type of simplification to run
  125405. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  125406. * @returns the current mesh
  125407. */
  125408. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  125409. }
  125410. /**
  125411. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  125412. * created in a scene
  125413. */
  125414. export class SimplicationQueueSceneComponent implements ISceneComponent {
  125415. /**
  125416. * The component name helpfull to identify the component in the list of scene components.
  125417. */
  125418. readonly name: string;
  125419. /**
  125420. * The scene the component belongs to.
  125421. */
  125422. scene: Scene;
  125423. /**
  125424. * Creates a new instance of the component for the given scene
  125425. * @param scene Defines the scene to register the component in
  125426. */
  125427. constructor(scene: Scene);
  125428. /**
  125429. * Registers the component in a given scene
  125430. */
  125431. register(): void;
  125432. /**
  125433. * Rebuilds the elements related to this component in case of
  125434. * context lost for instance.
  125435. */
  125436. rebuild(): void;
  125437. /**
  125438. * Disposes the component and the associated ressources
  125439. */
  125440. dispose(): void;
  125441. private _beforeCameraUpdate;
  125442. }
  125443. }
  125444. declare module BABYLON {
  125445. /**
  125446. * Navigation plugin interface to add navigation constrained by a navigation mesh
  125447. */
  125448. export interface INavigationEnginePlugin {
  125449. /**
  125450. * plugin name
  125451. */
  125452. name: string;
  125453. /**
  125454. * Creates a navigation mesh
  125455. * @param meshes array of all the geometry used to compute the navigatio mesh
  125456. * @param parameters bunch of parameters used to filter geometry
  125457. */
  125458. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  125459. /**
  125460. * Create a navigation mesh debug mesh
  125461. * @param scene is where the mesh will be added
  125462. * @returns debug display mesh
  125463. */
  125464. createDebugNavMesh(scene: Scene): Mesh;
  125465. /**
  125466. * Get a navigation mesh constrained position, closest to the parameter position
  125467. * @param position world position
  125468. * @returns the closest point to position constrained by the navigation mesh
  125469. */
  125470. getClosestPoint(position: Vector3): Vector3;
  125471. /**
  125472. * Get a navigation mesh constrained position, within a particular radius
  125473. * @param position world position
  125474. * @param maxRadius the maximum distance to the constrained world position
  125475. * @returns the closest point to position constrained by the navigation mesh
  125476. */
  125477. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  125478. /**
  125479. * Compute the final position from a segment made of destination-position
  125480. * @param position world position
  125481. * @param destination world position
  125482. * @returns the resulting point along the navmesh
  125483. */
  125484. moveAlong(position: Vector3, destination: Vector3): Vector3;
  125485. /**
  125486. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  125487. * @param start world position
  125488. * @param end world position
  125489. * @returns array containing world position composing the path
  125490. */
  125491. computePath(start: Vector3, end: Vector3): Vector3[];
  125492. /**
  125493. * If this plugin is supported
  125494. * @returns true if plugin is supported
  125495. */
  125496. isSupported(): boolean;
  125497. /**
  125498. * Create a new Crowd so you can add agents
  125499. * @param maxAgents the maximum agent count in the crowd
  125500. * @param maxAgentRadius the maximum radius an agent can have
  125501. * @param scene to attach the crowd to
  125502. * @returns the crowd you can add agents to
  125503. */
  125504. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  125505. /**
  125506. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  125507. * The queries will try to find a solution within those bounds
  125508. * default is (1,1,1)
  125509. * @param extent x,y,z value that define the extent around the queries point of reference
  125510. */
  125511. setDefaultQueryExtent(extent: Vector3): void;
  125512. /**
  125513. * Get the Bounding box extent specified by setDefaultQueryExtent
  125514. * @returns the box extent values
  125515. */
  125516. getDefaultQueryExtent(): Vector3;
  125517. /**
  125518. * Release all resources
  125519. */
  125520. dispose(): void;
  125521. }
  125522. /**
  125523. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  125524. */
  125525. export interface ICrowd {
  125526. /**
  125527. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  125528. * You can attach anything to that node. The node position is updated in the scene update tick.
  125529. * @param pos world position that will be constrained by the navigation mesh
  125530. * @param parameters agent parameters
  125531. * @param transform hooked to the agent that will be update by the scene
  125532. * @returns agent index
  125533. */
  125534. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  125535. /**
  125536. * Returns the agent position in world space
  125537. * @param index agent index returned by addAgent
  125538. * @returns world space position
  125539. */
  125540. getAgentPosition(index: number): Vector3;
  125541. /**
  125542. * Gets the agent velocity in world space
  125543. * @param index agent index returned by addAgent
  125544. * @returns world space velocity
  125545. */
  125546. getAgentVelocity(index: number): Vector3;
  125547. /**
  125548. * remove a particular agent previously created
  125549. * @param index agent index returned by addAgent
  125550. */
  125551. removeAgent(index: number): void;
  125552. /**
  125553. * get the list of all agents attached to this crowd
  125554. * @returns list of agent indices
  125555. */
  125556. getAgents(): number[];
  125557. /**
  125558. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  125559. * @param deltaTime in seconds
  125560. */
  125561. update(deltaTime: number): void;
  125562. /**
  125563. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  125564. * @param index agent index returned by addAgent
  125565. * @param destination targeted world position
  125566. */
  125567. agentGoto(index: number, destination: Vector3): void;
  125568. /**
  125569. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  125570. * The queries will try to find a solution within those bounds
  125571. * default is (1,1,1)
  125572. * @param extent x,y,z value that define the extent around the queries point of reference
  125573. */
  125574. setDefaultQueryExtent(extent: Vector3): void;
  125575. /**
  125576. * Get the Bounding box extent specified by setDefaultQueryExtent
  125577. * @returns the box extent values
  125578. */
  125579. getDefaultQueryExtent(): Vector3;
  125580. /**
  125581. * Release all resources
  125582. */
  125583. dispose(): void;
  125584. }
  125585. /**
  125586. * Configures an agent
  125587. */
  125588. export interface IAgentParameters {
  125589. /**
  125590. * Agent radius. [Limit: >= 0]
  125591. */
  125592. radius: number;
  125593. /**
  125594. * Agent height. [Limit: > 0]
  125595. */
  125596. height: number;
  125597. /**
  125598. * Maximum allowed acceleration. [Limit: >= 0]
  125599. */
  125600. maxAcceleration: number;
  125601. /**
  125602. * Maximum allowed speed. [Limit: >= 0]
  125603. */
  125604. maxSpeed: number;
  125605. /**
  125606. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  125607. */
  125608. collisionQueryRange: number;
  125609. /**
  125610. * The path visibility optimization range. [Limit: > 0]
  125611. */
  125612. pathOptimizationRange: number;
  125613. /**
  125614. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  125615. */
  125616. separationWeight: number;
  125617. }
  125618. /**
  125619. * Configures the navigation mesh creation
  125620. */
  125621. export interface INavMeshParameters {
  125622. /**
  125623. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  125624. */
  125625. cs: number;
  125626. /**
  125627. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  125628. */
  125629. ch: number;
  125630. /**
  125631. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  125632. */
  125633. walkableSlopeAngle: number;
  125634. /**
  125635. * Minimum floor to 'ceiling' height that will still allow the floor area to
  125636. * be considered walkable. [Limit: >= 3] [Units: vx]
  125637. */
  125638. walkableHeight: number;
  125639. /**
  125640. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  125641. */
  125642. walkableClimb: number;
  125643. /**
  125644. * The distance to erode/shrink the walkable area of the heightfield away from
  125645. * obstructions. [Limit: >=0] [Units: vx]
  125646. */
  125647. walkableRadius: number;
  125648. /**
  125649. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  125650. */
  125651. maxEdgeLen: number;
  125652. /**
  125653. * The maximum distance a simplfied contour's border edges should deviate
  125654. * the original raw contour. [Limit: >=0] [Units: vx]
  125655. */
  125656. maxSimplificationError: number;
  125657. /**
  125658. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  125659. */
  125660. minRegionArea: number;
  125661. /**
  125662. * Any regions with a span count smaller than this value will, if possible,
  125663. * be merged with larger regions. [Limit: >=0] [Units: vx]
  125664. */
  125665. mergeRegionArea: number;
  125666. /**
  125667. * The maximum number of vertices allowed for polygons generated during the
  125668. * contour to polygon conversion process. [Limit: >= 3]
  125669. */
  125670. maxVertsPerPoly: number;
  125671. /**
  125672. * Sets the sampling distance to use when generating the detail mesh.
  125673. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  125674. */
  125675. detailSampleDist: number;
  125676. /**
  125677. * The maximum distance the detail mesh surface should deviate from heightfield
  125678. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  125679. */
  125680. detailSampleMaxError: number;
  125681. }
  125682. }
  125683. declare module BABYLON {
  125684. /**
  125685. * RecastJS navigation plugin
  125686. */
  125687. export class RecastJSPlugin implements INavigationEnginePlugin {
  125688. /**
  125689. * Reference to the Recast library
  125690. */
  125691. bjsRECAST: any;
  125692. /**
  125693. * plugin name
  125694. */
  125695. name: string;
  125696. /**
  125697. * the first navmesh created. We might extend this to support multiple navmeshes
  125698. */
  125699. navMesh: any;
  125700. /**
  125701. * Initializes the recastJS plugin
  125702. * @param recastInjection can be used to inject your own recast reference
  125703. */
  125704. constructor(recastInjection?: any);
  125705. /**
  125706. * Creates a navigation mesh
  125707. * @param meshes array of all the geometry used to compute the navigatio mesh
  125708. * @param parameters bunch of parameters used to filter geometry
  125709. */
  125710. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  125711. /**
  125712. * Create a navigation mesh debug mesh
  125713. * @param scene is where the mesh will be added
  125714. * @returns debug display mesh
  125715. */
  125716. createDebugNavMesh(scene: Scene): Mesh;
  125717. /**
  125718. * Get a navigation mesh constrained position, closest to the parameter position
  125719. * @param position world position
  125720. * @returns the closest point to position constrained by the navigation mesh
  125721. */
  125722. getClosestPoint(position: Vector3): Vector3;
  125723. /**
  125724. * Get a navigation mesh constrained position, within a particular radius
  125725. * @param position world position
  125726. * @param maxRadius the maximum distance to the constrained world position
  125727. * @returns the closest point to position constrained by the navigation mesh
  125728. */
  125729. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  125730. /**
  125731. * Compute the final position from a segment made of destination-position
  125732. * @param position world position
  125733. * @param destination world position
  125734. * @returns the resulting point along the navmesh
  125735. */
  125736. moveAlong(position: Vector3, destination: Vector3): Vector3;
  125737. /**
  125738. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  125739. * @param start world position
  125740. * @param end world position
  125741. * @returns array containing world position composing the path
  125742. */
  125743. computePath(start: Vector3, end: Vector3): Vector3[];
  125744. /**
  125745. * Create a new Crowd so you can add agents
  125746. * @param maxAgents the maximum agent count in the crowd
  125747. * @param maxAgentRadius the maximum radius an agent can have
  125748. * @param scene to attach the crowd to
  125749. * @returns the crowd you can add agents to
  125750. */
  125751. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  125752. /**
  125753. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  125754. * The queries will try to find a solution within those bounds
  125755. * default is (1,1,1)
  125756. * @param extent x,y,z value that define the extent around the queries point of reference
  125757. */
  125758. setDefaultQueryExtent(extent: Vector3): void;
  125759. /**
  125760. * Get the Bounding box extent specified by setDefaultQueryExtent
  125761. * @returns the box extent values
  125762. */
  125763. getDefaultQueryExtent(): Vector3;
  125764. /**
  125765. * Disposes
  125766. */
  125767. dispose(): void;
  125768. /**
  125769. * If this plugin is supported
  125770. * @returns true if plugin is supported
  125771. */
  125772. isSupported(): boolean;
  125773. }
  125774. /**
  125775. * Recast detour crowd implementation
  125776. */
  125777. export class RecastJSCrowd implements ICrowd {
  125778. /**
  125779. * Recast/detour plugin
  125780. */
  125781. bjsRECASTPlugin: RecastJSPlugin;
  125782. /**
  125783. * Link to the detour crowd
  125784. */
  125785. recastCrowd: any;
  125786. /**
  125787. * One transform per agent
  125788. */
  125789. transforms: TransformNode[];
  125790. /**
  125791. * All agents created
  125792. */
  125793. agents: number[];
  125794. /**
  125795. * Link to the scene is kept to unregister the crowd from the scene
  125796. */
  125797. private _scene;
  125798. /**
  125799. * Observer for crowd updates
  125800. */
  125801. private _onBeforeAnimationsObserver;
  125802. /**
  125803. * Constructor
  125804. * @param plugin recastJS plugin
  125805. * @param maxAgents the maximum agent count in the crowd
  125806. * @param maxAgentRadius the maximum radius an agent can have
  125807. * @param scene to attach the crowd to
  125808. * @returns the crowd you can add agents to
  125809. */
  125810. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  125811. /**
  125812. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  125813. * You can attach anything to that node. The node position is updated in the scene update tick.
  125814. * @param pos world position that will be constrained by the navigation mesh
  125815. * @param parameters agent parameters
  125816. * @param transform hooked to the agent that will be update by the scene
  125817. * @returns agent index
  125818. */
  125819. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  125820. /**
  125821. * Returns the agent position in world space
  125822. * @param index agent index returned by addAgent
  125823. * @returns world space position
  125824. */
  125825. getAgentPosition(index: number): Vector3;
  125826. /**
  125827. * Returns the agent velocity in world space
  125828. * @param index agent index returned by addAgent
  125829. * @returns world space velocity
  125830. */
  125831. getAgentVelocity(index: number): Vector3;
  125832. /**
  125833. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  125834. * @param index agent index returned by addAgent
  125835. * @param destination targeted world position
  125836. */
  125837. agentGoto(index: number, destination: Vector3): void;
  125838. /**
  125839. * remove a particular agent previously created
  125840. * @param index agent index returned by addAgent
  125841. */
  125842. removeAgent(index: number): void;
  125843. /**
  125844. * get the list of all agents attached to this crowd
  125845. * @returns list of agent indices
  125846. */
  125847. getAgents(): number[];
  125848. /**
  125849. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  125850. * @param deltaTime in seconds
  125851. */
  125852. update(deltaTime: number): void;
  125853. /**
  125854. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  125855. * The queries will try to find a solution within those bounds
  125856. * default is (1,1,1)
  125857. * @param extent x,y,z value that define the extent around the queries point of reference
  125858. */
  125859. setDefaultQueryExtent(extent: Vector3): void;
  125860. /**
  125861. * Get the Bounding box extent specified by setDefaultQueryExtent
  125862. * @returns the box extent values
  125863. */
  125864. getDefaultQueryExtent(): Vector3;
  125865. /**
  125866. * Release all resources
  125867. */
  125868. dispose(): void;
  125869. }
  125870. }
  125871. declare module BABYLON {
  125872. /**
  125873. * Class used to enable access to IndexedDB
  125874. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  125875. */
  125876. export class Database implements IOfflineProvider {
  125877. private _callbackManifestChecked;
  125878. private _currentSceneUrl;
  125879. private _db;
  125880. private _enableSceneOffline;
  125881. private _enableTexturesOffline;
  125882. private _manifestVersionFound;
  125883. private _mustUpdateRessources;
  125884. private _hasReachedQuota;
  125885. private _isSupported;
  125886. private _idbFactory;
  125887. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  125888. private static IsUASupportingBlobStorage;
  125889. /**
  125890. * Gets a boolean indicating if Database storate is enabled (off by default)
  125891. */
  125892. static IDBStorageEnabled: boolean;
  125893. /**
  125894. * Gets a boolean indicating if scene must be saved in the database
  125895. */
  125896. readonly enableSceneOffline: boolean;
  125897. /**
  125898. * Gets a boolean indicating if textures must be saved in the database
  125899. */
  125900. readonly enableTexturesOffline: boolean;
  125901. /**
  125902. * Creates a new Database
  125903. * @param urlToScene defines the url to load the scene
  125904. * @param callbackManifestChecked defines the callback to use when manifest is checked
  125905. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  125906. */
  125907. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  125908. private static _ParseURL;
  125909. private static _ReturnFullUrlLocation;
  125910. private _checkManifestFile;
  125911. /**
  125912. * Open the database and make it available
  125913. * @param successCallback defines the callback to call on success
  125914. * @param errorCallback defines the callback to call on error
  125915. */
  125916. open(successCallback: () => void, errorCallback: () => void): void;
  125917. /**
  125918. * Loads an image from the database
  125919. * @param url defines the url to load from
  125920. * @param image defines the target DOM image
  125921. */
  125922. loadImage(url: string, image: HTMLImageElement): void;
  125923. private _loadImageFromDBAsync;
  125924. private _saveImageIntoDBAsync;
  125925. private _checkVersionFromDB;
  125926. private _loadVersionFromDBAsync;
  125927. private _saveVersionIntoDBAsync;
  125928. /**
  125929. * Loads a file from database
  125930. * @param url defines the URL to load from
  125931. * @param sceneLoaded defines a callback to call on success
  125932. * @param progressCallBack defines a callback to call when progress changed
  125933. * @param errorCallback defines a callback to call on error
  125934. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  125935. */
  125936. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  125937. private _loadFileAsync;
  125938. private _saveFileAsync;
  125939. /**
  125940. * Validates if xhr data is correct
  125941. * @param xhr defines the request to validate
  125942. * @param dataType defines the expected data type
  125943. * @returns true if data is correct
  125944. */
  125945. private static _ValidateXHRData;
  125946. }
  125947. }
  125948. declare module BABYLON {
  125949. /** @hidden */
  125950. export var gpuUpdateParticlesPixelShader: {
  125951. name: string;
  125952. shader: string;
  125953. };
  125954. }
  125955. declare module BABYLON {
  125956. /** @hidden */
  125957. export var gpuUpdateParticlesVertexShader: {
  125958. name: string;
  125959. shader: string;
  125960. };
  125961. }
  125962. declare module BABYLON {
  125963. /** @hidden */
  125964. export var clipPlaneFragmentDeclaration2: {
  125965. name: string;
  125966. shader: string;
  125967. };
  125968. }
  125969. declare module BABYLON {
  125970. /** @hidden */
  125971. export var gpuRenderParticlesPixelShader: {
  125972. name: string;
  125973. shader: string;
  125974. };
  125975. }
  125976. declare module BABYLON {
  125977. /** @hidden */
  125978. export var clipPlaneVertexDeclaration2: {
  125979. name: string;
  125980. shader: string;
  125981. };
  125982. }
  125983. declare module BABYLON {
  125984. /** @hidden */
  125985. export var gpuRenderParticlesVertexShader: {
  125986. name: string;
  125987. shader: string;
  125988. };
  125989. }
  125990. declare module BABYLON {
  125991. /**
  125992. * This represents a GPU particle system in Babylon
  125993. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  125994. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  125995. */
  125996. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  125997. /**
  125998. * The layer mask we are rendering the particles through.
  125999. */
  126000. layerMask: number;
  126001. private _capacity;
  126002. private _activeCount;
  126003. private _currentActiveCount;
  126004. private _accumulatedCount;
  126005. private _renderEffect;
  126006. private _updateEffect;
  126007. private _buffer0;
  126008. private _buffer1;
  126009. private _spriteBuffer;
  126010. private _updateVAO;
  126011. private _renderVAO;
  126012. private _targetIndex;
  126013. private _sourceBuffer;
  126014. private _targetBuffer;
  126015. private _engine;
  126016. private _currentRenderId;
  126017. private _started;
  126018. private _stopped;
  126019. private _timeDelta;
  126020. private _randomTexture;
  126021. private _randomTexture2;
  126022. private _attributesStrideSize;
  126023. private _updateEffectOptions;
  126024. private _randomTextureSize;
  126025. private _actualFrame;
  126026. private readonly _rawTextureWidth;
  126027. /**
  126028. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  126029. */
  126030. static readonly IsSupported: boolean;
  126031. /**
  126032. * An event triggered when the system is disposed.
  126033. */
  126034. onDisposeObservable: Observable<GPUParticleSystem>;
  126035. /**
  126036. * Gets the maximum number of particles active at the same time.
  126037. * @returns The max number of active particles.
  126038. */
  126039. getCapacity(): number;
  126040. /**
  126041. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  126042. * to override the particles.
  126043. */
  126044. forceDepthWrite: boolean;
  126045. /**
  126046. * Gets or set the number of active particles
  126047. */
  126048. activeParticleCount: number;
  126049. private _preWarmDone;
  126050. /**
  126051. * Is this system ready to be used/rendered
  126052. * @return true if the system is ready
  126053. */
  126054. isReady(): boolean;
  126055. /**
  126056. * Gets if the system has been started. (Note: this will still be true after stop is called)
  126057. * @returns True if it has been started, otherwise false.
  126058. */
  126059. isStarted(): boolean;
  126060. /**
  126061. * Starts the particle system and begins to emit
  126062. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  126063. */
  126064. start(delay?: number): void;
  126065. /**
  126066. * Stops the particle system.
  126067. */
  126068. stop(): void;
  126069. /**
  126070. * Remove all active particles
  126071. */
  126072. reset(): void;
  126073. /**
  126074. * Returns the string "GPUParticleSystem"
  126075. * @returns a string containing the class name
  126076. */
  126077. getClassName(): string;
  126078. private _colorGradientsTexture;
  126079. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  126080. /**
  126081. * Adds a new color gradient
  126082. * @param gradient defines the gradient to use (between 0 and 1)
  126083. * @param color1 defines the color to affect to the specified gradient
  126084. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  126085. * @returns the current particle system
  126086. */
  126087. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  126088. /**
  126089. * Remove a specific color gradient
  126090. * @param gradient defines the gradient to remove
  126091. * @returns the current particle system
  126092. */
  126093. removeColorGradient(gradient: number): GPUParticleSystem;
  126094. private _angularSpeedGradientsTexture;
  126095. private _sizeGradientsTexture;
  126096. private _velocityGradientsTexture;
  126097. private _limitVelocityGradientsTexture;
  126098. private _dragGradientsTexture;
  126099. private _addFactorGradient;
  126100. /**
  126101. * Adds a new size gradient
  126102. * @param gradient defines the gradient to use (between 0 and 1)
  126103. * @param factor defines the size factor to affect to the specified gradient
  126104. * @returns the current particle system
  126105. */
  126106. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  126107. /**
  126108. * Remove a specific size gradient
  126109. * @param gradient defines the gradient to remove
  126110. * @returns the current particle system
  126111. */
  126112. removeSizeGradient(gradient: number): GPUParticleSystem;
  126113. /**
  126114. * Adds a new angular speed gradient
  126115. * @param gradient defines the gradient to use (between 0 and 1)
  126116. * @param factor defines the angular speed to affect to the specified gradient
  126117. * @returns the current particle system
  126118. */
  126119. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  126120. /**
  126121. * Remove a specific angular speed gradient
  126122. * @param gradient defines the gradient to remove
  126123. * @returns the current particle system
  126124. */
  126125. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  126126. /**
  126127. * Adds a new velocity gradient
  126128. * @param gradient defines the gradient to use (between 0 and 1)
  126129. * @param factor defines the velocity to affect to the specified gradient
  126130. * @returns the current particle system
  126131. */
  126132. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  126133. /**
  126134. * Remove a specific velocity gradient
  126135. * @param gradient defines the gradient to remove
  126136. * @returns the current particle system
  126137. */
  126138. removeVelocityGradient(gradient: number): GPUParticleSystem;
  126139. /**
  126140. * Adds a new limit velocity gradient
  126141. * @param gradient defines the gradient to use (between 0 and 1)
  126142. * @param factor defines the limit velocity value to affect to the specified gradient
  126143. * @returns the current particle system
  126144. */
  126145. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  126146. /**
  126147. * Remove a specific limit velocity gradient
  126148. * @param gradient defines the gradient to remove
  126149. * @returns the current particle system
  126150. */
  126151. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  126152. /**
  126153. * Adds a new drag gradient
  126154. * @param gradient defines the gradient to use (between 0 and 1)
  126155. * @param factor defines the drag value to affect to the specified gradient
  126156. * @returns the current particle system
  126157. */
  126158. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  126159. /**
  126160. * Remove a specific drag gradient
  126161. * @param gradient defines the gradient to remove
  126162. * @returns the current particle system
  126163. */
  126164. removeDragGradient(gradient: number): GPUParticleSystem;
  126165. /**
  126166. * Not supported by GPUParticleSystem
  126167. * @param gradient defines the gradient to use (between 0 and 1)
  126168. * @param factor defines the emit rate value to affect to the specified gradient
  126169. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  126170. * @returns the current particle system
  126171. */
  126172. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  126173. /**
  126174. * Not supported by GPUParticleSystem
  126175. * @param gradient defines the gradient to remove
  126176. * @returns the current particle system
  126177. */
  126178. removeEmitRateGradient(gradient: number): IParticleSystem;
  126179. /**
  126180. * Not supported by GPUParticleSystem
  126181. * @param gradient defines the gradient to use (between 0 and 1)
  126182. * @param factor defines the start size value to affect to the specified gradient
  126183. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  126184. * @returns the current particle system
  126185. */
  126186. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  126187. /**
  126188. * Not supported by GPUParticleSystem
  126189. * @param gradient defines the gradient to remove
  126190. * @returns the current particle system
  126191. */
  126192. removeStartSizeGradient(gradient: number): IParticleSystem;
  126193. /**
  126194. * Not supported by GPUParticleSystem
  126195. * @param gradient defines the gradient to use (between 0 and 1)
  126196. * @param min defines the color remap minimal range
  126197. * @param max defines the color remap maximal range
  126198. * @returns the current particle system
  126199. */
  126200. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  126201. /**
  126202. * Not supported by GPUParticleSystem
  126203. * @param gradient defines the gradient to remove
  126204. * @returns the current particle system
  126205. */
  126206. removeColorRemapGradient(): IParticleSystem;
  126207. /**
  126208. * Not supported by GPUParticleSystem
  126209. * @param gradient defines the gradient to use (between 0 and 1)
  126210. * @param min defines the alpha remap minimal range
  126211. * @param max defines the alpha remap maximal range
  126212. * @returns the current particle system
  126213. */
  126214. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  126215. /**
  126216. * Not supported by GPUParticleSystem
  126217. * @param gradient defines the gradient to remove
  126218. * @returns the current particle system
  126219. */
  126220. removeAlphaRemapGradient(): IParticleSystem;
  126221. /**
  126222. * Not supported by GPUParticleSystem
  126223. * @param gradient defines the gradient to use (between 0 and 1)
  126224. * @param color defines the color to affect to the specified gradient
  126225. * @returns the current particle system
  126226. */
  126227. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  126228. /**
  126229. * Not supported by GPUParticleSystem
  126230. * @param gradient defines the gradient to remove
  126231. * @returns the current particle system
  126232. */
  126233. removeRampGradient(): IParticleSystem;
  126234. /**
  126235. * Not supported by GPUParticleSystem
  126236. * @returns the list of ramp gradients
  126237. */
  126238. getRampGradients(): Nullable<Array<Color3Gradient>>;
  126239. /**
  126240. * Not supported by GPUParticleSystem
  126241. * Gets or sets a boolean indicating that ramp gradients must be used
  126242. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  126243. */
  126244. useRampGradients: boolean;
  126245. /**
  126246. * Not supported by GPUParticleSystem
  126247. * @param gradient defines the gradient to use (between 0 and 1)
  126248. * @param factor defines the life time factor to affect to the specified gradient
  126249. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  126250. * @returns the current particle system
  126251. */
  126252. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  126253. /**
  126254. * Not supported by GPUParticleSystem
  126255. * @param gradient defines the gradient to remove
  126256. * @returns the current particle system
  126257. */
  126258. removeLifeTimeGradient(gradient: number): IParticleSystem;
  126259. /**
  126260. * Instantiates a GPU particle system.
  126261. * 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.
  126262. * @param name The name of the particle system
  126263. * @param options The options used to create the system
  126264. * @param scene The scene the particle system belongs to
  126265. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  126266. */
  126267. constructor(name: string, options: Partial<{
  126268. capacity: number;
  126269. randomTextureSize: number;
  126270. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  126271. protected _reset(): void;
  126272. private _createUpdateVAO;
  126273. private _createRenderVAO;
  126274. private _initialize;
  126275. /** @hidden */
  126276. _recreateUpdateEffect(): void;
  126277. /** @hidden */
  126278. _recreateRenderEffect(): void;
  126279. /**
  126280. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  126281. * @param preWarm defines if we are in the pre-warmimg phase
  126282. */
  126283. animate(preWarm?: boolean): void;
  126284. private _createFactorGradientTexture;
  126285. private _createSizeGradientTexture;
  126286. private _createAngularSpeedGradientTexture;
  126287. private _createVelocityGradientTexture;
  126288. private _createLimitVelocityGradientTexture;
  126289. private _createDragGradientTexture;
  126290. private _createColorGradientTexture;
  126291. /**
  126292. * Renders the particle system in its current state
  126293. * @param preWarm defines if the system should only update the particles but not render them
  126294. * @returns the current number of particles
  126295. */
  126296. render(preWarm?: boolean): number;
  126297. /**
  126298. * Rebuilds the particle system
  126299. */
  126300. rebuild(): void;
  126301. private _releaseBuffers;
  126302. private _releaseVAOs;
  126303. /**
  126304. * Disposes the particle system and free the associated resources
  126305. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  126306. */
  126307. dispose(disposeTexture?: boolean): void;
  126308. /**
  126309. * Clones the particle system.
  126310. * @param name The name of the cloned object
  126311. * @param newEmitter The new emitter to use
  126312. * @returns the cloned particle system
  126313. */
  126314. clone(name: string, newEmitter: any): GPUParticleSystem;
  126315. /**
  126316. * Serializes the particle system to a JSON object.
  126317. * @returns the JSON object
  126318. */
  126319. serialize(): any;
  126320. /**
  126321. * Parses a JSON object to create a GPU particle system.
  126322. * @param parsedParticleSystem The JSON object to parse
  126323. * @param scene The scene to create the particle system in
  126324. * @param rootUrl The root url to use to load external dependencies like texture
  126325. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  126326. * @returns the parsed GPU particle system
  126327. */
  126328. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  126329. }
  126330. }
  126331. declare module BABYLON {
  126332. /**
  126333. * Represents a set of particle systems working together to create a specific effect
  126334. */
  126335. export class ParticleSystemSet implements IDisposable {
  126336. /**
  126337. * Gets or sets base Assets URL
  126338. */
  126339. static BaseAssetsUrl: string;
  126340. private _emitterCreationOptions;
  126341. private _emitterNode;
  126342. /**
  126343. * Gets the particle system list
  126344. */
  126345. systems: IParticleSystem[];
  126346. /**
  126347. * Gets the emitter node used with this set
  126348. */
  126349. readonly emitterNode: Nullable<TransformNode>;
  126350. /**
  126351. * Creates a new emitter mesh as a sphere
  126352. * @param options defines the options used to create the sphere
  126353. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  126354. * @param scene defines the hosting scene
  126355. */
  126356. setEmitterAsSphere(options: {
  126357. diameter: number;
  126358. segments: number;
  126359. color: Color3;
  126360. }, renderingGroupId: number, scene: Scene): void;
  126361. /**
  126362. * Starts all particle systems of the set
  126363. * @param emitter defines an optional mesh to use as emitter for the particle systems
  126364. */
  126365. start(emitter?: AbstractMesh): void;
  126366. /**
  126367. * Release all associated resources
  126368. */
  126369. dispose(): void;
  126370. /**
  126371. * Serialize the set into a JSON compatible object
  126372. * @returns a JSON compatible representation of the set
  126373. */
  126374. serialize(): any;
  126375. /**
  126376. * Parse a new ParticleSystemSet from a serialized source
  126377. * @param data defines a JSON compatible representation of the set
  126378. * @param scene defines the hosting scene
  126379. * @param gpu defines if we want GPU particles or CPU particles
  126380. * @returns a new ParticleSystemSet
  126381. */
  126382. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  126383. }
  126384. }
  126385. declare module BABYLON {
  126386. /**
  126387. * This class is made for on one-liner static method to help creating particle system set.
  126388. */
  126389. export class ParticleHelper {
  126390. /**
  126391. * Gets or sets base Assets URL
  126392. */
  126393. static BaseAssetsUrl: string;
  126394. /**
  126395. * Create a default particle system that you can tweak
  126396. * @param emitter defines the emitter to use
  126397. * @param capacity defines the system capacity (default is 500 particles)
  126398. * @param scene defines the hosting scene
  126399. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  126400. * @returns the new Particle system
  126401. */
  126402. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  126403. /**
  126404. * This is the main static method (one-liner) of this helper to create different particle systems
  126405. * @param type This string represents the type to the particle system to create
  126406. * @param scene The scene where the particle system should live
  126407. * @param gpu If the system will use gpu
  126408. * @returns the ParticleSystemSet created
  126409. */
  126410. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  126411. /**
  126412. * Static function used to export a particle system to a ParticleSystemSet variable.
  126413. * Please note that the emitter shape is not exported
  126414. * @param systems defines the particle systems to export
  126415. * @returns the created particle system set
  126416. */
  126417. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  126418. }
  126419. }
  126420. declare module BABYLON {
  126421. interface Engine {
  126422. /**
  126423. * Create an effect to use with particle systems.
  126424. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  126425. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  126426. * @param uniformsNames defines a list of attribute names
  126427. * @param samplers defines an array of string used to represent textures
  126428. * @param defines defines the string containing the defines to use to compile the shaders
  126429. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  126430. * @param onCompiled defines a function to call when the effect creation is successful
  126431. * @param onError defines a function to call when the effect creation has failed
  126432. * @returns the new Effect
  126433. */
  126434. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  126435. }
  126436. interface Mesh {
  126437. /**
  126438. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  126439. * @returns an array of IParticleSystem
  126440. */
  126441. getEmittedParticleSystems(): IParticleSystem[];
  126442. /**
  126443. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  126444. * @returns an array of IParticleSystem
  126445. */
  126446. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  126447. }
  126448. /**
  126449. * @hidden
  126450. */
  126451. export var _IDoNeedToBeInTheBuild: number;
  126452. }
  126453. declare module BABYLON {
  126454. /** Defines the 4 color options */
  126455. export enum PointColor {
  126456. /** color value */
  126457. Color = 2,
  126458. /** uv value */
  126459. UV = 1,
  126460. /** random value */
  126461. Random = 0,
  126462. /** stated value */
  126463. Stated = 3
  126464. }
  126465. /**
  126466. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  126467. * 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.
  126468. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  126469. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  126470. *
  126471. * Full documentation here : TO BE ENTERED
  126472. */
  126473. export class PointsCloudSystem implements IDisposable {
  126474. /**
  126475. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  126476. * Example : var p = SPS.particles[i];
  126477. */
  126478. particles: CloudPoint[];
  126479. /**
  126480. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  126481. */
  126482. nbParticles: number;
  126483. /**
  126484. * This a counter for your own usage. It's not set by any SPS functions.
  126485. */
  126486. counter: number;
  126487. /**
  126488. * The PCS name. This name is also given to the underlying mesh.
  126489. */
  126490. name: string;
  126491. /**
  126492. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  126493. */
  126494. mesh: Mesh;
  126495. /**
  126496. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  126497. * Please read :
  126498. */
  126499. vars: any;
  126500. /**
  126501. * @hidden
  126502. */
  126503. _size: number;
  126504. private _scene;
  126505. private _promises;
  126506. private _positions;
  126507. private _indices;
  126508. private _normals;
  126509. private _colors;
  126510. private _uvs;
  126511. private _indices32;
  126512. private _positions32;
  126513. private _colors32;
  126514. private _uvs32;
  126515. private _updatable;
  126516. private _isVisibilityBoxLocked;
  126517. private _alwaysVisible;
  126518. private _groups;
  126519. private _groupCounter;
  126520. private _computeParticleColor;
  126521. private _computeParticleTexture;
  126522. private _computeParticleRotation;
  126523. private _computeBoundingBox;
  126524. private _isReady;
  126525. /**
  126526. * Creates a PCS (Points Cloud System) object
  126527. * @param name (String) is the PCS name, this will be the underlying mesh name
  126528. * @param pointSize (number) is the size for each point
  126529. * @param scene (Scene) is the scene in which the PCS is added
  126530. * @param options defines the options of the PCS e.g.
  126531. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  126532. */
  126533. constructor(name: string, pointSize: number, scene: Scene, options?: {
  126534. updatable?: boolean;
  126535. });
  126536. /**
  126537. * Builds the PCS underlying mesh. Returns a standard Mesh.
  126538. * If no points were added to the PCS, the returned mesh is just a single point.
  126539. * @returns a promise for the created mesh
  126540. */
  126541. buildMeshAsync(): Promise<Mesh>;
  126542. /**
  126543. * @hidden
  126544. */
  126545. private _buildMesh;
  126546. private _addParticle;
  126547. private _randomUnitVector;
  126548. private _getColorIndicesForCoord;
  126549. private _setPointsColorOrUV;
  126550. private _colorFromTexture;
  126551. private _calculateDensity;
  126552. /**
  126553. * Adds points to the PCS in random positions within a unit sphere
  126554. * @param nb (positive integer) the number of particles to be created from this model
  126555. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  126556. * @returns the number of groups in the system
  126557. */
  126558. addPoints(nb: number, pointFunction?: any): number;
  126559. /**
  126560. * Adds points to the PCS from the surface of the model shape
  126561. * @param mesh is any Mesh object that will be used as a surface model for the points
  126562. * @param nb (positive integer) the number of particles to be created from this model
  126563. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  126564. * @param color (color3) to be used when colorWith is stated
  126565. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  126566. * @returns the number of groups in the system
  126567. */
  126568. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4, range?: number): number;
  126569. /**
  126570. * Adds points to the PCS inside the model shape
  126571. * @param mesh is any Mesh object that will be used as a surface model for the points
  126572. * @param nb (positive integer) the number of particles to be created from this model
  126573. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible),
  126574. * @param color (color4) to be used when colorWith is stated
  126575. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  126576. * @returns the number of groups in the system
  126577. */
  126578. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4, range?: number): number;
  126579. /**
  126580. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  126581. * This method calls `updateParticle()` for each particle of the SPS.
  126582. * For an animated SPS, it is usually called within the render loop.
  126583. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  126584. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  126585. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  126586. * @returns the PCS.
  126587. */
  126588. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  126589. /**
  126590. * Disposes the PCS.
  126591. */
  126592. dispose(): void;
  126593. /**
  126594. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  126595. * doc :
  126596. * @returns the PCS.
  126597. */
  126598. refreshVisibleSize(): PointsCloudSystem;
  126599. /**
  126600. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  126601. * @param size the size (float) of the visibility box
  126602. * note : this doesn't lock the PCS mesh bounding box.
  126603. * doc :
  126604. */
  126605. setVisibilityBox(size: number): void;
  126606. /**
  126607. * Gets whether the PCS is always visible or not
  126608. * doc :
  126609. */
  126610. /**
  126611. * Sets the PCS as always visible or not
  126612. * doc :
  126613. */
  126614. isAlwaysVisible: boolean;
  126615. /**
  126616. * Tells to `setParticles()` to compute the particle rotations or not
  126617. * Default value : false. The PCS is faster when it's set to false
  126618. * Note : particle rotations are only applied to parent particles
  126619. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  126620. */
  126621. computeParticleRotation: boolean;
  126622. /**
  126623. * Tells to `setParticles()` to compute the particle colors or not.
  126624. * Default value : true. The PCS is faster when it's set to false.
  126625. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  126626. */
  126627. /**
  126628. * Gets if `setParticles()` computes the particle colors or not.
  126629. * Default value : false. The PCS is faster when it's set to false.
  126630. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  126631. */
  126632. computeParticleColor: boolean;
  126633. /**
  126634. * Gets if `setParticles()` computes the particle textures or not.
  126635. * Default value : false. The PCS is faster when it's set to false.
  126636. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  126637. */
  126638. computeParticleTexture: boolean;
  126639. /**
  126640. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  126641. */
  126642. /**
  126643. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  126644. */
  126645. computeBoundingBox: boolean;
  126646. /**
  126647. * This function does nothing. It may be overwritten to set all the particle first values.
  126648. * The PCS doesn't call this function, you may have to call it by your own.
  126649. * doc :
  126650. */
  126651. initParticles(): void;
  126652. /**
  126653. * This function does nothing. It may be overwritten to recycle a particle
  126654. * The PCS doesn't call this function, you can to call it
  126655. * doc :
  126656. * @param particle The particle to recycle
  126657. * @returns the recycled particle
  126658. */
  126659. recycleParticle(particle: CloudPoint): CloudPoint;
  126660. /**
  126661. * Updates a particle : this function should be overwritten by the user.
  126662. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  126663. * doc :
  126664. * @example : just set a particle position or velocity and recycle conditions
  126665. * @param particle The particle to update
  126666. * @returns the updated particle
  126667. */
  126668. updateParticle(particle: CloudPoint): CloudPoint;
  126669. /**
  126670. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  126671. * This does nothing and may be overwritten by the user.
  126672. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  126673. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  126674. * @param update the boolean update value actually passed to setParticles()
  126675. */
  126676. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  126677. /**
  126678. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  126679. * This will be passed three parameters.
  126680. * This does nothing and may be overwritten by the user.
  126681. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  126682. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  126683. * @param update the boolean update value actually passed to setParticles()
  126684. */
  126685. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  126686. }
  126687. }
  126688. declare module BABYLON {
  126689. /**
  126690. * Represents one particle of a points cloud system.
  126691. */
  126692. export class CloudPoint {
  126693. /**
  126694. * particle global index
  126695. */
  126696. idx: number;
  126697. /**
  126698. * The color of the particle
  126699. */
  126700. color: Nullable<Color4>;
  126701. /**
  126702. * The world space position of the particle.
  126703. */
  126704. position: Vector3;
  126705. /**
  126706. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  126707. */
  126708. rotation: Vector3;
  126709. /**
  126710. * The world space rotation quaternion of the particle.
  126711. */
  126712. rotationQuaternion: Nullable<Quaternion>;
  126713. /**
  126714. * The uv of the particle.
  126715. */
  126716. uv: Nullable<Vector2>;
  126717. /**
  126718. * The current speed of the particle.
  126719. */
  126720. velocity: Vector3;
  126721. /**
  126722. * The pivot point in the particle local space.
  126723. */
  126724. pivot: Vector3;
  126725. /**
  126726. * Must the particle be translated from its pivot point in its local space ?
  126727. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  126728. * Default : false
  126729. */
  126730. translateFromPivot: boolean;
  126731. /**
  126732. * Index of this particle in the global "positions" array (Internal use)
  126733. * @hidden
  126734. */
  126735. _pos: number;
  126736. /**
  126737. * @hidden Index of this particle in the global "indices" array (Internal use)
  126738. */
  126739. _ind: number;
  126740. /**
  126741. * Group this particle belongs to
  126742. */
  126743. _group: PointsGroup;
  126744. /**
  126745. * Group id of this particle
  126746. */
  126747. groupId: number;
  126748. /**
  126749. * Index of the particle in its group id (Internal use)
  126750. */
  126751. idxInGroup: number;
  126752. /**
  126753. * @hidden Particle BoundingInfo object (Internal use)
  126754. */
  126755. _boundingInfo: BoundingInfo;
  126756. /**
  126757. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  126758. */
  126759. _pcs: PointsCloudSystem;
  126760. /**
  126761. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  126762. */
  126763. _stillInvisible: boolean;
  126764. /**
  126765. * @hidden Last computed particle rotation matrix
  126766. */
  126767. _rotationMatrix: number[];
  126768. /**
  126769. * Parent particle Id, if any.
  126770. * Default null.
  126771. */
  126772. parentId: Nullable<number>;
  126773. /**
  126774. * @hidden Internal global position in the PCS.
  126775. */
  126776. _globalPosition: Vector3;
  126777. /**
  126778. * Creates a Point Cloud object.
  126779. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  126780. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  126781. * @param group (PointsGroup) is the group the particle belongs to
  126782. * @param groupId (integer) is the group identifier in the PCS.
  126783. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  126784. * @param pcs defines the PCS it is associated to
  126785. */
  126786. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  126787. /**
  126788. * get point size
  126789. */
  126790. /**
  126791. * Set point size
  126792. */
  126793. size: Vector3;
  126794. /**
  126795. * Legacy support, changed quaternion to rotationQuaternion
  126796. */
  126797. /**
  126798. * Legacy support, changed quaternion to rotationQuaternion
  126799. */
  126800. quaternion: Nullable<Quaternion>;
  126801. /**
  126802. * Returns a boolean. True if the particle intersects a mesh, else false
  126803. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  126804. * @param target is the object (point or mesh) what the intersection is computed against
  126805. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  126806. * @returns true if it intersects
  126807. */
  126808. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  126809. /**
  126810. * get the rotation matrix of the particle
  126811. * @hidden
  126812. */
  126813. getRotationMatrix(m: Matrix): void;
  126814. }
  126815. /**
  126816. * Represents a group of points in a points cloud system
  126817. * * PCS internal tool, don't use it manually.
  126818. */
  126819. export class PointsGroup {
  126820. /**
  126821. * The group id
  126822. * @hidden
  126823. */
  126824. groupID: number;
  126825. /**
  126826. * image data for group (internal use)
  126827. * @hidden
  126828. */
  126829. _groupImageData: Nullable<ArrayBufferView>;
  126830. /**
  126831. * Image Width (internal use)
  126832. * @hidden
  126833. */
  126834. _groupImgWidth: number;
  126835. /**
  126836. * Image Height (internal use)
  126837. * @hidden
  126838. */
  126839. _groupImgHeight: number;
  126840. /**
  126841. * Custom position function (internal use)
  126842. * @hidden
  126843. */
  126844. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  126845. /**
  126846. * density per facet for surface points
  126847. * @hidden
  126848. */
  126849. _groupDensity: number[];
  126850. /**
  126851. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  126852. * PCS internal tool, don't use it manually.
  126853. * @hidden
  126854. */
  126855. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  126856. }
  126857. }
  126858. declare module BABYLON {
  126859. interface Scene {
  126860. /** @hidden (Backing field) */
  126861. _physicsEngine: Nullable<IPhysicsEngine>;
  126862. /**
  126863. * Gets the current physics engine
  126864. * @returns a IPhysicsEngine or null if none attached
  126865. */
  126866. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  126867. /**
  126868. * Enables physics to the current scene
  126869. * @param gravity defines the scene's gravity for the physics engine
  126870. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  126871. * @return a boolean indicating if the physics engine was initialized
  126872. */
  126873. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  126874. /**
  126875. * Disables and disposes the physics engine associated with the scene
  126876. */
  126877. disablePhysicsEngine(): void;
  126878. /**
  126879. * Gets a boolean indicating if there is an active physics engine
  126880. * @returns a boolean indicating if there is an active physics engine
  126881. */
  126882. isPhysicsEnabled(): boolean;
  126883. /**
  126884. * Deletes a physics compound impostor
  126885. * @param compound defines the compound to delete
  126886. */
  126887. deleteCompoundImpostor(compound: any): void;
  126888. /**
  126889. * An event triggered when physic simulation is about to be run
  126890. */
  126891. onBeforePhysicsObservable: Observable<Scene>;
  126892. /**
  126893. * An event triggered when physic simulation has been done
  126894. */
  126895. onAfterPhysicsObservable: Observable<Scene>;
  126896. }
  126897. interface AbstractMesh {
  126898. /** @hidden */
  126899. _physicsImpostor: Nullable<PhysicsImpostor>;
  126900. /**
  126901. * Gets or sets impostor used for physic simulation
  126902. * @see http://doc.babylonjs.com/features/physics_engine
  126903. */
  126904. physicsImpostor: Nullable<PhysicsImpostor>;
  126905. /**
  126906. * Gets the current physics impostor
  126907. * @see http://doc.babylonjs.com/features/physics_engine
  126908. * @returns a physics impostor or null
  126909. */
  126910. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  126911. /** Apply a physic impulse to the mesh
  126912. * @param force defines the force to apply
  126913. * @param contactPoint defines where to apply the force
  126914. * @returns the current mesh
  126915. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  126916. */
  126917. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  126918. /**
  126919. * Creates a physic joint between two meshes
  126920. * @param otherMesh defines the other mesh to use
  126921. * @param pivot1 defines the pivot to use on this mesh
  126922. * @param pivot2 defines the pivot to use on the other mesh
  126923. * @param options defines additional options (can be plugin dependent)
  126924. * @returns the current mesh
  126925. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  126926. */
  126927. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  126928. /** @hidden */
  126929. _disposePhysicsObserver: Nullable<Observer<Node>>;
  126930. }
  126931. /**
  126932. * Defines the physics engine scene component responsible to manage a physics engine
  126933. */
  126934. export class PhysicsEngineSceneComponent implements ISceneComponent {
  126935. /**
  126936. * The component name helpful to identify the component in the list of scene components.
  126937. */
  126938. readonly name: string;
  126939. /**
  126940. * The scene the component belongs to.
  126941. */
  126942. scene: Scene;
  126943. /**
  126944. * Creates a new instance of the component for the given scene
  126945. * @param scene Defines the scene to register the component in
  126946. */
  126947. constructor(scene: Scene);
  126948. /**
  126949. * Registers the component in a given scene
  126950. */
  126951. register(): void;
  126952. /**
  126953. * Rebuilds the elements related to this component in case of
  126954. * context lost for instance.
  126955. */
  126956. rebuild(): void;
  126957. /**
  126958. * Disposes the component and the associated ressources
  126959. */
  126960. dispose(): void;
  126961. }
  126962. }
  126963. declare module BABYLON {
  126964. /**
  126965. * A helper for physics simulations
  126966. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  126967. */
  126968. export class PhysicsHelper {
  126969. private _scene;
  126970. private _physicsEngine;
  126971. /**
  126972. * Initializes the Physics helper
  126973. * @param scene Babylon.js scene
  126974. */
  126975. constructor(scene: Scene);
  126976. /**
  126977. * Applies a radial explosion impulse
  126978. * @param origin the origin of the explosion
  126979. * @param radiusOrEventOptions the radius or the options of radial explosion
  126980. * @param strength the explosion strength
  126981. * @param falloff possible options: Constant & Linear. Defaults to Constant
  126982. * @returns A physics radial explosion event, or null
  126983. */
  126984. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  126985. /**
  126986. * Applies a radial explosion force
  126987. * @param origin the origin of the explosion
  126988. * @param radiusOrEventOptions the radius or the options of radial explosion
  126989. * @param strength the explosion strength
  126990. * @param falloff possible options: Constant & Linear. Defaults to Constant
  126991. * @returns A physics radial explosion event, or null
  126992. */
  126993. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  126994. /**
  126995. * Creates a gravitational field
  126996. * @param origin the origin of the explosion
  126997. * @param radiusOrEventOptions the radius or the options of radial explosion
  126998. * @param strength the explosion strength
  126999. * @param falloff possible options: Constant & Linear. Defaults to Constant
  127000. * @returns A physics gravitational field event, or null
  127001. */
  127002. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  127003. /**
  127004. * Creates a physics updraft event
  127005. * @param origin the origin of the updraft
  127006. * @param radiusOrEventOptions the radius or the options of the updraft
  127007. * @param strength the strength of the updraft
  127008. * @param height the height of the updraft
  127009. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  127010. * @returns A physics updraft event, or null
  127011. */
  127012. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  127013. /**
  127014. * Creates a physics vortex event
  127015. * @param origin the of the vortex
  127016. * @param radiusOrEventOptions the radius or the options of the vortex
  127017. * @param strength the strength of the vortex
  127018. * @param height the height of the vortex
  127019. * @returns a Physics vortex event, or null
  127020. * A physics vortex event or null
  127021. */
  127022. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  127023. }
  127024. /**
  127025. * Represents a physics radial explosion event
  127026. */
  127027. class PhysicsRadialExplosionEvent {
  127028. private _scene;
  127029. private _options;
  127030. private _sphere;
  127031. private _dataFetched;
  127032. /**
  127033. * Initializes a radial explosioin event
  127034. * @param _scene BabylonJS scene
  127035. * @param _options The options for the vortex event
  127036. */
  127037. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  127038. /**
  127039. * Returns the data related to the radial explosion event (sphere).
  127040. * @returns The radial explosion event data
  127041. */
  127042. getData(): PhysicsRadialExplosionEventData;
  127043. /**
  127044. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  127045. * @param impostor A physics imposter
  127046. * @param origin the origin of the explosion
  127047. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  127048. */
  127049. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  127050. /**
  127051. * Triggers affecterd impostors callbacks
  127052. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  127053. */
  127054. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  127055. /**
  127056. * Disposes the sphere.
  127057. * @param force Specifies if the sphere should be disposed by force
  127058. */
  127059. dispose(force?: boolean): void;
  127060. /*** Helpers ***/
  127061. private _prepareSphere;
  127062. private _intersectsWithSphere;
  127063. }
  127064. /**
  127065. * Represents a gravitational field event
  127066. */
  127067. class PhysicsGravitationalFieldEvent {
  127068. private _physicsHelper;
  127069. private _scene;
  127070. private _origin;
  127071. private _options;
  127072. private _tickCallback;
  127073. private _sphere;
  127074. private _dataFetched;
  127075. /**
  127076. * Initializes the physics gravitational field event
  127077. * @param _physicsHelper A physics helper
  127078. * @param _scene BabylonJS scene
  127079. * @param _origin The origin position of the gravitational field event
  127080. * @param _options The options for the vortex event
  127081. */
  127082. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  127083. /**
  127084. * Returns the data related to the gravitational field event (sphere).
  127085. * @returns A gravitational field event
  127086. */
  127087. getData(): PhysicsGravitationalFieldEventData;
  127088. /**
  127089. * Enables the gravitational field.
  127090. */
  127091. enable(): void;
  127092. /**
  127093. * Disables the gravitational field.
  127094. */
  127095. disable(): void;
  127096. /**
  127097. * Disposes the sphere.
  127098. * @param force The force to dispose from the gravitational field event
  127099. */
  127100. dispose(force?: boolean): void;
  127101. private _tick;
  127102. }
  127103. /**
  127104. * Represents a physics updraft event
  127105. */
  127106. class PhysicsUpdraftEvent {
  127107. private _scene;
  127108. private _origin;
  127109. private _options;
  127110. private _physicsEngine;
  127111. private _originTop;
  127112. private _originDirection;
  127113. private _tickCallback;
  127114. private _cylinder;
  127115. private _cylinderPosition;
  127116. private _dataFetched;
  127117. /**
  127118. * Initializes the physics updraft event
  127119. * @param _scene BabylonJS scene
  127120. * @param _origin The origin position of the updraft
  127121. * @param _options The options for the updraft event
  127122. */
  127123. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  127124. /**
  127125. * Returns the data related to the updraft event (cylinder).
  127126. * @returns A physics updraft event
  127127. */
  127128. getData(): PhysicsUpdraftEventData;
  127129. /**
  127130. * Enables the updraft.
  127131. */
  127132. enable(): void;
  127133. /**
  127134. * Disables the updraft.
  127135. */
  127136. disable(): void;
  127137. /**
  127138. * Disposes the cylinder.
  127139. * @param force Specifies if the updraft should be disposed by force
  127140. */
  127141. dispose(force?: boolean): void;
  127142. private getImpostorHitData;
  127143. private _tick;
  127144. /*** Helpers ***/
  127145. private _prepareCylinder;
  127146. private _intersectsWithCylinder;
  127147. }
  127148. /**
  127149. * Represents a physics vortex event
  127150. */
  127151. class PhysicsVortexEvent {
  127152. private _scene;
  127153. private _origin;
  127154. private _options;
  127155. private _physicsEngine;
  127156. private _originTop;
  127157. private _tickCallback;
  127158. private _cylinder;
  127159. private _cylinderPosition;
  127160. private _dataFetched;
  127161. /**
  127162. * Initializes the physics vortex event
  127163. * @param _scene The BabylonJS scene
  127164. * @param _origin The origin position of the vortex
  127165. * @param _options The options for the vortex event
  127166. */
  127167. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  127168. /**
  127169. * Returns the data related to the vortex event (cylinder).
  127170. * @returns The physics vortex event data
  127171. */
  127172. getData(): PhysicsVortexEventData;
  127173. /**
  127174. * Enables the vortex.
  127175. */
  127176. enable(): void;
  127177. /**
  127178. * Disables the cortex.
  127179. */
  127180. disable(): void;
  127181. /**
  127182. * Disposes the sphere.
  127183. * @param force
  127184. */
  127185. dispose(force?: boolean): void;
  127186. private getImpostorHitData;
  127187. private _tick;
  127188. /*** Helpers ***/
  127189. private _prepareCylinder;
  127190. private _intersectsWithCylinder;
  127191. }
  127192. /**
  127193. * Options fot the radial explosion event
  127194. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127195. */
  127196. export class PhysicsRadialExplosionEventOptions {
  127197. /**
  127198. * The radius of the sphere for the radial explosion.
  127199. */
  127200. radius: number;
  127201. /**
  127202. * The strenth of the explosion.
  127203. */
  127204. strength: number;
  127205. /**
  127206. * The strenght of the force in correspondence to the distance of the affected object
  127207. */
  127208. falloff: PhysicsRadialImpulseFalloff;
  127209. /**
  127210. * Sphere options for the radial explosion.
  127211. */
  127212. sphere: {
  127213. segments: number;
  127214. diameter: number;
  127215. };
  127216. /**
  127217. * Sphere options for the radial explosion.
  127218. */
  127219. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  127220. }
  127221. /**
  127222. * Options fot the updraft event
  127223. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127224. */
  127225. export class PhysicsUpdraftEventOptions {
  127226. /**
  127227. * The radius of the cylinder for the vortex
  127228. */
  127229. radius: number;
  127230. /**
  127231. * The strenth of the updraft.
  127232. */
  127233. strength: number;
  127234. /**
  127235. * The height of the cylinder for the updraft.
  127236. */
  127237. height: number;
  127238. /**
  127239. * The mode for the the updraft.
  127240. */
  127241. updraftMode: PhysicsUpdraftMode;
  127242. }
  127243. /**
  127244. * Options fot the vortex event
  127245. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127246. */
  127247. export class PhysicsVortexEventOptions {
  127248. /**
  127249. * The radius of the cylinder for the vortex
  127250. */
  127251. radius: number;
  127252. /**
  127253. * The strenth of the vortex.
  127254. */
  127255. strength: number;
  127256. /**
  127257. * The height of the cylinder for the vortex.
  127258. */
  127259. height: number;
  127260. /**
  127261. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  127262. */
  127263. centripetalForceThreshold: number;
  127264. /**
  127265. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  127266. */
  127267. centripetalForceMultiplier: number;
  127268. /**
  127269. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  127270. */
  127271. centrifugalForceMultiplier: number;
  127272. /**
  127273. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  127274. */
  127275. updraftForceMultiplier: number;
  127276. }
  127277. /**
  127278. * The strenght of the force in correspondence to the distance of the affected object
  127279. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127280. */
  127281. export enum PhysicsRadialImpulseFalloff {
  127282. /** Defines that impulse is constant in strength across it's whole radius */
  127283. Constant = 0,
  127284. /** Defines that impulse gets weaker if it's further from the origin */
  127285. Linear = 1
  127286. }
  127287. /**
  127288. * The strength of the force in correspondence to the distance of the affected object
  127289. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127290. */
  127291. export enum PhysicsUpdraftMode {
  127292. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  127293. Center = 0,
  127294. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  127295. Perpendicular = 1
  127296. }
  127297. /**
  127298. * Interface for a physics hit data
  127299. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127300. */
  127301. export interface PhysicsHitData {
  127302. /**
  127303. * The force applied at the contact point
  127304. */
  127305. force: Vector3;
  127306. /**
  127307. * The contact point
  127308. */
  127309. contactPoint: Vector3;
  127310. /**
  127311. * The distance from the origin to the contact point
  127312. */
  127313. distanceFromOrigin: number;
  127314. }
  127315. /**
  127316. * Interface for radial explosion event data
  127317. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127318. */
  127319. export interface PhysicsRadialExplosionEventData {
  127320. /**
  127321. * A sphere used for the radial explosion event
  127322. */
  127323. sphere: Mesh;
  127324. }
  127325. /**
  127326. * Interface for gravitational field event data
  127327. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127328. */
  127329. export interface PhysicsGravitationalFieldEventData {
  127330. /**
  127331. * A sphere mesh used for the gravitational field event
  127332. */
  127333. sphere: Mesh;
  127334. }
  127335. /**
  127336. * Interface for updraft event data
  127337. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127338. */
  127339. export interface PhysicsUpdraftEventData {
  127340. /**
  127341. * A cylinder used for the updraft event
  127342. */
  127343. cylinder: Mesh;
  127344. }
  127345. /**
  127346. * Interface for vortex event data
  127347. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127348. */
  127349. export interface PhysicsVortexEventData {
  127350. /**
  127351. * A cylinder used for the vortex event
  127352. */
  127353. cylinder: Mesh;
  127354. }
  127355. /**
  127356. * Interface for an affected physics impostor
  127357. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127358. */
  127359. export interface PhysicsAffectedImpostorWithData {
  127360. /**
  127361. * The impostor affected by the effect
  127362. */
  127363. impostor: PhysicsImpostor;
  127364. /**
  127365. * The data about the hit/horce from the explosion
  127366. */
  127367. hitData: PhysicsHitData;
  127368. }
  127369. }
  127370. declare module BABYLON {
  127371. /** @hidden */
  127372. export var blackAndWhitePixelShader: {
  127373. name: string;
  127374. shader: string;
  127375. };
  127376. }
  127377. declare module BABYLON {
  127378. /**
  127379. * Post process used to render in black and white
  127380. */
  127381. export class BlackAndWhitePostProcess extends PostProcess {
  127382. /**
  127383. * Linear about to convert he result to black and white (default: 1)
  127384. */
  127385. degree: number;
  127386. /**
  127387. * Creates a black and white post process
  127388. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  127389. * @param name The name of the effect.
  127390. * @param options The required width/height ratio to downsize to before computing the render pass.
  127391. * @param camera The camera to apply the render pass to.
  127392. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127393. * @param engine The engine which the post process will be applied. (default: current engine)
  127394. * @param reusable If the post process can be reused on the same frame. (default: false)
  127395. */
  127396. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  127397. }
  127398. }
  127399. declare module BABYLON {
  127400. /**
  127401. * This represents a set of one or more post processes in Babylon.
  127402. * A post process can be used to apply a shader to a texture after it is rendered.
  127403. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  127404. */
  127405. export class PostProcessRenderEffect {
  127406. private _postProcesses;
  127407. private _getPostProcesses;
  127408. private _singleInstance;
  127409. private _cameras;
  127410. private _indicesForCamera;
  127411. /**
  127412. * Name of the effect
  127413. * @hidden
  127414. */
  127415. _name: string;
  127416. /**
  127417. * Instantiates a post process render effect.
  127418. * A post process can be used to apply a shader to a texture after it is rendered.
  127419. * @param engine The engine the effect is tied to
  127420. * @param name The name of the effect
  127421. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  127422. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  127423. */
  127424. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  127425. /**
  127426. * Checks if all the post processes in the effect are supported.
  127427. */
  127428. readonly isSupported: boolean;
  127429. /**
  127430. * Updates the current state of the effect
  127431. * @hidden
  127432. */
  127433. _update(): void;
  127434. /**
  127435. * Attaches the effect on cameras
  127436. * @param cameras The camera to attach to.
  127437. * @hidden
  127438. */
  127439. _attachCameras(cameras: Camera): void;
  127440. /**
  127441. * Attaches the effect on cameras
  127442. * @param cameras The camera to attach to.
  127443. * @hidden
  127444. */
  127445. _attachCameras(cameras: Camera[]): void;
  127446. /**
  127447. * Detaches the effect on cameras
  127448. * @param cameras The camera to detatch from.
  127449. * @hidden
  127450. */
  127451. _detachCameras(cameras: Camera): void;
  127452. /**
  127453. * Detatches the effect on cameras
  127454. * @param cameras The camera to detatch from.
  127455. * @hidden
  127456. */
  127457. _detachCameras(cameras: Camera[]): void;
  127458. /**
  127459. * Enables the effect on given cameras
  127460. * @param cameras The camera to enable.
  127461. * @hidden
  127462. */
  127463. _enable(cameras: Camera): void;
  127464. /**
  127465. * Enables the effect on given cameras
  127466. * @param cameras The camera to enable.
  127467. * @hidden
  127468. */
  127469. _enable(cameras: Nullable<Camera[]>): void;
  127470. /**
  127471. * Disables the effect on the given cameras
  127472. * @param cameras The camera to disable.
  127473. * @hidden
  127474. */
  127475. _disable(cameras: Camera): void;
  127476. /**
  127477. * Disables the effect on the given cameras
  127478. * @param cameras The camera to disable.
  127479. * @hidden
  127480. */
  127481. _disable(cameras: Nullable<Camera[]>): void;
  127482. /**
  127483. * Gets a list of the post processes contained in the effect.
  127484. * @param camera The camera to get the post processes on.
  127485. * @returns The list of the post processes in the effect.
  127486. */
  127487. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  127488. }
  127489. }
  127490. declare module BABYLON {
  127491. /** @hidden */
  127492. export var extractHighlightsPixelShader: {
  127493. name: string;
  127494. shader: string;
  127495. };
  127496. }
  127497. declare module BABYLON {
  127498. /**
  127499. * 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.
  127500. */
  127501. export class ExtractHighlightsPostProcess extends PostProcess {
  127502. /**
  127503. * The luminance threshold, pixels below this value will be set to black.
  127504. */
  127505. threshold: number;
  127506. /** @hidden */
  127507. _exposure: number;
  127508. /**
  127509. * Post process which has the input texture to be used when performing highlight extraction
  127510. * @hidden
  127511. */
  127512. _inputPostProcess: Nullable<PostProcess>;
  127513. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  127514. }
  127515. }
  127516. declare module BABYLON {
  127517. /** @hidden */
  127518. export var bloomMergePixelShader: {
  127519. name: string;
  127520. shader: string;
  127521. };
  127522. }
  127523. declare module BABYLON {
  127524. /**
  127525. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  127526. */
  127527. export class BloomMergePostProcess extends PostProcess {
  127528. /** Weight of the bloom to be added to the original input. */
  127529. weight: number;
  127530. /**
  127531. * Creates a new instance of @see BloomMergePostProcess
  127532. * @param name The name of the effect.
  127533. * @param originalFromInput Post process which's input will be used for the merge.
  127534. * @param blurred Blurred highlights post process which's output will be used.
  127535. * @param weight Weight of the bloom to be added to the original input.
  127536. * @param options The required width/height ratio to downsize to before computing the render pass.
  127537. * @param camera The camera to apply the render pass to.
  127538. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127539. * @param engine The engine which the post process will be applied. (default: current engine)
  127540. * @param reusable If the post process can be reused on the same frame. (default: false)
  127541. * @param textureType Type of textures used when performing the post process. (default: 0)
  127542. * @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)
  127543. */
  127544. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  127545. /** Weight of the bloom to be added to the original input. */
  127546. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  127547. }
  127548. }
  127549. declare module BABYLON {
  127550. /**
  127551. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  127552. */
  127553. export class BloomEffect extends PostProcessRenderEffect {
  127554. private bloomScale;
  127555. /**
  127556. * @hidden Internal
  127557. */
  127558. _effects: Array<PostProcess>;
  127559. /**
  127560. * @hidden Internal
  127561. */
  127562. _downscale: ExtractHighlightsPostProcess;
  127563. private _blurX;
  127564. private _blurY;
  127565. private _merge;
  127566. /**
  127567. * The luminance threshold to find bright areas of the image to bloom.
  127568. */
  127569. threshold: number;
  127570. /**
  127571. * The strength of the bloom.
  127572. */
  127573. weight: number;
  127574. /**
  127575. * Specifies the size of the bloom blur kernel, relative to the final output size
  127576. */
  127577. kernel: number;
  127578. /**
  127579. * Creates a new instance of @see BloomEffect
  127580. * @param scene The scene the effect belongs to.
  127581. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  127582. * @param bloomKernel The size of the kernel to be used when applying the blur.
  127583. * @param bloomWeight The the strength of bloom.
  127584. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  127585. * @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)
  127586. */
  127587. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  127588. /**
  127589. * Disposes each of the internal effects for a given camera.
  127590. * @param camera The camera to dispose the effect on.
  127591. */
  127592. disposeEffects(camera: Camera): void;
  127593. /**
  127594. * @hidden Internal
  127595. */
  127596. _updateEffects(): void;
  127597. /**
  127598. * Internal
  127599. * @returns if all the contained post processes are ready.
  127600. * @hidden
  127601. */
  127602. _isReady(): boolean;
  127603. }
  127604. }
  127605. declare module BABYLON {
  127606. /** @hidden */
  127607. export var chromaticAberrationPixelShader: {
  127608. name: string;
  127609. shader: string;
  127610. };
  127611. }
  127612. declare module BABYLON {
  127613. /**
  127614. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  127615. */
  127616. export class ChromaticAberrationPostProcess extends PostProcess {
  127617. /**
  127618. * The amount of seperation of rgb channels (default: 30)
  127619. */
  127620. aberrationAmount: number;
  127621. /**
  127622. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  127623. */
  127624. radialIntensity: number;
  127625. /**
  127626. * 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))
  127627. */
  127628. direction: Vector2;
  127629. /**
  127630. * 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))
  127631. */
  127632. centerPosition: Vector2;
  127633. /**
  127634. * Creates a new instance ChromaticAberrationPostProcess
  127635. * @param name The name of the effect.
  127636. * @param screenWidth The width of the screen to apply the effect on.
  127637. * @param screenHeight The height of the screen to apply the effect on.
  127638. * @param options The required width/height ratio to downsize to before computing the render pass.
  127639. * @param camera The camera to apply the render pass to.
  127640. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127641. * @param engine The engine which the post process will be applied. (default: current engine)
  127642. * @param reusable If the post process can be reused on the same frame. (default: false)
  127643. * @param textureType Type of textures used when performing the post process. (default: 0)
  127644. * @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)
  127645. */
  127646. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  127647. }
  127648. }
  127649. declare module BABYLON {
  127650. /** @hidden */
  127651. export var circleOfConfusionPixelShader: {
  127652. name: string;
  127653. shader: string;
  127654. };
  127655. }
  127656. declare module BABYLON {
  127657. /**
  127658. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  127659. */
  127660. export class CircleOfConfusionPostProcess extends PostProcess {
  127661. /**
  127662. * 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.
  127663. */
  127664. lensSize: number;
  127665. /**
  127666. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  127667. */
  127668. fStop: number;
  127669. /**
  127670. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  127671. */
  127672. focusDistance: number;
  127673. /**
  127674. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  127675. */
  127676. focalLength: number;
  127677. private _depthTexture;
  127678. /**
  127679. * Creates a new instance CircleOfConfusionPostProcess
  127680. * @param name The name of the effect.
  127681. * @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.
  127682. * @param options The required width/height ratio to downsize to before computing the render pass.
  127683. * @param camera The camera to apply the render pass to.
  127684. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127685. * @param engine The engine which the post process will be applied. (default: current engine)
  127686. * @param reusable If the post process can be reused on the same frame. (default: false)
  127687. * @param textureType Type of textures used when performing the post process. (default: 0)
  127688. * @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)
  127689. */
  127690. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  127691. /**
  127692. * 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.
  127693. */
  127694. depthTexture: RenderTargetTexture;
  127695. }
  127696. }
  127697. declare module BABYLON {
  127698. /** @hidden */
  127699. export var colorCorrectionPixelShader: {
  127700. name: string;
  127701. shader: string;
  127702. };
  127703. }
  127704. declare module BABYLON {
  127705. /**
  127706. *
  127707. * This post-process allows the modification of rendered colors by using
  127708. * a 'look-up table' (LUT). This effect is also called Color Grading.
  127709. *
  127710. * The object needs to be provided an url to a texture containing the color
  127711. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  127712. * Use an image editing software to tweak the LUT to match your needs.
  127713. *
  127714. * For an example of a color LUT, see here:
  127715. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  127716. * For explanations on color grading, see here:
  127717. * @see http://udn.epicgames.com/Three/ColorGrading.html
  127718. *
  127719. */
  127720. export class ColorCorrectionPostProcess extends PostProcess {
  127721. private _colorTableTexture;
  127722. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  127723. }
  127724. }
  127725. declare module BABYLON {
  127726. /** @hidden */
  127727. export var convolutionPixelShader: {
  127728. name: string;
  127729. shader: string;
  127730. };
  127731. }
  127732. declare module BABYLON {
  127733. /**
  127734. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  127735. * input texture to perform effects such as edge detection or sharpening
  127736. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  127737. */
  127738. export class ConvolutionPostProcess extends PostProcess {
  127739. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  127740. kernel: number[];
  127741. /**
  127742. * Creates a new instance ConvolutionPostProcess
  127743. * @param name The name of the effect.
  127744. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  127745. * @param options The required width/height ratio to downsize to before computing the render pass.
  127746. * @param camera The camera to apply the render pass to.
  127747. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127748. * @param engine The engine which the post process will be applied. (default: current engine)
  127749. * @param reusable If the post process can be reused on the same frame. (default: false)
  127750. * @param textureType Type of textures used when performing the post process. (default: 0)
  127751. */
  127752. constructor(name: string,
  127753. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  127754. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  127755. /**
  127756. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127757. */
  127758. static EdgeDetect0Kernel: number[];
  127759. /**
  127760. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127761. */
  127762. static EdgeDetect1Kernel: number[];
  127763. /**
  127764. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127765. */
  127766. static EdgeDetect2Kernel: number[];
  127767. /**
  127768. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127769. */
  127770. static SharpenKernel: number[];
  127771. /**
  127772. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127773. */
  127774. static EmbossKernel: number[];
  127775. /**
  127776. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127777. */
  127778. static GaussianKernel: number[];
  127779. }
  127780. }
  127781. declare module BABYLON {
  127782. /**
  127783. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  127784. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  127785. * based on samples that have a large difference in distance than the center pixel.
  127786. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  127787. */
  127788. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  127789. direction: Vector2;
  127790. /**
  127791. * Creates a new instance CircleOfConfusionPostProcess
  127792. * @param name The name of the effect.
  127793. * @param scene The scene the effect belongs to.
  127794. * @param direction The direction the blur should be applied.
  127795. * @param kernel The size of the kernel used to blur.
  127796. * @param options The required width/height ratio to downsize to before computing the render pass.
  127797. * @param camera The camera to apply the render pass to.
  127798. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  127799. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  127800. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127801. * @param engine The engine which the post process will be applied. (default: current engine)
  127802. * @param reusable If the post process can be reused on the same frame. (default: false)
  127803. * @param textureType Type of textures used when performing the post process. (default: 0)
  127804. * @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)
  127805. */
  127806. 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);
  127807. }
  127808. }
  127809. declare module BABYLON {
  127810. /** @hidden */
  127811. export var depthOfFieldMergePixelShader: {
  127812. name: string;
  127813. shader: string;
  127814. };
  127815. }
  127816. declare module BABYLON {
  127817. /**
  127818. * Options to be set when merging outputs from the default pipeline.
  127819. */
  127820. export class DepthOfFieldMergePostProcessOptions {
  127821. /**
  127822. * The original image to merge on top of
  127823. */
  127824. originalFromInput: PostProcess;
  127825. /**
  127826. * Parameters to perform the merge of the depth of field effect
  127827. */
  127828. depthOfField?: {
  127829. circleOfConfusion: PostProcess;
  127830. blurSteps: Array<PostProcess>;
  127831. };
  127832. /**
  127833. * Parameters to perform the merge of bloom effect
  127834. */
  127835. bloom?: {
  127836. blurred: PostProcess;
  127837. weight: number;
  127838. };
  127839. }
  127840. /**
  127841. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  127842. */
  127843. export class DepthOfFieldMergePostProcess extends PostProcess {
  127844. private blurSteps;
  127845. /**
  127846. * Creates a new instance of DepthOfFieldMergePostProcess
  127847. * @param name The name of the effect.
  127848. * @param originalFromInput Post process which's input will be used for the merge.
  127849. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  127850. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  127851. * @param options The required width/height ratio to downsize to before computing the render pass.
  127852. * @param camera The camera to apply the render pass to.
  127853. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127854. * @param engine The engine which the post process will be applied. (default: current engine)
  127855. * @param reusable If the post process can be reused on the same frame. (default: false)
  127856. * @param textureType Type of textures used when performing the post process. (default: 0)
  127857. * @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)
  127858. */
  127859. 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);
  127860. /**
  127861. * Updates the effect with the current post process compile time values and recompiles the shader.
  127862. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  127863. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  127864. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  127865. * @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
  127866. * @param onCompiled Called when the shader has been compiled.
  127867. * @param onError Called if there is an error when compiling a shader.
  127868. */
  127869. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  127870. }
  127871. }
  127872. declare module BABYLON {
  127873. /**
  127874. * Specifies the level of max blur that should be applied when using the depth of field effect
  127875. */
  127876. export enum DepthOfFieldEffectBlurLevel {
  127877. /**
  127878. * Subtle blur
  127879. */
  127880. Low = 0,
  127881. /**
  127882. * Medium blur
  127883. */
  127884. Medium = 1,
  127885. /**
  127886. * Large blur
  127887. */
  127888. High = 2
  127889. }
  127890. /**
  127891. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  127892. */
  127893. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  127894. private _circleOfConfusion;
  127895. /**
  127896. * @hidden Internal, blurs from high to low
  127897. */
  127898. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  127899. private _depthOfFieldBlurY;
  127900. private _dofMerge;
  127901. /**
  127902. * @hidden Internal post processes in depth of field effect
  127903. */
  127904. _effects: Array<PostProcess>;
  127905. /**
  127906. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  127907. */
  127908. focalLength: number;
  127909. /**
  127910. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  127911. */
  127912. fStop: number;
  127913. /**
  127914. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  127915. */
  127916. focusDistance: number;
  127917. /**
  127918. * 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.
  127919. */
  127920. lensSize: number;
  127921. /**
  127922. * Creates a new instance DepthOfFieldEffect
  127923. * @param scene The scene the effect belongs to.
  127924. * @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.
  127925. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  127926. * @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)
  127927. */
  127928. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  127929. /**
  127930. * Get the current class name of the current effet
  127931. * @returns "DepthOfFieldEffect"
  127932. */
  127933. getClassName(): string;
  127934. /**
  127935. * 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.
  127936. */
  127937. depthTexture: RenderTargetTexture;
  127938. /**
  127939. * Disposes each of the internal effects for a given camera.
  127940. * @param camera The camera to dispose the effect on.
  127941. */
  127942. disposeEffects(camera: Camera): void;
  127943. /**
  127944. * @hidden Internal
  127945. */
  127946. _updateEffects(): void;
  127947. /**
  127948. * Internal
  127949. * @returns if all the contained post processes are ready.
  127950. * @hidden
  127951. */
  127952. _isReady(): boolean;
  127953. }
  127954. }
  127955. declare module BABYLON {
  127956. /** @hidden */
  127957. export var displayPassPixelShader: {
  127958. name: string;
  127959. shader: string;
  127960. };
  127961. }
  127962. declare module BABYLON {
  127963. /**
  127964. * DisplayPassPostProcess which produces an output the same as it's input
  127965. */
  127966. export class DisplayPassPostProcess extends PostProcess {
  127967. /**
  127968. * Creates the DisplayPassPostProcess
  127969. * @param name The name of the effect.
  127970. * @param options The required width/height ratio to downsize to before computing the render pass.
  127971. * @param camera The camera to apply the render pass to.
  127972. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127973. * @param engine The engine which the post process will be applied. (default: current engine)
  127974. * @param reusable If the post process can be reused on the same frame. (default: false)
  127975. */
  127976. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  127977. }
  127978. }
  127979. declare module BABYLON {
  127980. /** @hidden */
  127981. export var filterPixelShader: {
  127982. name: string;
  127983. shader: string;
  127984. };
  127985. }
  127986. declare module BABYLON {
  127987. /**
  127988. * Applies a kernel filter to the image
  127989. */
  127990. export class FilterPostProcess extends PostProcess {
  127991. /** The matrix to be applied to the image */
  127992. kernelMatrix: Matrix;
  127993. /**
  127994. *
  127995. * @param name The name of the effect.
  127996. * @param kernelMatrix The matrix to be applied to the image
  127997. * @param options The required width/height ratio to downsize to before computing the render pass.
  127998. * @param camera The camera to apply the render pass to.
  127999. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128000. * @param engine The engine which the post process will be applied. (default: current engine)
  128001. * @param reusable If the post process can be reused on the same frame. (default: false)
  128002. */
  128003. constructor(name: string,
  128004. /** The matrix to be applied to the image */
  128005. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  128006. }
  128007. }
  128008. declare module BABYLON {
  128009. /** @hidden */
  128010. export var fxaaPixelShader: {
  128011. name: string;
  128012. shader: string;
  128013. };
  128014. }
  128015. declare module BABYLON {
  128016. /** @hidden */
  128017. export var fxaaVertexShader: {
  128018. name: string;
  128019. shader: string;
  128020. };
  128021. }
  128022. declare module BABYLON {
  128023. /**
  128024. * Fxaa post process
  128025. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  128026. */
  128027. export class FxaaPostProcess extends PostProcess {
  128028. /** @hidden */
  128029. texelWidth: number;
  128030. /** @hidden */
  128031. texelHeight: number;
  128032. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  128033. private _getDefines;
  128034. }
  128035. }
  128036. declare module BABYLON {
  128037. /** @hidden */
  128038. export var grainPixelShader: {
  128039. name: string;
  128040. shader: string;
  128041. };
  128042. }
  128043. declare module BABYLON {
  128044. /**
  128045. * The GrainPostProcess adds noise to the image at mid luminance levels
  128046. */
  128047. export class GrainPostProcess extends PostProcess {
  128048. /**
  128049. * The intensity of the grain added (default: 30)
  128050. */
  128051. intensity: number;
  128052. /**
  128053. * If the grain should be randomized on every frame
  128054. */
  128055. animated: boolean;
  128056. /**
  128057. * Creates a new instance of @see GrainPostProcess
  128058. * @param name The name of the effect.
  128059. * @param options The required width/height ratio to downsize to before computing the render pass.
  128060. * @param camera The camera to apply the render pass to.
  128061. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128062. * @param engine The engine which the post process will be applied. (default: current engine)
  128063. * @param reusable If the post process can be reused on the same frame. (default: false)
  128064. * @param textureType Type of textures used when performing the post process. (default: 0)
  128065. * @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)
  128066. */
  128067. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128068. }
  128069. }
  128070. declare module BABYLON {
  128071. /** @hidden */
  128072. export var highlightsPixelShader: {
  128073. name: string;
  128074. shader: string;
  128075. };
  128076. }
  128077. declare module BABYLON {
  128078. /**
  128079. * Extracts highlights from the image
  128080. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  128081. */
  128082. export class HighlightsPostProcess extends PostProcess {
  128083. /**
  128084. * Extracts highlights from the image
  128085. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  128086. * @param name The name of the effect.
  128087. * @param options The required width/height ratio to downsize to before computing the render pass.
  128088. * @param camera The camera to apply the render pass to.
  128089. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128090. * @param engine The engine which the post process will be applied. (default: current engine)
  128091. * @param reusable If the post process can be reused on the same frame. (default: false)
  128092. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  128093. */
  128094. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  128095. }
  128096. }
  128097. declare module BABYLON {
  128098. /** @hidden */
  128099. export var mrtFragmentDeclaration: {
  128100. name: string;
  128101. shader: string;
  128102. };
  128103. }
  128104. declare module BABYLON {
  128105. /** @hidden */
  128106. export var geometryPixelShader: {
  128107. name: string;
  128108. shader: string;
  128109. };
  128110. }
  128111. declare module BABYLON {
  128112. /** @hidden */
  128113. export var geometryVertexShader: {
  128114. name: string;
  128115. shader: string;
  128116. };
  128117. }
  128118. declare module BABYLON {
  128119. /** @hidden */
  128120. interface ISavedTransformationMatrix {
  128121. world: Matrix;
  128122. viewProjection: Matrix;
  128123. }
  128124. /**
  128125. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  128126. */
  128127. export class GeometryBufferRenderer {
  128128. /**
  128129. * Constant used to retrieve the position texture index in the G-Buffer textures array
  128130. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  128131. */
  128132. static readonly POSITION_TEXTURE_TYPE: number;
  128133. /**
  128134. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  128135. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  128136. */
  128137. static readonly VELOCITY_TEXTURE_TYPE: number;
  128138. /**
  128139. * Dictionary used to store the previous transformation matrices of each rendered mesh
  128140. * in order to compute objects velocities when enableVelocity is set to "true"
  128141. * @hidden
  128142. */
  128143. _previousTransformationMatrices: {
  128144. [index: number]: ISavedTransformationMatrix;
  128145. };
  128146. /**
  128147. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  128148. * in order to compute objects velocities when enableVelocity is set to "true"
  128149. * @hidden
  128150. */
  128151. _previousBonesTransformationMatrices: {
  128152. [index: number]: Float32Array;
  128153. };
  128154. /**
  128155. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  128156. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  128157. */
  128158. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  128159. private _scene;
  128160. private _multiRenderTarget;
  128161. private _ratio;
  128162. private _enablePosition;
  128163. private _enableVelocity;
  128164. private _positionIndex;
  128165. private _velocityIndex;
  128166. protected _effect: Effect;
  128167. protected _cachedDefines: string;
  128168. /**
  128169. * Set the render list (meshes to be rendered) used in the G buffer.
  128170. */
  128171. renderList: Mesh[];
  128172. /**
  128173. * Gets wether or not G buffer are supported by the running hardware.
  128174. * This requires draw buffer supports
  128175. */
  128176. readonly isSupported: boolean;
  128177. /**
  128178. * Returns the index of the given texture type in the G-Buffer textures array
  128179. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  128180. * @returns the index of the given texture type in the G-Buffer textures array
  128181. */
  128182. getTextureIndex(textureType: number): number;
  128183. /**
  128184. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  128185. */
  128186. /**
  128187. * Sets whether or not objects positions are enabled for the G buffer.
  128188. */
  128189. enablePosition: boolean;
  128190. /**
  128191. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  128192. */
  128193. /**
  128194. * Sets wether or not objects velocities are enabled for the G buffer.
  128195. */
  128196. enableVelocity: boolean;
  128197. /**
  128198. * Gets the scene associated with the buffer.
  128199. */
  128200. readonly scene: Scene;
  128201. /**
  128202. * Gets the ratio used by the buffer during its creation.
  128203. * How big is the buffer related to the main canvas.
  128204. */
  128205. readonly ratio: number;
  128206. /** @hidden */
  128207. static _SceneComponentInitialization: (scene: Scene) => void;
  128208. /**
  128209. * Creates a new G Buffer for the scene
  128210. * @param scene The scene the buffer belongs to
  128211. * @param ratio How big is the buffer related to the main canvas.
  128212. */
  128213. constructor(scene: Scene, ratio?: number);
  128214. /**
  128215. * Checks wether everything is ready to render a submesh to the G buffer.
  128216. * @param subMesh the submesh to check readiness for
  128217. * @param useInstances is the mesh drawn using instance or not
  128218. * @returns true if ready otherwise false
  128219. */
  128220. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  128221. /**
  128222. * Gets the current underlying G Buffer.
  128223. * @returns the buffer
  128224. */
  128225. getGBuffer(): MultiRenderTarget;
  128226. /**
  128227. * Gets the number of samples used to render the buffer (anti aliasing).
  128228. */
  128229. /**
  128230. * Sets the number of samples used to render the buffer (anti aliasing).
  128231. */
  128232. samples: number;
  128233. /**
  128234. * Disposes the renderer and frees up associated resources.
  128235. */
  128236. dispose(): void;
  128237. protected _createRenderTargets(): void;
  128238. private _copyBonesTransformationMatrices;
  128239. }
  128240. }
  128241. declare module BABYLON {
  128242. interface Scene {
  128243. /** @hidden (Backing field) */
  128244. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  128245. /**
  128246. * Gets or Sets the current geometry buffer associated to the scene.
  128247. */
  128248. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  128249. /**
  128250. * Enables a GeometryBufferRender and associates it with the scene
  128251. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  128252. * @returns the GeometryBufferRenderer
  128253. */
  128254. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  128255. /**
  128256. * Disables the GeometryBufferRender associated with the scene
  128257. */
  128258. disableGeometryBufferRenderer(): void;
  128259. }
  128260. /**
  128261. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  128262. * in several rendering techniques.
  128263. */
  128264. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  128265. /**
  128266. * The component name helpful to identify the component in the list of scene components.
  128267. */
  128268. readonly name: string;
  128269. /**
  128270. * The scene the component belongs to.
  128271. */
  128272. scene: Scene;
  128273. /**
  128274. * Creates a new instance of the component for the given scene
  128275. * @param scene Defines the scene to register the component in
  128276. */
  128277. constructor(scene: Scene);
  128278. /**
  128279. * Registers the component in a given scene
  128280. */
  128281. register(): void;
  128282. /**
  128283. * Rebuilds the elements related to this component in case of
  128284. * context lost for instance.
  128285. */
  128286. rebuild(): void;
  128287. /**
  128288. * Disposes the component and the associated ressources
  128289. */
  128290. dispose(): void;
  128291. private _gatherRenderTargets;
  128292. }
  128293. }
  128294. declare module BABYLON {
  128295. /** @hidden */
  128296. export var motionBlurPixelShader: {
  128297. name: string;
  128298. shader: string;
  128299. };
  128300. }
  128301. declare module BABYLON {
  128302. /**
  128303. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  128304. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  128305. * As an example, all you have to do is to create the post-process:
  128306. * var mb = new BABYLON.MotionBlurPostProcess(
  128307. * 'mb', // The name of the effect.
  128308. * scene, // The scene containing the objects to blur according to their velocity.
  128309. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  128310. * camera // The camera to apply the render pass to.
  128311. * );
  128312. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  128313. */
  128314. export class MotionBlurPostProcess extends PostProcess {
  128315. /**
  128316. * Defines how much the image is blurred by the movement. Default value is equal to 1
  128317. */
  128318. motionStrength: number;
  128319. /**
  128320. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  128321. */
  128322. /**
  128323. * Sets the number of iterations to be used for motion blur quality
  128324. */
  128325. motionBlurSamples: number;
  128326. private _motionBlurSamples;
  128327. private _geometryBufferRenderer;
  128328. /**
  128329. * Creates a new instance MotionBlurPostProcess
  128330. * @param name The name of the effect.
  128331. * @param scene The scene containing the objects to blur according to their velocity.
  128332. * @param options The required width/height ratio to downsize to before computing the render pass.
  128333. * @param camera The camera to apply the render pass to.
  128334. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128335. * @param engine The engine which the post process will be applied. (default: current engine)
  128336. * @param reusable If the post process can be reused on the same frame. (default: false)
  128337. * @param textureType Type of textures used when performing the post process. (default: 0)
  128338. * @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)
  128339. */
  128340. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128341. /**
  128342. * Excludes the given skinned mesh from computing bones velocities.
  128343. * 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.
  128344. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  128345. */
  128346. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  128347. /**
  128348. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  128349. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  128350. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  128351. */
  128352. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  128353. /**
  128354. * Disposes the post process.
  128355. * @param camera The camera to dispose the post process on.
  128356. */
  128357. dispose(camera?: Camera): void;
  128358. }
  128359. }
  128360. declare module BABYLON {
  128361. /** @hidden */
  128362. export var refractionPixelShader: {
  128363. name: string;
  128364. shader: string;
  128365. };
  128366. }
  128367. declare module BABYLON {
  128368. /**
  128369. * Post process which applies a refractin texture
  128370. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  128371. */
  128372. export class RefractionPostProcess extends PostProcess {
  128373. /** the base color of the refraction (used to taint the rendering) */
  128374. color: Color3;
  128375. /** simulated refraction depth */
  128376. depth: number;
  128377. /** the coefficient of the base color (0 to remove base color tainting) */
  128378. colorLevel: number;
  128379. private _refTexture;
  128380. private _ownRefractionTexture;
  128381. /**
  128382. * Gets or sets the refraction texture
  128383. * Please note that you are responsible for disposing the texture if you set it manually
  128384. */
  128385. refractionTexture: Texture;
  128386. /**
  128387. * Initializes the RefractionPostProcess
  128388. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  128389. * @param name The name of the effect.
  128390. * @param refractionTextureUrl Url of the refraction texture to use
  128391. * @param color the base color of the refraction (used to taint the rendering)
  128392. * @param depth simulated refraction depth
  128393. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  128394. * @param camera The camera to apply the render pass to.
  128395. * @param options The required width/height ratio to downsize to before computing the render pass.
  128396. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128397. * @param engine The engine which the post process will be applied. (default: current engine)
  128398. * @param reusable If the post process can be reused on the same frame. (default: false)
  128399. */
  128400. constructor(name: string, refractionTextureUrl: string,
  128401. /** the base color of the refraction (used to taint the rendering) */
  128402. color: Color3,
  128403. /** simulated refraction depth */
  128404. depth: number,
  128405. /** the coefficient of the base color (0 to remove base color tainting) */
  128406. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  128407. /**
  128408. * Disposes of the post process
  128409. * @param camera Camera to dispose post process on
  128410. */
  128411. dispose(camera: Camera): void;
  128412. }
  128413. }
  128414. declare module BABYLON {
  128415. /** @hidden */
  128416. export var sharpenPixelShader: {
  128417. name: string;
  128418. shader: string;
  128419. };
  128420. }
  128421. declare module BABYLON {
  128422. /**
  128423. * The SharpenPostProcess applies a sharpen kernel to every pixel
  128424. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  128425. */
  128426. export class SharpenPostProcess extends PostProcess {
  128427. /**
  128428. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  128429. */
  128430. colorAmount: number;
  128431. /**
  128432. * How much sharpness should be applied (default: 0.3)
  128433. */
  128434. edgeAmount: number;
  128435. /**
  128436. * Creates a new instance ConvolutionPostProcess
  128437. * @param name The name of the effect.
  128438. * @param options The required width/height ratio to downsize to before computing the render pass.
  128439. * @param camera The camera to apply the render pass to.
  128440. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128441. * @param engine The engine which the post process will be applied. (default: current engine)
  128442. * @param reusable If the post process can be reused on the same frame. (default: false)
  128443. * @param textureType Type of textures used when performing the post process. (default: 0)
  128444. * @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)
  128445. */
  128446. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128447. }
  128448. }
  128449. declare module BABYLON {
  128450. /**
  128451. * PostProcessRenderPipeline
  128452. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  128453. */
  128454. export class PostProcessRenderPipeline {
  128455. private engine;
  128456. private _renderEffects;
  128457. private _renderEffectsForIsolatedPass;
  128458. /**
  128459. * List of inspectable custom properties (used by the Inspector)
  128460. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  128461. */
  128462. inspectableCustomProperties: IInspectable[];
  128463. /**
  128464. * @hidden
  128465. */
  128466. protected _cameras: Camera[];
  128467. /** @hidden */
  128468. _name: string;
  128469. /**
  128470. * Gets pipeline name
  128471. */
  128472. readonly name: string;
  128473. /** Gets the list of attached cameras */
  128474. readonly cameras: Camera[];
  128475. /**
  128476. * Initializes a PostProcessRenderPipeline
  128477. * @param engine engine to add the pipeline to
  128478. * @param name name of the pipeline
  128479. */
  128480. constructor(engine: Engine, name: string);
  128481. /**
  128482. * Gets the class name
  128483. * @returns "PostProcessRenderPipeline"
  128484. */
  128485. getClassName(): string;
  128486. /**
  128487. * If all the render effects in the pipeline are supported
  128488. */
  128489. readonly isSupported: boolean;
  128490. /**
  128491. * Adds an effect to the pipeline
  128492. * @param renderEffect the effect to add
  128493. */
  128494. addEffect(renderEffect: PostProcessRenderEffect): void;
  128495. /** @hidden */
  128496. _rebuild(): void;
  128497. /** @hidden */
  128498. _enableEffect(renderEffectName: string, cameras: Camera): void;
  128499. /** @hidden */
  128500. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  128501. /** @hidden */
  128502. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  128503. /** @hidden */
  128504. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  128505. /** @hidden */
  128506. _attachCameras(cameras: Camera, unique: boolean): void;
  128507. /** @hidden */
  128508. _attachCameras(cameras: Camera[], unique: boolean): void;
  128509. /** @hidden */
  128510. _detachCameras(cameras: Camera): void;
  128511. /** @hidden */
  128512. _detachCameras(cameras: Nullable<Camera[]>): void;
  128513. /** @hidden */
  128514. _update(): void;
  128515. /** @hidden */
  128516. _reset(): void;
  128517. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  128518. /**
  128519. * Disposes of the pipeline
  128520. */
  128521. dispose(): void;
  128522. }
  128523. }
  128524. declare module BABYLON {
  128525. /**
  128526. * PostProcessRenderPipelineManager class
  128527. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  128528. */
  128529. export class PostProcessRenderPipelineManager {
  128530. private _renderPipelines;
  128531. /**
  128532. * Initializes a PostProcessRenderPipelineManager
  128533. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  128534. */
  128535. constructor();
  128536. /**
  128537. * Gets the list of supported render pipelines
  128538. */
  128539. readonly supportedPipelines: PostProcessRenderPipeline[];
  128540. /**
  128541. * Adds a pipeline to the manager
  128542. * @param renderPipeline The pipeline to add
  128543. */
  128544. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  128545. /**
  128546. * Attaches a camera to the pipeline
  128547. * @param renderPipelineName The name of the pipeline to attach to
  128548. * @param cameras the camera to attach
  128549. * @param unique if the camera can be attached multiple times to the pipeline
  128550. */
  128551. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  128552. /**
  128553. * Detaches a camera from the pipeline
  128554. * @param renderPipelineName The name of the pipeline to detach from
  128555. * @param cameras the camera to detach
  128556. */
  128557. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  128558. /**
  128559. * Enables an effect by name on a pipeline
  128560. * @param renderPipelineName the name of the pipeline to enable the effect in
  128561. * @param renderEffectName the name of the effect to enable
  128562. * @param cameras the cameras that the effect should be enabled on
  128563. */
  128564. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  128565. /**
  128566. * Disables an effect by name on a pipeline
  128567. * @param renderPipelineName the name of the pipeline to disable the effect in
  128568. * @param renderEffectName the name of the effect to disable
  128569. * @param cameras the cameras that the effect should be disabled on
  128570. */
  128571. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  128572. /**
  128573. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  128574. */
  128575. update(): void;
  128576. /** @hidden */
  128577. _rebuild(): void;
  128578. /**
  128579. * Disposes of the manager and pipelines
  128580. */
  128581. dispose(): void;
  128582. }
  128583. }
  128584. declare module BABYLON {
  128585. interface Scene {
  128586. /** @hidden (Backing field) */
  128587. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  128588. /**
  128589. * Gets the postprocess render pipeline manager
  128590. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  128591. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  128592. */
  128593. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  128594. }
  128595. /**
  128596. * Defines the Render Pipeline scene component responsible to rendering pipelines
  128597. */
  128598. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  128599. /**
  128600. * The component name helpfull to identify the component in the list of scene components.
  128601. */
  128602. readonly name: string;
  128603. /**
  128604. * The scene the component belongs to.
  128605. */
  128606. scene: Scene;
  128607. /**
  128608. * Creates a new instance of the component for the given scene
  128609. * @param scene Defines the scene to register the component in
  128610. */
  128611. constructor(scene: Scene);
  128612. /**
  128613. * Registers the component in a given scene
  128614. */
  128615. register(): void;
  128616. /**
  128617. * Rebuilds the elements related to this component in case of
  128618. * context lost for instance.
  128619. */
  128620. rebuild(): void;
  128621. /**
  128622. * Disposes the component and the associated ressources
  128623. */
  128624. dispose(): void;
  128625. private _gatherRenderTargets;
  128626. }
  128627. }
  128628. declare module BABYLON {
  128629. /**
  128630. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  128631. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  128632. */
  128633. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  128634. private _scene;
  128635. private _camerasToBeAttached;
  128636. /**
  128637. * ID of the sharpen post process,
  128638. */
  128639. private readonly SharpenPostProcessId;
  128640. /**
  128641. * @ignore
  128642. * ID of the image processing post process;
  128643. */
  128644. readonly ImageProcessingPostProcessId: string;
  128645. /**
  128646. * @ignore
  128647. * ID of the Fast Approximate Anti-Aliasing post process;
  128648. */
  128649. readonly FxaaPostProcessId: string;
  128650. /**
  128651. * ID of the chromatic aberration post process,
  128652. */
  128653. private readonly ChromaticAberrationPostProcessId;
  128654. /**
  128655. * ID of the grain post process
  128656. */
  128657. private readonly GrainPostProcessId;
  128658. /**
  128659. * Sharpen post process which will apply a sharpen convolution to enhance edges
  128660. */
  128661. sharpen: SharpenPostProcess;
  128662. private _sharpenEffect;
  128663. private bloom;
  128664. /**
  128665. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  128666. */
  128667. depthOfField: DepthOfFieldEffect;
  128668. /**
  128669. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  128670. */
  128671. fxaa: FxaaPostProcess;
  128672. /**
  128673. * Image post processing pass used to perform operations such as tone mapping or color grading.
  128674. */
  128675. imageProcessing: ImageProcessingPostProcess;
  128676. /**
  128677. * Chromatic aberration post process which will shift rgb colors in the image
  128678. */
  128679. chromaticAberration: ChromaticAberrationPostProcess;
  128680. private _chromaticAberrationEffect;
  128681. /**
  128682. * Grain post process which add noise to the image
  128683. */
  128684. grain: GrainPostProcess;
  128685. private _grainEffect;
  128686. /**
  128687. * Glow post process which adds a glow to emissive areas of the image
  128688. */
  128689. private _glowLayer;
  128690. /**
  128691. * Animations which can be used to tweak settings over a period of time
  128692. */
  128693. animations: Animation[];
  128694. private _imageProcessingConfigurationObserver;
  128695. private _sharpenEnabled;
  128696. private _bloomEnabled;
  128697. private _depthOfFieldEnabled;
  128698. private _depthOfFieldBlurLevel;
  128699. private _fxaaEnabled;
  128700. private _imageProcessingEnabled;
  128701. private _defaultPipelineTextureType;
  128702. private _bloomScale;
  128703. private _chromaticAberrationEnabled;
  128704. private _grainEnabled;
  128705. private _buildAllowed;
  128706. /**
  128707. * Gets active scene
  128708. */
  128709. readonly scene: Scene;
  128710. /**
  128711. * Enable or disable the sharpen process from the pipeline
  128712. */
  128713. sharpenEnabled: boolean;
  128714. private _resizeObserver;
  128715. private _hardwareScaleLevel;
  128716. private _bloomKernel;
  128717. /**
  128718. * Specifies the size of the bloom blur kernel, relative to the final output size
  128719. */
  128720. bloomKernel: number;
  128721. /**
  128722. * Specifies the weight of the bloom in the final rendering
  128723. */
  128724. private _bloomWeight;
  128725. /**
  128726. * Specifies the luma threshold for the area that will be blurred by the bloom
  128727. */
  128728. private _bloomThreshold;
  128729. private _hdr;
  128730. /**
  128731. * The strength of the bloom.
  128732. */
  128733. bloomWeight: number;
  128734. /**
  128735. * The strength of the bloom.
  128736. */
  128737. bloomThreshold: number;
  128738. /**
  128739. * The scale of the bloom, lower value will provide better performance.
  128740. */
  128741. bloomScale: number;
  128742. /**
  128743. * Enable or disable the bloom from the pipeline
  128744. */
  128745. bloomEnabled: boolean;
  128746. private _rebuildBloom;
  128747. /**
  128748. * If the depth of field is enabled.
  128749. */
  128750. depthOfFieldEnabled: boolean;
  128751. /**
  128752. * Blur level of the depth of field effect. (Higher blur will effect performance)
  128753. */
  128754. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  128755. /**
  128756. * If the anti aliasing is enabled.
  128757. */
  128758. fxaaEnabled: boolean;
  128759. private _samples;
  128760. /**
  128761. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  128762. */
  128763. samples: number;
  128764. /**
  128765. * If image processing is enabled.
  128766. */
  128767. imageProcessingEnabled: boolean;
  128768. /**
  128769. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  128770. */
  128771. glowLayerEnabled: boolean;
  128772. /**
  128773. * Gets the glow layer (or null if not defined)
  128774. */
  128775. readonly glowLayer: Nullable<GlowLayer>;
  128776. /**
  128777. * Enable or disable the chromaticAberration process from the pipeline
  128778. */
  128779. chromaticAberrationEnabled: boolean;
  128780. /**
  128781. * Enable or disable the grain process from the pipeline
  128782. */
  128783. grainEnabled: boolean;
  128784. /**
  128785. * @constructor
  128786. * @param name - The rendering pipeline name (default: "")
  128787. * @param hdr - If high dynamic range textures should be used (default: true)
  128788. * @param scene - The scene linked to this pipeline (default: the last created scene)
  128789. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  128790. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  128791. */
  128792. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  128793. /**
  128794. * Get the class name
  128795. * @returns "DefaultRenderingPipeline"
  128796. */
  128797. getClassName(): string;
  128798. /**
  128799. * Force the compilation of the entire pipeline.
  128800. */
  128801. prepare(): void;
  128802. private _hasCleared;
  128803. private _prevPostProcess;
  128804. private _prevPrevPostProcess;
  128805. private _setAutoClearAndTextureSharing;
  128806. private _depthOfFieldSceneObserver;
  128807. private _buildPipeline;
  128808. private _disposePostProcesses;
  128809. /**
  128810. * Adds a camera to the pipeline
  128811. * @param camera the camera to be added
  128812. */
  128813. addCamera(camera: Camera): void;
  128814. /**
  128815. * Removes a camera from the pipeline
  128816. * @param camera the camera to remove
  128817. */
  128818. removeCamera(camera: Camera): void;
  128819. /**
  128820. * Dispose of the pipeline and stop all post processes
  128821. */
  128822. dispose(): void;
  128823. /**
  128824. * Serialize the rendering pipeline (Used when exporting)
  128825. * @returns the serialized object
  128826. */
  128827. serialize(): any;
  128828. /**
  128829. * Parse the serialized pipeline
  128830. * @param source Source pipeline.
  128831. * @param scene The scene to load the pipeline to.
  128832. * @param rootUrl The URL of the serialized pipeline.
  128833. * @returns An instantiated pipeline from the serialized object.
  128834. */
  128835. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  128836. }
  128837. }
  128838. declare module BABYLON {
  128839. /** @hidden */
  128840. export var lensHighlightsPixelShader: {
  128841. name: string;
  128842. shader: string;
  128843. };
  128844. }
  128845. declare module BABYLON {
  128846. /** @hidden */
  128847. export var depthOfFieldPixelShader: {
  128848. name: string;
  128849. shader: string;
  128850. };
  128851. }
  128852. declare module BABYLON {
  128853. /**
  128854. * BABYLON.JS Chromatic Aberration GLSL Shader
  128855. * Author: Olivier Guyot
  128856. * Separates very slightly R, G and B colors on the edges of the screen
  128857. * Inspired by Francois Tarlier & Martins Upitis
  128858. */
  128859. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  128860. /**
  128861. * @ignore
  128862. * The chromatic aberration PostProcess id in the pipeline
  128863. */
  128864. LensChromaticAberrationEffect: string;
  128865. /**
  128866. * @ignore
  128867. * The highlights enhancing PostProcess id in the pipeline
  128868. */
  128869. HighlightsEnhancingEffect: string;
  128870. /**
  128871. * @ignore
  128872. * The depth-of-field PostProcess id in the pipeline
  128873. */
  128874. LensDepthOfFieldEffect: string;
  128875. private _scene;
  128876. private _depthTexture;
  128877. private _grainTexture;
  128878. private _chromaticAberrationPostProcess;
  128879. private _highlightsPostProcess;
  128880. private _depthOfFieldPostProcess;
  128881. private _edgeBlur;
  128882. private _grainAmount;
  128883. private _chromaticAberration;
  128884. private _distortion;
  128885. private _highlightsGain;
  128886. private _highlightsThreshold;
  128887. private _dofDistance;
  128888. private _dofAperture;
  128889. private _dofDarken;
  128890. private _dofPentagon;
  128891. private _blurNoise;
  128892. /**
  128893. * @constructor
  128894. *
  128895. * Effect parameters are as follow:
  128896. * {
  128897. * chromatic_aberration: number; // from 0 to x (1 for realism)
  128898. * edge_blur: number; // from 0 to x (1 for realism)
  128899. * distortion: number; // from 0 to x (1 for realism)
  128900. * grain_amount: number; // from 0 to 1
  128901. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  128902. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  128903. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  128904. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  128905. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  128906. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  128907. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  128908. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  128909. * }
  128910. * Note: if an effect parameter is unset, effect is disabled
  128911. *
  128912. * @param name The rendering pipeline name
  128913. * @param parameters - An object containing all parameters (see above)
  128914. * @param scene The scene linked to this pipeline
  128915. * @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)
  128916. * @param cameras The array of cameras that the rendering pipeline will be attached to
  128917. */
  128918. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  128919. /**
  128920. * Get the class name
  128921. * @returns "LensRenderingPipeline"
  128922. */
  128923. getClassName(): string;
  128924. /**
  128925. * Gets associated scene
  128926. */
  128927. readonly scene: Scene;
  128928. /**
  128929. * Gets or sets the edge blur
  128930. */
  128931. edgeBlur: number;
  128932. /**
  128933. * Gets or sets the grain amount
  128934. */
  128935. grainAmount: number;
  128936. /**
  128937. * Gets or sets the chromatic aberration amount
  128938. */
  128939. chromaticAberration: number;
  128940. /**
  128941. * Gets or sets the depth of field aperture
  128942. */
  128943. dofAperture: number;
  128944. /**
  128945. * Gets or sets the edge distortion
  128946. */
  128947. edgeDistortion: number;
  128948. /**
  128949. * Gets or sets the depth of field distortion
  128950. */
  128951. dofDistortion: number;
  128952. /**
  128953. * Gets or sets the darken out of focus amount
  128954. */
  128955. darkenOutOfFocus: number;
  128956. /**
  128957. * Gets or sets a boolean indicating if blur noise is enabled
  128958. */
  128959. blurNoise: boolean;
  128960. /**
  128961. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  128962. */
  128963. pentagonBokeh: boolean;
  128964. /**
  128965. * Gets or sets the highlight grain amount
  128966. */
  128967. highlightsGain: number;
  128968. /**
  128969. * Gets or sets the highlight threshold
  128970. */
  128971. highlightsThreshold: number;
  128972. /**
  128973. * Sets the amount of blur at the edges
  128974. * @param amount blur amount
  128975. */
  128976. setEdgeBlur(amount: number): void;
  128977. /**
  128978. * Sets edge blur to 0
  128979. */
  128980. disableEdgeBlur(): void;
  128981. /**
  128982. * Sets the amout of grain
  128983. * @param amount Amount of grain
  128984. */
  128985. setGrainAmount(amount: number): void;
  128986. /**
  128987. * Set grain amount to 0
  128988. */
  128989. disableGrain(): void;
  128990. /**
  128991. * Sets the chromatic aberration amount
  128992. * @param amount amount of chromatic aberration
  128993. */
  128994. setChromaticAberration(amount: number): void;
  128995. /**
  128996. * Sets chromatic aberration amount to 0
  128997. */
  128998. disableChromaticAberration(): void;
  128999. /**
  129000. * Sets the EdgeDistortion amount
  129001. * @param amount amount of EdgeDistortion
  129002. */
  129003. setEdgeDistortion(amount: number): void;
  129004. /**
  129005. * Sets edge distortion to 0
  129006. */
  129007. disableEdgeDistortion(): void;
  129008. /**
  129009. * Sets the FocusDistance amount
  129010. * @param amount amount of FocusDistance
  129011. */
  129012. setFocusDistance(amount: number): void;
  129013. /**
  129014. * Disables depth of field
  129015. */
  129016. disableDepthOfField(): void;
  129017. /**
  129018. * Sets the Aperture amount
  129019. * @param amount amount of Aperture
  129020. */
  129021. setAperture(amount: number): void;
  129022. /**
  129023. * Sets the DarkenOutOfFocus amount
  129024. * @param amount amount of DarkenOutOfFocus
  129025. */
  129026. setDarkenOutOfFocus(amount: number): void;
  129027. private _pentagonBokehIsEnabled;
  129028. /**
  129029. * Creates a pentagon bokeh effect
  129030. */
  129031. enablePentagonBokeh(): void;
  129032. /**
  129033. * Disables the pentagon bokeh effect
  129034. */
  129035. disablePentagonBokeh(): void;
  129036. /**
  129037. * Enables noise blur
  129038. */
  129039. enableNoiseBlur(): void;
  129040. /**
  129041. * Disables noise blur
  129042. */
  129043. disableNoiseBlur(): void;
  129044. /**
  129045. * Sets the HighlightsGain amount
  129046. * @param amount amount of HighlightsGain
  129047. */
  129048. setHighlightsGain(amount: number): void;
  129049. /**
  129050. * Sets the HighlightsThreshold amount
  129051. * @param amount amount of HighlightsThreshold
  129052. */
  129053. setHighlightsThreshold(amount: number): void;
  129054. /**
  129055. * Disables highlights
  129056. */
  129057. disableHighlights(): void;
  129058. /**
  129059. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  129060. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  129061. */
  129062. dispose(disableDepthRender?: boolean): void;
  129063. private _createChromaticAberrationPostProcess;
  129064. private _createHighlightsPostProcess;
  129065. private _createDepthOfFieldPostProcess;
  129066. private _createGrainTexture;
  129067. }
  129068. }
  129069. declare module BABYLON {
  129070. /** @hidden */
  129071. export var ssao2PixelShader: {
  129072. name: string;
  129073. shader: string;
  129074. };
  129075. }
  129076. declare module BABYLON {
  129077. /** @hidden */
  129078. export var ssaoCombinePixelShader: {
  129079. name: string;
  129080. shader: string;
  129081. };
  129082. }
  129083. declare module BABYLON {
  129084. /**
  129085. * Render pipeline to produce ssao effect
  129086. */
  129087. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  129088. /**
  129089. * @ignore
  129090. * The PassPostProcess id in the pipeline that contains the original scene color
  129091. */
  129092. SSAOOriginalSceneColorEffect: string;
  129093. /**
  129094. * @ignore
  129095. * The SSAO PostProcess id in the pipeline
  129096. */
  129097. SSAORenderEffect: string;
  129098. /**
  129099. * @ignore
  129100. * The horizontal blur PostProcess id in the pipeline
  129101. */
  129102. SSAOBlurHRenderEffect: string;
  129103. /**
  129104. * @ignore
  129105. * The vertical blur PostProcess id in the pipeline
  129106. */
  129107. SSAOBlurVRenderEffect: string;
  129108. /**
  129109. * @ignore
  129110. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  129111. */
  129112. SSAOCombineRenderEffect: string;
  129113. /**
  129114. * The output strength of the SSAO post-process. Default value is 1.0.
  129115. */
  129116. totalStrength: number;
  129117. /**
  129118. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  129119. */
  129120. maxZ: number;
  129121. /**
  129122. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  129123. */
  129124. minZAspect: number;
  129125. private _samples;
  129126. /**
  129127. * Number of samples used for the SSAO calculations. Default value is 8
  129128. */
  129129. samples: number;
  129130. private _textureSamples;
  129131. /**
  129132. * Number of samples to use for antialiasing
  129133. */
  129134. textureSamples: number;
  129135. /**
  129136. * Ratio object used for SSAO ratio and blur ratio
  129137. */
  129138. private _ratio;
  129139. /**
  129140. * Dynamically generated sphere sampler.
  129141. */
  129142. private _sampleSphere;
  129143. /**
  129144. * Blur filter offsets
  129145. */
  129146. private _samplerOffsets;
  129147. private _expensiveBlur;
  129148. /**
  129149. * If bilateral blur should be used
  129150. */
  129151. expensiveBlur: boolean;
  129152. /**
  129153. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  129154. */
  129155. radius: number;
  129156. /**
  129157. * The base color of the SSAO post-process
  129158. * The final result is "base + ssao" between [0, 1]
  129159. */
  129160. base: number;
  129161. /**
  129162. * Support test.
  129163. */
  129164. static readonly IsSupported: boolean;
  129165. private _scene;
  129166. private _depthTexture;
  129167. private _normalTexture;
  129168. private _randomTexture;
  129169. private _originalColorPostProcess;
  129170. private _ssaoPostProcess;
  129171. private _blurHPostProcess;
  129172. private _blurVPostProcess;
  129173. private _ssaoCombinePostProcess;
  129174. private _firstUpdate;
  129175. /**
  129176. * Gets active scene
  129177. */
  129178. readonly scene: Scene;
  129179. /**
  129180. * @constructor
  129181. * @param name The rendering pipeline name
  129182. * @param scene The scene linked to this pipeline
  129183. * @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 }
  129184. * @param cameras The array of cameras that the rendering pipeline will be attached to
  129185. */
  129186. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  129187. /**
  129188. * Get the class name
  129189. * @returns "SSAO2RenderingPipeline"
  129190. */
  129191. getClassName(): string;
  129192. /**
  129193. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  129194. */
  129195. dispose(disableGeometryBufferRenderer?: boolean): void;
  129196. private _createBlurPostProcess;
  129197. /** @hidden */
  129198. _rebuild(): void;
  129199. private _bits;
  129200. private _radicalInverse_VdC;
  129201. private _hammersley;
  129202. private _hemisphereSample_uniform;
  129203. private _generateHemisphere;
  129204. private _createSSAOPostProcess;
  129205. private _createSSAOCombinePostProcess;
  129206. private _createRandomTexture;
  129207. /**
  129208. * Serialize the rendering pipeline (Used when exporting)
  129209. * @returns the serialized object
  129210. */
  129211. serialize(): any;
  129212. /**
  129213. * Parse the serialized pipeline
  129214. * @param source Source pipeline.
  129215. * @param scene The scene to load the pipeline to.
  129216. * @param rootUrl The URL of the serialized pipeline.
  129217. * @returns An instantiated pipeline from the serialized object.
  129218. */
  129219. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  129220. }
  129221. }
  129222. declare module BABYLON {
  129223. /** @hidden */
  129224. export var ssaoPixelShader: {
  129225. name: string;
  129226. shader: string;
  129227. };
  129228. }
  129229. declare module BABYLON {
  129230. /**
  129231. * Render pipeline to produce ssao effect
  129232. */
  129233. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  129234. /**
  129235. * @ignore
  129236. * The PassPostProcess id in the pipeline that contains the original scene color
  129237. */
  129238. SSAOOriginalSceneColorEffect: string;
  129239. /**
  129240. * @ignore
  129241. * The SSAO PostProcess id in the pipeline
  129242. */
  129243. SSAORenderEffect: string;
  129244. /**
  129245. * @ignore
  129246. * The horizontal blur PostProcess id in the pipeline
  129247. */
  129248. SSAOBlurHRenderEffect: string;
  129249. /**
  129250. * @ignore
  129251. * The vertical blur PostProcess id in the pipeline
  129252. */
  129253. SSAOBlurVRenderEffect: string;
  129254. /**
  129255. * @ignore
  129256. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  129257. */
  129258. SSAOCombineRenderEffect: string;
  129259. /**
  129260. * The output strength of the SSAO post-process. Default value is 1.0.
  129261. */
  129262. totalStrength: number;
  129263. /**
  129264. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  129265. */
  129266. radius: number;
  129267. /**
  129268. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  129269. * Must not be equal to fallOff and superior to fallOff.
  129270. * Default value is 0.0075
  129271. */
  129272. area: number;
  129273. /**
  129274. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  129275. * Must not be equal to area and inferior to area.
  129276. * Default value is 0.000001
  129277. */
  129278. fallOff: number;
  129279. /**
  129280. * The base color of the SSAO post-process
  129281. * The final result is "base + ssao" between [0, 1]
  129282. */
  129283. base: number;
  129284. private _scene;
  129285. private _depthTexture;
  129286. private _randomTexture;
  129287. private _originalColorPostProcess;
  129288. private _ssaoPostProcess;
  129289. private _blurHPostProcess;
  129290. private _blurVPostProcess;
  129291. private _ssaoCombinePostProcess;
  129292. private _firstUpdate;
  129293. /**
  129294. * Gets active scene
  129295. */
  129296. readonly scene: Scene;
  129297. /**
  129298. * @constructor
  129299. * @param name - The rendering pipeline name
  129300. * @param scene - The scene linked to this pipeline
  129301. * @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 }
  129302. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  129303. */
  129304. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  129305. /**
  129306. * Get the class name
  129307. * @returns "SSAORenderingPipeline"
  129308. */
  129309. getClassName(): string;
  129310. /**
  129311. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  129312. */
  129313. dispose(disableDepthRender?: boolean): void;
  129314. private _createBlurPostProcess;
  129315. /** @hidden */
  129316. _rebuild(): void;
  129317. private _createSSAOPostProcess;
  129318. private _createSSAOCombinePostProcess;
  129319. private _createRandomTexture;
  129320. }
  129321. }
  129322. declare module BABYLON {
  129323. /** @hidden */
  129324. export var standardPixelShader: {
  129325. name: string;
  129326. shader: string;
  129327. };
  129328. }
  129329. declare module BABYLON {
  129330. /**
  129331. * Standard rendering pipeline
  129332. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  129333. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  129334. */
  129335. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  129336. /**
  129337. * Public members
  129338. */
  129339. /**
  129340. * Post-process which contains the original scene color before the pipeline applies all the effects
  129341. */
  129342. originalPostProcess: Nullable<PostProcess>;
  129343. /**
  129344. * Post-process used to down scale an image x4
  129345. */
  129346. downSampleX4PostProcess: Nullable<PostProcess>;
  129347. /**
  129348. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  129349. */
  129350. brightPassPostProcess: Nullable<PostProcess>;
  129351. /**
  129352. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  129353. */
  129354. blurHPostProcesses: PostProcess[];
  129355. /**
  129356. * Post-process array storing all the vertical blur post-processes used by the pipeline
  129357. */
  129358. blurVPostProcesses: PostProcess[];
  129359. /**
  129360. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  129361. */
  129362. textureAdderPostProcess: Nullable<PostProcess>;
  129363. /**
  129364. * Post-process used to create volumetric lighting effect
  129365. */
  129366. volumetricLightPostProcess: Nullable<PostProcess>;
  129367. /**
  129368. * Post-process used to smooth the previous volumetric light post-process on the X axis
  129369. */
  129370. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  129371. /**
  129372. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  129373. */
  129374. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  129375. /**
  129376. * Post-process used to merge the volumetric light effect and the real scene color
  129377. */
  129378. volumetricLightMergePostProces: Nullable<PostProcess>;
  129379. /**
  129380. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  129381. */
  129382. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  129383. /**
  129384. * Base post-process used to calculate the average luminance of the final image for HDR
  129385. */
  129386. luminancePostProcess: Nullable<PostProcess>;
  129387. /**
  129388. * Post-processes used to create down sample post-processes in order to get
  129389. * the average luminance of the final image for HDR
  129390. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  129391. */
  129392. luminanceDownSamplePostProcesses: PostProcess[];
  129393. /**
  129394. * Post-process used to create a HDR effect (light adaptation)
  129395. */
  129396. hdrPostProcess: Nullable<PostProcess>;
  129397. /**
  129398. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  129399. */
  129400. textureAdderFinalPostProcess: Nullable<PostProcess>;
  129401. /**
  129402. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  129403. */
  129404. lensFlareFinalPostProcess: Nullable<PostProcess>;
  129405. /**
  129406. * Post-process used to merge the final HDR post-process and the real scene color
  129407. */
  129408. hdrFinalPostProcess: Nullable<PostProcess>;
  129409. /**
  129410. * Post-process used to create a lens flare effect
  129411. */
  129412. lensFlarePostProcess: Nullable<PostProcess>;
  129413. /**
  129414. * Post-process that merges the result of the lens flare post-process and the real scene color
  129415. */
  129416. lensFlareComposePostProcess: Nullable<PostProcess>;
  129417. /**
  129418. * Post-process used to create a motion blur effect
  129419. */
  129420. motionBlurPostProcess: Nullable<PostProcess>;
  129421. /**
  129422. * Post-process used to create a depth of field effect
  129423. */
  129424. depthOfFieldPostProcess: Nullable<PostProcess>;
  129425. /**
  129426. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  129427. */
  129428. fxaaPostProcess: Nullable<FxaaPostProcess>;
  129429. /**
  129430. * Represents the brightness threshold in order to configure the illuminated surfaces
  129431. */
  129432. brightThreshold: number;
  129433. /**
  129434. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  129435. */
  129436. blurWidth: number;
  129437. /**
  129438. * Sets if the blur for highlighted surfaces must be only horizontal
  129439. */
  129440. horizontalBlur: boolean;
  129441. /**
  129442. * Gets the overall exposure used by the pipeline
  129443. */
  129444. /**
  129445. * Sets the overall exposure used by the pipeline
  129446. */
  129447. exposure: number;
  129448. /**
  129449. * Texture used typically to simulate "dirty" on camera lens
  129450. */
  129451. lensTexture: Nullable<Texture>;
  129452. /**
  129453. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  129454. */
  129455. volumetricLightCoefficient: number;
  129456. /**
  129457. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  129458. */
  129459. volumetricLightPower: number;
  129460. /**
  129461. * Used the set the blur intensity to smooth the volumetric lights
  129462. */
  129463. volumetricLightBlurScale: number;
  129464. /**
  129465. * Light (spot or directional) used to generate the volumetric lights rays
  129466. * The source light must have a shadow generate so the pipeline can get its
  129467. * depth map
  129468. */
  129469. sourceLight: Nullable<SpotLight | DirectionalLight>;
  129470. /**
  129471. * For eye adaptation, represents the minimum luminance the eye can see
  129472. */
  129473. hdrMinimumLuminance: number;
  129474. /**
  129475. * For eye adaptation, represents the decrease luminance speed
  129476. */
  129477. hdrDecreaseRate: number;
  129478. /**
  129479. * For eye adaptation, represents the increase luminance speed
  129480. */
  129481. hdrIncreaseRate: number;
  129482. /**
  129483. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  129484. */
  129485. /**
  129486. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  129487. */
  129488. hdrAutoExposure: boolean;
  129489. /**
  129490. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  129491. */
  129492. lensColorTexture: Nullable<Texture>;
  129493. /**
  129494. * The overall strengh for the lens flare effect
  129495. */
  129496. lensFlareStrength: number;
  129497. /**
  129498. * Dispersion coefficient for lens flare ghosts
  129499. */
  129500. lensFlareGhostDispersal: number;
  129501. /**
  129502. * Main lens flare halo width
  129503. */
  129504. lensFlareHaloWidth: number;
  129505. /**
  129506. * Based on the lens distortion effect, defines how much the lens flare result
  129507. * is distorted
  129508. */
  129509. lensFlareDistortionStrength: number;
  129510. /**
  129511. * Configures the blur intensity used for for lens flare (halo)
  129512. */
  129513. lensFlareBlurWidth: number;
  129514. /**
  129515. * Lens star texture must be used to simulate rays on the flares and is available
  129516. * in the documentation
  129517. */
  129518. lensStarTexture: Nullable<Texture>;
  129519. /**
  129520. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  129521. * flare effect by taking account of the dirt texture
  129522. */
  129523. lensFlareDirtTexture: Nullable<Texture>;
  129524. /**
  129525. * Represents the focal length for the depth of field effect
  129526. */
  129527. depthOfFieldDistance: number;
  129528. /**
  129529. * Represents the blur intensity for the blurred part of the depth of field effect
  129530. */
  129531. depthOfFieldBlurWidth: number;
  129532. /**
  129533. * Gets how much the image is blurred by the movement while using the motion blur post-process
  129534. */
  129535. /**
  129536. * Sets how much the image is blurred by the movement while using the motion blur post-process
  129537. */
  129538. motionStrength: number;
  129539. /**
  129540. * Gets wether or not the motion blur post-process is object based or screen based.
  129541. */
  129542. /**
  129543. * Sets wether or not the motion blur post-process should be object based or screen based
  129544. */
  129545. objectBasedMotionBlur: boolean;
  129546. /**
  129547. * List of animations for the pipeline (IAnimatable implementation)
  129548. */
  129549. animations: Animation[];
  129550. /**
  129551. * Private members
  129552. */
  129553. private _scene;
  129554. private _currentDepthOfFieldSource;
  129555. private _basePostProcess;
  129556. private _fixedExposure;
  129557. private _currentExposure;
  129558. private _hdrAutoExposure;
  129559. private _hdrCurrentLuminance;
  129560. private _motionStrength;
  129561. private _isObjectBasedMotionBlur;
  129562. private _floatTextureType;
  129563. private _camerasToBeAttached;
  129564. private _ratio;
  129565. private _bloomEnabled;
  129566. private _depthOfFieldEnabled;
  129567. private _vlsEnabled;
  129568. private _lensFlareEnabled;
  129569. private _hdrEnabled;
  129570. private _motionBlurEnabled;
  129571. private _fxaaEnabled;
  129572. private _motionBlurSamples;
  129573. private _volumetricLightStepsCount;
  129574. private _samples;
  129575. /**
  129576. * @ignore
  129577. * Specifies if the bloom pipeline is enabled
  129578. */
  129579. BloomEnabled: boolean;
  129580. /**
  129581. * @ignore
  129582. * Specifies if the depth of field pipeline is enabed
  129583. */
  129584. DepthOfFieldEnabled: boolean;
  129585. /**
  129586. * @ignore
  129587. * Specifies if the lens flare pipeline is enabed
  129588. */
  129589. LensFlareEnabled: boolean;
  129590. /**
  129591. * @ignore
  129592. * Specifies if the HDR pipeline is enabled
  129593. */
  129594. HDREnabled: boolean;
  129595. /**
  129596. * @ignore
  129597. * Specifies if the volumetric lights scattering effect is enabled
  129598. */
  129599. VLSEnabled: boolean;
  129600. /**
  129601. * @ignore
  129602. * Specifies if the motion blur effect is enabled
  129603. */
  129604. MotionBlurEnabled: boolean;
  129605. /**
  129606. * Specifies if anti-aliasing is enabled
  129607. */
  129608. fxaaEnabled: boolean;
  129609. /**
  129610. * Specifies the number of steps used to calculate the volumetric lights
  129611. * Typically in interval [50, 200]
  129612. */
  129613. volumetricLightStepsCount: number;
  129614. /**
  129615. * Specifies the number of samples used for the motion blur effect
  129616. * Typically in interval [16, 64]
  129617. */
  129618. motionBlurSamples: number;
  129619. /**
  129620. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  129621. */
  129622. samples: number;
  129623. /**
  129624. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  129625. * @constructor
  129626. * @param name The rendering pipeline name
  129627. * @param scene The scene linked to this pipeline
  129628. * @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)
  129629. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  129630. * @param cameras The array of cameras that the rendering pipeline will be attached to
  129631. */
  129632. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  129633. private _buildPipeline;
  129634. private _createDownSampleX4PostProcess;
  129635. private _createBrightPassPostProcess;
  129636. private _createBlurPostProcesses;
  129637. private _createTextureAdderPostProcess;
  129638. private _createVolumetricLightPostProcess;
  129639. private _createLuminancePostProcesses;
  129640. private _createHdrPostProcess;
  129641. private _createLensFlarePostProcess;
  129642. private _createDepthOfFieldPostProcess;
  129643. private _createMotionBlurPostProcess;
  129644. private _getDepthTexture;
  129645. private _disposePostProcesses;
  129646. /**
  129647. * Dispose of the pipeline and stop all post processes
  129648. */
  129649. dispose(): void;
  129650. /**
  129651. * Serialize the rendering pipeline (Used when exporting)
  129652. * @returns the serialized object
  129653. */
  129654. serialize(): any;
  129655. /**
  129656. * Parse the serialized pipeline
  129657. * @param source Source pipeline.
  129658. * @param scene The scene to load the pipeline to.
  129659. * @param rootUrl The URL of the serialized pipeline.
  129660. * @returns An instantiated pipeline from the serialized object.
  129661. */
  129662. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  129663. /**
  129664. * Luminance steps
  129665. */
  129666. static LuminanceSteps: number;
  129667. }
  129668. }
  129669. declare module BABYLON {
  129670. /** @hidden */
  129671. export var tonemapPixelShader: {
  129672. name: string;
  129673. shader: string;
  129674. };
  129675. }
  129676. declare module BABYLON {
  129677. /** Defines operator used for tonemapping */
  129678. export enum TonemappingOperator {
  129679. /** Hable */
  129680. Hable = 0,
  129681. /** Reinhard */
  129682. Reinhard = 1,
  129683. /** HejiDawson */
  129684. HejiDawson = 2,
  129685. /** Photographic */
  129686. Photographic = 3
  129687. }
  129688. /**
  129689. * Defines a post process to apply tone mapping
  129690. */
  129691. export class TonemapPostProcess extends PostProcess {
  129692. private _operator;
  129693. /** Defines the required exposure adjustement */
  129694. exposureAdjustment: number;
  129695. /**
  129696. * Creates a new TonemapPostProcess
  129697. * @param name defines the name of the postprocess
  129698. * @param _operator defines the operator to use
  129699. * @param exposureAdjustment defines the required exposure adjustement
  129700. * @param camera defines the camera to use (can be null)
  129701. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  129702. * @param engine defines the hosting engine (can be ignore if camera is set)
  129703. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  129704. */
  129705. constructor(name: string, _operator: TonemappingOperator,
  129706. /** Defines the required exposure adjustement */
  129707. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  129708. }
  129709. }
  129710. declare module BABYLON {
  129711. /** @hidden */
  129712. export var depthVertexShader: {
  129713. name: string;
  129714. shader: string;
  129715. };
  129716. }
  129717. declare module BABYLON {
  129718. /** @hidden */
  129719. export var volumetricLightScatteringPixelShader: {
  129720. name: string;
  129721. shader: string;
  129722. };
  129723. }
  129724. declare module BABYLON {
  129725. /** @hidden */
  129726. export var volumetricLightScatteringPassVertexShader: {
  129727. name: string;
  129728. shader: string;
  129729. };
  129730. }
  129731. declare module BABYLON {
  129732. /** @hidden */
  129733. export var volumetricLightScatteringPassPixelShader: {
  129734. name: string;
  129735. shader: string;
  129736. };
  129737. }
  129738. declare module BABYLON {
  129739. /**
  129740. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  129741. */
  129742. export class VolumetricLightScatteringPostProcess extends PostProcess {
  129743. private _volumetricLightScatteringPass;
  129744. private _volumetricLightScatteringRTT;
  129745. private _viewPort;
  129746. private _screenCoordinates;
  129747. private _cachedDefines;
  129748. /**
  129749. * If not undefined, the mesh position is computed from the attached node position
  129750. */
  129751. attachedNode: {
  129752. position: Vector3;
  129753. };
  129754. /**
  129755. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  129756. */
  129757. customMeshPosition: Vector3;
  129758. /**
  129759. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  129760. */
  129761. useCustomMeshPosition: boolean;
  129762. /**
  129763. * If the post-process should inverse the light scattering direction
  129764. */
  129765. invert: boolean;
  129766. /**
  129767. * The internal mesh used by the post-process
  129768. */
  129769. mesh: Mesh;
  129770. /**
  129771. * @hidden
  129772. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  129773. */
  129774. useDiffuseColor: boolean;
  129775. /**
  129776. * Array containing the excluded meshes not rendered in the internal pass
  129777. */
  129778. excludedMeshes: AbstractMesh[];
  129779. /**
  129780. * Controls the overall intensity of the post-process
  129781. */
  129782. exposure: number;
  129783. /**
  129784. * Dissipates each sample's contribution in range [0, 1]
  129785. */
  129786. decay: number;
  129787. /**
  129788. * Controls the overall intensity of each sample
  129789. */
  129790. weight: number;
  129791. /**
  129792. * Controls the density of each sample
  129793. */
  129794. density: number;
  129795. /**
  129796. * @constructor
  129797. * @param name The post-process name
  129798. * @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)
  129799. * @param camera The camera that the post-process will be attached to
  129800. * @param mesh The mesh used to create the light scattering
  129801. * @param samples The post-process quality, default 100
  129802. * @param samplingModeThe post-process filtering mode
  129803. * @param engine The babylon engine
  129804. * @param reusable If the post-process is reusable
  129805. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  129806. */
  129807. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  129808. /**
  129809. * Returns the string "VolumetricLightScatteringPostProcess"
  129810. * @returns "VolumetricLightScatteringPostProcess"
  129811. */
  129812. getClassName(): string;
  129813. private _isReady;
  129814. /**
  129815. * Sets the new light position for light scattering effect
  129816. * @param position The new custom light position
  129817. */
  129818. setCustomMeshPosition(position: Vector3): void;
  129819. /**
  129820. * Returns the light position for light scattering effect
  129821. * @return Vector3 The custom light position
  129822. */
  129823. getCustomMeshPosition(): Vector3;
  129824. /**
  129825. * Disposes the internal assets and detaches the post-process from the camera
  129826. */
  129827. dispose(camera: Camera): void;
  129828. /**
  129829. * Returns the render target texture used by the post-process
  129830. * @return the render target texture used by the post-process
  129831. */
  129832. getPass(): RenderTargetTexture;
  129833. private _meshExcluded;
  129834. private _createPass;
  129835. private _updateMeshScreenCoordinates;
  129836. /**
  129837. * Creates a default mesh for the Volumeric Light Scattering post-process
  129838. * @param name The mesh name
  129839. * @param scene The scene where to create the mesh
  129840. * @return the default mesh
  129841. */
  129842. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  129843. }
  129844. }
  129845. declare module BABYLON {
  129846. interface Scene {
  129847. /** @hidden (Backing field) */
  129848. _boundingBoxRenderer: BoundingBoxRenderer;
  129849. /** @hidden (Backing field) */
  129850. _forceShowBoundingBoxes: boolean;
  129851. /**
  129852. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  129853. */
  129854. forceShowBoundingBoxes: boolean;
  129855. /**
  129856. * Gets the bounding box renderer associated with the scene
  129857. * @returns a BoundingBoxRenderer
  129858. */
  129859. getBoundingBoxRenderer(): BoundingBoxRenderer;
  129860. }
  129861. interface AbstractMesh {
  129862. /** @hidden (Backing field) */
  129863. _showBoundingBox: boolean;
  129864. /**
  129865. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  129866. */
  129867. showBoundingBox: boolean;
  129868. }
  129869. /**
  129870. * Component responsible of rendering the bounding box of the meshes in a scene.
  129871. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  129872. */
  129873. export class BoundingBoxRenderer implements ISceneComponent {
  129874. /**
  129875. * The component name helpfull to identify the component in the list of scene components.
  129876. */
  129877. readonly name: string;
  129878. /**
  129879. * The scene the component belongs to.
  129880. */
  129881. scene: Scene;
  129882. /**
  129883. * Color of the bounding box lines placed in front of an object
  129884. */
  129885. frontColor: Color3;
  129886. /**
  129887. * Color of the bounding box lines placed behind an object
  129888. */
  129889. backColor: Color3;
  129890. /**
  129891. * Defines if the renderer should show the back lines or not
  129892. */
  129893. showBackLines: boolean;
  129894. /**
  129895. * @hidden
  129896. */
  129897. renderList: SmartArray<BoundingBox>;
  129898. private _colorShader;
  129899. private _vertexBuffers;
  129900. private _indexBuffer;
  129901. private _fillIndexBuffer;
  129902. private _fillIndexData;
  129903. /**
  129904. * Instantiates a new bounding box renderer in a scene.
  129905. * @param scene the scene the renderer renders in
  129906. */
  129907. constructor(scene: Scene);
  129908. /**
  129909. * Registers the component in a given scene
  129910. */
  129911. register(): void;
  129912. private _evaluateSubMesh;
  129913. private _activeMesh;
  129914. private _prepareRessources;
  129915. private _createIndexBuffer;
  129916. /**
  129917. * Rebuilds the elements related to this component in case of
  129918. * context lost for instance.
  129919. */
  129920. rebuild(): void;
  129921. /**
  129922. * @hidden
  129923. */
  129924. reset(): void;
  129925. /**
  129926. * Render the bounding boxes of a specific rendering group
  129927. * @param renderingGroupId defines the rendering group to render
  129928. */
  129929. render(renderingGroupId: number): void;
  129930. /**
  129931. * In case of occlusion queries, we can render the occlusion bounding box through this method
  129932. * @param mesh Define the mesh to render the occlusion bounding box for
  129933. */
  129934. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  129935. /**
  129936. * Dispose and release the resources attached to this renderer.
  129937. */
  129938. dispose(): void;
  129939. }
  129940. }
  129941. declare module BABYLON {
  129942. /** @hidden */
  129943. export var depthPixelShader: {
  129944. name: string;
  129945. shader: string;
  129946. };
  129947. }
  129948. declare module BABYLON {
  129949. /**
  129950. * This represents a depth renderer in Babylon.
  129951. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  129952. */
  129953. export class DepthRenderer {
  129954. private _scene;
  129955. private _depthMap;
  129956. private _effect;
  129957. private readonly _storeNonLinearDepth;
  129958. private readonly _clearColor;
  129959. /** Get if the depth renderer is using packed depth or not */
  129960. readonly isPacked: boolean;
  129961. private _cachedDefines;
  129962. private _camera;
  129963. /**
  129964. * Specifiess that the depth renderer will only be used within
  129965. * the camera it is created for.
  129966. * This can help forcing its rendering during the camera processing.
  129967. */
  129968. useOnlyInActiveCamera: boolean;
  129969. /** @hidden */
  129970. static _SceneComponentInitialization: (scene: Scene) => void;
  129971. /**
  129972. * Instantiates a depth renderer
  129973. * @param scene The scene the renderer belongs to
  129974. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  129975. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  129976. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  129977. */
  129978. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  129979. /**
  129980. * Creates the depth rendering effect and checks if the effect is ready.
  129981. * @param subMesh The submesh to be used to render the depth map of
  129982. * @param useInstances If multiple world instances should be used
  129983. * @returns if the depth renderer is ready to render the depth map
  129984. */
  129985. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  129986. /**
  129987. * Gets the texture which the depth map will be written to.
  129988. * @returns The depth map texture
  129989. */
  129990. getDepthMap(): RenderTargetTexture;
  129991. /**
  129992. * Disposes of the depth renderer.
  129993. */
  129994. dispose(): void;
  129995. }
  129996. }
  129997. declare module BABYLON {
  129998. interface Scene {
  129999. /** @hidden (Backing field) */
  130000. _depthRenderer: {
  130001. [id: string]: DepthRenderer;
  130002. };
  130003. /**
  130004. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  130005. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  130006. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  130007. * @returns the created depth renderer
  130008. */
  130009. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  130010. /**
  130011. * Disables a depth renderer for a given camera
  130012. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  130013. */
  130014. disableDepthRenderer(camera?: Nullable<Camera>): void;
  130015. }
  130016. /**
  130017. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  130018. * in several rendering techniques.
  130019. */
  130020. export class DepthRendererSceneComponent implements ISceneComponent {
  130021. /**
  130022. * The component name helpfull to identify the component in the list of scene components.
  130023. */
  130024. readonly name: string;
  130025. /**
  130026. * The scene the component belongs to.
  130027. */
  130028. scene: Scene;
  130029. /**
  130030. * Creates a new instance of the component for the given scene
  130031. * @param scene Defines the scene to register the component in
  130032. */
  130033. constructor(scene: Scene);
  130034. /**
  130035. * Registers the component in a given scene
  130036. */
  130037. register(): void;
  130038. /**
  130039. * Rebuilds the elements related to this component in case of
  130040. * context lost for instance.
  130041. */
  130042. rebuild(): void;
  130043. /**
  130044. * Disposes the component and the associated ressources
  130045. */
  130046. dispose(): void;
  130047. private _gatherRenderTargets;
  130048. private _gatherActiveCameraRenderTargets;
  130049. }
  130050. }
  130051. declare module BABYLON {
  130052. /** @hidden */
  130053. export var outlinePixelShader: {
  130054. name: string;
  130055. shader: string;
  130056. };
  130057. }
  130058. declare module BABYLON {
  130059. /** @hidden */
  130060. export var outlineVertexShader: {
  130061. name: string;
  130062. shader: string;
  130063. };
  130064. }
  130065. declare module BABYLON {
  130066. interface Scene {
  130067. /** @hidden */
  130068. _outlineRenderer: OutlineRenderer;
  130069. /**
  130070. * Gets the outline renderer associated with the scene
  130071. * @returns a OutlineRenderer
  130072. */
  130073. getOutlineRenderer(): OutlineRenderer;
  130074. }
  130075. interface AbstractMesh {
  130076. /** @hidden (Backing field) */
  130077. _renderOutline: boolean;
  130078. /**
  130079. * Gets or sets a boolean indicating if the outline must be rendered as well
  130080. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  130081. */
  130082. renderOutline: boolean;
  130083. /** @hidden (Backing field) */
  130084. _renderOverlay: boolean;
  130085. /**
  130086. * Gets or sets a boolean indicating if the overlay must be rendered as well
  130087. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  130088. */
  130089. renderOverlay: boolean;
  130090. }
  130091. /**
  130092. * This class is responsible to draw bothe outline/overlay of meshes.
  130093. * It should not be used directly but through the available method on mesh.
  130094. */
  130095. export class OutlineRenderer implements ISceneComponent {
  130096. /**
  130097. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  130098. */
  130099. private static _StencilReference;
  130100. /**
  130101. * The name of the component. Each component must have a unique name.
  130102. */
  130103. name: string;
  130104. /**
  130105. * The scene the component belongs to.
  130106. */
  130107. scene: Scene;
  130108. /**
  130109. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  130110. */
  130111. zOffset: number;
  130112. private _engine;
  130113. private _effect;
  130114. private _cachedDefines;
  130115. private _savedDepthWrite;
  130116. /**
  130117. * Instantiates a new outline renderer. (There could be only one per scene).
  130118. * @param scene Defines the scene it belongs to
  130119. */
  130120. constructor(scene: Scene);
  130121. /**
  130122. * Register the component to one instance of a scene.
  130123. */
  130124. register(): void;
  130125. /**
  130126. * Rebuilds the elements related to this component in case of
  130127. * context lost for instance.
  130128. */
  130129. rebuild(): void;
  130130. /**
  130131. * Disposes the component and the associated ressources.
  130132. */
  130133. dispose(): void;
  130134. /**
  130135. * Renders the outline in the canvas.
  130136. * @param subMesh Defines the sumesh to render
  130137. * @param batch Defines the batch of meshes in case of instances
  130138. * @param useOverlay Defines if the rendering is for the overlay or the outline
  130139. */
  130140. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  130141. /**
  130142. * Returns whether or not the outline renderer is ready for a given submesh.
  130143. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  130144. * @param subMesh Defines the submesh to check readyness for
  130145. * @param useInstances Defines wheter wee are trying to render instances or not
  130146. * @returns true if ready otherwise false
  130147. */
  130148. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  130149. private _beforeRenderingMesh;
  130150. private _afterRenderingMesh;
  130151. }
  130152. }
  130153. declare module BABYLON {
  130154. /**
  130155. * Class used to manage multiple sprites of different sizes on the same spritesheet
  130156. * @see http://doc.babylonjs.com/babylon101/sprites
  130157. */
  130158. export class SpritePackedManager extends SpriteManager {
  130159. /** defines the packed manager's name */
  130160. name: string;
  130161. /**
  130162. * Creates a new sprite manager from a packed sprite sheet
  130163. * @param name defines the manager's name
  130164. * @param imgUrl defines the sprite sheet url
  130165. * @param capacity defines the maximum allowed number of sprites
  130166. * @param scene defines the hosting scene
  130167. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  130168. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  130169. * @param samplingMode defines the smapling mode to use with spritesheet
  130170. * @param fromPacked set to true; do not alter
  130171. */
  130172. constructor(
  130173. /** defines the packed manager's name */
  130174. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  130175. }
  130176. }
  130177. declare module BABYLON {
  130178. /**
  130179. * Defines the list of states available for a task inside a AssetsManager
  130180. */
  130181. export enum AssetTaskState {
  130182. /**
  130183. * Initialization
  130184. */
  130185. INIT = 0,
  130186. /**
  130187. * Running
  130188. */
  130189. RUNNING = 1,
  130190. /**
  130191. * Done
  130192. */
  130193. DONE = 2,
  130194. /**
  130195. * Error
  130196. */
  130197. ERROR = 3
  130198. }
  130199. /**
  130200. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  130201. */
  130202. export abstract class AbstractAssetTask {
  130203. /**
  130204. * Task name
  130205. */ name: string;
  130206. /**
  130207. * Callback called when the task is successful
  130208. */
  130209. onSuccess: (task: any) => void;
  130210. /**
  130211. * Callback called when the task is not successful
  130212. */
  130213. onError: (task: any, message?: string, exception?: any) => void;
  130214. /**
  130215. * Creates a new AssetsManager
  130216. * @param name defines the name of the task
  130217. */
  130218. constructor(
  130219. /**
  130220. * Task name
  130221. */ name: string);
  130222. private _isCompleted;
  130223. private _taskState;
  130224. private _errorObject;
  130225. /**
  130226. * Get if the task is completed
  130227. */
  130228. readonly isCompleted: boolean;
  130229. /**
  130230. * Gets the current state of the task
  130231. */
  130232. readonly taskState: AssetTaskState;
  130233. /**
  130234. * Gets the current error object (if task is in error)
  130235. */
  130236. readonly errorObject: {
  130237. message?: string;
  130238. exception?: any;
  130239. };
  130240. /**
  130241. * Internal only
  130242. * @hidden
  130243. */
  130244. _setErrorObject(message?: string, exception?: any): void;
  130245. /**
  130246. * Execute the current task
  130247. * @param scene defines the scene where you want your assets to be loaded
  130248. * @param onSuccess is a callback called when the task is successfully executed
  130249. * @param onError is a callback called if an error occurs
  130250. */
  130251. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130252. /**
  130253. * Execute the current task
  130254. * @param scene defines the scene where you want your assets to be loaded
  130255. * @param onSuccess is a callback called when the task is successfully executed
  130256. * @param onError is a callback called if an error occurs
  130257. */
  130258. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130259. /**
  130260. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  130261. * This can be used with failed tasks that have the reason for failure fixed.
  130262. */
  130263. reset(): void;
  130264. private onErrorCallback;
  130265. private onDoneCallback;
  130266. }
  130267. /**
  130268. * Define the interface used by progress events raised during assets loading
  130269. */
  130270. export interface IAssetsProgressEvent {
  130271. /**
  130272. * Defines the number of remaining tasks to process
  130273. */
  130274. remainingCount: number;
  130275. /**
  130276. * Defines the total number of tasks
  130277. */
  130278. totalCount: number;
  130279. /**
  130280. * Defines the task that was just processed
  130281. */
  130282. task: AbstractAssetTask;
  130283. }
  130284. /**
  130285. * Class used to share progress information about assets loading
  130286. */
  130287. export class AssetsProgressEvent implements IAssetsProgressEvent {
  130288. /**
  130289. * Defines the number of remaining tasks to process
  130290. */
  130291. remainingCount: number;
  130292. /**
  130293. * Defines the total number of tasks
  130294. */
  130295. totalCount: number;
  130296. /**
  130297. * Defines the task that was just processed
  130298. */
  130299. task: AbstractAssetTask;
  130300. /**
  130301. * Creates a AssetsProgressEvent
  130302. * @param remainingCount defines the number of remaining tasks to process
  130303. * @param totalCount defines the total number of tasks
  130304. * @param task defines the task that was just processed
  130305. */
  130306. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  130307. }
  130308. /**
  130309. * Define a task used by AssetsManager to load meshes
  130310. */
  130311. export class MeshAssetTask extends AbstractAssetTask {
  130312. /**
  130313. * Defines the name of the task
  130314. */
  130315. name: string;
  130316. /**
  130317. * Defines the list of mesh's names you want to load
  130318. */
  130319. meshesNames: any;
  130320. /**
  130321. * Defines the root url to use as a base to load your meshes and associated resources
  130322. */
  130323. rootUrl: string;
  130324. /**
  130325. * Defines the filename of the scene to load from
  130326. */
  130327. sceneFilename: string;
  130328. /**
  130329. * Gets the list of loaded meshes
  130330. */
  130331. loadedMeshes: Array<AbstractMesh>;
  130332. /**
  130333. * Gets the list of loaded particle systems
  130334. */
  130335. loadedParticleSystems: Array<IParticleSystem>;
  130336. /**
  130337. * Gets the list of loaded skeletons
  130338. */
  130339. loadedSkeletons: Array<Skeleton>;
  130340. /**
  130341. * Gets the list of loaded animation groups
  130342. */
  130343. loadedAnimationGroups: Array<AnimationGroup>;
  130344. /**
  130345. * Callback called when the task is successful
  130346. */
  130347. onSuccess: (task: MeshAssetTask) => void;
  130348. /**
  130349. * Callback called when the task is successful
  130350. */
  130351. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  130352. /**
  130353. * Creates a new MeshAssetTask
  130354. * @param name defines the name of the task
  130355. * @param meshesNames defines the list of mesh's names you want to load
  130356. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  130357. * @param sceneFilename defines the filename of the scene to load from
  130358. */
  130359. constructor(
  130360. /**
  130361. * Defines the name of the task
  130362. */
  130363. name: string,
  130364. /**
  130365. * Defines the list of mesh's names you want to load
  130366. */
  130367. meshesNames: any,
  130368. /**
  130369. * Defines the root url to use as a base to load your meshes and associated resources
  130370. */
  130371. rootUrl: string,
  130372. /**
  130373. * Defines the filename of the scene to load from
  130374. */
  130375. sceneFilename: string);
  130376. /**
  130377. * Execute the current task
  130378. * @param scene defines the scene where you want your assets to be loaded
  130379. * @param onSuccess is a callback called when the task is successfully executed
  130380. * @param onError is a callback called if an error occurs
  130381. */
  130382. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130383. }
  130384. /**
  130385. * Define a task used by AssetsManager to load text content
  130386. */
  130387. export class TextFileAssetTask extends AbstractAssetTask {
  130388. /**
  130389. * Defines the name of the task
  130390. */
  130391. name: string;
  130392. /**
  130393. * Defines the location of the file to load
  130394. */
  130395. url: string;
  130396. /**
  130397. * Gets the loaded text string
  130398. */
  130399. text: string;
  130400. /**
  130401. * Callback called when the task is successful
  130402. */
  130403. onSuccess: (task: TextFileAssetTask) => void;
  130404. /**
  130405. * Callback called when the task is successful
  130406. */
  130407. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  130408. /**
  130409. * Creates a new TextFileAssetTask object
  130410. * @param name defines the name of the task
  130411. * @param url defines the location of the file to load
  130412. */
  130413. constructor(
  130414. /**
  130415. * Defines the name of the task
  130416. */
  130417. name: string,
  130418. /**
  130419. * Defines the location of the file to load
  130420. */
  130421. url: string);
  130422. /**
  130423. * Execute the current task
  130424. * @param scene defines the scene where you want your assets to be loaded
  130425. * @param onSuccess is a callback called when the task is successfully executed
  130426. * @param onError is a callback called if an error occurs
  130427. */
  130428. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130429. }
  130430. /**
  130431. * Define a task used by AssetsManager to load binary data
  130432. */
  130433. export class BinaryFileAssetTask extends AbstractAssetTask {
  130434. /**
  130435. * Defines the name of the task
  130436. */
  130437. name: string;
  130438. /**
  130439. * Defines the location of the file to load
  130440. */
  130441. url: string;
  130442. /**
  130443. * Gets the lodaded data (as an array buffer)
  130444. */
  130445. data: ArrayBuffer;
  130446. /**
  130447. * Callback called when the task is successful
  130448. */
  130449. onSuccess: (task: BinaryFileAssetTask) => void;
  130450. /**
  130451. * Callback called when the task is successful
  130452. */
  130453. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  130454. /**
  130455. * Creates a new BinaryFileAssetTask object
  130456. * @param name defines the name of the new task
  130457. * @param url defines the location of the file to load
  130458. */
  130459. constructor(
  130460. /**
  130461. * Defines the name of the task
  130462. */
  130463. name: string,
  130464. /**
  130465. * Defines the location of the file to load
  130466. */
  130467. url: string);
  130468. /**
  130469. * Execute the current task
  130470. * @param scene defines the scene where you want your assets to be loaded
  130471. * @param onSuccess is a callback called when the task is successfully executed
  130472. * @param onError is a callback called if an error occurs
  130473. */
  130474. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130475. }
  130476. /**
  130477. * Define a task used by AssetsManager to load images
  130478. */
  130479. export class ImageAssetTask extends AbstractAssetTask {
  130480. /**
  130481. * Defines the name of the task
  130482. */
  130483. name: string;
  130484. /**
  130485. * Defines the location of the image to load
  130486. */
  130487. url: string;
  130488. /**
  130489. * Gets the loaded images
  130490. */
  130491. image: HTMLImageElement;
  130492. /**
  130493. * Callback called when the task is successful
  130494. */
  130495. onSuccess: (task: ImageAssetTask) => void;
  130496. /**
  130497. * Callback called when the task is successful
  130498. */
  130499. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  130500. /**
  130501. * Creates a new ImageAssetTask
  130502. * @param name defines the name of the task
  130503. * @param url defines the location of the image to load
  130504. */
  130505. constructor(
  130506. /**
  130507. * Defines the name of the task
  130508. */
  130509. name: string,
  130510. /**
  130511. * Defines the location of the image to load
  130512. */
  130513. url: string);
  130514. /**
  130515. * Execute the current task
  130516. * @param scene defines the scene where you want your assets to be loaded
  130517. * @param onSuccess is a callback called when the task is successfully executed
  130518. * @param onError is a callback called if an error occurs
  130519. */
  130520. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130521. }
  130522. /**
  130523. * Defines the interface used by texture loading tasks
  130524. */
  130525. export interface ITextureAssetTask<TEX extends BaseTexture> {
  130526. /**
  130527. * Gets the loaded texture
  130528. */
  130529. texture: TEX;
  130530. }
  130531. /**
  130532. * Define a task used by AssetsManager to load 2D textures
  130533. */
  130534. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  130535. /**
  130536. * Defines the name of the task
  130537. */
  130538. name: string;
  130539. /**
  130540. * Defines the location of the file to load
  130541. */
  130542. url: string;
  130543. /**
  130544. * Defines if mipmap should not be generated (default is false)
  130545. */
  130546. noMipmap?: boolean | undefined;
  130547. /**
  130548. * Defines if texture must be inverted on Y axis (default is false)
  130549. */
  130550. invertY?: boolean | undefined;
  130551. /**
  130552. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  130553. */
  130554. samplingMode: number;
  130555. /**
  130556. * Gets the loaded texture
  130557. */
  130558. texture: Texture;
  130559. /**
  130560. * Callback called when the task is successful
  130561. */
  130562. onSuccess: (task: TextureAssetTask) => void;
  130563. /**
  130564. * Callback called when the task is successful
  130565. */
  130566. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  130567. /**
  130568. * Creates a new TextureAssetTask object
  130569. * @param name defines the name of the task
  130570. * @param url defines the location of the file to load
  130571. * @param noMipmap defines if mipmap should not be generated (default is false)
  130572. * @param invertY defines if texture must be inverted on Y axis (default is false)
  130573. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  130574. */
  130575. constructor(
  130576. /**
  130577. * Defines the name of the task
  130578. */
  130579. name: string,
  130580. /**
  130581. * Defines the location of the file to load
  130582. */
  130583. url: string,
  130584. /**
  130585. * Defines if mipmap should not be generated (default is false)
  130586. */
  130587. noMipmap?: boolean | undefined,
  130588. /**
  130589. * Defines if texture must be inverted on Y axis (default is false)
  130590. */
  130591. invertY?: boolean | undefined,
  130592. /**
  130593. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  130594. */
  130595. samplingMode?: number);
  130596. /**
  130597. * Execute the current task
  130598. * @param scene defines the scene where you want your assets to be loaded
  130599. * @param onSuccess is a callback called when the task is successfully executed
  130600. * @param onError is a callback called if an error occurs
  130601. */
  130602. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130603. }
  130604. /**
  130605. * Define a task used by AssetsManager to load cube textures
  130606. */
  130607. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  130608. /**
  130609. * Defines the name of the task
  130610. */
  130611. name: string;
  130612. /**
  130613. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  130614. */
  130615. url: string;
  130616. /**
  130617. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  130618. */
  130619. extensions?: string[] | undefined;
  130620. /**
  130621. * Defines if mipmaps should not be generated (default is false)
  130622. */
  130623. noMipmap?: boolean | undefined;
  130624. /**
  130625. * Defines the explicit list of files (undefined by default)
  130626. */
  130627. files?: string[] | undefined;
  130628. /**
  130629. * Gets the loaded texture
  130630. */
  130631. texture: CubeTexture;
  130632. /**
  130633. * Callback called when the task is successful
  130634. */
  130635. onSuccess: (task: CubeTextureAssetTask) => void;
  130636. /**
  130637. * Callback called when the task is successful
  130638. */
  130639. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  130640. /**
  130641. * Creates a new CubeTextureAssetTask
  130642. * @param name defines the name of the task
  130643. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  130644. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  130645. * @param noMipmap defines if mipmaps should not be generated (default is false)
  130646. * @param files defines the explicit list of files (undefined by default)
  130647. */
  130648. constructor(
  130649. /**
  130650. * Defines the name of the task
  130651. */
  130652. name: string,
  130653. /**
  130654. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  130655. */
  130656. url: string,
  130657. /**
  130658. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  130659. */
  130660. extensions?: string[] | undefined,
  130661. /**
  130662. * Defines if mipmaps should not be generated (default is false)
  130663. */
  130664. noMipmap?: boolean | undefined,
  130665. /**
  130666. * Defines the explicit list of files (undefined by default)
  130667. */
  130668. files?: string[] | undefined);
  130669. /**
  130670. * Execute the current task
  130671. * @param scene defines the scene where you want your assets to be loaded
  130672. * @param onSuccess is a callback called when the task is successfully executed
  130673. * @param onError is a callback called if an error occurs
  130674. */
  130675. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130676. }
  130677. /**
  130678. * Define a task used by AssetsManager to load HDR cube textures
  130679. */
  130680. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  130681. /**
  130682. * Defines the name of the task
  130683. */
  130684. name: string;
  130685. /**
  130686. * Defines the location of the file to load
  130687. */
  130688. url: string;
  130689. /**
  130690. * Defines the desired size (the more it increases the longer the generation will be)
  130691. */
  130692. size: number;
  130693. /**
  130694. * Defines if mipmaps should not be generated (default is false)
  130695. */
  130696. noMipmap: boolean;
  130697. /**
  130698. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  130699. */
  130700. generateHarmonics: boolean;
  130701. /**
  130702. * 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)
  130703. */
  130704. gammaSpace: boolean;
  130705. /**
  130706. * Internal Use Only
  130707. */
  130708. reserved: boolean;
  130709. /**
  130710. * Gets the loaded texture
  130711. */
  130712. texture: HDRCubeTexture;
  130713. /**
  130714. * Callback called when the task is successful
  130715. */
  130716. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  130717. /**
  130718. * Callback called when the task is successful
  130719. */
  130720. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  130721. /**
  130722. * Creates a new HDRCubeTextureAssetTask object
  130723. * @param name defines the name of the task
  130724. * @param url defines the location of the file to load
  130725. * @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.
  130726. * @param noMipmap defines if mipmaps should not be generated (default is false)
  130727. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  130728. * @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)
  130729. * @param reserved Internal use only
  130730. */
  130731. constructor(
  130732. /**
  130733. * Defines the name of the task
  130734. */
  130735. name: string,
  130736. /**
  130737. * Defines the location of the file to load
  130738. */
  130739. url: string,
  130740. /**
  130741. * Defines the desired size (the more it increases the longer the generation will be)
  130742. */
  130743. size: number,
  130744. /**
  130745. * Defines if mipmaps should not be generated (default is false)
  130746. */
  130747. noMipmap?: boolean,
  130748. /**
  130749. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  130750. */
  130751. generateHarmonics?: boolean,
  130752. /**
  130753. * 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)
  130754. */
  130755. gammaSpace?: boolean,
  130756. /**
  130757. * Internal Use Only
  130758. */
  130759. reserved?: boolean);
  130760. /**
  130761. * Execute the current task
  130762. * @param scene defines the scene where you want your assets to be loaded
  130763. * @param onSuccess is a callback called when the task is successfully executed
  130764. * @param onError is a callback called if an error occurs
  130765. */
  130766. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130767. }
  130768. /**
  130769. * Define a task used by AssetsManager to load Equirectangular cube textures
  130770. */
  130771. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  130772. /**
  130773. * Defines the name of the task
  130774. */
  130775. name: string;
  130776. /**
  130777. * Defines the location of the file to load
  130778. */
  130779. url: string;
  130780. /**
  130781. * Defines the desired size (the more it increases the longer the generation will be)
  130782. */
  130783. size: number;
  130784. /**
  130785. * Defines if mipmaps should not be generated (default is false)
  130786. */
  130787. noMipmap: boolean;
  130788. /**
  130789. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  130790. * but the standard material would require them in Gamma space) (default is true)
  130791. */
  130792. gammaSpace: boolean;
  130793. /**
  130794. * Gets the loaded texture
  130795. */
  130796. texture: EquiRectangularCubeTexture;
  130797. /**
  130798. * Callback called when the task is successful
  130799. */
  130800. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  130801. /**
  130802. * Callback called when the task is successful
  130803. */
  130804. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  130805. /**
  130806. * Creates a new EquiRectangularCubeTextureAssetTask object
  130807. * @param name defines the name of the task
  130808. * @param url defines the location of the file to load
  130809. * @param size defines the desired size (the more it increases the longer the generation will be)
  130810. * If the size is omitted this implies you are using a preprocessed cubemap.
  130811. * @param noMipmap defines if mipmaps should not be generated (default is false)
  130812. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  130813. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  130814. * (default is true)
  130815. */
  130816. constructor(
  130817. /**
  130818. * Defines the name of the task
  130819. */
  130820. name: string,
  130821. /**
  130822. * Defines the location of the file to load
  130823. */
  130824. url: string,
  130825. /**
  130826. * Defines the desired size (the more it increases the longer the generation will be)
  130827. */
  130828. size: number,
  130829. /**
  130830. * Defines if mipmaps should not be generated (default is false)
  130831. */
  130832. noMipmap?: boolean,
  130833. /**
  130834. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  130835. * but the standard material would require them in Gamma space) (default is true)
  130836. */
  130837. gammaSpace?: boolean);
  130838. /**
  130839. * Execute the current task
  130840. * @param scene defines the scene where you want your assets to be loaded
  130841. * @param onSuccess is a callback called when the task is successfully executed
  130842. * @param onError is a callback called if an error occurs
  130843. */
  130844. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130845. }
  130846. /**
  130847. * This class can be used to easily import assets into a scene
  130848. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  130849. */
  130850. export class AssetsManager {
  130851. private _scene;
  130852. private _isLoading;
  130853. protected _tasks: AbstractAssetTask[];
  130854. protected _waitingTasksCount: number;
  130855. protected _totalTasksCount: number;
  130856. /**
  130857. * Callback called when all tasks are processed
  130858. */
  130859. onFinish: (tasks: AbstractAssetTask[]) => void;
  130860. /**
  130861. * Callback called when a task is successful
  130862. */
  130863. onTaskSuccess: (task: AbstractAssetTask) => void;
  130864. /**
  130865. * Callback called when a task had an error
  130866. */
  130867. onTaskError: (task: AbstractAssetTask) => void;
  130868. /**
  130869. * Callback called when a task is done (whatever the result is)
  130870. */
  130871. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  130872. /**
  130873. * Observable called when all tasks are processed
  130874. */
  130875. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  130876. /**
  130877. * Observable called when a task had an error
  130878. */
  130879. onTaskErrorObservable: Observable<AbstractAssetTask>;
  130880. /**
  130881. * Observable called when all tasks were executed
  130882. */
  130883. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  130884. /**
  130885. * Observable called when a task is done (whatever the result is)
  130886. */
  130887. onProgressObservable: Observable<IAssetsProgressEvent>;
  130888. /**
  130889. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  130890. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  130891. */
  130892. useDefaultLoadingScreen: boolean;
  130893. /**
  130894. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  130895. * when all assets have been downloaded.
  130896. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  130897. */
  130898. autoHideLoadingUI: boolean;
  130899. /**
  130900. * Creates a new AssetsManager
  130901. * @param scene defines the scene to work on
  130902. */
  130903. constructor(scene: Scene);
  130904. /**
  130905. * Add a MeshAssetTask to the list of active tasks
  130906. * @param taskName defines the name of the new task
  130907. * @param meshesNames defines the name of meshes to load
  130908. * @param rootUrl defines the root url to use to locate files
  130909. * @param sceneFilename defines the filename of the scene file
  130910. * @returns a new MeshAssetTask object
  130911. */
  130912. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  130913. /**
  130914. * Add a TextFileAssetTask to the list of active tasks
  130915. * @param taskName defines the name of the new task
  130916. * @param url defines the url of the file to load
  130917. * @returns a new TextFileAssetTask object
  130918. */
  130919. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  130920. /**
  130921. * Add a BinaryFileAssetTask to the list of active tasks
  130922. * @param taskName defines the name of the new task
  130923. * @param url defines the url of the file to load
  130924. * @returns a new BinaryFileAssetTask object
  130925. */
  130926. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  130927. /**
  130928. * Add a ImageAssetTask to the list of active tasks
  130929. * @param taskName defines the name of the new task
  130930. * @param url defines the url of the file to load
  130931. * @returns a new ImageAssetTask object
  130932. */
  130933. addImageTask(taskName: string, url: string): ImageAssetTask;
  130934. /**
  130935. * Add a TextureAssetTask to the list of active tasks
  130936. * @param taskName defines the name of the new task
  130937. * @param url defines the url of the file to load
  130938. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  130939. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  130940. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  130941. * @returns a new TextureAssetTask object
  130942. */
  130943. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  130944. /**
  130945. * Add a CubeTextureAssetTask to the list of active tasks
  130946. * @param taskName defines the name of the new task
  130947. * @param url defines the url of the file to load
  130948. * @param extensions defines the extension to use to load the cube map (can be null)
  130949. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  130950. * @param files defines the list of files to load (can be null)
  130951. * @returns a new CubeTextureAssetTask object
  130952. */
  130953. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  130954. /**
  130955. *
  130956. * Add a HDRCubeTextureAssetTask to the list of active tasks
  130957. * @param taskName defines the name of the new task
  130958. * @param url defines the url of the file to load
  130959. * @param size defines the size you want for the cubemap (can be null)
  130960. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  130961. * @param generateHarmonics defines if you want to automatically generate (true by default)
  130962. * @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)
  130963. * @param reserved Internal use only
  130964. * @returns a new HDRCubeTextureAssetTask object
  130965. */
  130966. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  130967. /**
  130968. *
  130969. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  130970. * @param taskName defines the name of the new task
  130971. * @param url defines the url of the file to load
  130972. * @param size defines the size you want for the cubemap (can be null)
  130973. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  130974. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  130975. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  130976. * @returns a new EquiRectangularCubeTextureAssetTask object
  130977. */
  130978. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  130979. /**
  130980. * Remove a task from the assets manager.
  130981. * @param task the task to remove
  130982. */
  130983. removeTask(task: AbstractAssetTask): void;
  130984. private _decreaseWaitingTasksCount;
  130985. private _runTask;
  130986. /**
  130987. * Reset the AssetsManager and remove all tasks
  130988. * @return the current instance of the AssetsManager
  130989. */
  130990. reset(): AssetsManager;
  130991. /**
  130992. * Start the loading process
  130993. * @return the current instance of the AssetsManager
  130994. */
  130995. load(): AssetsManager;
  130996. /**
  130997. * Start the loading process as an async operation
  130998. * @return a promise returning the list of failed tasks
  130999. */
  131000. loadAsync(): Promise<void>;
  131001. }
  131002. }
  131003. declare module BABYLON {
  131004. /**
  131005. * Wrapper class for promise with external resolve and reject.
  131006. */
  131007. export class Deferred<T> {
  131008. /**
  131009. * The promise associated with this deferred object.
  131010. */
  131011. readonly promise: Promise<T>;
  131012. private _resolve;
  131013. private _reject;
  131014. /**
  131015. * The resolve method of the promise associated with this deferred object.
  131016. */
  131017. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  131018. /**
  131019. * The reject method of the promise associated with this deferred object.
  131020. */
  131021. readonly reject: (reason?: any) => void;
  131022. /**
  131023. * Constructor for this deferred object.
  131024. */
  131025. constructor();
  131026. }
  131027. }
  131028. declare module BABYLON {
  131029. /**
  131030. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  131031. */
  131032. export class MeshExploder {
  131033. private _centerMesh;
  131034. private _meshes;
  131035. private _meshesOrigins;
  131036. private _toCenterVectors;
  131037. private _scaledDirection;
  131038. private _newPosition;
  131039. private _centerPosition;
  131040. /**
  131041. * Explodes meshes from a center mesh.
  131042. * @param meshes The meshes to explode.
  131043. * @param centerMesh The mesh to be center of explosion.
  131044. */
  131045. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  131046. private _setCenterMesh;
  131047. /**
  131048. * Get class name
  131049. * @returns "MeshExploder"
  131050. */
  131051. getClassName(): string;
  131052. /**
  131053. * "Exploded meshes"
  131054. * @returns Array of meshes with the centerMesh at index 0.
  131055. */
  131056. getMeshes(): Array<Mesh>;
  131057. /**
  131058. * Explodes meshes giving a specific direction
  131059. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  131060. */
  131061. explode(direction?: number): void;
  131062. }
  131063. }
  131064. declare module BABYLON {
  131065. /**
  131066. * Class used to help managing file picking and drag'n'drop
  131067. */
  131068. export class FilesInput {
  131069. /**
  131070. * List of files ready to be loaded
  131071. */
  131072. static readonly FilesToLoad: {
  131073. [key: string]: File;
  131074. };
  131075. /**
  131076. * Callback called when a file is processed
  131077. */
  131078. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  131079. private _engine;
  131080. private _currentScene;
  131081. private _sceneLoadedCallback;
  131082. private _progressCallback;
  131083. private _additionalRenderLoopLogicCallback;
  131084. private _textureLoadingCallback;
  131085. private _startingProcessingFilesCallback;
  131086. private _onReloadCallback;
  131087. private _errorCallback;
  131088. private _elementToMonitor;
  131089. private _sceneFileToLoad;
  131090. private _filesToLoad;
  131091. /**
  131092. * Creates a new FilesInput
  131093. * @param engine defines the rendering engine
  131094. * @param scene defines the hosting scene
  131095. * @param sceneLoadedCallback callback called when scene is loaded
  131096. * @param progressCallback callback called to track progress
  131097. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  131098. * @param textureLoadingCallback callback called when a texture is loading
  131099. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  131100. * @param onReloadCallback callback called when a reload is requested
  131101. * @param errorCallback callback call if an error occurs
  131102. */
  131103. constructor(engine: Engine, scene: Scene, sceneLoadedCallback: (sceneFile: File, scene: Scene) => void, progressCallback: (progress: SceneLoaderProgressEvent) => void, additionalRenderLoopLogicCallback: () => void, textureLoadingCallback: (remaining: number) => void, startingProcessingFilesCallback: (files?: File[]) => void, onReloadCallback: (sceneFile: File) => void, errorCallback: (sceneFile: File, scene: Scene, message: string) => void);
  131104. private _dragEnterHandler;
  131105. private _dragOverHandler;
  131106. private _dropHandler;
  131107. /**
  131108. * Calls this function to listen to drag'n'drop events on a specific DOM element
  131109. * @param elementToMonitor defines the DOM element to track
  131110. */
  131111. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  131112. /**
  131113. * Release all associated resources
  131114. */
  131115. dispose(): void;
  131116. private renderFunction;
  131117. private drag;
  131118. private drop;
  131119. private _traverseFolder;
  131120. private _processFiles;
  131121. /**
  131122. * Load files from a drop event
  131123. * @param event defines the drop event to use as source
  131124. */
  131125. loadFiles(event: any): void;
  131126. private _processReload;
  131127. /**
  131128. * Reload the current scene from the loaded files
  131129. */
  131130. reload(): void;
  131131. }
  131132. }
  131133. declare module BABYLON {
  131134. /**
  131135. * Defines the root class used to create scene optimization to use with SceneOptimizer
  131136. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131137. */
  131138. export class SceneOptimization {
  131139. /**
  131140. * Defines the priority of this optimization (0 by default which means first in the list)
  131141. */
  131142. priority: number;
  131143. /**
  131144. * Gets a string describing the action executed by the current optimization
  131145. * @returns description string
  131146. */
  131147. getDescription(): string;
  131148. /**
  131149. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131150. * @param scene defines the current scene where to apply this optimization
  131151. * @param optimizer defines the current optimizer
  131152. * @returns true if everything that can be done was applied
  131153. */
  131154. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131155. /**
  131156. * Creates the SceneOptimization object
  131157. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  131158. * @param desc defines the description associated with the optimization
  131159. */
  131160. constructor(
  131161. /**
  131162. * Defines the priority of this optimization (0 by default which means first in the list)
  131163. */
  131164. priority?: number);
  131165. }
  131166. /**
  131167. * Defines an optimization used to reduce the size of render target textures
  131168. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131169. */
  131170. export class TextureOptimization extends SceneOptimization {
  131171. /**
  131172. * Defines the priority of this optimization (0 by default which means first in the list)
  131173. */
  131174. priority: number;
  131175. /**
  131176. * 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
  131177. */
  131178. maximumSize: number;
  131179. /**
  131180. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  131181. */
  131182. step: number;
  131183. /**
  131184. * Gets a string describing the action executed by the current optimization
  131185. * @returns description string
  131186. */
  131187. getDescription(): string;
  131188. /**
  131189. * Creates the TextureOptimization object
  131190. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  131191. * @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
  131192. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  131193. */
  131194. constructor(
  131195. /**
  131196. * Defines the priority of this optimization (0 by default which means first in the list)
  131197. */
  131198. priority?: number,
  131199. /**
  131200. * 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
  131201. */
  131202. maximumSize?: number,
  131203. /**
  131204. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  131205. */
  131206. step?: number);
  131207. /**
  131208. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131209. * @param scene defines the current scene where to apply this optimization
  131210. * @param optimizer defines the current optimizer
  131211. * @returns true if everything that can be done was applied
  131212. */
  131213. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131214. }
  131215. /**
  131216. * Defines an optimization used to increase or decrease the rendering resolution
  131217. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131218. */
  131219. export class HardwareScalingOptimization extends SceneOptimization {
  131220. /**
  131221. * Defines the priority of this optimization (0 by default which means first in the list)
  131222. */
  131223. priority: number;
  131224. /**
  131225. * Defines the maximum scale to use (2 by default)
  131226. */
  131227. maximumScale: number;
  131228. /**
  131229. * Defines the step to use between two passes (0.5 by default)
  131230. */
  131231. step: number;
  131232. private _currentScale;
  131233. private _directionOffset;
  131234. /**
  131235. * Gets a string describing the action executed by the current optimization
  131236. * @return description string
  131237. */
  131238. getDescription(): string;
  131239. /**
  131240. * Creates the HardwareScalingOptimization object
  131241. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  131242. * @param maximumScale defines the maximum scale to use (2 by default)
  131243. * @param step defines the step to use between two passes (0.5 by default)
  131244. */
  131245. constructor(
  131246. /**
  131247. * Defines the priority of this optimization (0 by default which means first in the list)
  131248. */
  131249. priority?: number,
  131250. /**
  131251. * Defines the maximum scale to use (2 by default)
  131252. */
  131253. maximumScale?: number,
  131254. /**
  131255. * Defines the step to use between two passes (0.5 by default)
  131256. */
  131257. step?: number);
  131258. /**
  131259. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131260. * @param scene defines the current scene where to apply this optimization
  131261. * @param optimizer defines the current optimizer
  131262. * @returns true if everything that can be done was applied
  131263. */
  131264. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131265. }
  131266. /**
  131267. * Defines an optimization used to remove shadows
  131268. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131269. */
  131270. export class ShadowsOptimization extends SceneOptimization {
  131271. /**
  131272. * Gets a string describing the action executed by the current optimization
  131273. * @return description string
  131274. */
  131275. getDescription(): string;
  131276. /**
  131277. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131278. * @param scene defines the current scene where to apply this optimization
  131279. * @param optimizer defines the current optimizer
  131280. * @returns true if everything that can be done was applied
  131281. */
  131282. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131283. }
  131284. /**
  131285. * Defines an optimization used to turn post-processes off
  131286. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131287. */
  131288. export class PostProcessesOptimization extends SceneOptimization {
  131289. /**
  131290. * Gets a string describing the action executed by the current optimization
  131291. * @return description string
  131292. */
  131293. getDescription(): string;
  131294. /**
  131295. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131296. * @param scene defines the current scene where to apply this optimization
  131297. * @param optimizer defines the current optimizer
  131298. * @returns true if everything that can be done was applied
  131299. */
  131300. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131301. }
  131302. /**
  131303. * Defines an optimization used to turn lens flares off
  131304. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131305. */
  131306. export class LensFlaresOptimization extends SceneOptimization {
  131307. /**
  131308. * Gets a string describing the action executed by the current optimization
  131309. * @return description string
  131310. */
  131311. getDescription(): string;
  131312. /**
  131313. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131314. * @param scene defines the current scene where to apply this optimization
  131315. * @param optimizer defines the current optimizer
  131316. * @returns true if everything that can be done was applied
  131317. */
  131318. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131319. }
  131320. /**
  131321. * Defines an optimization based on user defined callback.
  131322. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131323. */
  131324. export class CustomOptimization extends SceneOptimization {
  131325. /**
  131326. * Callback called to apply the custom optimization.
  131327. */
  131328. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  131329. /**
  131330. * Callback called to get custom description
  131331. */
  131332. onGetDescription: () => string;
  131333. /**
  131334. * Gets a string describing the action executed by the current optimization
  131335. * @returns description string
  131336. */
  131337. getDescription(): string;
  131338. /**
  131339. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131340. * @param scene defines the current scene where to apply this optimization
  131341. * @param optimizer defines the current optimizer
  131342. * @returns true if everything that can be done was applied
  131343. */
  131344. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131345. }
  131346. /**
  131347. * Defines an optimization used to turn particles off
  131348. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131349. */
  131350. export class ParticlesOptimization extends SceneOptimization {
  131351. /**
  131352. * Gets a string describing the action executed by the current optimization
  131353. * @return description string
  131354. */
  131355. getDescription(): string;
  131356. /**
  131357. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131358. * @param scene defines the current scene where to apply this optimization
  131359. * @param optimizer defines the current optimizer
  131360. * @returns true if everything that can be done was applied
  131361. */
  131362. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131363. }
  131364. /**
  131365. * Defines an optimization used to turn render targets off
  131366. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131367. */
  131368. export class RenderTargetsOptimization extends SceneOptimization {
  131369. /**
  131370. * Gets a string describing the action executed by the current optimization
  131371. * @return description string
  131372. */
  131373. getDescription(): string;
  131374. /**
  131375. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131376. * @param scene defines the current scene where to apply this optimization
  131377. * @param optimizer defines the current optimizer
  131378. * @returns true if everything that can be done was applied
  131379. */
  131380. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131381. }
  131382. /**
  131383. * Defines an optimization used to merge meshes with compatible materials
  131384. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131385. */
  131386. export class MergeMeshesOptimization extends SceneOptimization {
  131387. private static _UpdateSelectionTree;
  131388. /**
  131389. * Gets or sets a boolean which defines if optimization octree has to be updated
  131390. */
  131391. /**
  131392. * Gets or sets a boolean which defines if optimization octree has to be updated
  131393. */
  131394. static UpdateSelectionTree: boolean;
  131395. /**
  131396. * Gets a string describing the action executed by the current optimization
  131397. * @return description string
  131398. */
  131399. getDescription(): string;
  131400. private _canBeMerged;
  131401. /**
  131402. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131403. * @param scene defines the current scene where to apply this optimization
  131404. * @param optimizer defines the current optimizer
  131405. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  131406. * @returns true if everything that can be done was applied
  131407. */
  131408. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  131409. }
  131410. /**
  131411. * Defines a list of options used by SceneOptimizer
  131412. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131413. */
  131414. export class SceneOptimizerOptions {
  131415. /**
  131416. * Defines the target frame rate to reach (60 by default)
  131417. */
  131418. targetFrameRate: number;
  131419. /**
  131420. * Defines the interval between two checkes (2000ms by default)
  131421. */
  131422. trackerDuration: number;
  131423. /**
  131424. * Gets the list of optimizations to apply
  131425. */
  131426. optimizations: SceneOptimization[];
  131427. /**
  131428. * Creates a new list of options used by SceneOptimizer
  131429. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  131430. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  131431. */
  131432. constructor(
  131433. /**
  131434. * Defines the target frame rate to reach (60 by default)
  131435. */
  131436. targetFrameRate?: number,
  131437. /**
  131438. * Defines the interval between two checkes (2000ms by default)
  131439. */
  131440. trackerDuration?: number);
  131441. /**
  131442. * Add a new optimization
  131443. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  131444. * @returns the current SceneOptimizerOptions
  131445. */
  131446. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  131447. /**
  131448. * Add a new custom optimization
  131449. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  131450. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  131451. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  131452. * @returns the current SceneOptimizerOptions
  131453. */
  131454. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  131455. /**
  131456. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  131457. * @param targetFrameRate defines the target frame rate (60 by default)
  131458. * @returns a SceneOptimizerOptions object
  131459. */
  131460. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  131461. /**
  131462. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  131463. * @param targetFrameRate defines the target frame rate (60 by default)
  131464. * @returns a SceneOptimizerOptions object
  131465. */
  131466. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  131467. /**
  131468. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  131469. * @param targetFrameRate defines the target frame rate (60 by default)
  131470. * @returns a SceneOptimizerOptions object
  131471. */
  131472. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  131473. }
  131474. /**
  131475. * Class used to run optimizations in order to reach a target frame rate
  131476. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131477. */
  131478. export class SceneOptimizer implements IDisposable {
  131479. private _isRunning;
  131480. private _options;
  131481. private _scene;
  131482. private _currentPriorityLevel;
  131483. private _targetFrameRate;
  131484. private _trackerDuration;
  131485. private _currentFrameRate;
  131486. private _sceneDisposeObserver;
  131487. private _improvementMode;
  131488. /**
  131489. * Defines an observable called when the optimizer reaches the target frame rate
  131490. */
  131491. onSuccessObservable: Observable<SceneOptimizer>;
  131492. /**
  131493. * Defines an observable called when the optimizer enables an optimization
  131494. */
  131495. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  131496. /**
  131497. * Defines an observable called when the optimizer is not able to reach the target frame rate
  131498. */
  131499. onFailureObservable: Observable<SceneOptimizer>;
  131500. /**
  131501. * Gets a boolean indicating if the optimizer is in improvement mode
  131502. */
  131503. readonly isInImprovementMode: boolean;
  131504. /**
  131505. * Gets the current priority level (0 at start)
  131506. */
  131507. readonly currentPriorityLevel: number;
  131508. /**
  131509. * Gets the current frame rate checked by the SceneOptimizer
  131510. */
  131511. readonly currentFrameRate: number;
  131512. /**
  131513. * Gets or sets the current target frame rate (60 by default)
  131514. */
  131515. /**
  131516. * Gets or sets the current target frame rate (60 by default)
  131517. */
  131518. targetFrameRate: number;
  131519. /**
  131520. * Gets or sets the current interval between two checks (every 2000ms by default)
  131521. */
  131522. /**
  131523. * Gets or sets the current interval between two checks (every 2000ms by default)
  131524. */
  131525. trackerDuration: number;
  131526. /**
  131527. * Gets the list of active optimizations
  131528. */
  131529. readonly optimizations: SceneOptimization[];
  131530. /**
  131531. * Creates a new SceneOptimizer
  131532. * @param scene defines the scene to work on
  131533. * @param options defines the options to use with the SceneOptimizer
  131534. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  131535. * @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)
  131536. */
  131537. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  131538. /**
  131539. * Stops the current optimizer
  131540. */
  131541. stop(): void;
  131542. /**
  131543. * Reset the optimizer to initial step (current priority level = 0)
  131544. */
  131545. reset(): void;
  131546. /**
  131547. * Start the optimizer. By default it will try to reach a specific framerate
  131548. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  131549. */
  131550. start(): void;
  131551. private _checkCurrentState;
  131552. /**
  131553. * Release all resources
  131554. */
  131555. dispose(): void;
  131556. /**
  131557. * Helper function to create a SceneOptimizer with one single line of code
  131558. * @param scene defines the scene to work on
  131559. * @param options defines the options to use with the SceneOptimizer
  131560. * @param onSuccess defines a callback to call on success
  131561. * @param onFailure defines a callback to call on failure
  131562. * @returns the new SceneOptimizer object
  131563. */
  131564. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  131565. }
  131566. }
  131567. declare module BABYLON {
  131568. /**
  131569. * Class used to serialize a scene into a string
  131570. */
  131571. export class SceneSerializer {
  131572. /**
  131573. * Clear cache used by a previous serialization
  131574. */
  131575. static ClearCache(): void;
  131576. /**
  131577. * Serialize a scene into a JSON compatible object
  131578. * @param scene defines the scene to serialize
  131579. * @returns a JSON compatible object
  131580. */
  131581. static Serialize(scene: Scene): any;
  131582. /**
  131583. * Serialize a mesh into a JSON compatible object
  131584. * @param toSerialize defines the mesh to serialize
  131585. * @param withParents defines if parents must be serialized as well
  131586. * @param withChildren defines if children must be serialized as well
  131587. * @returns a JSON compatible object
  131588. */
  131589. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  131590. }
  131591. }
  131592. declare module BABYLON {
  131593. /**
  131594. * Class used to host texture specific utilities
  131595. */
  131596. export class TextureTools {
  131597. /**
  131598. * Uses the GPU to create a copy texture rescaled at a given size
  131599. * @param texture Texture to copy from
  131600. * @param width defines the desired width
  131601. * @param height defines the desired height
  131602. * @param useBilinearMode defines if bilinear mode has to be used
  131603. * @return the generated texture
  131604. */
  131605. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  131606. }
  131607. }
  131608. declare module BABYLON {
  131609. /**
  131610. * This represents the different options available for the video capture.
  131611. */
  131612. export interface VideoRecorderOptions {
  131613. /** Defines the mime type of the video. */
  131614. mimeType: string;
  131615. /** Defines the FPS the video should be recorded at. */
  131616. fps: number;
  131617. /** Defines the chunk size for the recording data. */
  131618. recordChunckSize: number;
  131619. /** The audio tracks to attach to the recording. */
  131620. audioTracks?: MediaStreamTrack[];
  131621. }
  131622. /**
  131623. * This can help with recording videos from BabylonJS.
  131624. * This is based on the available WebRTC functionalities of the browser.
  131625. *
  131626. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  131627. */
  131628. export class VideoRecorder {
  131629. private static readonly _defaultOptions;
  131630. /**
  131631. * Returns whether or not the VideoRecorder is available in your browser.
  131632. * @param engine Defines the Babylon Engine.
  131633. * @returns true if supported otherwise false.
  131634. */
  131635. static IsSupported(engine: Engine): boolean;
  131636. private readonly _options;
  131637. private _canvas;
  131638. private _mediaRecorder;
  131639. private _recordedChunks;
  131640. private _fileName;
  131641. private _resolve;
  131642. private _reject;
  131643. /**
  131644. * True when a recording is already in progress.
  131645. */
  131646. readonly isRecording: boolean;
  131647. /**
  131648. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  131649. * @param engine Defines the BabylonJS Engine you wish to record.
  131650. * @param options Defines options that can be used to customize the capture.
  131651. */
  131652. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  131653. /**
  131654. * Stops the current recording before the default capture timeout passed in the startRecording function.
  131655. */
  131656. stopRecording(): void;
  131657. /**
  131658. * Starts recording the canvas for a max duration specified in parameters.
  131659. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  131660. * If null no automatic download will start and you can rely on the promise to get the data back.
  131661. * @param maxDuration Defines the maximum recording time in seconds.
  131662. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  131663. * @return A promise callback at the end of the recording with the video data in Blob.
  131664. */
  131665. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  131666. /**
  131667. * Releases internal resources used during the recording.
  131668. */
  131669. dispose(): void;
  131670. private _handleDataAvailable;
  131671. private _handleError;
  131672. private _handleStop;
  131673. }
  131674. }
  131675. declare module BABYLON {
  131676. /**
  131677. * Class containing a set of static utilities functions for screenshots
  131678. */
  131679. export class ScreenshotTools {
  131680. /**
  131681. * Captures a screenshot of the current rendering
  131682. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  131683. * @param engine defines the rendering engine
  131684. * @param camera defines the source camera
  131685. * @param size This parameter can be set to a single number or to an object with the
  131686. * following (optional) properties: precision, width, height. If a single number is passed,
  131687. * it will be used for both width and height. If an object is passed, the screenshot size
  131688. * will be derived from the parameters. The precision property is a multiplier allowing
  131689. * rendering at a higher or lower resolution
  131690. * @param successCallback defines the callback receives a single parameter which contains the
  131691. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  131692. * src parameter of an <img> to display it
  131693. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  131694. * Check your browser for supported MIME types
  131695. */
  131696. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  131697. /**
  131698. * Captures a screenshot of the current rendering
  131699. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  131700. * @param engine defines the rendering engine
  131701. * @param camera defines the source camera
  131702. * @param size This parameter can be set to a single number or to an object with the
  131703. * following (optional) properties: precision, width, height. If a single number is passed,
  131704. * it will be used for both width and height. If an object is passed, the screenshot size
  131705. * will be derived from the parameters. The precision property is a multiplier allowing
  131706. * rendering at a higher or lower resolution
  131707. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  131708. * Check your browser for supported MIME types
  131709. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  131710. * to the src parameter of an <img> to display it
  131711. */
  131712. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  131713. /**
  131714. * Generates an image screenshot from the specified camera.
  131715. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  131716. * @param engine The engine to use for rendering
  131717. * @param camera The camera to use for rendering
  131718. * @param size This parameter can be set to a single number or to an object with the
  131719. * following (optional) properties: precision, width, height. If a single number is passed,
  131720. * it will be used for both width and height. If an object is passed, the screenshot size
  131721. * will be derived from the parameters. The precision property is a multiplier allowing
  131722. * rendering at a higher or lower resolution
  131723. * @param successCallback The callback receives a single parameter which contains the
  131724. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  131725. * src parameter of an <img> to display it
  131726. * @param mimeType The MIME type of the screenshot image (default: image/png).
  131727. * Check your browser for supported MIME types
  131728. * @param samples Texture samples (default: 1)
  131729. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  131730. * @param fileName A name for for the downloaded file.
  131731. */
  131732. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  131733. /**
  131734. * Generates an image screenshot from the specified camera.
  131735. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  131736. * @param engine The engine to use for rendering
  131737. * @param camera The camera to use for rendering
  131738. * @param size This parameter can be set to a single number or to an object with the
  131739. * following (optional) properties: precision, width, height. If a single number is passed,
  131740. * it will be used for both width and height. If an object is passed, the screenshot size
  131741. * will be derived from the parameters. The precision property is a multiplier allowing
  131742. * rendering at a higher or lower resolution
  131743. * @param mimeType The MIME type of the screenshot image (default: image/png).
  131744. * Check your browser for supported MIME types
  131745. * @param samples Texture samples (default: 1)
  131746. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  131747. * @param fileName A name for for the downloaded file.
  131748. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  131749. * to the src parameter of an <img> to display it
  131750. */
  131751. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  131752. /**
  131753. * Gets height and width for screenshot size
  131754. * @private
  131755. */
  131756. private static _getScreenshotSize;
  131757. }
  131758. }
  131759. declare module BABYLON {
  131760. /**
  131761. * Interface for a data buffer
  131762. */
  131763. export interface IDataBuffer {
  131764. /**
  131765. * Reads bytes from the data buffer.
  131766. * @param byteOffset The byte offset to read
  131767. * @param byteLength The byte length to read
  131768. * @returns A promise that resolves when the bytes are read
  131769. */
  131770. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  131771. /**
  131772. * The byte length of the buffer.
  131773. */
  131774. readonly byteLength: number;
  131775. }
  131776. /**
  131777. * Utility class for reading from a data buffer
  131778. */
  131779. export class DataReader {
  131780. /**
  131781. * The data buffer associated with this data reader.
  131782. */
  131783. readonly buffer: IDataBuffer;
  131784. /**
  131785. * The current byte offset from the beginning of the data buffer.
  131786. */
  131787. byteOffset: number;
  131788. private _dataView;
  131789. private _dataByteOffset;
  131790. /**
  131791. * Constructor
  131792. * @param buffer The buffer to read
  131793. */
  131794. constructor(buffer: IDataBuffer);
  131795. /**
  131796. * Loads the given byte length.
  131797. * @param byteLength The byte length to load
  131798. * @returns A promise that resolves when the load is complete
  131799. */
  131800. loadAsync(byteLength: number): Promise<void>;
  131801. /**
  131802. * Read a unsigned 32-bit integer from the currently loaded data range.
  131803. * @returns The 32-bit integer read
  131804. */
  131805. readUint32(): number;
  131806. /**
  131807. * Read a byte array from the currently loaded data range.
  131808. * @param byteLength The byte length to read
  131809. * @returns The byte array read
  131810. */
  131811. readUint8Array(byteLength: number): Uint8Array;
  131812. /**
  131813. * Read a string from the currently loaded data range.
  131814. * @param byteLength The byte length to read
  131815. * @returns The string read
  131816. */
  131817. readString(byteLength: number): string;
  131818. /**
  131819. * Skips the given byte length the currently loaded data range.
  131820. * @param byteLength The byte length to skip
  131821. */
  131822. skipBytes(byteLength: number): void;
  131823. }
  131824. }
  131825. declare module BABYLON {
  131826. /**
  131827. * A cursor which tracks a point on a path
  131828. */
  131829. export class PathCursor {
  131830. private path;
  131831. /**
  131832. * Stores path cursor callbacks for when an onchange event is triggered
  131833. */
  131834. private _onchange;
  131835. /**
  131836. * The value of the path cursor
  131837. */
  131838. value: number;
  131839. /**
  131840. * The animation array of the path cursor
  131841. */
  131842. animations: Animation[];
  131843. /**
  131844. * Initializes the path cursor
  131845. * @param path The path to track
  131846. */
  131847. constructor(path: Path2);
  131848. /**
  131849. * Gets the cursor point on the path
  131850. * @returns A point on the path cursor at the cursor location
  131851. */
  131852. getPoint(): Vector3;
  131853. /**
  131854. * Moves the cursor ahead by the step amount
  131855. * @param step The amount to move the cursor forward
  131856. * @returns This path cursor
  131857. */
  131858. moveAhead(step?: number): PathCursor;
  131859. /**
  131860. * Moves the cursor behind by the step amount
  131861. * @param step The amount to move the cursor back
  131862. * @returns This path cursor
  131863. */
  131864. moveBack(step?: number): PathCursor;
  131865. /**
  131866. * Moves the cursor by the step amount
  131867. * If the step amount is greater than one, an exception is thrown
  131868. * @param step The amount to move the cursor
  131869. * @returns This path cursor
  131870. */
  131871. move(step: number): PathCursor;
  131872. /**
  131873. * Ensures that the value is limited between zero and one
  131874. * @returns This path cursor
  131875. */
  131876. private ensureLimits;
  131877. /**
  131878. * Runs onchange callbacks on change (used by the animation engine)
  131879. * @returns This path cursor
  131880. */
  131881. private raiseOnChange;
  131882. /**
  131883. * Executes a function on change
  131884. * @param f A path cursor onchange callback
  131885. * @returns This path cursor
  131886. */
  131887. onchange(f: (cursor: PathCursor) => void): PathCursor;
  131888. }
  131889. }
  131890. declare module BABYLON {
  131891. /** @hidden */
  131892. export var blurPixelShader: {
  131893. name: string;
  131894. shader: string;
  131895. };
  131896. }
  131897. declare module BABYLON {
  131898. /** @hidden */
  131899. export var pointCloudVertexDeclaration: {
  131900. name: string;
  131901. shader: string;
  131902. };
  131903. }
  131904. // Mixins
  131905. interface Window {
  131906. mozIndexedDB: IDBFactory;
  131907. webkitIndexedDB: IDBFactory;
  131908. msIndexedDB: IDBFactory;
  131909. webkitURL: typeof URL;
  131910. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  131911. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  131912. WebGLRenderingContext: WebGLRenderingContext;
  131913. MSGesture: MSGesture;
  131914. CANNON: any;
  131915. AudioContext: AudioContext;
  131916. webkitAudioContext: AudioContext;
  131917. PointerEvent: any;
  131918. Math: Math;
  131919. Uint8Array: Uint8ArrayConstructor;
  131920. Float32Array: Float32ArrayConstructor;
  131921. mozURL: typeof URL;
  131922. msURL: typeof URL;
  131923. VRFrameData: any; // WebVR, from specs 1.1
  131924. DracoDecoderModule: any;
  131925. setImmediate(handler: (...args: any[]) => void): number;
  131926. }
  131927. interface HTMLCanvasElement {
  131928. requestPointerLock(): void;
  131929. msRequestPointerLock?(): void;
  131930. mozRequestPointerLock?(): void;
  131931. webkitRequestPointerLock?(): void;
  131932. /** Track wether a record is in progress */
  131933. isRecording: boolean;
  131934. /** Capture Stream method defined by some browsers */
  131935. captureStream(fps?: number): MediaStream;
  131936. }
  131937. interface CanvasRenderingContext2D {
  131938. msImageSmoothingEnabled: boolean;
  131939. }
  131940. interface MouseEvent {
  131941. mozMovementX: number;
  131942. mozMovementY: number;
  131943. webkitMovementX: number;
  131944. webkitMovementY: number;
  131945. msMovementX: number;
  131946. msMovementY: number;
  131947. }
  131948. interface Navigator {
  131949. mozGetVRDevices: (any: any) => any;
  131950. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  131951. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  131952. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  131953. webkitGetGamepads(): Gamepad[];
  131954. msGetGamepads(): Gamepad[];
  131955. webkitGamepads(): Gamepad[];
  131956. }
  131957. interface HTMLVideoElement {
  131958. mozSrcObject: any;
  131959. }
  131960. interface Math {
  131961. fround(x: number): number;
  131962. imul(a: number, b: number): number;
  131963. }
  131964. interface WebGLRenderingContext {
  131965. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  131966. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  131967. vertexAttribDivisor(index: number, divisor: number): void;
  131968. createVertexArray(): any;
  131969. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  131970. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  131971. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  131972. renderbufferStorageMultisample(target: number, samples: number, internalformat: number, width: number, height: number): void;
  131973. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  131974. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  131975. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  131976. // Queries
  131977. createQuery(): WebGLQuery;
  131978. deleteQuery(query: WebGLQuery): void;
  131979. beginQuery(target: number, query: WebGLQuery): void;
  131980. endQuery(target: number): void;
  131981. getQueryParameter(query: WebGLQuery, pname: number): any;
  131982. getQuery(target: number, pname: number): any;
  131983. MAX_SAMPLES: number;
  131984. RGBA8: number;
  131985. READ_FRAMEBUFFER: number;
  131986. DRAW_FRAMEBUFFER: number;
  131987. UNIFORM_BUFFER: number;
  131988. HALF_FLOAT_OES: number;
  131989. RGBA16F: number;
  131990. RGBA32F: number;
  131991. R32F: number;
  131992. RG32F: number;
  131993. RGB32F: number;
  131994. R16F: number;
  131995. RG16F: number;
  131996. RGB16F: number;
  131997. RED: number;
  131998. RG: number;
  131999. R8: number;
  132000. RG8: number;
  132001. UNSIGNED_INT_24_8: number;
  132002. DEPTH24_STENCIL8: number;
  132003. MIN: number;
  132004. MAX: number;
  132005. /* Multiple Render Targets */
  132006. drawBuffers(buffers: number[]): void;
  132007. readBuffer(src: number): void;
  132008. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  132009. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  132010. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  132011. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  132012. // Occlusion Query
  132013. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  132014. ANY_SAMPLES_PASSED: number;
  132015. QUERY_RESULT_AVAILABLE: number;
  132016. QUERY_RESULT: number;
  132017. }
  132018. interface WebGLProgram {
  132019. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  132020. }
  132021. interface EXT_disjoint_timer_query {
  132022. QUERY_COUNTER_BITS_EXT: number;
  132023. TIME_ELAPSED_EXT: number;
  132024. TIMESTAMP_EXT: number;
  132025. GPU_DISJOINT_EXT: number;
  132026. QUERY_RESULT_EXT: number;
  132027. QUERY_RESULT_AVAILABLE_EXT: number;
  132028. queryCounterEXT(query: WebGLQuery, target: number): void;
  132029. createQueryEXT(): WebGLQuery;
  132030. beginQueryEXT(target: number, query: WebGLQuery): void;
  132031. endQueryEXT(target: number): void;
  132032. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  132033. deleteQueryEXT(query: WebGLQuery): void;
  132034. }
  132035. interface WebGLUniformLocation {
  132036. _currentState: any;
  132037. }
  132038. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  132039. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  132040. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  132041. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  132042. interface WebGLRenderingContext {
  132043. readonly RASTERIZER_DISCARD: number;
  132044. readonly DEPTH_COMPONENT24: number;
  132045. readonly TEXTURE_3D: number;
  132046. readonly TEXTURE_2D_ARRAY: number;
  132047. readonly TEXTURE_COMPARE_FUNC: number;
  132048. readonly TEXTURE_COMPARE_MODE: number;
  132049. readonly COMPARE_REF_TO_TEXTURE: number;
  132050. readonly TEXTURE_WRAP_R: number;
  132051. readonly HALF_FLOAT: number;
  132052. readonly RGB8: number;
  132053. readonly RED_INTEGER: number;
  132054. readonly RG_INTEGER: number;
  132055. readonly RGB_INTEGER: number;
  132056. readonly RGBA_INTEGER: number;
  132057. readonly R8_SNORM: number;
  132058. readonly RG8_SNORM: number;
  132059. readonly RGB8_SNORM: number;
  132060. readonly RGBA8_SNORM: number;
  132061. readonly R8I: number;
  132062. readonly RG8I: number;
  132063. readonly RGB8I: number;
  132064. readonly RGBA8I: number;
  132065. readonly R8UI: number;
  132066. readonly RG8UI: number;
  132067. readonly RGB8UI: number;
  132068. readonly RGBA8UI: number;
  132069. readonly R16I: number;
  132070. readonly RG16I: number;
  132071. readonly RGB16I: number;
  132072. readonly RGBA16I: number;
  132073. readonly R16UI: number;
  132074. readonly RG16UI: number;
  132075. readonly RGB16UI: number;
  132076. readonly RGBA16UI: number;
  132077. readonly R32I: number;
  132078. readonly RG32I: number;
  132079. readonly RGB32I: number;
  132080. readonly RGBA32I: number;
  132081. readonly R32UI: number;
  132082. readonly RG32UI: number;
  132083. readonly RGB32UI: number;
  132084. readonly RGBA32UI: number;
  132085. readonly RGB10_A2UI: number;
  132086. readonly R11F_G11F_B10F: number;
  132087. readonly RGB9_E5: number;
  132088. readonly RGB10_A2: number;
  132089. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  132090. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  132091. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  132092. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  132093. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  132094. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  132095. 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;
  132096. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  132097. readonly TRANSFORM_FEEDBACK: number;
  132098. readonly INTERLEAVED_ATTRIBS: number;
  132099. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  132100. createTransformFeedback(): WebGLTransformFeedback;
  132101. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  132102. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  132103. beginTransformFeedback(primitiveMode: number): void;
  132104. endTransformFeedback(): void;
  132105. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  132106. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  132107. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  132108. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  132109. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  132110. }
  132111. interface ImageBitmap {
  132112. readonly width: number;
  132113. readonly height: number;
  132114. close(): void;
  132115. }
  132116. interface WebGLQuery extends WebGLObject {
  132117. }
  132118. declare var WebGLQuery: {
  132119. prototype: WebGLQuery;
  132120. new(): WebGLQuery;
  132121. };
  132122. interface WebGLSampler extends WebGLObject {
  132123. }
  132124. declare var WebGLSampler: {
  132125. prototype: WebGLSampler;
  132126. new(): WebGLSampler;
  132127. };
  132128. interface WebGLSync extends WebGLObject {
  132129. }
  132130. declare var WebGLSync: {
  132131. prototype: WebGLSync;
  132132. new(): WebGLSync;
  132133. };
  132134. interface WebGLTransformFeedback extends WebGLObject {
  132135. }
  132136. declare var WebGLTransformFeedback: {
  132137. prototype: WebGLTransformFeedback;
  132138. new(): WebGLTransformFeedback;
  132139. };
  132140. interface WebGLVertexArrayObject extends WebGLObject {
  132141. }
  132142. declare var WebGLVertexArrayObject: {
  132143. prototype: WebGLVertexArrayObject;
  132144. new(): WebGLVertexArrayObject;
  132145. };
  132146. // Type definitions for WebVR API
  132147. // Project: https://w3c.github.io/webvr/
  132148. // Definitions by: six a <https://github.com/lostfictions>
  132149. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  132150. interface VRDisplay extends EventTarget {
  132151. /**
  132152. * Dictionary of capabilities describing the VRDisplay.
  132153. */
  132154. readonly capabilities: VRDisplayCapabilities;
  132155. /**
  132156. * z-depth defining the far plane of the eye view frustum
  132157. * enables mapping of values in the render target depth
  132158. * attachment to scene coordinates. Initially set to 10000.0.
  132159. */
  132160. depthFar: number;
  132161. /**
  132162. * z-depth defining the near plane of the eye view frustum
  132163. * enables mapping of values in the render target depth
  132164. * attachment to scene coordinates. Initially set to 0.01.
  132165. */
  132166. depthNear: number;
  132167. /**
  132168. * An identifier for this distinct VRDisplay. Used as an
  132169. * association point in the Gamepad API.
  132170. */
  132171. readonly displayId: number;
  132172. /**
  132173. * A display name, a user-readable name identifying it.
  132174. */
  132175. readonly displayName: string;
  132176. readonly isConnected: boolean;
  132177. readonly isPresenting: boolean;
  132178. /**
  132179. * If this VRDisplay supports room-scale experiences, the optional
  132180. * stage attribute contains details on the room-scale parameters.
  132181. */
  132182. readonly stageParameters: VRStageParameters | null;
  132183. /**
  132184. * Passing the value returned by `requestAnimationFrame` to
  132185. * `cancelAnimationFrame` will unregister the callback.
  132186. * @param handle Define the hanle of the request to cancel
  132187. */
  132188. cancelAnimationFrame(handle: number): void;
  132189. /**
  132190. * Stops presenting to the VRDisplay.
  132191. * @returns a promise to know when it stopped
  132192. */
  132193. exitPresent(): Promise<void>;
  132194. /**
  132195. * Return the current VREyeParameters for the given eye.
  132196. * @param whichEye Define the eye we want the parameter for
  132197. * @returns the eye parameters
  132198. */
  132199. getEyeParameters(whichEye: string): VREyeParameters;
  132200. /**
  132201. * Populates the passed VRFrameData with the information required to render
  132202. * the current frame.
  132203. * @param frameData Define the data structure to populate
  132204. * @returns true if ok otherwise false
  132205. */
  132206. getFrameData(frameData: VRFrameData): boolean;
  132207. /**
  132208. * Get the layers currently being presented.
  132209. * @returns the list of VR layers
  132210. */
  132211. getLayers(): VRLayer[];
  132212. /**
  132213. * Return a VRPose containing the future predicted pose of the VRDisplay
  132214. * when the current frame will be presented. The value returned will not
  132215. * change until JavaScript has returned control to the browser.
  132216. *
  132217. * The VRPose will contain the position, orientation, velocity,
  132218. * and acceleration of each of these properties.
  132219. * @returns the pose object
  132220. */
  132221. getPose(): VRPose;
  132222. /**
  132223. * Return the current instantaneous pose of the VRDisplay, with no
  132224. * prediction applied.
  132225. * @returns the current instantaneous pose
  132226. */
  132227. getImmediatePose(): VRPose;
  132228. /**
  132229. * The callback passed to `requestAnimationFrame` will be called
  132230. * any time a new frame should be rendered. When the VRDisplay is
  132231. * presenting the callback will be called at the native refresh
  132232. * rate of the HMD. When not presenting this function acts
  132233. * identically to how window.requestAnimationFrame acts. Content should
  132234. * make no assumptions of frame rate or vsync behavior as the HMD runs
  132235. * asynchronously from other displays and at differing refresh rates.
  132236. * @param callback Define the eaction to run next frame
  132237. * @returns the request handle it
  132238. */
  132239. requestAnimationFrame(callback: FrameRequestCallback): number;
  132240. /**
  132241. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  132242. * Repeat calls while already presenting will update the VRLayers being displayed.
  132243. * @param layers Define the list of layer to present
  132244. * @returns a promise to know when the request has been fulfilled
  132245. */
  132246. requestPresent(layers: VRLayer[]): Promise<void>;
  132247. /**
  132248. * Reset the pose for this display, treating its current position and
  132249. * orientation as the "origin/zero" values. VRPose.position,
  132250. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  132251. * updated when calling resetPose(). This should be called in only
  132252. * sitting-space experiences.
  132253. */
  132254. resetPose(): void;
  132255. /**
  132256. * The VRLayer provided to the VRDisplay will be captured and presented
  132257. * in the HMD. Calling this function has the same effect on the source
  132258. * canvas as any other operation that uses its source image, and canvases
  132259. * created without preserveDrawingBuffer set to true will be cleared.
  132260. * @param pose Define the pose to submit
  132261. */
  132262. submitFrame(pose?: VRPose): void;
  132263. }
  132264. declare var VRDisplay: {
  132265. prototype: VRDisplay;
  132266. new(): VRDisplay;
  132267. };
  132268. interface VRLayer {
  132269. leftBounds?: number[] | Float32Array | null;
  132270. rightBounds?: number[] | Float32Array | null;
  132271. source?: HTMLCanvasElement | null;
  132272. }
  132273. interface VRDisplayCapabilities {
  132274. readonly canPresent: boolean;
  132275. readonly hasExternalDisplay: boolean;
  132276. readonly hasOrientation: boolean;
  132277. readonly hasPosition: boolean;
  132278. readonly maxLayers: number;
  132279. }
  132280. interface VREyeParameters {
  132281. /** @deprecated */
  132282. readonly fieldOfView: VRFieldOfView;
  132283. readonly offset: Float32Array;
  132284. readonly renderHeight: number;
  132285. readonly renderWidth: number;
  132286. }
  132287. interface VRFieldOfView {
  132288. readonly downDegrees: number;
  132289. readonly leftDegrees: number;
  132290. readonly rightDegrees: number;
  132291. readonly upDegrees: number;
  132292. }
  132293. interface VRFrameData {
  132294. readonly leftProjectionMatrix: Float32Array;
  132295. readonly leftViewMatrix: Float32Array;
  132296. readonly pose: VRPose;
  132297. readonly rightProjectionMatrix: Float32Array;
  132298. readonly rightViewMatrix: Float32Array;
  132299. readonly timestamp: number;
  132300. }
  132301. interface VRPose {
  132302. readonly angularAcceleration: Float32Array | null;
  132303. readonly angularVelocity: Float32Array | null;
  132304. readonly linearAcceleration: Float32Array | null;
  132305. readonly linearVelocity: Float32Array | null;
  132306. readonly orientation: Float32Array | null;
  132307. readonly position: Float32Array | null;
  132308. readonly timestamp: number;
  132309. }
  132310. interface VRStageParameters {
  132311. sittingToStandingTransform?: Float32Array;
  132312. sizeX?: number;
  132313. sizeY?: number;
  132314. }
  132315. interface Navigator {
  132316. getVRDisplays(): Promise<VRDisplay[]>;
  132317. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  132318. }
  132319. interface Window {
  132320. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  132321. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  132322. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  132323. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  132324. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  132325. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  132326. }
  132327. interface Gamepad {
  132328. readonly displayId: number;
  132329. }
  132330. type XRSessionMode =
  132331. | "inline"
  132332. | "immersive-vr"
  132333. | "immersive-ar";
  132334. type XRReferenceSpaceType =
  132335. | "viewer"
  132336. | "local"
  132337. | "local-floor"
  132338. | "bounded-floor"
  132339. | "unbounded";
  132340. type XREnvironmentBlendMode =
  132341. | "opaque"
  132342. | "additive"
  132343. | "alpha-blend";
  132344. type XRVisibilityState =
  132345. | "visible"
  132346. | "visible-blurred"
  132347. | "hidden";
  132348. type XRHandedness =
  132349. | "none"
  132350. | "left"
  132351. | "right";
  132352. type XRTargetRayMode =
  132353. | "gaze"
  132354. | "tracked-pointer"
  132355. | "screen";
  132356. type XREye =
  132357. | "none"
  132358. | "left"
  132359. | "right";
  132360. interface XRSpace extends EventTarget {
  132361. }
  132362. interface XRRenderState {
  132363. depthNear?: number;
  132364. depthFar?: number;
  132365. inlineVerticalFieldOfView?: number;
  132366. baseLayer?: XRWebGLLayer;
  132367. }
  132368. interface XRInputSource {
  132369. handedness: XRHandedness;
  132370. targetRayMode: XRTargetRayMode;
  132371. targetRaySpace: XRSpace;
  132372. gripSpace: XRSpace | undefined;
  132373. gamepad: Gamepad | undefined;
  132374. profiles: Array<string>;
  132375. }
  132376. interface XRSession {
  132377. addEventListener: Function;
  132378. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  132379. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  132380. requestAnimationFrame: Function;
  132381. end(): Promise<void>;
  132382. renderState: XRRenderState;
  132383. inputSources: Array<XRInputSource>;
  132384. }
  132385. interface XRReferenceSpace extends XRSpace {
  132386. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  132387. onreset: any;
  132388. }
  132389. interface XRFrame {
  132390. session: XRSession;
  132391. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  132392. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  132393. }
  132394. interface XRViewerPose extends XRPose {
  132395. views: Array<XRView>;
  132396. }
  132397. interface XRPose {
  132398. transform: XRRigidTransform;
  132399. emulatedPosition: boolean;
  132400. }
  132401. declare var XRWebGLLayer: {
  132402. prototype: XRWebGLLayer;
  132403. new(session: XRSession, context: WebGLRenderingContext | undefined): XRWebGLLayer;
  132404. };
  132405. interface XRWebGLLayer {
  132406. framebuffer: WebGLFramebuffer;
  132407. framebufferWidth: number;
  132408. framebufferHeight: number;
  132409. getViewport: Function;
  132410. }
  132411. interface XRRigidTransform {
  132412. position: DOMPointReadOnly;
  132413. orientation: DOMPointReadOnly;
  132414. matrix: Float32Array;
  132415. inverse: XRRigidTransform;
  132416. }
  132417. interface XRView {
  132418. eye: XREye;
  132419. projectionMatrix: Float32Array;
  132420. transform: XRRigidTransform;
  132421. }
  132422. interface XRInputSourceChangeEvent {
  132423. session: XRSession;
  132424. removed: Array<XRInputSource>;
  132425. added: Array<XRInputSource>;
  132426. }